diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/cdn/2018-05-10 | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/cdn/2018-05-10')
| -rw-r--r-- | data/zh_cn/cdn/2018-05-10/api-docs.php | 25954 |
1 files changed, 25954 insertions, 0 deletions
diff --git a/data/zh_cn/cdn/2018-05-10/api-docs.php b/data/zh_cn/cdn/2018-05-10/api-docs.php new file mode 100644 index 0000000..f9cf900 --- /dev/null +++ b/data/zh_cn/cdn/2018-05-10/api-docs.php @@ -0,0 +1,25954 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cdn', + 'version' => '2018-05-10', + ], + 'directories' => [ + [ + 'id' => 159131, + 'title' => '域名管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 159132, + 'title' => '添加/删除域名', + 'type' => 'directory', + 'children' => [ + 'AddCdnDomain', + 'BatchAddCdnDomain', + 'DeleteCdnDomain', + 'DescribeCdnDeletedDomains', + ], + ], + [ + 'id' => 159137, + 'title' => '域名归属校验', + 'type' => 'directory', + 'children' => [ + 'VerifyDomainOwner', + 'DescribeVerifyContent', + 'DescribeDomainVerifyData', + ], + ], + [ + 'id' => 159140, + 'title' => '停用/启用加速域名', + 'type' => 'directory', + 'children' => [ + 'StartCdnDomain', + 'BatchStartCdnDomain', + 'StopCdnDomain', + 'BatchStopCdnDomain', + ], + ], + [ + 'id' => 159145, + 'title' => '域名配置', + 'type' => 'directory', + 'children' => [ + 'DescribeUserDomains', + 'DescribeDomainCname', + 'DescribeDomainsBySource', + 'DescribeCdnUserDomainsByFunc', + 'DescribeCdnDomainDetail', + 'DescribeCdnDomainConfigs', + 'BatchSetCdnDomainConfig', + 'BatchDeleteCdnDomainConfig', + 'BatchUpdateCdnDomain', + 'DeleteSpecificConfig', + 'ModifyCdnDomainSchdmByProperty', + 'ModifyCdnDomain', + ], + ], + [ + 'id' => 159157, + 'title' => '域名模拟环境配置', + 'type' => 'directory', + 'children' => [ + 'DescribeCdnDomainStagingConfig', + 'SetCdnDomainStagingConfig', + 'RollbackStagingConfig', + 'PublishStagingConfigToProduction', + 'DeleteSpecificStagingConfig', + ], + ], + [ + 'id' => 159163, + 'title' => '安全配置', + 'type' => 'directory', + 'children' => [ + 'SetWaitingRoomConfig', + 'DescribeCdnUserConfigs', + 'DescribeCdnWafDomain', + 'DescribeBlockedRegions', + ], + ], + ], + ], + [ + 'id' => 159185, + 'title' => '刷新预热', + 'type' => 'directory', + 'children' => [ + 'RefreshObjectCacheByCacheTag', + 'DescribeRefreshQuota', + 'PushObjectCache', + 'RefreshObjectCaches', + 'DescribeRefreshTasks', + 'DescribeRefreshTaskById', + 'DescribePreloadDetailById', + 'DescribeCdnUserQuota', + ], + ], + [ + 'id' => 159074, + 'title' => '监控查询', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 159075, + 'title' => '资源监控', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 171915, + 'title' => '访问数据', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainPathData', + 'DescribeDomainQpsData', + 'DescribeDomainQpsDataByLayer', + 'DescribeDomainBpsData', + 'DescribeDomainBpsDataByLayer', + 'DescribeDomainBpsDataByTimeStamp', + 'DescribeDomainTrafficData', + 'DescribeDomainHttpCodeData', + 'DescribeDomainHttpCodeDataByLayer', + 'DescribeDomainHitRateData', + 'DescribeDomainReqHitRateData', + 'DescribeDomainsUsageByDay', + 'DescribeDomainDetailDataByLayer', + 'DescribeRangeDataByLocateAndIspService', + ], + ], + [ + 'id' => 171916, + 'title' => '回源数据', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainSrcBpsData', + 'DescribeDomainSrcHttpCodeData', + 'DescribeDomainSrcTrafficData', + 'DescribeDomainSrcQpsData', + ], + ], + ], + ], + [ + 'id' => 159094, + 'title' => '实时监控', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 171917, + 'title' => '访问数据', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainRealTimeTrafficData', + 'DescribeDomainRealTimeBpsData', + 'DescribeDomainRealTimeHttpCodeData', + 'DescribeDomainRealTimeQpsData', + 'DescribeDomainRealTimeReqHitRateData', + 'DescribeDomainRealTimeByteHitRateData', + ], + ], + [ + 'id' => 171918, + 'title' => '回源数据', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainRealTimeSrcBpsData', + 'DescribeDomainRealTimeSrcHttpCodeData', + 'DescribeDomainRealTimeSrcTrafficData', + ], + ], + ], + ], + [ + 'id' => 159128, + 'title' => '边缘脚本监控', + 'type' => 'directory', + 'children' => [ + 'DescribeEsExecuteData', + 'DescribeEsExceptionData', + ], + ], + ], + ], + [ + 'id' => 159116, + 'title' => '用量查询', + 'type' => 'directory', + 'children' => [ + 'DescribeCdnUserBillHistory', + 'DescribeCdnUserBillType', + 'DescribeCdnUserBillPrediction', + 'CreateUserUsageDataExportTask', + 'DescribeUserUsageDataExportTask', + 'DeleteUserUsageDataExportTask', + 'CreateUsageDetailDataExportTask', + 'DescribeUserUsageDetailDataExportTask', + 'DeleteUsageDetailDataExportTask', + 'DescribeDomainMax95BpsData', + 'DescribeDomainUsageData', + 'DescribeCdnUserResourcePackage', + ], + ], + [ + 'id' => 159168, + 'title' => '日志管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 159169, + 'title' => '实时日志', + 'type' => 'directory', + 'children' => [ + 'DeleteRealTimeLogLogstore', + 'CreateRealTimeLogDelivery', + 'ModifyRealtimeLogDelivery', + 'DeleteRealtimeLogDelivery', + 'DisableRealtimeLogDelivery', + 'EnableRealtimeLogDelivery', + 'ListRealtimeLogDelivery', + 'DescribeDomainRealtimeLogDelivery', + 'DescribeRealtimeDeliveryAcc', + 'ListRealtimeLogDeliveryInfos', + 'ListRealtimeLogDeliveryDomains', + ], + ], + [ + 'id' => 159179, + 'title' => '离线日志', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainCustomLogConfig', + 'DescribeCustomLogConfig', + 'DescribeCdnDomainLogs', + 'ListDomainsByLogConfigId', + 'ListUserCustomLogConfig', + ], + ], + ], + ], + [ + 'id' => 159191, + 'title' => '服务管理', + 'type' => 'directory', + 'children' => [ + 'OpenCdnService', + 'DescribeCdnRegionAndIsp', + 'DescribeCdnOrderCommodityCode', + 'DescribeCdnService', + ], + ], + [ + 'id' => 159194, + 'title' => '证书管理', + 'type' => 'directory', + 'children' => [ + 'DescribeCdnDomainByCertificate', + 'DescribeDomainCertificateInfo', + 'DescribeCdnCertificateDetail', + 'DescribeCdnCertificateList', + 'DescribeCdnSSLCertificateList', + 'DescribeCdnHttpsDomainList', + 'DescribeCertificateInfoByID', + 'DescribeCdnCertificateDetailById', + 'DescribeUserCertificateExpireCount', + 'CreateCdnCertificateSigningRequest', + 'SetCdnDomainCSRCertificate', + 'SetCdnDomainSMCertificate', + 'DescribeCdnSMCertificateList', + 'DescribeCdnSMCertificateDetail', + 'SetCdnDomainSSLCertificate', + ], + ], + [ + 'id' => 159209, + 'title' => '标签管理', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'DescribeTagResources', + 'DescribeUserTags', + 'UntagResources', + 'ListTagResources', + ], + ], + [ + 'id' => 159214, + 'title' => '运营报表', + 'type' => 'directory', + 'children' => [ + 'CreateCdnSubTask', + 'DescribeCdnSubList', + 'UpdateCdnSubTask', + 'DeleteCdnSubTask', + 'DescribeCdnReport', + 'DescribeCdnReportList', + 'CreateCdnDeliverTask', + 'DescribeCdnDeliverList', + 'UpdateCdnDeliverTask', + 'DeleteCdnDeliverTask', + ], + ], + [ + 'id' => 169776, + 'title' => '辅助工具', + 'type' => 'directory', + 'children' => [ + 'DescribeIpInfo', + 'DescribeStagingIp', + 'DescribeL2VipsByDomain', + 'DescribeUserVipsByDomain', + 'DescribeIpStatus', + 'AddFCTrigger', + 'UpdateFCTrigger', + 'DescribeFCTrigger', + 'DeleteFCTrigger', + 'ListFCTrigger', + ], + ], + [ + 'id' => 159234, + 'title' => '安全信息查询', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainCcActivityLog', + ], + ], + [ + 'id' => 170411, + 'title' => '旧版已下线', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 159104, + 'title' => '统计分析', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainPvData', + 'DescribeDomainUvData', + 'DescribeDomainTopUrlVisit', + 'DescribeDomainTopClientIpVisit', + 'DescribeDomainTopReferVisit', + 'DescribeDomainSrcTopUrlVisit', + 'DescribeTopDomainsByFlow', + 'DescribeDomainRegionData', + 'DescribeDomainISPData', + 'DescribeDomainAverageResponseTime', + ], + ], + 'DescribeDomainRealTimeDetailData', + 'DescribeDomainMultiUsageData', + 'DescribeUserConfigs', + 'SetReqHeaderConfig', + ], + ], + [ + 'id' => 182313, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ModifyCdnService', + 'DescribeUserCdnStatus', + 'DescribeCdnTypes', + 'ModifyCdnDomainOwner', + 'DescribeCdnConditionIPBInfo', + 'DescribeCdnSecFuncInfo', + 'CheckCdnDomainExist', + 'CheckCdnDomainICP', + 'BatchDescribeCdnIpInfo', + 'DescribeCdnFullDomainsBlockIPHistory', + 'SetCdnFullDomainsBlockIP', + 'DescribeCdnFullDomainsBlockIPConfig', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AddCdnDomain' => [ + 'summary' => '调用AddCdnDomain添加加速域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '111676', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CdnType', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名的业务类型。取值：'."\n" + ."\n" + .'- **web**：图片小文件。'."\n" + .'- **download**：大文件下载。'."\n" + .'- **video**：视音频点播。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'download' => '大文件下载', + 'web' => '图片小文件', + 'video' => '音视频点播', + ], + 'example' => 'web', + 'enum' => [ + 'unitcell', + 'web', + 'download', + 'liveStream', + 'video', + 'app', + 'mixed_download', + ], + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要接入CDN的加速域名。'."\n" + ."\n" + .'支持泛域名，以英文句号（.）开头，例如.example.com。', + 'type' => 'string', + 'required' => true, + 'example' => '.example.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'不传该参数时，系统自动补全为默认资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyuji4b6r4**', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'schema' => [ + 'description' => '回源地址列表。', + 'type' => 'string', + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "content": "192.0.2.0",'."\n" + .' "type": "ipaddr",'."\n" + .' "priority": "20",'."\n" + .' "port": 80,'."\n" + .' "weight": "15"'."\n" + .' }'."\n" + .']', + ], + ], + [ + 'name' => 'CheckUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检测URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com/test.html', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '加速区域。取值：'."\n" + ."\n" + .'- **domestic**（默认值）：仅中国内地。'."\n" + ."\n" + .'- **overseas**：全球（不包含中国内地）。'."\n" + ."\n" + .'- **global**：全球。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + ], + ], + [ + 'name' => 'TopLevelDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '顶级接入域。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息列表。最大可填入20个标签信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified DomainName is malformed.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The input parameter cdnType that is mandatory for processing this request is not supplied.', + ], + [ + 'errorCode' => 'InvalidCdnType.Malformed', + 'errorMessage' => 'Specified CdnType is malformed.', + ], + [ + 'errorCode' => 'InvalidSources.Malformed', + 'errorMessage' => 'Specified Sources is malformed.', + ], + [ + 'errorCode' => 'InvalidSourceType.Malformed', + 'errorMessage' => 'Specified CdnType is malformed.', + ], + [ + 'errorCode' => 'InvalidSource.Priority.Malformed', + 'errorMessage' => 'The specified Source Priority is invalid.', + ], + [ + 'errorCode' => 'InvalidTypeAndContent.MissMatch', + 'errorMessage' => 'The specified source type does not match the specified source content.', + ], + [ + 'errorCode' => 'InvalidScope.Malformed', + 'errorMessage' => 'Specified Scope is malformed.', + ], + [ + 'errorCode' => 'SourceIp.Exceed', + 'errorMessage' => 'The Certificate you provided is malformed', + ], + [ + 'errorCode' => 'InvalidCertificate', + 'errorMessage' => 'The Certificate you provided is malformed', + ], + [ + 'errorCode' => 'InvalidCertificate.TooLong', + 'errorMessage' => 'The Certificate you provided is over the max length', + ], + [ + 'errorCode' => 'InnerAddDomainDenied', + 'errorMessage' => 'Your account has not bind aoneId, can not add domain.', + ], + [ + 'errorCode' => 'CheckSourceHealthFailed', + 'errorMessage' => 'sources ip or source domain check health failed,please input right source.', + ], + [ + 'errorCode' => 'ExtensiveAndAllBothExist', + 'errorMessage' => 'Extensive domain and the domain begins with all. can not exist at the same time.', + ], + [ + 'errorCode' => 'CdnTypeNotSupportExtensiveDomain', + 'errorMessage' => 'Extensive domain not supported for this cdn type.', + ], + [ + 'errorCode' => 'ExtensiveAndSpecificDomainConflict', + 'errorMessage' => 'The number of wildcard domain names exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidResourceGroupId.Malformed', + 'errorMessage' => 'Specified ResourceGroupId is malformed.', + ], + [ + 'errorCode' => 'DomainReserved', + 'errorMessage' => 'The root domain of your domain is reserved by another account. Submit a ticket to contact customer support.', + ], + [ + 'errorCode' => 'InvalidDomainNameLevel', + 'errorMessage' => 'Domain name suffixed with alicdn.com only support third level.', + ], + [ + 'errorCode' => 'InvalidTopLevelDomain.Malformed', + 'errorMessage' => 'Specified TopLevelDomain is malformed.', + ], + [ + 'errorCode' => 'TopLevelDomain.NotFound', + 'errorMessage' => 'TopLevelDomain is not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'InvalidStatus.ResourceGroup', + 'errorMessage' => 'It is not allowed to do this operation because of the current status of resource-group.', + ], + [ + 'errorCode' => 'NotInternationRealIdentity', + 'errorMessage' => 'You need to do real name authentication when you use Chinese mainland resources.', + ], + [ + 'errorCode' => 'Abs.CheckUrl.Malformed', + 'errorMessage' => 'The CheckUrl you provided is malformed.', + ], + [ + 'errorCode' => 'RecordCheckNotAvailable', + 'errorMessage' => 'The ICP filing interface is unavailable. Please try again later.', + ], + [ + 'errorCode' => 'IcpBlack', + 'errorMessage' => 'The domain is on the ICP blacklist.', + ], + [ + 'errorCode' => 'IspBlack', + 'errorMessage' => 'The domain is on the ISP blacklist.', + ], + [ + 'errorCode' => 'DomainOwnerVerifyFail', + 'errorMessage' => 'Owner verification of the root domain failed.', + ], + [ + 'errorCode' => 'TopLevelDomain.Mismatch', + 'errorMessage' => 'The specified TopLevelDomain does not match webSiteType.', + ], + [ + 'errorCode' => 'DomainInBlacklist', + 'errorMessage' => 'The domain is in the blacklist.', + ], + [ + 'errorCode' => 'InvalidTagKey', + 'errorMessage' => 'The specified TagKey is invalid.', + ], + [ + 'errorCode' => 'InvalidTagValue', + 'errorMessage' => 'The specified TagValue is invalid.', + ], + [ + 'errorCode' => 'InvalidTagKey.Repeated', + 'errorMessage' => 'The specified TagKey is duplicated.', + ], + [ + 'errorCode' => 'InvalidTag', + 'errorMessage' => 'The specified Tag is Invalid.', + ], + [ + 'errorCode' => 'InvalidTagKey.OverLimit', + 'errorMessage' => 'The number of Tag can not over limit 20.', + ], + [ + 'errorCode' => 'SourceInBlacklist', + 'errorMessage' => 'Source is in the blacklist.', + ], + [ + 'errorCode' => 'ReservedTagKey', + 'errorMessage' => 'The tag key is used internally as a reserved field and is not allowed to be used.', + ], + [ + 'errorCode' => 'DomainOverLimit', + 'errorMessage' => 'The maximum number of domains is exceeded.', + ], + [ + 'errorCode' => 'DomainInRiskList', + 'errorMessage' => 'The domain you added may be at risk. If you have any questions, please submit a ticket.', + ], + [ + 'errorCode' => 'RegionNoResource', + 'errorMessage' => 'Resource allocation failed. Please submit a work order to contact customer service.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccountException', + 'errorMessage' => 'Account exception. Please open ticket to make an appeal.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<AddCdnDomainResponse>\\n <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\n</AddCdnDomainResponse>","errorExample":""}]', + 'title' => '添加域名', + 'description' => '- 添加域名之前，您需要先开通CDN服务。具体操作，请参见[开通CDN服务](~~27272~~)。'."\n" + .'- 加速域名必须已成功备案。'."\n" + .'- 每次只能添加一个加速域名，每个用户最多可以添加50个域名。'."\n" + .'- 源站内容如果不在阿里云平台上，需进行审核，审核工作会在下一个工作日前完成。'."\n" + .'- 单个用户的调用频率：30次/秒。'."\n" + ."\n" + .'## 注意事项'."\n" + .'- 通过接口添加了域名之后，将会有3～5分钟的域名生效时间，在这段时间内请不要添加任何配置，待域名状态处于online以后再进行下一步的配置。', + 'requestParamsDescription' => 'Sources参数的各字段含义如下表所示。'."\n" + ."\n" + .'| 参数 | 类型 | 是否必选 | 描述 |'."\n" + .'|------------|--------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| type | String | 是 | 源站类型。取值：<br>ipaddr：IP源站。<br>domain：域名源站。<br>oss：OSS Bucket为源站。<br>fc_domain：函数计算为源站。 |'."\n" + .'| content | String | 是 | 回源地址，可以是IP或域名。 |'."\n" + .'| port| Integer| 否 | 端口。<br>您可以指定443或80端口，也可以自定义端口，默认值为80端口。443端口支持HTTPS协议回源。 |'."\n" + .'| priority | String | 否 | 源站地址对应的优先级。<br>支持20和30，默认值为20。20是主源，30是备源。|'."\n" + .'| weight | String | 否 | 回源权重，取值范围为100以内，默认值为10。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchAddCdnDomain' => [ + 'summary' => '调用BatchAddCdnDomain可以实现批量添加加速域名，一次最多可以添加50个加速域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '111681', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CdnType', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名的业务类型。取值：'."\n" + ."\n" + .'- **web**：图片小文件。'."\n" + ."\n" + .'- **download**：大文件下载。'."\n" + ."\n" + .'- **video**：视音频点播。', + 'type' => 'string', + 'required' => true, + 'example' => 'web', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要接入CDN的加速域名，多个域名用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com,aliyundoc.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，不传时，自动补全默认资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyuji4b6r4**', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'schema' => [ + 'description' => '回源地址列表。', + 'type' => 'string', + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "content": "192.0.2.0",'."\n" + .' "type": "ipaddr",'."\n" + .' "priority": "20",'."\n" + .' "port": 80,'."\n" + .' "weight": "15"'."\n" + .' }'."\n" + .']', + ], + ], + [ + 'name' => 'CheckUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '检测URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'url', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '加速区域。取值：'."\n" + ."\n" + .'- **domestic**：仅中国内地。'."\n" + ."\n" + .'- **overseas**：全球（不包含中国内地）。'."\n" + ."\n" + .'- **global**：全球。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + ], + ], + [ + 'name' => 'TopLevelDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '顶级接入域。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified DomainName is malformed.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The input parameter cdnType that is mandatory for processing this request is not supplied.', + ], + [ + 'errorCode' => 'InvalidCdnType.Malformed', + 'errorMessage' => 'Specified CdnType is malformed.', + ], + [ + 'errorCode' => 'InvalidSources.Malformed', + 'errorMessage' => 'Specified Sources is malformed.', + ], + [ + 'errorCode' => 'InvalidSourceType.Malformed', + 'errorMessage' => 'Specified CdnType is malformed.', + ], + [ + 'errorCode' => 'InvalidSource.Priority.Malformed', + 'errorMessage' => 'The specified Source Priority is invalid.', + ], + [ + 'errorCode' => 'InvalidTypeAndContent.MissMatch', + 'errorMessage' => 'InvalidTypeAndContent.MissMatch', + ], + [ + 'errorCode' => 'InvalidScope.Malformed', + 'errorMessage' => 'Specified Scope is malformed.', + ], + [ + 'errorCode' => 'SourceIp.Exceed', + 'errorMessage' => 'The Certificate you provided is malformed', + ], + [ + 'errorCode' => 'InvalidCertificate', + 'errorMessage' => 'The Certificate you provided is malformed', + ], + [ + 'errorCode' => 'InvalidCertificate.TooLong', + 'errorMessage' => 'The Certificate you provided is over the max length', + ], + [ + 'errorCode' => 'InnerAddDomainDenied', + 'errorMessage' => 'Your account has not bind aoneId, can not add domain.', + ], + [ + 'errorCode' => 'CheckSourceHealthFailed', + 'errorMessage' => 'sources ip or source domain check health failed,please input right source.', + ], + [ + 'errorCode' => 'ExtensiveAndAllBothExist', + 'errorMessage' => 'Extensive domain and the domain begins with all. can not exist at the same time.', + ], + [ + 'errorCode' => 'CdnTypeNotSupportExtensiveDomain', + 'errorMessage' => 'Extensive domain not supported for this cdn type.', + ], + [ + 'errorCode' => 'ExtensiveAndSpecificDomainConflict', + 'errorMessage' => 'The number of wildcard domain names exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidResourceGroupId.Malformed', + 'errorMessage' => 'Specified ResourceGroupId is malformed.', + ], + [ + 'errorCode' => 'DomainReserved', + 'errorMessage' => 'The root domain of your domain is reserved by another account. Submit a ticket to contact customer support.', + ], + [ + 'errorCode' => 'InvalidDomainNameLevel', + 'errorMessage' => 'Domain name suffixed with alicdn.com only support third level.', + ], + [ + 'errorCode' => 'InvalidTopLevelDomain.Malformed', + 'errorMessage' => 'Specified TopLevelDomain is malformed.', + ], + [ + 'errorCode' => 'TopLevelDomain.NotFound', + 'errorMessage' => 'TopLevelDomain is not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'InvalidStatus.ResourceGroup', + 'errorMessage' => 'It is not allowed to do this operation because of the current status of resource-group.', + ], + [ + 'errorCode' => 'NotInternationRealIdentity', + 'errorMessage' => 'You need to do real name authentication when you use Chinese mainland resources.', + ], + [ + 'errorCode' => 'RecordCheckNotAvailable', + 'errorMessage' => 'The ICP filing interface is unavailable. Please try again later.', + ], + [ + 'errorCode' => 'IcpBlack', + 'errorMessage' => 'The domain is on the ICP blacklist.', + ], + [ + 'errorCode' => 'IspBlack', + 'errorMessage' => 'The domain is on the ISP blacklist.', + ], + [ + 'errorCode' => 'DomainOwnerVerifyFail', + 'errorMessage' => 'Owner verification of the root domain failed.', + ], + [ + 'errorCode' => 'TopLevelDomain.Mismatch', + 'errorMessage' => 'The specified TopLevelDomain does not match webSiteType.', + ], + [ + 'errorCode' => 'DomainOverLimit', + 'errorMessage' => 'The maximum number of domains is exceeded.', + ], + [ + 'errorCode' => 'DomainInRiskList', + 'errorMessage' => 'The domain you added may be at risk. If you have any questions, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchAddCdnDomainResponse>\\r\\n\\t<RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\r\\n</BatchAddCdnDomainResponse>","errorExample":""}]', + 'title' => '批量添加域名', + 'description' => '- 添加加速域名之前，必须先开通CDN服务。具体操作，请参见[开通CDN服务](~~27272~~)。'."\n" + .'- 如果加速区域选择的是仅中国内地或者全球，则加速域名必须已完成备案。'."\n" + .'- 支持批量查询域名，多个域名用半角逗号（,）分隔，一次最多支持50个域名查询。'."\n" + .'- 其他配置相关的详细说明，具体请参见[添加加速域名](~~122181~~)。'."\n" + .'- 单用户调用频率：30次/秒。', + 'requestParamsDescription' => 'Sources各字段含义如下所示。'."\n" + ."\n" + .'| 参数 | 类型 | 是否必选 | 描述 |'."\n" + .'|------------|--------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| type | String | 是 | 源站类型。<br>ipaddr：IP源站。<br>domain：域名源站。<br>oss：OSS Bucket为源站。<br>fc_domain：函数计算源站。 |'."\n" + .'| content | String | 是 | 回源地址，可以是IP或域名。 |'."\n" + .'| port| Integer| 否 | 端口，可以指定443、80（默认值），也可以自定义端口。443是HTTPS协议回源。 |'."\n" + .'| priority | String | 否 | 源站地址对应的优先级，支持20（默认值）和30。20是主源，30是备源。|'."\n" + .'| weight | String | 否 | 回源权重，100以内，默认值为10。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCdnDomain' => [ + 'summary' => '调用DeleteCdnDomain删除已添加的加速域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '111702', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的CDN的域名，仅支持删除单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + [ + 'errorCode' => 'RewriteHostRely', + 'errorMessage' => 'Domain name is configured as rewrite host by others.', + ], + [ + 'errorCode' => 'InvalidDomain.BelongToConfigGroup', + 'errorMessage' => 'This Domain activated in configuration group and should modify by config group.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'You do not have access to this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DeleteCdnDomainResponse>\\t\\r\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\r\\n</DeleteCdnDomainResponse>","errorExample":""}]', + 'title' => '删除域名', + 'description' => '- 删除域名前建议您前往域名解析服务商处恢复域名A记录，以免删除域名后导致域名不可访问。'."\n" + .'- DeleteCdnDomain接口调用成功后将删除本条加速域名的全部相关记录，如果您仅需要暂停该加速域名的使用，请调用StopCdnDomain接口。'."\n" + .'- 单用户调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnDeletedDomains' => [ + 'summary' => '调用DescribeCdnDeletedDomains查询您名下已删除的域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111723', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码，默认值**1**，取值范围：**1**~**100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的域名个数，默认值**20**，取值范围：**1**~**500**之前的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '5', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AA75AADB-5E25-4970-B480-EAA1F5658483', + ], + 'PageNumber' => [ + 'description' => '当前页码，同请求参数的**PageNumber**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的域名个数，同请求参数的**PageSize**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'TotalCount' => [ + 'description' => '查询到的域名总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'Domains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PageData' => [ + 'description' => '加速域名的状态信息。', + 'type' => 'array', + 'items' => [ + 'description' => '域名信息。', + 'type' => 'object', + 'properties' => [ + 'GmtModified' => [ + 'description' => '加速域名修改时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2015-10-28T11:05:52Z', + ], + 'DomainName' => [ + 'description' => '加速域名名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageNumber.ValueNotSupported', + 'errorMessage' => 'The specified value of PageNumber is not supported.', + ], + [ + 'errorCode' => 'InvalidPageSize.ValueNotSupported', + 'errorMessage' => 'The specified value of PageSize is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AA75AADB-5E25-4970-B480-EAA1F5658483\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"TotalCount\\": 16,\\n \\"Domains\\": {\\n \\"PageData\\": [\\n {\\n \\"GmtModified\\": \\"2015-10-28T11:05:52Z\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnDeletedDomainsResponse>\\n<PageNumber>1</PageNumber>\\n<TotalCount>16</TotalCount>\\n<PageSize>5</PageSize>\\n<RequestId>AA75AADB-5E25-4970-B480-EAA1F5658483</RequestId>\\n<Domains>\\n <PageData>\\n <DomainName>example.com</DomainName>\\n <GmtModified>2015-10-28T11:05:52Z</GmtModified>\\n </PageData>\\n <PageData>\\n <DomainName>example.org</DomainName>\\n <GmtModified>2015-10-28T11:05:50Z</GmtModified>\\n </PageData>\\n <PageData>\\n <DomainName>example.net</DomainName>\\n <GmtModified>2015-10-27T06:26:34Z</GmtModified>\\n </PageData>\\n <PageData>\\n <DomainName>example.edu</DomainName>\\n <GmtModified>2015-10-23T09:23:29Z</GmtModified>\\n </PageData>\\n <PageData>\\n <DomainName>aliyundoc.com</DomainName>\\n <GmtModified>2015-10-23T09:02:11Z</GmtModified>\\n </PageData>\\n</Domains>\\n</DescribeCdnDeletedDomainsResponse>","errorExample":""}]', + 'title' => '查询已删除域名', + 'description' => '> 单用户调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'VerifyDomainOwner' => [ + 'summary' => '调用VerifyDomainOwner对域名归属权进行校验。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111923', + 'abilityTreeNodes' => [ + 'FEATUREcdnRLQ471', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '只支持单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'VerifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '校验方式，取值：'."\n" + ."\n" + .'- **dnsCheck**：DNS验证。'."\n" + .'- **fileCheck**：文件验证。', + 'type' => 'string', + 'required' => true, + 'example' => 'dnsCheck', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '校验内容。'."\n" + ."\n" + .'>调用成功不返回该参数，调用失败返回校验内容。', + 'type' => 'string', + 'example' => 'verify_dffeb6610035dcb77b413a59c32c****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34AB41F1-04A5-496F-8C8D-634BDBE6A9FB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DomainOwnerVerifyFail', + 'errorMessage' => 'Owner verification of the root domain failed.', + ], + [ + 'errorCode' => 'InvalidFile', + 'errorMessage' => 'The file is not found.', + ], + [ + 'errorCode' => 'VerifyError', + 'errorMessage' => 'The specified Verify is incorrectly formatted.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413a59c32c****\\",\\n \\"RequestId\\": \\"34AB41F1-04A5-496F-8C8D-634BDBE6A9FB\\"\\n}","errorExample":""},{"type":"xml","example":"<VerifyDomainOwnerResponse>\\n<Content>verify_dffeb6610035dcb77b413a59c32c****</Content>\\n<RequestId>34AB41F1-04A5-496F-8C8D-634BDBE6A9FB</RequestId>\\n</VerifyDomainOwnerResponse>","errorExample":""}]', + 'title' => '校验域名归属权', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVerifyContent' => [ + 'summary' => '调用DescribeVerifyContent查询归属校验内容。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111847', + 'abilityTreeNodes' => [ + 'FEATUREcdnRLQ471', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '只支持单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '校验内容。', + 'type' => 'string', + 'example' => 'verify_dffeb6610035dcb77b413a59c32cd91f', + ], + 'RequestId' => [ + 'description' => '该条任务请求ID。', + 'type' => 'string', + 'example' => '34AB41F1-04A5-496F-8C8D-634BDBE6A9FB', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413a59c32cd91f\\",\\n \\"RequestId\\": \\"34AB41F1-04A5-496F-8C8D-634BDBE6A9FB\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeVerifyContentResponse>\\n<Content>verify_dffeb6610035dcb77b413a59c32cd91f</Content>\\n<RequestId>34AB41F1-04A5-496F-8C8D-634BDBE6A9FB</RequestId>\\n</DescribeVerifyContentResponse>","errorExample":""}]', + 'title' => '查询校验归属权内容', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainVerifyData' => [ + 'summary' => '调用DescribeDomainVerifyData，根据加速域名是否开启全球资源计划，返回对应的校验内容。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '178430', + 'abilityTreeNodes' => [ + 'FEATUREcdnRLQ471', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持查询单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.yourdomain.com', + ], + ], + [ + 'name' => 'GlobalResourcePlan', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启全球资源计划。'."\n" + .'支持：'."\n" + .'- **on**（开启）'."\n" + .'- **off**（不开启）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'off', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '校验内容。', + 'type' => 'string', + 'example' => '{'."\n" + .' "verifiCode": "uy0-DxxxxxxxxKl-JnJY4",'."\n" + .' "verifyKey": "_acxxxe-xxxx"'."\n" + .'}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"{\\\\n \\\\\\"verifiCode\\\\\\": \\\\\\"uy0-DxxxxxxxxKl-JnJY4\\\\\\",\\\\n \\\\\\"verifyKey\\\\\\": \\\\\\"_acxxxe-xxxx\\\\\\"\\\\n}\\",\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', + 'title' => '查询域名归属校验内容', + ], + 'StartCdnDomain' => [ + 'summary' => '调用StartCdnDomain启用状态为停用的加速域名，将DomainStatus变更为Online。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111916', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持启用单个。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RecordCheckNotAvailable', + 'errorMessage' => 'The ICP filing interface is unavailable. Please try again later.', + ], + [ + 'errorCode' => 'IcpBlack', + 'errorMessage' => 'The domain is on the ICP blacklist.', + ], + [ + 'errorCode' => 'IspBlack', + 'errorMessage' => 'The domain is on the ISP blacklist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<StartCdnDomainResponse>\\r\\n\\t<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>\\r\\n</StartCdnDomainResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '启用域名', + 'description' => '- 如果域名处于非法状态或域名对应账户欠费，您将无法正常调用该接口启用加速域名。'."\n" + .'- 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchStartCdnDomain' => [ + 'summary' => '调用BatchStartCdnDomain批量启用状态为停用的加速域名，将DomainStatus变更为Online。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111686', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RecordCheckNotAvailable', + 'errorMessage' => 'The ICP filing interface is unavailable. Please try again later.', + ], + [ + 'errorCode' => 'IcpBlack', + 'errorMessage' => 'The domain is on the ICP blacklist.', + ], + [ + 'errorCode' => 'IspBlack', + 'errorMessage' => 'The domain is on the ISP blacklist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}"},{"type":"xml","example":"<BatchStartCdnDomainResponse>\\r\\n\\t<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>\\r\\n</BatchStartCdnDomainResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '批量启用域名', + 'description' => '- 如果域名处于非法状态或域名对应账户欠费，您将无法正常调用该接口启用加速域名。'."\n" + .'- 单用户调用频率：30次/秒。'."\n" + .'- 单次配置的域名数量不超过50个。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopCdnDomain' => [ + 'summary' => '调用StopCdnDomain停用某个加速域名，将DomainStatus变更为Offline。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111917', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持停用单个。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomain.BelongToConfigGroup', + 'errorMessage' => 'This Domain activated in configuration group and should modify by config group.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<StopCdnDomainResponse>\\r\\n\\t<RequestId>324AEFFF-308C-4DA7-8CD3-01B277B98F28</RequestId>\\r\\n</StopCdnDomainResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '停用域名', + 'description' => '- 停用加速域名后，加速域名的配置信息仍然会保留，但是阿里云CDN将停止为该域名提供加速服务，且该域名会被解析到无效地址“offline.***.com”，无法被继续访问。'."\n" + .'- 单用户调用频率：40次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchStopCdnDomain' => [ + 'summary' => '调用BatchStopCdnDomain批量停用加速域名，将DomainStatus变更为Offline。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111687', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '324AEFFF-308C-4DA7-8CD3-01B277B98F28', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"324AEFFF-308C-4DA7-8CD3-01B277B98F28\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"324AEFFF-308C-4DA7-8CD3-01B277B98F28\\"\\n}"},{"type":"xml","example":"<BatchStopCdnDomainResponse>\\r\\n\\t<RequestId>324AEFFF-308C-4DA7-8CD3-01B277B98F28</RequestId>\\r\\n</BatchStopCdnDomainResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '批量停用域名', + 'description' => '- 停用加速域名后，加速域名的配置信息仍然会保留，但是阿里云CDN将停止为该域名提供加速服务，且该域名会被解析到无效地址“offline.***.com”，无法被继续访问。'."\n" + .'- 如果您暂时不需要对某域名进行加速，推荐您使用StopDomain接口，暂停域名加速效果。'."\n" + .'- 单用户调用频率：30次/秒。'."\n" + .'- 单次配置的域名数量不超过50个。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserDomains' => [ + 'summary' => '调用DescribeUserDomains查询用户名下所有的域名与状态，支持域名模糊匹配过滤和域名状态过滤。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111842', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，取值**1~500**，默认值为**20**，最大值为**500**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'example' => '5', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围：**1**~**100000**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。如果不传该参数，默认不做域名匹配搜索，返回所有符合条件的域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + 'maxLength' => 6800, + ], + ], + [ + 'name' => 'DomainStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '域名状态过滤。取值：'."\n" + .'- **online**：启用。'."\n" + .'- **offline**：停用。'."\n" + .'- **configuring**：配置中。'."\n" + .'- **configure_failed**：配置失败。'."\n" + .'- **checking**：正在审核。'."\n" + .'- **check_failed**：审核失败。'."\n" + .'- **stopping**：停用中。'."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'如果不传该参数，默认查询所有状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'configure_failed', + ], + ], + [ + 'name' => 'DomainSearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '域名查询类型。取值：'."\n" + .'- **fuzzy_match**：模糊匹配。'."\n" + .'- **pre_match**：前匹配。'."\n" + .'- **suf_match**：后匹配。'."\n" + .'- **full_match**（默认值）：完全匹配。'."\n" + ."\n" + .'> 传递了域名参数的情况下，不传DomainSearchType参数，则默认采用完全匹配模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy_match', + ], + ], + [ + 'name' => 'CdnType', + 'in' => 'query', + 'schema' => [ + 'description' => 'CDN业务类型，多个用半角逗号（,）分隔。取值：'."\n" + .'- **web**：图片小文件。'."\n" + .'- **download**：大文件下载。'."\n" + .'- **video**：视音频点播。'."\n" + ."\n" + .'如果不传该参数，默认查询所有业务类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'download,web,video', + ], + ], + [ + 'name' => 'CheckDomainShow', + 'in' => 'query', + 'schema' => [ + 'description' => '是否展示审核中、审核失败、配置失败的域名。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，默认查询所有资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcd1234abcd1234', + ], + ], + [ + 'name' => 'ChangeStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '更新开始时间，使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-10-10T12:14:55Z', + ], + ], + [ + 'name' => 'ChangeEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '更新结束时间，使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需晚于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-10-10T12:14:58Z', + ], + ], + [ + 'name' => 'Coverage', + 'in' => 'query', + 'schema' => [ + 'description' => '加速区域，默认为全部区域。取值：'."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **global**：全球。'."\n" + .'- **overseas**：全球（不包含中国内地）。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '源站信息。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。列表元素最大数量：20。', + 'type' => 'array', + 'items' => [ + 'description' => '标签解释。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + ."\n" + .'默认查询所有标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'默认查询所有标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '参数解释。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BDA62CE4-3477-439A-B52E-D2D7C829D7C1', + ], + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Domains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PageData' => [ + 'description' => '域名信息。', + 'type' => 'array', + 'items' => [ + 'description' => '域名信息。', + 'type' => 'object', + 'properties' => [ + 'SslProtocol' => [ + 'description' => 'HTTPS开关。取值：'."\n" + ."\n" + .'- **on**：已开启。'."\n" + .'- **off**：未开启。', + 'type' => 'string', + 'example' => 'on', + ], + 'Sandbox' => [ + 'description' => '是否在沙箱。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **空字符串**：否', + 'type' => 'string', + 'example' => 'true', + ], + 'GmtModified' => [ + 'description' => '加速域名修改时间。', + 'type' => 'string', + 'example' => '2015-10-28T11:05:52Z', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DomainId' => [ + 'description' => '加速域名ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11223344', + ], + 'GmtCreated' => [ + 'description' => '加速域名创建时间。', + 'type' => 'string', + 'example' => '2015-10-28T09:32:51Z', + ], + 'Description' => [ + 'description' => '域名备案信息的描述。', + 'type' => 'string', + 'example' => 'filing description', + ], + 'Coverage' => [ + 'description' => '加速区域。取值：'."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **global**：全球。'."\n" + .'- **overseas**：全球（不包含中国内地）。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'abcd1234abcd1234', + ], + 'Cname' => [ + 'description' => '加速域名对应的CNAME。', + 'type' => 'string', + 'example' => 'example.com.w.alikunlun.net', + ], + 'DomainStatus' => [ + 'description' => '加速域名状态。取值：'."\n" + .'- **online**：启用。'."\n" + .'- **offline**：停用。'."\n" + .'- **configuring**：配置中。'."\n" + .'- **configure_failed**：配置失败。'."\n" + .'- **checking**：正在审核。'."\n" + .'- **check_failed**：审核失败。'."\n" + .'- **stopping**：停用中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'configure_failed', + ], + 'CdnType' => [ + 'description' => '加速业务类型。取值：'."\n" + ."\n" + .'- **web**：图片小文件。'."\n" + .'- **download**：大文件下载。'."\n" + .'- **video**：视音频点播。'."\n", + 'type' => 'string', + 'example' => 'download', + ], + 'Sources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Source' => [ + 'description' => '数据类型Source。', + 'type' => 'array', + 'items' => [ + 'description' => '数据类型Source。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '源站类型。', + 'type' => 'string', + 'example' => 'oss', + ], + 'Weight' => [ + 'description' => '回源权重。', + 'type' => 'string', + 'example' => '15', + ], + 'Priority' => [ + 'description' => '优先级。', + 'type' => 'string', + 'example' => '20', + ], + 'Port' => [ + 'description' => '源站端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Content' => [ + 'description' => '源站地址。', + 'type' => 'string', + 'example' => '***.oss-cn-hangzhou.aliyuncs.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageNumber.ValueNotSupported', + 'errorMessage' => 'The specified value of PageNumber is not supported.', + ], + [ + 'errorCode' => 'InvalidPageSize.ValueNotSupported', + 'errorMessage' => 'The specified value of PageSize is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainStatus.ValueNotSupported', + 'errorMessage' => 'The specified value of DomainStatus is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainSearchType.ValueNotSupported', + 'errorMessage' => 'The specified value of DomainSearchType is invalid.', + ], + [ + 'errorCode' => 'InvalidChangeStartTime.Malformed', + 'errorMessage' => 'The specified ChangeStartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidChangeEndTime.Malformed', + 'errorMessage' => 'The specified ChangeEndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidCdnType.Malformed', + 'errorMessage' => 'The specified CdnType is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BDA62CE4-3477-439A-B52E-D2D7C829D7C1\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Domains\\": {\\n \\"PageData\\": [\\n {\\n \\"SslProtocol\\": \\"on\\",\\n \\"Sandbox\\": \\"true\\",\\n \\"GmtModified\\": \\"2015-10-28T11:05:52Z\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DomainId\\": 11223344,\\n \\"GmtCreated\\": \\"2015-10-28T09:32:51Z\\",\\n \\"Description\\": \\"filing description\\",\\n \\"Coverage\\": \\"domestic\\",\\n \\"ResourceGroupId\\": \\"abcd1234abcd1234\\",\\n \\"Cname\\": \\"example.com.w.alikunlun.net\\",\\n \\"DomainStatus\\": \\"configure_failed\\",\\n \\"CdnType\\": \\"download\\",\\n \\"Sources\\": {\\n \\"Source\\": [\\n {\\n \\"Type\\": \\"oss\\",\\n \\"Weight\\": \\"15\\",\\n \\"Priority\\": \\"20\\",\\n \\"Port\\": 80,\\n \\"Content\\": \\"***.oss-cn-hangzhou.aliyuncs.com\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserDomainsResponse>\\n <RequestId>BDA62CE4-3477-439A-B52E-D2D7C829D7C1</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n <TotalCount>2</TotalCount>\\n <Domains>\\n <SslProtocol>on</SslProtocol>\\n <Sandbox>normal</Sandbox>\\n <GmtModified>2015-10-28T11:05:52Z</GmtModified>\\n <DomainName>example.com</DomainName>\\n <DomainId>11223344</DomainId>\\n <GmtCreated>2015-10-28T09:32:51Z</GmtCreated>\\n <Description>filing description</Description>\\n <Coverage>domestic</Coverage>\\n <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>\\n <Cname>example.com.w.alikunlun.net</Cname>\\n <DomainStatus>configure_failed</DomainStatus>\\n <CdnType>download</CdnType>\\n <Sources>\\n <Type>oss</Type>\\n <Weight>15</Weight>\\n <Priority>20</Priority>\\n <Port>80</Port>\\n <Content>***.oss-cn-hangzhou.aliyuncs.com</Content>\\n </Sources>\\n </Domains>\\n</DescribeUserDomainsResponse>","errorExample":""}]', + 'title' => '查询用户域名', + 'description' => '- 单用户调用频率：100次/秒。'."\n" + .'- 支持批量查询域名，多个域名用半角逗号（,）分隔，一次最多支持50个域名查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainCname' => [ + 'summary' => '调用接口对加速域名 Cname 进行解析检测，查看解析结果判断是否完成Cname配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111769', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的加速域名，多个用逗号（,）分隔。参数不可为空', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com,example.org', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '检测结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '06D29681-B7CD-4034-A8CC-28AFFA213539', + ], + 'CnameDatas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Data' => [ + 'description' => 'Cname检测结果数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'Cname信息', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Cname检查结果。取值：'."\n" + ."\n" + .'- 0 表示通过域名解析检测到分配给域名的cname。'."\n" + .'- 1 表示通过域名解析暂未监测到分配给域名的cname。'."\n" + .'- -1 表示通过域名解析检测到分配给域名的cname超时', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '0', + '1', + -1 => '-1', + ], + 'example' => '0', + ], + 'Domain' => [ + 'description' => '输入参数中的加速域名。', + 'type' => 'string', + 'example' => 'a.com', + ], + 'Cname' => [ + 'description' => '阿里云CDN分配给域名的Cname', + 'type' => 'string', + 'example' => 'a.com.w.alikunlun.net', + ], + 'Passed' => [ + 'description' => '通过域名解析检测到分配给域名的cname是否通过，取值：'."\n" + .'- true: 通过'."\n" + .'- false: 不通过'."\n" + .'- timeout: 超时', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrMsg' => [ + 'description' => '通过域名解析检测到分配给域名的cname不通过或超时的错误信息。', + 'type' => 'string', + 'example' => 'timeout', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 30 domains are supported for each request.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvaildParameter', + 'errorMessage' => 'The parameter you provided is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06D29681-B7CD-4034-A8CC-28AFFA213539\\",\\n \\"CnameDatas\\": {\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"Domain\\": \\"a.com\\",\\n \\"Cname\\": \\"a.com.w.alikunlun.net\\",\\n \\"Passed\\": \\"true\\",\\n \\"ErrMsg\\": \\"timeout\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '检测加速域名的Cname是否完成配置', + ], + 'DescribeDomainsBySource' => [ + 'summary' => '调用DescribeDomainsBySource按源站查询加速域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111802', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Sources', + 'in' => 'query', + 'schema' => [ + 'description' => '源站，多个用半角逗号（,）分隔，不支持模糊匹配。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '参数解释。', + 'type' => 'object', + 'properties' => [ + 'Sources' => [ + 'description' => '请求的源站。', + 'type' => 'string', + 'example' => 'example.com,aliyundoc.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B0F074E5-A1AC-4B32-8EA2-6F450410D1E0', + ], + 'DomainsList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainsData' => [ + 'description' => '由DomainsData组成的数组格式，返回各个源站对应的域名名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '由DomainsData组成的数组格式，返回各个源站对应的域名名称列表。', + 'type' => 'object', + 'properties' => [ + 'Source' => [ + 'description' => '请求的一个源站。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DomainInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'domainInfo' => [ + 'description' => '由domainInfo组成的列表格式，返回域名的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '由domainInfo组成的列表格式，返回域名的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '域名状态。取值：'."\n" + ."\n" + .'- **applying**：审核中'."\n" + .'- **configuring**：配置中'."\n" + .'- **online**：正常运行'."\n" + .'- **stopping**：停止中'."\n" + .'- **offline**：停止'."\n" + .'- **disabling**：删除中', + 'type' => 'string', + 'example' => 'online', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2017-03-31T04:49:00+08:00', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2016-07-12T11:53:19+08:00', + ], + 'DomainCname' => [ + 'description' => 'CNAME。', + 'type' => 'string', + 'example' => '***.alikunlun.com', + ], + 'CdnType' => [ + 'description' => '加速域名的业务类型。取值：'."\n" + ."\n" + .'- **web**：图片小文件。'."\n" + ."\n" + .'- **download**：大文件下载。'."\n" + ."\n" + .'- **video**：视音频点播。', + 'type' => 'string', + 'example' => 'web', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.org', + ], + ], + ], + ], + ], + ], + 'Domains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'domainNames' => [ + 'description' => '由domainNames组成的列表格式，返回单个域名对应的域名名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '由domainNames组成的列表格式，返回单个域名对应的域名名称列表。', + 'type' => 'string', + 'example' => 'example.org', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The parameter Sources miss.', + ], + [ + 'errorCode' => 'InvalidSources.Malformed', + 'errorMessage' => 'Specified Sources is malformed.', + ], + [ + 'errorCode' => 'InvalidSources.NotFound', + 'errorMessage' => 'The sources provided does not found in your domains', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Sources\\": \\"example.com,aliyundoc.com\\",\\n \\"RequestId\\": \\"B0F074E5-A1AC-4B32-8EA2-6F450410D1E0\\",\\n \\"DomainsList\\": {\\n \\"DomainsData\\": [\\n {\\n \\"Source\\": \\"example.com\\",\\n \\"DomainInfos\\": {\\n \\"domainInfo\\": [\\n {\\n \\"Status\\": \\"online\\",\\n \\"UpdateTime\\": \\"2017-03-31T04:49:00+08:00\\",\\n \\"CreateTime\\": \\"2016-07-12T11:53:19+08:00\\",\\n \\"DomainCname\\": \\"***.alikunlun.com\\",\\n \\"CdnType\\": \\"web\\",\\n \\"DomainName\\": \\"example.org\\"\\n }\\n ]\\n },\\n \\"Domains\\": {\\n \\"domainNames\\": [\\n \\"example.org\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainsBySourceResponse>\\n <Sources>example.com,aliyundoc.com</Sources>\\n <RequestId>B0F074E5-A1AC-4B32-8EA2-6F450410D1E0</RequestId>\\n <DomainsList>\\n <Source>example.com</Source>\\n <DomainInfos>\\n <Status>online</Status>\\n <UpdateTime>2017-03-31T04:49:00+08:00</UpdateTime>\\n <CreateTime>2016-07-12T11:53:19+08:00</CreateTime>\\n <DomainCname>***.alikunlun.com</DomainCname>\\n <CdnType>web</CdnType>\\n <DomainName>example.org</DomainName>\\n </DomainInfos>\\n <Domains>example.org</Domains>\\n </DomainsList>\\n</DescribeDomainsBySourceResponse>","errorExample":""}]', + 'title' => '查询域名-按源站', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnUserDomainsByFunc' => [ + 'summary' => '调用DescribeCdnUserDomainsByFunc查询用户名下配置了指定功能的所有的域名及其状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111750', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FuncId', + 'in' => 'query', + 'schema' => [ + 'description' => '功能ID，您可在[域名配置功能参数](~~388460~~)文档，根据功能名称搜索查询。'."\n" + .'例如：配置回源HOST（set_req_host_header）功能ID为18。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值：**1**。'."\n" + ."\n" + .'取值范围：**1**~**100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页显示域名的数量，默认值：**20**。'."\n" + ."\n" + .'取值范围：**1**~**50**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AA75AADB-5E25-4970-B480-EAA1F5658483', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '单页显示域名的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'TotalCount' => [ + 'description' => '域名总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'Domains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PageData' => [ + 'description' => '加速域名的配置数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreated' => [ + 'description' => '加速域名创建时间。', + 'type' => 'string', + 'example' => '2015-10-28T11:05:52Z', + ], + 'SslProtocol' => [ + 'description' => 'https开关。取值：'."\n" + .'- **on**：已开启。'."\n" + .'- **off**：未开启。', + 'type' => 'string', + 'example' => 'on', + ], + 'Description' => [ + 'description' => '状态描述。', + 'type' => 'string', + 'example' => 'audit failed', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-xxxxx', + ], + 'DomainStatus' => [ + 'description' => '加速域名状态。取值：'."\n" + ."\n" + .'- **online**：启用。'."\n" + .'- **offline**：停用。'."\n" + .'- **configuring**：配置中。'."\n" + .'- **configure_failed**：配置失败。'."\n" + .'- **checking**：正在审核。'."\n" + .'- **check_failed**：审核失败。'."\n" + .'- **stopping**：停用中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'configure_failed', + ], + 'Cname' => [ + 'description' => '加速域名对应的CNAME域名。', + 'type' => 'string', + 'example' => 'example.com.w.alikunlun.com', + ], + 'GmtModified' => [ + 'description' => '加速域名修改时间。', + 'type' => 'string', + 'example' => '2015-10-29T10:15:31Z', + ], + 'CdnType' => [ + 'description' => '加速业务类型。取值：'."\n" + .'- **web**：图片小文件加速。'."\n" + .'- **download**：大文件下载加速。'."\n" + .'- **video**：视音频点播加速。'."\n" + .'- **liveStream**：直播流媒体加速。', + 'type' => 'string', + 'example' => 'web', + ], + 'DomainName' => [ + 'description' => '加速域名名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Sources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Source' => [ + 'description' => '源站信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '源站类型。取值：'."\n" + ."\n" + .'- **ipaddr**：IP源站。'."\n" + .'- **domain**：域名源站。'."\n" + .'- **oss**：OSS Bucket为源站。'."\n" + .'- **fc_domain**：函数计算为源站。', + 'type' => 'string', + 'example' => 'ipaddr', + ], + 'Weight' => [ + 'description' => '回源权重。', + 'type' => 'string', + 'example' => '10', + ], + 'Priority' => [ + 'description' => '优先级。', + 'type' => 'string', + 'example' => '20', + ], + 'Port' => [ + 'description' => '源站端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Content' => [ + 'description' => '源站地址。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageNumber.ValueNotSupported', + 'errorMessage' => 'The specified value of PageNumber is not supported.', + ], + [ + 'errorCode' => 'InvalidPageSize.ValueNotSupported', + 'errorMessage' => 'The specified value of PageSize is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainStatus.ValueNotSupported', + 'errorMessage' => 'The specified value of DomainStatus is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainSearchType.ValueNotSupported', + 'errorMessage' => 'The specified value of DomainSearchType is invalid.', + ], + [ + 'errorCode' => 'InvalidChangeStartTime.Malformed', + 'errorMessage' => 'The specified ChangeStartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidChangeEndTime.Malformed', + 'errorMessage' => 'The specified ChangeEndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidCdnType.Malformed', + 'errorMessage' => 'The specified CdnType is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AA75AADB-5E25-4970-B480-EAA1F5658483\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"TotalCount\\": 16,\\n \\"Domains\\": {\\n \\"PageData\\": [\\n {\\n \\"GmtCreated\\": \\"2015-10-28T11:05:52Z\\",\\n \\"SslProtocol\\": \\"on\\",\\n \\"Description\\": \\"audit failed\\",\\n \\"ResourceGroupId\\": \\"rg-xxxxx\\",\\n \\"DomainStatus\\": \\"configure_failed\\",\\n \\"Cname\\": \\"example.com.w.alikunlun.com\\",\\n \\"GmtModified\\": \\"2015-10-29T10:15:31Z\\",\\n \\"CdnType\\": \\"web\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Sources\\": {\\n \\"Source\\": [\\n {\\n \\"Type\\": \\"ipaddr\\",\\n \\"Weight\\": \\"10\\",\\n \\"Priority\\": \\"20\\",\\n \\"Port\\": 80,\\n \\"Content\\": \\"1.1.1.1\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<PageNumber>1</PageNumber>\\n<TotalCount>16</TotalCount>\\n<PageSize>5</PageSize>\\n<RequestId>AA75AADB-5E25-4970-B480-EAA1F5658483</RequestId>\\n<Domains>\\n <PageData>\\n <CdnType>download</CdnType>\\n <DomainStatus>configure_failed</DomainStatus>\\n <DomainName>example.com</DomainName>\\n <GmtModified>2015-10-28T11:05:52Z</GmtModified>\\n <GmtCreated>2015-10-28T09:32:51Z</GmtCreated>\\n <Description>audit failed</Description>\\n <ResourceGroupId>rg-xxxxx</ResourceGroupId>\\n <Sources>\\n <Source>\\n <Type>ipaddr</Type>\\n <Content>1.1.1.1</Content>\\n <Priority>20</Priority>\\n <Port>80</Port>\\n <Weight>10</Weight>\\n </Source>\\n </Sources>\\n </PageData>\\n <PageData>\\n <CdnType>web</CdnType>\\n <DomainStatus>configure_failed</DomainStatus>\\n <DomainName>example.org</DomainName>\\n <GmtModified>2015-10-28T11:05:50Z</GmtModified>\\n <GmtCreated>2015-10-28T09:31:59Z</GmtCreated>\\n <ResourceGroupId>rg-xxxxx</ResourceGroupId>\\n </PageData>\\n <PageData>\\n <Cname>example.edu.w.alikunlun.com</Cname>\\n <CdnType>video</CdnType>\\n <DomainStatus>online</DomainStatus>\\n <DomainName>example.edu</DomainName>\\n <GmtModified>2015-10-23T09:02:11Z</GmtModified>\\n <GmtCreated>2015-10-23T09:01:57Z</GmtCreated>\\n <ResourceGroupId>rg-xxxxx</ResourceGroupId>\\n </PageData>\\n</Domains>","errorExample":""}]', + 'title' => '查询域名-按功能', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnDomainDetail' => [ + 'summary' => '调用DescribeCdnDomainDetail查询指定加速域名的基本配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111728', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名信息，仅支持单个查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '18CF38AA-1275-451D-A12B-4EC0BF1C5E30', + ], + 'GetDomainDetailModel' => [ + 'description' => '域名详情。', + 'type' => 'object', + 'properties' => [ + 'GmtCreated' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2015-06-25T03:30:50Z', + ], + 'Description' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '直播域名', + ], + 'HttpsCname' => [ + 'description' => '开启HTTPS的CNAME域名。', + 'type' => 'string', + 'example' => 'example.com.w.kunlunle.com', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'abcd1234abcd1234', + ], + 'ServerCertificateStatus' => [ + 'description' => '是否开启SSL证书。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'Scope' => [ + 'description' => '加速区域。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'DomainStatus' => [ + 'description' => '加速域名运行状态。取值：'."\n" + .'- **online**：启用。'."\n" + .'- **offline**：停用。'."\n" + .'- **configuring**：配置中。'."\n" + .'- **configure_failed**：配置失败。'."\n" + .'- **checking**：正在审核。'."\n" + .'- **check_failed**：审核失败。'."\n" + .'- **stopping**：停用中。 '."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'online', + ], + 'Cname' => [ + 'description' => '为加速域名生成的一个CNAME域名，需要在域名解析服务商处将加速域名CNAME解析到该域名。', + 'type' => 'string', + 'example' => 'example.com.w.kunlunle.com', + ], + 'GmtModified' => [ + 'description' => '最近修改时间。', + 'type' => 'string', + 'example' => '2017-06-25T03:30:50Z', + ], + 'CdnType' => [ + 'description' => '加速域名的业务类型。取值：'."\n" + ."\n" + .'- **web**：图片小文件。'."\n" + ."\n" + .'- **download**：大文件下载。'."\n" + ."\n" + .'- **video**：视音频点播。', + 'type' => 'string', + 'example' => 'web', + ], + 'DomainName' => [ + 'description' => '加速的域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'SourceModels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SourceModel' => [ + 'description' => '源站信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '源站类型。取值：'."\n" + .'- **ipaddr**：IP源站。'."\n" + .'- **domain**：域名源站。'."\n" + .'- **oss**：OSS Bucket为源站。'."\n" + .'- **fc_domain**：函数计算为源站。', + 'type' => 'string', + 'example' => 'domain', + ], + 'Weight' => [ + 'description' => '回源权重。', + 'type' => 'string', + 'example' => '10', + ], + 'Enabled' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'online', + ], + 'Priority' => [ + 'description' => '优先级。', + 'type' => 'string', + 'example' => '20', + ], + 'Port' => [ + 'description' => '端口，支持443和80。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Content' => [ + 'description' => '回源地址。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"18CF38AA-1275-451D-A12B-4EC0BF1C5E30\\",\\n \\"GetDomainDetailModel\\": {\\n \\"GmtCreated\\": \\"2015-06-25T03:30:50Z\\",\\n \\"Description\\": \\"直播域名\\",\\n \\"HttpsCname\\": \\"example.com.w.kunlunle.com\\",\\n \\"ResourceGroupId\\": \\"abcd1234abcd1234\\",\\n \\"ServerCertificateStatus\\": \\"on\\",\\n \\"Scope\\": \\"domestic\\",\\n \\"DomainStatus\\": \\"online\\",\\n \\"Cname\\": \\"example.com.w.kunlunle.com\\",\\n \\"GmtModified\\": \\"2017-06-25T03:30:50Z\\",\\n \\"CdnType\\": \\"web\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"SourceModels\\": {\\n \\"SourceModel\\": [\\n {\\n \\"Type\\": \\"domain\\",\\n \\"Weight\\": \\"10\\",\\n \\"Enabled\\": \\"online\\",\\n \\"Priority\\": \\"20\\",\\n \\"Port\\": 80,\\n \\"Content\\": \\"example.com\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeCdnDomainDetailResponse>\\n<GetDomainDetailModel>\\n <CdnType>web</CdnType>\\n <Cname>example.com.w.kunlunle.com</Cname>\\n <DomainName>example.com</DomainName>\\n <DomainStatus>online</DomainStatus>\\n <GmtCreated>2015-06-25T03:30:50Z</GmtCreated>\\n <GmtModified>2015-06-25T03:30:53Z</GmtModified>\\n <HttpsCname>example.com.w.kunlunle.com</HttpsCname>\\n <SourceType>domain</SourceType>\\n <ResourceGroupId>abcd1234abcd1234</ResourceGroupId>\\n <SourceModels>\\n <SourceModel>\\n <Enabled>online</Enabled>\\n <Port>80</Port>\\n <Type>domain</Type>\\n <Content>example.com</Content>\\n <Priority>20</Priority>\\n <Weight>10</Weight>\\n </SourceModel>\\n </SourceModels>\\n</GetDomainDetailModel>\\n<RequestId>18CF38AA-1275-451D-A12B-4EC0BF1C5E30</RequestId>\\n</DescribeCdnDomainDetailResponse>","errorExample":""}]', + 'title' => '查询域名详情', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnDomainConfigs' => [ + 'summary' => '调用DescribeCdnDomainConfigs获取加速域名的配置信息，一次可查询多个功能配置信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111727', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持查询单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'FunctionNames', + 'in' => 'query', + 'schema' => [ + 'description' => '功能函数名称，多个用英文逗号（,）分隔。更多功能名称，请参见[域名配置功能参数](~~388460~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliauth', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '功能配置ID。ConfigId查询和使用，请参见[ConfigId使用说明](~~388994~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '6295', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C80705BF-0F76-41FA-BAD1-5B59296A4E59', + ], + 'DomainConfigs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainConfig' => [ + 'description' => '域名配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '配置状态。取值：'."\n" + ."\n" + .'- **success**：成功。'."\n" + ."\n" + .'- **testing**：测试中。'."\n" + ."\n" + .'- **failed**：失败。'."\n" + ."\n" + .'- **configuring**：配置中。', + 'type' => 'string', + 'example' => 'success', + ], + 'ParentId' => [ + 'description' => '规则条件ID，非必填项。'."\n" + ."\n" + .'通过配置[域名配置功能参数](~~388460~~)中的功能函数**condition**（规则引擎），可以创建出规则条件（规则条件可以通过识别用户请求中携带的各种参数来匹配和过滤用户请求），每一个规则条件被创建以后都会生成一个对应的[ConfigId](~~388994~~)，ConfigId可以被当作ParentId参数被其他功能函数引用，这样规则条件就可以与功能配置一起组合形成更灵活的配置。'."\n" + ."\n" + .'具体配置操作请参考[批量配置域名](~~90915~~)或下文ParentId配置示例说明。', + 'type' => 'string', + 'example' => '222728944812032', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'string', + 'example' => '6295', + ], + 'FunctionName' => [ + 'description' => '功能函数名称。', + 'type' => 'string', + 'example' => 'aliauth', + ], + 'FunctionArgs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FunctionArg' => [ + 'description' => '各个功能函数所对应的参数配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ArgName' => [ + 'description' => '参数名称，**functionName**的配置项（可配置多个配置项）。', + 'type' => 'string', + 'example' => 'auth_type', + ], + 'ArgValue' => [ + 'description' => '参数值，**functionName**的配置项的取值。', + 'type' => 'string', + 'example' => 'req_auth', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C80705BF-0F76-41FA-BAD1-5B59296A4E59\\",\\n \\"DomainConfigs\\": {\\n \\"DomainConfig\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"ParentId\\": \\"222728944812032\\",\\n \\"ConfigId\\": \\"6295\\",\\n \\"FunctionName\\": \\"aliauth\\",\\n \\"FunctionArgs\\": {\\n \\"FunctionArg\\": [\\n {\\n \\"ArgName\\": \\"auth_type\\",\\n \\"ArgValue\\": \\"req_auth\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnDomainConfigsResponse>\\n <RequestId>C80705BF-0F76-41FA-BAD1-5B59296A4E59</RequestId>\\n <DomainConfigs>\\n <Status>success</Status>\\n <ParentId>222728944812032</ParentId>\\n <ConfigId>6295</ConfigId>\\n <FunctionName>aliauth</FunctionName>\\n <FunctionArgs>\\n <ArgName>auth_type</ArgName>\\n <ArgValue>req_auth</ArgValue>\\n </FunctionArgs>\\n </DomainConfigs>\\n</DescribeCdnDomainConfigsResponse>","errorExample":""}]', + 'title' => '查询域名配置', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## ParentId配置示例'."\n" + .' **parentId**为**-1**：表示删除该配置里面已有的规则条件。'."\n" + .'```[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "功能参数A", '."\n" + .' "argValue": "功能参数A对应的值"'."\n" + .' }, '."\n" + .' {'."\n" + .' "argName": "功能参数B", '."\n" + .' "argValue": "功能参数B对应的值"'."\n" + .' }], '."\n" + .' "functionName": "功能名称",'."\n" + .' "parentId": "选填项，对应引用规则条件的configid"'."\n" + .'}]'."\n" + .'```'."\n" + .'不使用**parentId**的情况下，配置示例如下：'."\n" + .'使用函数**origin_request_header**添加回源HTTP请求头的时候引用了**configid=222728944812032**的规则条件，请求参数如下：'."\n" + .'```[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "header_operation_type",'."\n" + .' "argValue": "add"'."\n" + .' }, {'."\n" + .' "argName": "header_name",'."\n" + .' "argValue": "Accept-Encoding"'."\n" + .' }, {'."\n" + .' "argName": "header_value",'."\n" + .' "argValue": "gzip"'."\n" + .' }, {'."\n" + .' "argName": "duplicate",'."\n" + .' "argValue": "off"'."\n" + .' }],'."\n" + .' "functionName": "origin_request_header"'."\n" + .'}]'."\n" + .'```'."\n" + .'使用**parentId**的情况下，配置示例如下：'."\n" + .'使用函数**origin_request_header**添加回源HTTP请求头的时候引用了**configid=222728944812032**的规则条件，请求参数如下：'."\n" + .'```[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "header_operation_type",'."\n" + .' "argValue": "add"'."\n" + .' }, {'."\n" + .' "argName": "header_name",'."\n" + .' "argValue": "Accept-Encoding"'."\n" + .' }, {'."\n" + .' "argName": "header_value",'."\n" + .' "argValue": "gzip"'."\n" + .' }, {'."\n" + .' "argName": "duplicate",'."\n" + .' "argValue": "off"'."\n" + .' }],'."\n" + .' "functionName": "origin_request_header",'."\n" + .' "parentId": "222728944812032"'."\n" + .'}]'."\n" + .'```', + 'extraInfo' => ' ', + ], + 'BatchSetCdnDomainConfig' => [ + 'summary' => '调用BatchSetCdnDomainConfig进行域名批量配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111684', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，注意以下配置限制：'."\n" + ."\n" + .'- 一次最多传50个域名。'."\n" + .'- 域名个数乘以 Functions个数，小于等于50。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'Functions', + 'in' => 'query', + 'schema' => [ + 'description' => '功能列表，一次传入最多50条，格式如下：'."\n" + ."\n" + .'- **functionName**（功能名称，必填）：可配置功能请参见[功能列表](~~388460~~)，多个参数之间用半角逗号（,）分隔。'."\n" + .'- **argName**（参数名称，必填）：**functionName**的配置项（可配置多个配置项）。'."\n" + .'- **argValue**（参数值，必填）：**functionName**的配置项的取值。'."\n" + .'- **parentid**（规则条件ID，非必填）：通过配置[域名配置功能参数](~~388460~~)中的功能函数**condition**（规则引擎），可以创建出规则条件（规则条件可以通过识别用户请求中携带的各种参数来匹配和过滤用户请求），每一个规则条件被创建以后都会生成一个对应的[configid](~~388994~~)，configid可以被当作ParentId参数被其他功能函数引用，这样规则条件就可以与功能配置一起组合形成更灵活的配置。'."\n" + ."\n" + .'**parentId**为 **-1**：表示删除该配置里面已有的规则条件。'."\n" + .'```[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "功能参数A", '."\n" + .' "argValue": "功能参数A对应的值"'."\n" + .' }, '."\n" + .' {'."\n" + .' "argName": "功能参数B", '."\n" + .' "argValue": "功能参数B对应的值"'."\n" + .' }], '."\n" + .' "functionName": "功能名称",'."\n" + .' "parentId": 选填项，对应引用规则条件的configid'."\n" + .'}]'."\n" + .'```'."\n" + .'不使用**parentId**的情况下，配置示例如下：'."\n" + .'使用函数**origin_request_header**添加回源HTTP请求头的时候引用了**configid=222728944812032**的规则条件，请求参数如下：'."\n" + .'```[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "header_operation_type",'."\n" + .' "argValue": "add"'."\n" + .' }, {'."\n" + .' "argName": "header_name",'."\n" + .' "argValue": "Accept-Encoding"'."\n" + .' }, {'."\n" + .' "argName": "header_value",'."\n" + .' "argValue": "gzip"'."\n" + .' }, {'."\n" + .' "argName": "duplicate",'."\n" + .' "argValue": "off"'."\n" + .' }],'."\n" + .' "functionName": "origin_request_header"'."\n" + .'}]'."\n" + .'```'."\n" + .'使用**parentId**的情况下，配置示例如下：'."\n" + .'使用函数**origin_request_header**添加回源HTTP请求头的时候引用了**configid=222728944812032**的规则条件，请求参数如下：'."\n" + .'```[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "header_operation_type",'."\n" + .' "argValue": "add"'."\n" + .' }, {'."\n" + .' "argName": "header_name",'."\n" + .' "argValue": "Accept-Encoding"'."\n" + .' }, {'."\n" + .' "argName": "header_value",'."\n" + .' "argValue": "gzip"'."\n" + .' }, {'."\n" + .' "argName": "duplicate",'."\n" + .' "argValue": "off"'."\n" + .' }],'."\n" + .' "functionName": "origin_request_header",'."\n" + .' "parentId": 222728944812032'."\n" + .'}]'."\n" + .'```'."\n" + .'对一个已经使用了**parentId**的功能配置删除对**parentId**的引用，配置示例如下：'."\n" + .'函数**origin_request_header**添加回源HTTP请求头的时候已经引用了**configid=222728944812032**的规则条件，现在要删掉对规则条件的引用，请求参数如下：'."\n" + .'```[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "header_operation_type",'."\n" + .' "argValue": "add"'."\n" + .' }, {'."\n" + .' "argName": "header_name",'."\n" + .' "argValue": "Accept-Encoding"'."\n" + .' }, {'."\n" + .' "argName": "header_value",'."\n" + .' "argValue": "gzip"'."\n" + .' }, {'."\n" + .' "argName": "duplicate",'."\n" + .' "argValue": "off"'."\n" + .' }],'."\n" + .' "functionName": "origin_request_header",'."\n" + .' "parentId": -1'."\n" + .'}]'."\n" + .'```', + 'type' => 'string', + 'required' => true, + 'example' => '[{"functionArgs": [{"argName": "key","argValue": "Content-Encoding"},{"argName": "value","argValue": "gzip"}],"functionName": "set_resp_header"} ]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'DomainConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainConfigModel' => [ + 'description' => '域名配置清单。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID，如果返回为0，则表示该条配置未配置成功，需要重新配置。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'FunctionName' => [ + 'description' => '功能名称。', + 'type' => 'string', + 'example' => 'set_resp_header', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFunctions.Malformed', + 'errorMessage' => 'The specified Functions is incorrectly formatted.', + ], + [ + 'errorCode' => 'InvalidArgValue.Malformed', + 'errorMessage' => 'The specified ArgValue is invalid.', + ], + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => '[%s] is not supported.', + ], + [ + 'errorCode' => 'Invalid%s.Malformed', + 'errorMessage' => 'The specified ArgValue [%s] is invalid.', + ], + [ + 'errorCode' => 'MissingParameter%s', + 'errorMessage' => 'The specified value of ArgName[%s] is missing.', + ], + [ + 'errorCode' => 'InvalidFunctionArgs.Malformed', + 'errorMessage' => 'The specified FunctionArgs is invalid.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgValue is missing.', + ], + [ + 'errorCode' => 'InvalidHeaderKey.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter HeaderKey is not supported.', + ], + [ + 'errorCode' => 'TooManyDomains', + 'errorMessage' => 'The count of domain is over 50.', + ], + [ + 'errorCode' => 'InvalidRule.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ConfigurationConflicts', + 'errorMessage' => 'The staging environment has a configuration in effect and cannot modify the production environment configuration.', + ], + [ + 'errorCode' => 'InvalidFunction.NotSupported', + 'errorMessage' => 'The domain is not supported to set the function.', + ], + [ + 'errorCode' => 'InvalidDomain.BelongToConfigGroup', + 'errorMessage' => 'This Domain activated in configuration group and should modify by config group.', + ], + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'EntityNotExist.Role', + ], + [ + 'errorCode' => 'MissingParameterFunctions', + 'errorMessage' => 'The specified value of Functions is missing.', + ], + [ + 'errorCode' => 'NoPermission.SLR', + 'errorMessage' => 'The current user does not have permission to create servicelinkedrole. Please contact the Alibaba Cloud account or administrator to authorize AliyunCDNFullAccess or custom policy:Service Name:cdn-ddos.cdn.aliyuncs.com,Role: AliyunServiceRoleForCDNAccessingDDoS,Permission: ram: CreateServiceLinkedRole', + ], + [ + 'errorCode' => 'ConfigExceedLimit', + 'errorMessage' => 'Count of config entries exceeds the limit.', + ], + [ + 'errorCode' => 'EdgeScriptCountExceedLimit', + 'errorMessage' => 'The number of rules exceeds the default limit.', + ], + [ + 'errorCode' => 'EdgeScripOptionsHasInnerConfig', + 'errorMessage' => 'The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptGrammarNotSupport', + 'errorMessage' => 'A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptNotSupportJs', + 'errorMessage' => 'JavaScript rules are not supported. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'Failed to invoke service.', + ], + [ + 'errorCode' => 'ConfigParentExceedLimit', + 'errorMessage' => 'Config parent exceed limit.', + ], + [ + 'errorCode' => 'Function.InvalidParentId', + 'errorMessage' => 'The specified parentId does not exist.', + ], + [ + 'errorCode' => 'BatchSetBusinessError', + 'errorMessage' => 'some configs error:%s', + ], + [ + 'errorCode' => 'ConfigDuplicate', + 'errorMessage' => 'Duplicate configuration. This function has already been configured and cannot be added repeatedly.', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'The function parameter of the domain configuration is incorrect.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"DomainConfigList\\": {\\n \\"DomainConfigModel\\": [\\n {\\n \\"ConfigId\\": 1234567,\\n \\"DomainName\\": \\"www.example.com\\",\\n \\"FunctionName\\": \\"set_resp_header\\"\\n }\\n ]\\n }\\n}","errorExample":"[{\\"functionArgs\\":[{\\"argName\\":\\"file_type\\",\\"argValue\\":\\"jpg\\"},{\\"argName\\":\\"ttl\\",\\"argValue\\":\\"18\\"},{\\"argName\\":\\"weight\\",\\"argValue\\":\\"30\\"}],\\"functionName\\":\\"filetype_based_ttl_set\\",\\"configId\\":5068995}]"},{"type":"xml","example":"<BatchSetCdnDomainConfigResponse>\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n<DomainConfigModel>\\n <DomainName>www.example.com</DomainName>\\n <ConfigId>1234567</ConfigId>\\n <FunctionName>set_resp_header</FunctionName>\\n</DomainConfigModel>\\n</BatchSetCdnDomainConfigResponse>","errorExample":"http://cdn.aliyuncs.com/?Action=BatchSetCdnDomainConfig\\n&DomainName=example.com\\n&Functions=[{\\"functionArgs\\":[{\\"argName\\":\\"domain_name\\",\\"argValue\\":\\"api.hellodtworld.com\\"}],\\"functionName\\":\\"set_req_host_header\\"}]\\n&<公共请求参数>"}]', + 'title' => '批量配置域名', + 'description' => '- 单用户调用频率：3次/秒。'."\n" + .'- 支持批量配置域名，多个域名用半角逗号（,）分隔，一次最多支持配置50个域名。'."\n" + .'- 调用BatchSetCdnDomainConfig给域名配置某些功能后，将会生成唯一的ConfigId，通过ConfigId可以完成更新和删除配置操作。具体使用方法，请参见[ConfigId使用与查询](~~388994~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchDeleteCdnDomainConfig' => [ + 'summary' => '调用BatchDeleteCdnDomainConfig批量删除加速域名的配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '111682', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除配置的加速域名，多个用半角逗号（,）分隔，注意以下配置限制：'."\n" + ."\n" + .'- 一次最多传50个域名。'."\n" + .'- 域名个数 乘以 FunctionNames个数，小于等于50。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com,example.org', + ], + ], + [ + 'name' => 'FunctionNames', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的功能函数名称，多个用半角逗号（,）分隔，一次传入最多50个。更多功能名称，请参见[域名配置功能参数](~~388460~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'referer_white_list_set,https_force', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + [ + 'errorCode' => 'DeleteFunctionFailed', + 'errorMessage' => 'Batch delete functions failed.', + ], + [ + 'errorCode' => 'EdgeScriptCountExceedLimit', + 'errorMessage' => 'The number of rules exceeds the default limit (1). To increase the limit, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScripOptionsHasInnerConfig', + 'errorMessage' => 'The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptNotSupportJs', + 'errorMessage' => 'JavaScript rules are not supported. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'InvalidRule.Malformed ', + 'errorMessage' => 'Check rules error: %s', + ], + [ + 'errorCode' => 'EdgeScriptGrammarNotSupport', + 'errorMessage' => 'A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchDeleteCdnDomainConfigResponse>\\r\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</BatchDeleteCdnDomainConfigResponse>","errorExample":""}]', + 'title' => '批量删除域名配置', + 'description' => '- 单次配置的域名数量不超过50个。'."\n" + .'- 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchUpdateCdnDomain' => [ + 'summary' => '调用BatchUpdateCdnDomain批量更新加速域名基本信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111688', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com,example.org', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'schema' => [ + 'description' => '回源地址列表。'."\n" + ."\n" + .'> 不支持同时传入**Sources**和**TopLevelDomain**参数，如果您同时传入**Sources**和**TopLevelDomain**参数，**TopLevelDomain**将不生效。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"content":"10.10.10.10","type":"ipaddr","priority":"20","port":80,"weight":"15"}]', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyuji4b6r4**', + ], + ], + [ + 'name' => 'TopLevelDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '顶级接入域。'."\n" + ."\n" + .'> 不支持同时传入**Sources**和**TopLevelDomain**参数，如果您同时传入**Sources**和**TopLevelDomain**参数，**TopLevelDomain**将不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingDomainName', + 'errorMessage' => 'The domainName parameter is required.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + [ + 'errorCode' => 'InvalidSource.Content.Malformed', + 'errorMessage' => 'The specified Source Content is invalid.', + ], + [ + 'errorCode' => 'InvalidTypeContent.Mismatch', + 'errorMessage' => 'The specified source type does not match the specified source content.', + ], + [ + 'errorCode' => 'MissingSource.Content', + 'errorMessage' => 'The Source Content must be specified.', + ], + [ + 'errorCode' => 'MissingSource.Type', + 'errorMessage' => 'The Source Type must be specified.', + ], + [ + 'errorCode' => 'InvalidSources.Malformed', + 'errorMessage' => 'Specified Sources is malformed.', + ], + [ + 'errorCode' => 'InvalidSource.Type.Malformed', + 'errorMessage' => 'The specified Source Type is invalid.', + ], + [ + 'errorCode' => 'InvalidSource.Priority.Malformed', + 'errorMessage' => 'The specified Source Priority is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceGroupId.Malformed', + 'errorMessage' => 'The specified ResourceGroupId is invalid.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'InvalidStatus.ResourceGroup', + 'errorMessage' => 'It is not allowed to do this operation because of the current status of resource-group.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DomainInProtectedMode', + 'errorMessage' => 'The domain is in protection mode. To request permission, contact Customer Service.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchUpdateCdnDomainResponse>\\t\\r\\n <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\r\\n</BatchUpdateCdnDomainResponse>\\t","errorExample":""}]', + 'title' => '批量更新域名', + 'description' => '- 单用户调用频率：30次/秒。'."\n" + .'- 支持批量查询域名，多个域名用半角逗号（,）分隔，一次最多支持更新50个域名。', + 'requestParamsDescription' => 'Sources各字段含义如下所示。'."\n" + ."\n" + .'| 参数 | 类型 | 是否必选 | 描述 |'."\n" + .'|------------|--------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| type | String | 是 | 源站类型。<br>ipaddr：IP源站。<br>domain：域名源站。<br>oss：OSS Bucket为源站。<br>fc_domain：函数计算源站。 |'."\n" + .'| content | String | 是 | 回源地址，可以是IP或域名。 |'."\n" + .'| port| Integer| 否 | 端口。您可以指定80、443，也可以自定义端口，默认值为80。443端口支持HTTPS协议回源。 |'."\n" + .'| priority | String | 否 | 源站地址对应的优先级，支持20和30，默认值为20。20是主源，30是备源。|'."\n" + .'| weight | String | 否 | 回源权重，100以内，默认值为10。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSpecificConfig' => [ + 'summary' => '调用DeleteSpecificConfig删除域名的指定配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '111710', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持单个删除。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '功能配置ID，多个用半角逗号（,）分隔。ConfigId查询和使用，请参见[ConfigId使用说明](~~388994~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2317', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + [ + 'errorCode' => 'ConfigurationConflicts', + 'errorMessage' => 'The staging environment has a configuration in effect and cannot modify the production environment configuration.', + ], + [ + 'errorCode' => 'EdgeScriptCountExceedLimit', + 'errorMessage' => 'The number of rules exceeds the default limit (1). To increase the limit, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScripOptionsHasInnerConfig', + 'errorMessage' => 'The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptGrammarNotSupport', + 'errorMessage' => 'A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptNotSupportJs', + 'errorMessage' => 'JavaScript rules are not supported. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'InvalidDomain.BelongToConfigGroup', + 'errorMessage' => 'This Domain activated in configuration group and should modify by config group.', + ], + [ + 'errorCode' => 'InvalidRule.Malformed ', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"<DeleteSpecificConfigResponse>\\r\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</DeleteSpecificConfigResponse>","errorExample":""}]', + 'title' => '删除域名的指定配置', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCdnDomainSchdmByProperty' => [ + 'summary' => '调用ModifyCdnDomainSchdmByProperty通过配置组修改域名的加速区域。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111870', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需修改加速区域的域名，仅支持单个域名进行修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Property', + 'in' => 'query', + 'schema' => [ + 'description' => '加速区域属性'."\n" + ."\n" + .'{"coverage":"overseas"} '."\n" + ."\n" + .'其中coverage参数的取值如下：'."\n" + ."\n" + .'- **domestic**：仅中国内地。'."\n" + .'- **overseas**：全球（不含中国内地）。'."\n" + .'- **global**：全球。', + 'type' => 'string', + 'required' => true, + 'example' => '{"coverage":"overseas"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Schedule.NotFound', + 'errorMessage' => 'there is no schedule domain found by the targeted coverage value', + ], + [ + 'errorCode' => 'DomainTraffic.ExceedThreshold', + 'errorMessage' => 'not allowed to do this operation because the last day traffic exceeds the threshold', + ], + [ + 'errorCode' => 'Domain.BeianInvalid', + 'errorMessage' => 'not allowed to do this operation because the domain registration record invalid in China main land', + ], + [ + 'errorCode' => 'Schedule.ChangeFail', + 'errorMessage' => 'change domain failed', + ], + [ + 'errorCode' => 'InvalidTopLevelDomain.Malformed', + 'errorMessage' => 'Specified TopLevelDomain is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyCdnDomainSchdmByPropertyResponse>\\r\\n\\t<RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\r\\n</ModifyCdnDomainSchdmByPropertyResponse>","errorExample":""}]', + 'title' => '修改域名的加速区域', + 'description' => '> - 单用户调用频率：100次/秒。'."\n" + .'> - 域名业务类型是直播的情况下，修改域名加速区域可能会引发业务不可用，因此直播域名不允许通过该接口来修改加速区域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCdnDomain' => [ + 'summary' => '调用ModifyCdnDomain修改加速域名基础信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111869', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持修改单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'schema' => [ + 'description' => '回源地址列表。'."\n" + ."\n" + .'> 不支持同时传入**Sources**和**TopLevelDomain**参数，如果您同时传入**Sources**和**TopLevelDomain**参数，**TopLevelDomain**将不生效。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"content":"1.1.1.1","type":"ipaddr","priority":"20","port":80,"weight":"15"}]', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyuji4b6r4**', + ], + ], + [ + 'name' => 'TopLevelDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '顶级接入域。只有白名单用户CDN_TOP_LEVEL_DOMAIN_GREY_USER_LIST设置才有效。'."\n" + ."\n" + .'> 不支持同时传入**Sources**和**TopLevelDomain**参数，如果您同时传入**Sources**和**TopLevelDomain**参数，**TopLevelDomain**将不生效。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Abs.Sources.Malformed', + 'errorMessage' => 'The specified Sources is invalid.', + ], + [ + 'errorCode' => 'MissingDomainName', + 'errorMessage' => 'The domainName parameter is required.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + [ + 'errorCode' => 'InvalidSource.Content.Malformed', + 'errorMessage' => 'The specified Source Content is invalid.', + ], + [ + 'errorCode' => 'InvalidTypeContent.Mismatch', + 'errorMessage' => 'The specified source type does not match the specified source content.', + ], + [ + 'errorCode' => 'MissingSource.Content', + 'errorMessage' => 'The Source Content must be specified.', + ], + [ + 'errorCode' => 'MissingSource.Type', + 'errorMessage' => 'The Source Type must be specified.', + ], + [ + 'errorCode' => 'InvalidSource.Type.Malformed', + 'errorMessage' => 'The specified Source Type is invalid.', + ], + [ + 'errorCode' => 'InvalidSource.Priority.Malformed', + 'errorMessage' => 'The specified Source Priority is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceGroupId.Malformed', + 'errorMessage' => 'The specified ResourceGroupId is invalid.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'InvalidStatus.ResourceGroup', + 'errorMessage' => 'It is not allowed to do this operation because of the current status of resource-group.', + ], + [ + 'errorCode' => 'TopLevelDomain.NotFound', + 'errorMessage' => 'TopLevelDomain is not exist.', + ], + [ + 'errorCode' => 'InvalidTopLevelDomain.Malformed', + 'errorMessage' => 'Specified TopLevelDomain is malformed.', + ], + [ + 'errorCode' => 'TopLevelDomain.Mismatch', + 'errorMessage' => 'The specified TopLevelDomain does not match webSiteType.', + ], + [ + 'errorCode' => 'SourceInBlacklist', + 'errorMessage' => 'Source is in the blacklist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DomainInProtectedMode', + 'errorMessage' => 'The domain is in protection mode. To request permission, contact Customer Service.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<ModifyCdnDomainResponse>\\r\\n\\t<RequestId>94E3559F-7B6A-4A5E-AFFD-44E2A208A249</RequestId>\\r\\n</ModifyCdnDomainResponse>","errorExample":""}]', + 'title' => '修改域名基础信息', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => 'Sources各字段含义如下所示。'."\n" + ."\n" + .'| 参数 | 类型 | 是否必选 | 描述 |'."\n" + .'|------------|--------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| type | String | 是 | 源站类型。<br>ipaddr：IP源站。<br>domain：域名源站。<br>oss：OSS Bucket为源站。<br>fc_domain：函数计算源站。 |'."\n" + .'| content | String | 是 | 回源地址，可以是IP或域名。 |'."\n" + .'| port| Integer| 否 | 端口，可以指定80、443，也可以自定义端口，默认值为80。443是HTTPS协议回源。 |'."\n" + .'| priority | String | 否 | 源站地址对应的优先级，支持20和30，默认值为20。20是主源，30是备源。|'."\n" + .'| weight | String | 否 | 回源权重，100以内，默认值为10。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnDomainStagingConfig' => [ + 'summary' => '调用DescribeCdnDomainStagingConfig查询模拟环境配置信息，一次可查询多个功能配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111730', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持单个查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'FunctionNames', + 'in' => 'query', + 'schema' => [ + 'description' => '功能名称列表，多个用半角逗号（,）分隔，可配置功能请参见[功能列表](~~388460~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C80705BF-0F76-41FA-BAD1-5B59296A4E59', + ], + 'DomainConfigs' => [ + 'description' => '域名配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '配置状态。取值：'."\n" + .'- **testing**：配置校验中。'."\n" + .'- **configuring**：配置中。'."\n" + .'- **success**：成功。'."\n" + .'- **failed**：失败。'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'ParentId' => [ + 'description' => '规则条件ID，非必填项。通过配置[域名配置功能参数](~~388460~~)中的功能函数**condition**（规则引擎），可以创建出规则条件（规则条件可以通过识别用户请求中携带的各种参数来匹配和过滤用户请求），每一个规则条件被创建以后都会生成一个对应的[ConfigId](~~388994~~)，ConfigId可以被当作ParentId参数被其他功能函数引用，这样规则条件就可以与功能配置一起组合形成更灵活的配置。'."\n" + .'具体配置操作请参考[批量配置域名](~~90915~~)或下文ParentId配置示例说明。'."\n", + 'type' => 'string', + 'example' => '222728944812032', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'string', + 'example' => '6xx5', + ], + 'FunctionName' => [ + 'description' => '功能名称。', + 'type' => 'string', + 'example' => 'aliauth', + ], + 'FunctionArgs' => [ + 'description' => '各个功能说明。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ArgName' => [ + 'description' => '配置名称。', + 'type' => 'string', + 'example' => 'auth_type', + ], + 'ArgValue' => [ + 'description' => '配置值。', + 'type' => 'string', + 'example' => 'req_auth', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"RequestId\\": \\"C80705BF-0F76-41FA-BAD1-5B59296A4E59\\",\\n \\"DomainConfigs\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"ParentId\\": \\"222728944812032\\",\\n \\"ConfigId\\": \\"6xx5\\",\\n \\"FunctionName\\": \\"aliauth\\",\\n \\"FunctionArgs\\": [\\n {\\n \\"ArgName\\": \\"auth_type\\",\\n \\"ArgValue\\": \\"req_auth\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnDomainStagingConfigResponse>\\n <DomainName>example.com</DomainName>\\n <RequestId>C80705BF-0F76-41FA-BAD1-5B59296A4E59</RequestId>\\n <DomainConfigs>\\n <Status>success</Status>\\n <ParentId>222728944812032</ParentId>\\n <ConfigId>6xx5</ConfigId>\\n <FunctionName>aliauth</FunctionName>\\n <FunctionArgs>\\n <ArgName>auth_type</ArgName>\\n <ArgValue>req_auth</ArgValue>\\n </FunctionArgs>\\n </DomainConfigs>\\n</DescribeCdnDomainStagingConfigResponse>","errorExample":""}]', + 'title' => '查询模拟环境配置', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '### ParentId配置示例'."\n" + ."\n" + .'**parentId**为`-1`：表示删除该配置里面已有的规则条件。'."\n" + ."\n" + .'```json'."\n" + .'[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "功能参数A", '."\n" + .' "argValue": "功能参数A对应的值"'."\n" + .' }, '."\n" + .' {'."\n" + .' "argName": "功能参数B", '."\n" + .' "argValue": "功能参数B对应的值"'."\n" + .' }], '."\n" + .' "functionName": "功能名称",'."\n" + .' "parentId": "选填项，对应引用规则条件的configid"'."\n" + .'}]'."\n" + .'```'."\n" + ."\n" + .'不使用**parentId**的情况下，配置示例如下：'."\n" + ."\n" + .'使用函数**origin\\_request\\_header**添加回源HTTP请求头的时候引用了**configid=222728944812032**的规则条件，请求参数如下：'."\n" + ."\n" + .'```json'."\n" + .'[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "header_operation_type",'."\n" + .' "argValue": "add"'."\n" + .' }, {'."\n" + .' "argName": "header_name",'."\n" + .' "argValue": "Accept-Encoding"'."\n" + .' }, {'."\n" + .' "argName": "header_value",'."\n" + .' "argValue": "gzip"'."\n" + .' }, {'."\n" + .' "argName": "duplicate",'."\n" + .' "argValue": "off"'."\n" + .' }],'."\n" + .' "functionName": "origin_request_header"'."\n" + .'}]'."\n" + .'```'."\n" + ."\n" + .'使用**parentId**的情况下，配置示例如下：'."\n" + ."\n" + .'使用函数**origin\\_request\\_header**添加回源HTTP请求头的时候引用了**configid=222728944812032**的规则条件，请求参数如下：'."\n" + ."\n" + .'```json'."\n" + .'[{'."\n" + .' "functionArgs": [{'."\n" + .' "argName": "header_operation_type",'."\n" + .' "argValue": "add"'."\n" + .' }, {'."\n" + .' "argName": "header_name",'."\n" + .' "argValue": "Accept-Encoding"'."\n" + .' }, {'."\n" + .' "argName": "header_value",'."\n" + .' "argValue": "gzip"'."\n" + .' }, {'."\n" + .' "argName": "duplicate",'."\n" + .' "argValue": "off"'."\n" + .' }],'."\n" + .' "functionName": "origin_request_header",'."\n" + .' "parentId": "222728944812032"'."\n" + .'}]'."\n" + .'```', + 'extraInfo' => ' ', + ], + 'SetCdnDomainStagingConfig' => [ + 'summary' => '调用SetCdnDomainStagingConfig设置模拟环境下的加速域名配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111889', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持单个域名进行设置。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Functions', + 'in' => 'query', + 'schema' => [ + 'description' => '功能列表，格式如下：'."\n" + ."\n" + .'> - **functionName**（功能名称）：可配置功能请参见[功能列表](~~388460~~)，多个参数之间用半角逗号（,）分隔。'."\n" + .'> - **argName**：**functionName**的配置项（可配置多个配置项）。'."\n" + .'> - **argValue**：**functionName**的配置项的取值。'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "functionArgs": ['."\n" + .' {'."\n" + .' "argName": "功能参数A",'."\n" + .' "argValue": "功能参数A对应的值"'."\n" + .' },'."\n" + .' {'."\n" + .' "argName": "功能参数B",'."\n" + .' "argValue": "功能参数B对应的值"'."\n" + .' }'."\n" + .' ],'."\n" + .' "functionName": "功能名称"'."\n" + .' }'."\n" + .']'."\n" + .'```', + 'type' => 'string', + 'required' => true, + 'example' => '[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'DomainConfigList' => [ + 'description' => '域名配置清单。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'FunctionName' => [ + 'description' => '功能名称。', + 'type' => 'string', + 'example' => 'set_resp_header', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFunctionName.ValueNotSupported', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidArgValue.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ConfigurationConflicts', + 'errorMessage' => 'The staging environment has a configuration in effect and cannot modify the production environment configuration.', + ], + [ + 'errorCode' => 'InvalidArgName.ValueNotSupported', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'GrayConfigExist', + 'errorMessage' => 'The domain exists other gray config.', + ], + [ + 'errorCode' => 'InvalidRule.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidDomain.BelongToConfigGroup', + 'errorMessage' => 'This Domain activated in configuration group and should modify by config group.', + ], + [ + 'errorCode' => 'EdgeScriptCountExceedLimit', + 'errorMessage' => 'The number of rules exceeds the default limit.', + ], + [ + 'errorCode' => 'EdgeScripOptionsHasInnerConfig', + 'errorMessage' => 'The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptGrammarNotSupport', + 'errorMessage' => 'A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptNotSupportJs', + 'errorMessage' => 'JavaScript rules are not supported. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'MissingRequiredArg', + 'errorMessage' => 'required argument missing.', + ], + [ + 'errorCode' => 'FunctionArgError', + 'errorMessage' => 'The function parameter of the domain configuration is incorrect.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"DomainConfigList\\": [\\n {\\n \\"ConfigId\\": 1234567,\\n \\"DomainName\\": \\"www.example.com\\",\\n \\"FunctionName\\": \\"set_resp_header\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SetCdnDomainStagingConfigResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <DomainConfigList>\\n <ConfigId>1234567</ConfigId>\\n <DomainName>www.example.com</DomainName>\\n <FunctionName>set_resp_header</FunctionName>\\n </DomainConfigList>\\n</SetCdnDomainStagingConfigResponse>","errorExample":""}]', + 'title' => '设置模拟环境配置', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => "\n" + .'### edge_function边缘函数功能说明'."\n" + ."\n" + .'所有参数值均按照字符串类型处理。'."\n" + ."\n" + .'| 功能名称 | 参数 |'."\n" + .'| ----------------------- | ------------------------------------------------------------ |'."\n" + .'| edge_function：边缘函数 | 必填参数：<br>**rule**：DSL规则；<br>**pri**：优先级；<br>**enable**：本条规则是否生效，取值范围on/off；<br>可选参数：<br>**name**：规则名称。仅支持英文字母和下划线；<br>**pos**：规则执行位置；<br>**brk**：命中本条规则后，当前执行位置剩余规则均跳过；<br>**option**：option管控；<br>**grammar**：grammar管控，可选值：空、es2、js；<br>**jsmode**：js域名白单管控，可选值：redirect、bypass； |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RollbackStagingConfig' => [ + 'summary' => '调用RollbackStagingConfig可以起到回滚模拟环境配置的作用，配置回滚后的模拟环境将被还原为初始状态，模拟环境下的所有配置都将被清空。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '111884', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'StagingConfig.NotFound', + 'errorMessage' => 'The Staging configuration does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<RollbackStagingConfigResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</RollbackStagingConfigResponse>","errorExample":""}]', + 'title' => '回滚模拟环境配置', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PublishStagingConfigToProduction' => [ + 'summary' => '调用PublishStagingConfigToProduction将模拟环境配置发布为生产环境配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111879', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StagingConfig.Failed', + 'errorMessage' => 'Rules in staging are being configured, please try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StagingConfig.NotFound', + 'errorMessage' => 'The Staging configuration does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<PublishStagingConfigToProductionResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</PublishStagingConfigToProductionResponse>","errorExample":""}]', + 'title' => '发布模拟环境配置到生产环境', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSpecificStagingConfig' => [ + 'summary' => '调用DeleteSpecificStagingConfig删除模拟环境中的指定配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '111711', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的加速域名，多个域名使用半角逗号（,）分隔，一次最多支持50个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '功能配置ID，多个ID用半角逗号（,）分隔。ConfigId查询和使用，请参见[ConfigId使用说明](~~388994~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2317', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + [ + 'errorCode' => 'GrayConfigIsNull', + 'errorMessage' => 'You cannot delete all gary configurations. You can clear them by rolling back the simulation environment.', + ], + [ + 'errorCode' => 'EdgeScriptCountExceedLimit', + 'errorMessage' => 'The number of rules exceeds the default limit (1). To increase the limit, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScripOptionsHasInnerConfig', + 'errorMessage' => 'The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptGrammarNotSupport', + 'errorMessage' => 'A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptNotSupportJs', + 'errorMessage' => 'JavaScript rules are not supported. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'InvalidRule.Malformed ', + 'errorMessage' => 'Check rules error: %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSpecificStagingConfigResponse>\\r\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</DeleteSpecificStagingConfigResponse>","errorExample":""}]', + 'title' => '删除模拟环境指定配置', + 'description' => '> 单用户调用频率：20次/秒。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetWaitingRoomConfig' => [ + 'summary' => '调用SetWaitingRoomConfig设置waiting_room功能，只支持全站加速类型域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111915', + 'abilityTreeNodes' => [ + 'FEATUREcdn2GPRJF', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的加速域名，仅支持单个设置。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'WaitUri', + 'in' => 'query', + 'schema' => [ + 'description' => '开启waiting_room功能的URI正则字符串。', + 'type' => 'string', + 'required' => true, + 'example' => '.*/aaa/bbb$', + ], + ], + [ + 'name' => 'AllowPct', + 'in' => 'query', + 'schema' => [ + 'description' => '允许回源比例，取值范围：**0**~**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'MaxTimeWait', + 'in' => 'query', + 'schema' => [ + 'description' => '进入排队后，排队时长，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'GapTime', + 'in' => 'query', + 'schema' => [ + 'description' => '离开排队后，跳过排队时长，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'WaitUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '排队等待页面URL。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://example.com/waitingroom.html'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<SetWaitingRoomConfigResponse>\\r\\n <RequestId>AED00EC1-32A8-4D48-BEB9-BD782AF3C6BD</RequestId>\\r\\n</SetWaitingRoomConfigResponse>","errorExample":""}]', + 'title' => '配置WaitingRoom', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnUserConfigs' => [ + 'summary' => '调用DescribeCdnUserConfigs查询安全功能相关的配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111749', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的配置，支持查询的配置如下：'."\n" + .'- **domain_business_control**：用户配置。'."\n" + .'- **waf**：WAF功能配置。', + 'type' => 'string', + 'required' => true, + 'example' => 'domain_business_control', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06D29681-B7CD-4034-A8CC-28AFFA213539', + ], + 'Configs' => [ + 'description' => '用户对应的配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ArgValue' => [ + 'description' => '配置值。取值：'."\n" + .'- **cc_rule**：CC规则。'."\n" + .'- **ddos_dispatch**：DDoS联动调度。'."\n" + .'- **edge_safe**：边缘应用安全。'."\n" + .'- **blocked_regions**：区域封禁。'."\n" + .'- **http_acl_policy**：精准访问控制。'."\n" + .'- **bot_manager**：机器流量管理。'."\n" + .'- **ip_reputation**：IP信誉库。', + 'type' => 'string', + 'example' => '{\\"dcdn_allow\\":[\\"cc_rule\\",\\"ddos_dispatch\\"]}', + ], + 'ArgName' => [ + 'description' => '配置名称。'."\n" + ."\n" + .'政企用户相关配置。', + 'type' => 'string', + 'example' => 'allow_function', + ], + 'FunctionName' => [ + 'description' => '功能名称。', + 'type' => 'string', + 'example' => 'domain_business_control', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidArgValue.Malformed', + 'errorMessage' => 'The specified ArgValue is invalid.', + ], + [ + 'errorCode' => 'InvalidArgName.ValueNotSupported', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"06D29681-B7CD-4034-A8CC-28AFFA213539\\",\\n \\"Configs\\": [\\n {\\n \\"ArgValue\\": \\"{\\\\\\\\\\\\\\"dcdn_allow\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"cc_rule\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ddos_dispatch\\\\\\\\\\\\\\"]}\\",\\n \\"ArgName\\": \\"allow_function\\",\\n \\"FunctionName\\": \\"domain_business_control\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnUserConfigsResponse>\\n <RequestId>06D29681-B7CD-4034-A8CC-28AFFA213539</RequestId>\\n <Configs>\\n <FunctionName>domain_business_control</FunctionName>\\n <ArgValue>{\\"dcdn_allow\\":[\\"cc_rule\\",\\"ddos_dispatch\\"]}</ArgValue>\\n <ArgName>allow_function</ArgName>\\n </Configs>\\n</DescribeCdnUserConfigsResponse>","errorExample":""}]', + 'title' => '查询安全功能配置', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnWafDomain' => [ + 'summary' => '调用DescribeCdnWafDomain查询WAF全量域名列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111755', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WAF管控区域。取值：'."\n" + .'- **cn-hangzhou**：WAF中国内地（大陆）管控区域。'."\n" + .'- **ap-southeast-1**：WAF非中国内地（大陆）管控区域。'."\n" + ."\n" + .'> 非中国内地（大陆）包含中国香港、中国澳门、中国台湾以及其他国家和地区。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'enum' => [ + 'cn-hangzhou', + 'ap-southeast-1', + ], + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的域名。'."\n" + ."\n" + .'仅支持填写单个域名，详细见以下三种填写方式：'."\n" + .'- 填写精确域名：例如example.com，则查询example.com域名的配置信息。'."\n" + .'- 填写关键字：例如example，则查询所有包含example的域名配置信息。'."\n" + .'- 不填该参数：则默认返回所有开通了WAF的加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '加速域名的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB1A380B-09F0-41BB-802B-72F8FD6DA2FE', + ], + 'OutPutDomains' => [ + 'description' => '加速域名信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AclStatus' => [ + 'description' => 'ACL状态。取值：'."\n" + .'- **0**：关闭。'."\n" + .'- **1**：开通。', + 'type' => 'string', + 'example' => '1', + ], + 'Status' => [ + 'description' => 'WAF域名状态。取值：'."\n" + .'- **1**：WAF域名创建成功或WAF域名有效。'."\n" + .'- **10**：WAF域名创建中。'."\n" + .'- **11**：WAF域名创建失败。', + 'type' => 'string', + 'example' => '1', + ], + 'Domain' => [ + 'description' => '域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CcStatus' => [ + 'description' => 'CC状态。取值：'."\n" + .'- **0**：关闭。'."\n" + .'- **1**：开通。', + 'type' => 'string', + 'example' => '1', + ], + 'WafStatus' => [ + 'description' => 'WAF状态。取值：'."\n" + .'- **0**：关闭。'."\n" + .'- **1**：开通。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'InvalidParameter.', + ], + [ + 'errorCode' => 'InvalidParameterRegionId', + 'errorMessage' => 'Invalid Region ID.', + ], + [ + 'errorCode' => 'InvalidParameterDomain', + 'errorMessage' => 'Invalid Domain Name.', + ], + [ + 'errorCode' => 'DomainNotExist ', + 'errorMessage' => 'Specified Domain Not Exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-802B-72F8FD6DA2FE\\",\\n \\"OutPutDomains\\": [\\n {\\n \\"AclStatus\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"CcStatus\\": \\"1\\",\\n \\"WafStatus\\": \\"1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnWafDomainResponse>\\n<TotalCount>1</TotalCount>\\n<OutputDomains>\\n <AclStatus>1</AclStatus>\\n <CcStatus>1</CcStatus>\\n <Domain>example.com</Domain>\\n <Status>1</Status>\\n <WafStatus>1</WafStatus>\\n</OutputDomains>\\n<RequestId>CB1A380B-09F0-41BB-802B-72F8FD6DA2FE</RequestId>\\n</DescribeCdnWafDomainResponse>","errorExample":""}]', + 'title' => '查询WAF全量域名', + 'description' => '> 单用户调用频率：150次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBlockedRegions' => [ + 'summary' => '调用DescribeBlockedRegions查询区域封禁支持的国家和地区。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111717', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。取值：'."\n" + ."\n" + .'- **zh**：简体中文。'."\n" + .'- **en**：英文。'."\n" + .'- **jp**：日文。', + 'type' => 'string', + 'required' => true, + 'example' => 'zh', + 'enum' => [ + 'zh', + 'en', + 'jp', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BFFCDFAD-DACC-484E-9BE6-0AF3B3A0DD23', + ], + 'InfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InfoItem' => [ + 'description' => '信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CountriesAndRegions' => [ + 'description' => '国家地区缩写。', + 'type' => 'string', + 'example' => 'AF', + ], + 'Continent' => [ + 'description' => '国家地区所属大区。', + 'type' => 'string', + 'example' => '亚洲', + ], + 'CountriesAndRegionsName' => [ + 'description' => '国家地区名称。', + 'type' => 'string', + 'example' => '阿富汗', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MISS_PARAMETER', + 'errorMessage' => 'MISS_PARAMETER', + ], + [ + 'errorCode' => 'INVALID_PARAMETER', + 'errorMessage' => 'INVALID_PARAMETER', + ], + [ + 'errorCode' => 'FAILED', + 'errorMessage' => 'FAILED', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BFFCDFAD-DACC-484E-9BE6-0AF3B3A0DD23\\",\\n \\"InfoList\\": {\\n \\"InfoItem\\": [\\n {\\n \\"CountriesAndRegions\\": \\"AF\\",\\n \\"Continent\\": \\"亚洲\\",\\n \\"CountriesAndRegionsName\\": \\"阿富汗\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBlockedRegionsResponse>\\n<RequestId>BFFCDFAD-DACC-484E-9BE6-0AF3B3A0DD23</RequestId>\\n<InfoList>\\n <InfoItem>\\n <Continent>亚洲</Continent>\\n <CountriesAndRegions>AF</CountriesAndRegions>\\n <CountriesAndRegionsName>阿富汗</CountriesAndRegionsName>\\n </InfoItem>\\n</InfoList>\\n</DescribeBlockedRegionsResponse>","errorExample":""}]', + 'title' => '查询支持封禁的区域', + 'description' => '> 单用户调用频率：50次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefreshObjectCacheByCacheTag' => [ + 'summary' => '当用户设置了缓存标签功能后，通过调用RefreshObjectCacheByCacheTag指定缓存标签对缓存进行刷新。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '206248', + 'abilityTreeNodes' => [ + 'FEATUREcdnW2530F', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'CacheTag', + 'in' => 'query', + 'schema' => [ + 'description' => '缓存标签。多个用逗号隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'tag1,tag2', + 'maxLength' => 16384, + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制刷新对应范围内的全部资源。默认为false。'."\n" + .'- **true**：刷新全部资源。选择 “true” 时，如果用户请求的内容匹配到了对应范围内的资源，CDN 节点将会直接回源拉取新资源返回给用户，并重新缓存该资源。'."\n" + .'- **false**：刷新变更资源。选择 “false” 时，如果用户请求的内容匹配到了对应范围内的资源，CDN 节点将会回源获取资源的 Last-Modified 信息，若与当前缓存资源一致，则直接返回已缓存资源，若不一致，则回源拉取新资源返回给用户，并重新缓存该资源。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2E5AD83F-BD7B-462E-8319-2E30E305519A', + ], + 'RefreshTaskId' => [ + 'description' => '刷新返回的任务ID。', + 'type' => 'string', + 'example' => '17772470184', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SingleRequest.OverLimit', + 'errorMessage' => 'A maximum of 1000 URLs are supported for each request.', + ], + [ + 'errorCode' => 'InvalidObjectType.Malformed', + 'errorMessage' => 'The specified ObjectType is invalid.', + ], + [ + 'errorCode' => 'InvalidObjectPath.Malformed', + 'errorMessage' => 'The specified ObjectPath is invalid.', + ], + [ + 'errorCode' => 'InvalidObjectPath.Size.Malformed', + 'errorMessage' => 'The size of ObjectPath is bigger than 1000.', + ], + [ + 'errorCode' => 'QuotaExceeded.Refresh', + 'errorMessage' => 'You\'ve exceeded the prescribed refresh limits.', + ], + [ + 'errorCode' => 'InvalidExtensiveDomain.ValueNotSupported', + 'errorMessage' => 'The specified ExtensiveDomain is not supported.', + ], + [ + 'errorCode' => 'QuotaPerMinuteExceeded.Refresh', + 'errorMessage' => 'You tried to refresh too frequently; please try again later.', + ], + [ + 'errorCode' => 'TooMany.Refresh', + 'errorMessage' => 'The refresh queue is full; please try again later.', + ], + [ + 'errorCode' => 'PreloadQueueFull', + 'errorMessage' => 'Preload queue is full, please try again later!', + ], + [ + 'errorCode' => 'InvalidStations.Malformed', + 'errorMessage' => 'The specified Stations is invalid.', + ], + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The parameters you provided are invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E5AD83F-BD7B-462E-8319-2E30E305519A\\",\\n \\"RefreshTaskId\\": \\"17772470184\\"\\n}","type":"json"}]', + 'title' => '根据缓存标签刷新缓存', + ], + 'DescribeRefreshQuota' => [ + 'summary' => '调用DescribeRefreshQuota查询当天URL刷新、目录刷新、预热及封禁的最大限制数量和剩余量。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111830', + 'abilityTreeNodes' => [ + 'FEATUREcdnW2530F', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PreloadRemain' => [ + 'description' => '当天L2节点剩余预热数量。', + 'type' => 'string', + 'example' => '400', + ], + 'BlockRemain' => [ + 'description' => '当天剩余封禁数量。', + 'type' => 'string', + 'example' => '100', + ], + 'RegexRemain' => [ + 'description' => '当天剩余正则刷新数量。', + 'type' => 'string', + 'example' => '10', + ], + 'UrlRemain' => [ + 'description' => '当天剩余URL刷新数量。', + 'type' => 'string', + 'example' => '1996', + ], + 'DirRemain' => [ + 'description' => '当天剩余目录刷新数量。', + 'type' => 'string', + 'example' => '99', + ], + 'UrlQuota' => [ + 'description' => '当天URL刷新数量上限。', + 'type' => 'string', + 'example' => '2000', + ], + 'BlockQuota' => [ + 'description' => '当天封禁数量上限。', + 'type' => 'string', + 'example' => '300', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '42E0554B-80F4-4921-AED6-ACFB22CAAAD0', + ], + 'DirQuota' => [ + 'description' => '当天目录刷新数量上限。', + 'type' => 'string', + 'example' => '100', + ], + 'PreloadEdgeQuota' => [ + 'description' => '当天L1节点预热数量上限。', + 'type' => 'string', + 'example' => '20', + ], + 'PreloadEdgeRemain' => [ + 'description' => '当前L1节点剩余预热数量。', + 'type' => 'string', + 'example' => '20', + ], + 'PreloadQuota' => [ + 'description' => '当天L2节点预热数量上限。', + 'type' => 'string', + 'example' => '500', + ], + 'RegexQuota' => [ + 'description' => '当天正则刷新数量上限。', + 'type' => 'string', + 'example' => '20', + ], + 'IgnoreParamsQuota' => [ + 'description' => '当天忽略参数刷新数量上限。', + 'type' => 'string', + 'example' => '100', + ], + 'IgnoreParamsRemain' => [ + 'description' => '当天剩余忽略参数刷新数量。', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreloadRemain\\": \\"400\\",\\n \\"BlockRemain\\": \\"100\\",\\n \\"RegexRemain\\": \\"10\\",\\n \\"UrlRemain\\": \\"1996\\",\\n \\"DirRemain\\": \\"99\\",\\n \\"UrlQuota\\": \\"2000\\",\\n \\"BlockQuota\\": \\"300\\",\\n \\"RequestId\\": \\"42E0554B-80F4-4921-AED6-ACFB22CAAAD0\\",\\n \\"DirQuota\\": \\"100\\",\\n \\"PreloadEdgeQuota\\": \\"20\\",\\n \\"PreloadEdgeRemain\\": \\"20\\",\\n \\"PreloadQuota\\": \\"500\\",\\n \\"RegexQuota\\": \\"20\\",\\n \\"IgnoreParamsQuota\\": \\"100\\",\\n \\"IgnoreParamsRemain\\": \\"10\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeRefreshQuotaResponse>\\r\\n <RequestId>42E0554B-80F4-4921-AED6-ACFB22CAAAD0</RequestId>\\r\\n\\t<UrlQuota>2000</UrlQuota>\\r\\n <DirQuota>100</DirQuota>\\r\\n <UrlRemain>1996</UrlRemain>\\r\\n\\t<DirRemain>99</DirRemain>\\r\\n\\t<PreloadQuota>500</PreloadQuota>\\r\\n\\t<PreloadRemain>400</PreloadRemain>\\r\\n <BlockQuota>300</BlockQuota>\\r\\n <RegexQuota>20</RegexQuota>\\r\\n <RegexRemain>10</RegexRemain>\\r\\n <blockRemain>200</blockRemain>\\r\\n</DescribeRefreshQuotaResponse>\\t","errorExample":""}]', + 'title' => '查询刷新预热配额', + 'description' => '- 刷新预热类接口包含[RefreshObjectCaches](~~448057~~)刷新接口和[PushObjectCache](~~448058~~)预热接口。'."\n" + .'- 单用户调用频率：20次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PushObjectCache' => [ + 'summary' => '将源站的内容主动预热到缓存节点上。您首次访问可直接命中缓存，缓解源站压力。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111882', + 'abilityTreeNodes' => [ + 'FEATUREcdnKZKOWX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ObjectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '预热URL，格式为**加速域名/预热的文件**。'."\n" + ."\n" + .'> 多个URL之间用换行符（\\n）或（\\r\\n）分隔，ObjectPath的单条长度最长为1024个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com/image/1.png\\nexample.org/image/2.png', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'schema' => [ + 'description' => '预热区域，取值：'."\n" + ."\n" + .'- **domestic**：**仅中国内地**。'."\n" + .'- **overseas**：**全球**（不包含中国内地）。'."\n" + ."\n" + .'如果不传该参数，默认的预热区域为您的域名所配置的CDN加速区域。'."\n" + ."\n" + .'> '."\n" + .'> - 如果需要预热区域为**全球**，则必须保证加速域名的加速区域为**全球**，然后该参数不传参。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + 'enum' => [ + 'domestic', + 'overseas', + ], + ], + ], + [ + 'name' => 'L2Preload', + 'in' => 'query', + 'schema' => [ + 'description' => '是否直接预热到L2节点。取值：'."\n" + ."\n" + .'- **true**：代表预热的节点层级必须包含L2节点。'."\n" + .'- **false**：代表仅预热回源层节点（**false**为默认值，回源层节点可能是L2节点，也可能是L3节点）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'WithHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '预热请求默认携带的header是Accept-Encoding:gzip，如果您需要预热请求携带其他header，或者实现多副本预热，那么可以使用该参数来实现自定义预热header。用JSON串格式提交。'."\n" + ."\n" + .'> 若预热的时候不需要Accept-Encoding头部，则按如下提交'."\n" + .'> - {"Accept-Encoding": [" "]}', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Accept-Encoding": ['."\n" + .' "gzip, deflate, br"'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'QueryHashkey', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数用于控制执行预热任务时是否开启hashkey查询模式。取值范围：'."\n" + .'- false：默认模式，不传参数的时候使用该模式，指的是直接使用提交的URL作为预热文件的hashkey。'."\n" + .'- true：根据域名的配置来查询预热URL实际使用的hashkey。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConsistencyHash', + 'in' => 'query', + 'schema' => [ + 'description' => '如果域名加速区域为中国大陆并且开启了HASH回源，可通过此参数设置HASH预热，实现区域回源收敛，减少预热产生的回源带宽。'."\n" + ."\n" + .'- true： 开启HASH预热。'."\n" + .'- false： 缺省逻辑，不开启HASH预热。'."\n" + ."\n" + .'><notice>仅对加速区域为中国大陆的域名有效。></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PushTaskId' => [ + 'description' => '预热返回的任务ID，多个任务ID用半角逗号（,）分隔。预热返回的任务ID会按照以下两条规则对预热任务做合并：'."\n" + ."\n" + .'- 同一个域名、同一秒钟提交的预热任务（URL颗粒度）会被合并为同一个PushTaskId。'."\n" + .'- 同一个域名、同一秒钟提交的预热任务（URL颗粒度）如果超过500条，那么会按照每500条合并为一个PushTaskId的方式处理。', + 'type' => 'string', + 'example' => '9524xxxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SingleRequest.OverLimit', + 'errorMessage' => 'A maximum of 1000 URLs are supported for each request.', + ], + [ + 'errorCode' => 'QuotaExceeded.Preload', + 'errorMessage' => 'Your preload attempts have exceeded the daily limit.', + ], + [ + 'errorCode' => 'InvalidObjectPath.Malformed', + 'errorMessage' => 'The specified ObjectPath is invalid.', + ], + [ + 'errorCode' => 'InvalidExtensiveDomain.ValueNotSupported', + 'errorMessage' => 'The specified ExtensiveDomain is not supported.', + ], + [ + 'errorCode' => 'PreloadQueueFull', + 'errorMessage' => 'The warming queue is full,please try again later.', + ], + [ + 'errorCode' => 'QuotaPerMinuteExceeded.Refresh', + 'errorMessage' => 'You have exceeded the prescribed preload limits per minute.', + ], + [ + 'errorCode' => 'InvalidObjectPath.ExceedsMaximum', + 'errorMessage' => 'The maximum number of urls is exceeded.', + ], + [ + 'errorCode' => 'InvalidCustomHeader', + 'errorMessage' => 'Parse preload header failed.', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'System load fluctuates, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PushTaskId\\": \\"9524xxxx\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<PushObjectCacheResponse>\\n <PushTaskId>9524xxxx</PushTaskId>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</PushObjectCacheResponse>","errorExample":""}]', + 'title' => '预热URL', + 'description' => '- 请求方式：支持POST请求，参数用form表单显示。'."\n" + .'- 相关接口：刷新预热类接口包含[RefreshObjectCaches](~~91164~~)刷新接口和[PushObjectCache](~~91161~~)预热接口。'."\n" + .'- URL预热配额（每日）：默认情况下，一个账号每日最多可以提交1000条URL预热任务，如果您账号的日带宽峰值大于200 Mbps，可通过<props="china">[配额管理](~~256513~~)</props><props="intl">[提交工单](https://account.alibabacloud.com/login/login.htm?oauth_callback=https%3A//ticket-intl.console.aliyun.com/%23/ticket/createIndex)</props>申请提升每日配额，阿里云将根据您业务的实际需求进行评估和配置。'."\n" + .'- 每次最多可以提交100条URL预热任务。'."\n" + .'- 预热队列规则：每个账号的预热队列最大为100000条URL，CDN根据URL提交的先后顺序进行预热；当预热队列中待预热的URL达到了100000条时，CDN将会拒绝接收新的预热任务。'."\n" + .'- 单用户调用频率：50次/秒。'."\n" + .'- 如果您需要自动化刷新或预热，请参见[刷新预热批处理脚本](~~151829~~)。'."\n" + ."\n" + .'## 注意事项'."\n" + .'- 提交预热任务并成功执行后，CDN节点会立即回源站加载所需资源，因此大批量提交预热任务会生成较多的并发下载任务，导致回源带宽和请求突增，增加源站压力。'."\n" + .'- 预热任务从提交到预热完成，实际执行时间视预热文件大小而定，大约需要5~30分钟，文件平均大小越小，预热速度越快。'."\n" + .'- 使用RAM用户来执行刷新或预热操作的，需要先获得授权，请参见[授予RAM用户刷新预热权限](~~260300~~)完成授权。'."\n" + .'- 预热请求默认携带的header是Accept-Encoding:gzip，如果您需要预热请求携带其他header，或者实现多副本预热，那么可以使用请求参数WithHeader来实现自定义预热header。'."\n" + .'- 预热时，如果源站返回307等重定向相关的状态码，预热任务并不会跟随重定向地址继续完成预热，最终会导致预热失败。如果源站返回的是301或者302状态码，并且CDN上已经开启了回源301/302跟随，这种情况下正常预热不受影响。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefreshObjectCaches' => [ + 'summary' => '刷新节点上的文件内容。被刷新的文件缓存将立即失效，新的请求将回源获取最新的文件，支持URL批量刷新。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111883', + 'abilityTreeNodes' => [ + 'FEATUREcdnW2530F', + 'FEATUREcdnMNEAI4', + 'FEATUREcdnMZ37V7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ObjectPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '- 单次提交多个URL或多个目录时，使用换行符（\\n）或（\\r\\n）分隔。'."\n" + .'- 单次提交的任务中所有URL的域名个数总和需要在10个以内。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://example.com/image/1.png'."\n" + .'http://aliyundoc.com/image/2.png', + ], + ], + [ + 'name' => 'ObjectType', + 'in' => 'formData', + 'schema' => [ + 'description' => '刷新类型。取值范围：'."\n" + ."\n" + .'- **File**（默认值）：URL。'."\n" + .'- **Directory**：目录。'."\n" + .'- **Regex**：正则刷新。'."\n" + .'- **IgnoreParams**：去参数刷新。去参数指的是去除请求URL中`?`及`?`之后的参数，去参数刷新指的是用户先通过接口提交去参数后的URL，然后用户提交的待刷新URL将会与已缓存资源的URL进行去参数匹配，如果已缓存资源的URL去参数以后与待刷新URL匹配，那么CDN节点将对缓存资源执行刷新处理。'."\n" + ."\n" + .'> - URL刷新和目录刷新的功能说明请参考[刷新和预热资源](~~64936~~)。'."\n" + .'>- 文件刷新将直接删除节点上的资源，当有新请求时回源拉取新资源。其它刷新类型默认只刷新发生变更的资源，需要强制刷新请配置Force参数为true，详见Force参数说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'File', + 'default' => 'File', + ], + ], + [ + 'name' => 'Force', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否直接删除CDN节点上的缓存。默认为false。'."\n" + ."\n" + .'- **true**：直接删除CDN节点上的缓存。直接删除意味着立即将指定的缓存资源从CDN的所有节点上删除，下一个对该资源的请求将需要访问源服务器去获取最新版本的数据，然后重新进行缓存。这种方式可以确保一旦执行了删除操作后，所有后续请求都将获得最新的内容，适合于需要立即更新缓存内容的情况，例如紧急修复安全漏洞或者发布重要更新时。但需要注意的是，这可能会瞬间增加源服务器的压力，因为所有相关请求都需要访问源服务器。'."\n" + ."\n" + .'- **false**：对CDN节点上的缓存标记过期。将缓存资源标记为过期之后，下一个对该资源的请求到达时，CDN节点将会回源验证该资源的最新版本，若与当前缓存资源一致，则直接返回已缓存资源，若不一致，则回源拉取新资源返回给用户，并重新缓存该资源。这种方法的好处是它允许逐渐更新缓存中的内容，而不是立即全部清除，适用于需要平滑过渡的情况，可以减少由于直接删除大量缓存而可能导致源站压力增大。'."\n" + ."\n" + .'> 此参数生效范围：使用目录刷新、正则刷新、去参数刷新这三种刷新方式的时候可以生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshTaskId' => [ + 'description' => '刷新返回的任务ID，多个任务ID用半角逗号（,）分隔。刷新返回的任务ID会按照以下两条规则对刷新任务做合并：'."\n" + ."\n" + .'- 同一个域名、同一秒钟提交的刷新任务（URL颗粒度）会被合并为同一个RefreshTaskId。'."\n" + .'- 同一个域名、同一秒钟提交的刷新任务（URL颗粒度）如果超过2000条，那么会按照每2000条合并为一个RefreshTaskId的方式处理。', + 'type' => 'string', + 'example' => '704222901', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SingleRequest.OverLimit', + 'errorMessage' => 'A maximum of 1000 URLs are supported for each request.', + ], + [ + 'errorCode' => 'InvalidObjectType.Malformed', + 'errorMessage' => 'The specified ObjectType is invalid.', + ], + [ + 'errorCode' => 'InvalidObjectPath.Malformed', + 'errorMessage' => 'The specified ObjectPath is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.Refresh', + 'errorMessage' => 'Your refresh attempts have exceeded the daily limit.', + ], + [ + 'errorCode' => 'InvalidExtensiveDomain.ValueNotSupported', + 'errorMessage' => 'The specified ExtensiveDomain is not supported.', + ], + [ + 'errorCode' => 'QuotaPerMinuteExceeded.Refresh', + 'errorMessage' => 'You tried to refresh too frequently, please try again later.', + ], + [ + 'errorCode' => 'TooMany.Refresh', + 'errorMessage' => 'The refresh queue is full, please try again later.', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests, please try again later', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RefreshTaskId\\": \\"704222901\\",\\n \\"RequestId\\": \\"D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C\\"\\n}","errorExample":"{\\n\\"RefreshTaskId\\":\\"704222904\\"，\\"RequestId\\":\\"D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C\\"\\n}"},{"type":"xml","example":"<RefreshObjectCachesResponse>\\n<RefreshTaskId>704222904</RefreshTaskId>\\n<RequestId>D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C</RequestId>\\n</RefreshObjectCachesResponse>","errorExample":"<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>，<RefreshObjectCachesResponse>，<RefreshTaskId>704225667</RefreshTaskId>，<RequestId>AB14769A-A5F2-4CCD-B85B-3368DFF63C0A</RequestId>，</RefreshObjectCachesResponse>"}]', + 'title' => '刷新缓存', + 'description' => '- 请求方式：支持POST请求，参数用form表单显示。'."\n" + .'- 相关接口：刷新预热类接口包含[RefreshObjectCaches](~~91164~~)刷新接口和[PushObjectCache](~~91161~~)预热接口。'."\n" + .'- 单用户调用频率：50次/秒。'."\n" + .'- 如果您需要自动化刷新或预热，请参见[刷新预热自动化脚本](~~151829~~)。'."\n" + ."\n" + .'## 注意事项'."\n" + .'- 提交刷新任务并成功执行后，CDN节点上对应的缓存资源将会失效，当您再次发起访问请求时，节点会回源站拉取所需资源，并重新缓存在节点上，因此大批量提交刷新任务会清空较多缓存，导致回源带宽和请求突增，增加源站压力。'."\n" + .'- 刷新任务从提交到生效，大约需要5~6分钟，如果文件或者目录配置的缓存过期时间少于5分钟，您无需执行刷新操作，等待文件或者目录缓存超时更新即可。'."\n" + .'- 使用RAM用户来执行刷新或预热操作的，需要先获得授权，请参见[授予RAM用户刷新预热权限](~~260300~~)完成授权。'."\n" + ."\n" + .'### URL刷新配额'."\n" + .'- 默认情况下，一个账号每日最多可以提交10000条URL刷新和100个目录刷新，目录刷新包含子目录。如果您的阿里云账号的日带宽峰值大于200 Mbps，您可以参考<props="china">[配额管理](~~256513~~)</props><props="intl">[提交工单](https://account.alibabacloud.com/login/login.htm?oauth_callback=https%3A//ticket-intl.console.aliyun.com/%23/ticket/createIndex)</props>申请提升每日配额，阿里云将根据您业务的实际需求进行评估和配置。'."\n" + .'- 默认情况下，一个账号每日最多可以提交20个正则刷新、100个去参数刷新，如果您的阿里云账号的日带宽峰值大于10 Gbps，您可以通过<props="china">[填写信息](https://page.aliyun.com/form/act2017566026/index.htm)</props><props="intl">[提交工单](https://workorder-intl.console.aliyun.com/#/ticket/createIndex)</props>来申请提升每日配额。'."\n" + .'- 每次请求最多支持提交1000条URL刷新或者100个目录刷新或者1个正则刷新。'."\n" + .'- 单个域名每分钟最多支持提交10000条URL刷新。', + ], + 'DescribeRefreshTasks' => [ + 'summary' => '调用DescribeRefreshTasks查询刷新、预热状态是否在全网生效。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111832', + 'abilityTreeNodes' => [ + 'FEATUREcdnW2530F', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '按任务ID查询刷新状态。', + 'type' => 'string', + 'required' => false, + 'example' => '1234321', + ], + ], + [ + 'name' => 'ObjectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '按路径查询，准确匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/1.txt', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围为：**1**~**100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **file**：文件刷新。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **regex**：正则刷新。'."\n" + .'- **preload**：文件预热。'."\n" + .'- **block**：URL封禁。'."\n" + .'- **unblock**：URL解封禁。'."\n" + ."\n" + .'> 当指定**DomainName**或**Status**参数时，**ObjectType**参数为必传参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'file', + 'enum' => [ + 'file', + 'directory', + 'preload', + 'regex', + 'IgnoreParams', + 'block', + 'unblock', + ], + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。仅支持单个查询，默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：处理中。'."\n" + .'- **Timeout**：超时未执行。'."\n" + .'- **Canceled**：取消。'."\n" + .'- **Failed**：失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Complete', + 'enum' => [ + 'Complete', + 'Refreshing', + 'Failed', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认**20**，最大**100**。取值：**1**~**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyuji4b6r4**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '174F6032-AA26-470D-B90E-36F0EB205BEE', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '整页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CDNTask' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：处理中。'."\n" + .'- **Failed**：失败。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'CreationTime' => [ + 'description' => '任务对象创建时间，UTC+0时间。', + 'type' => 'string', + 'example' => '2014-11-27T08:23:22Z', + ], + 'ObjectType' => [ + 'description' => '任务类型。'."\n" + ."\n" + .'- **file**：文件刷新。'."\n" + ."\n" + .'- **directory**：目录刷新。'."\n" + ."\n" + .'- **regex**：正则刷新。'."\n" + ."\n" + .'- **preload**：文件预热。', + 'type' => 'string', + 'example' => 'file', + ], + 'Process' => [ + 'description' => '进度百分比。', + 'type' => 'string', + 'example' => '100%', + ], + 'Description' => [ + 'description' => '刷新预热失败返回的错误描述。'."\n" + ."\n" + .'- **InternalError**：内部错误。'."\n" + ."\n" + .'- **OriginTimeout**：源站响应超时。'."\n" + ."\n" + .'- **OriginReturnStatusCode 5XX**：源站响应5xx错误码。', + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ObjectPath' => [ + 'description' => '刷新对象路径。', + 'type' => 'string', + 'example' => 'http://example.com/1.txt', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '704225667', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified TaskId is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or Status is specified.', + ], + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidObjectPath.Malformed', + 'errorMessage' => 'The specified ObjectPath is invalid.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.ValueNotSupported', + 'errorMessage' => 'The specified EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidObjectType.ValueNotSupported', + 'errorMessage' => 'The specified ObjectType is not supported.', + ], + [ + 'errorCode' => 'InvalidStatus.ValueNotSupported', + 'errorMessage' => 'The specified Status is not supported.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The parameter you provided is invalid.', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'The server is busy. Please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"174F6032-AA26-470D-B90E-36F0EB205BEE\\",\\n \\"PageNumber\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 2,\\n \\"Tasks\\": {\\n \\"CDNTask\\": [\\n {\\n \\"Status\\": \\"Complete\\",\\n \\"CreationTime\\": \\"2014-11-27T08:23:22Z\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"Process\\": \\"100%\\",\\n \\"Description\\": \\"Internal Error\\",\\n \\"ObjectPath\\": \\"http://example.com/1.txt\\",\\n \\"TaskId\\": \\"704225667\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<Tasks>\\n <CDNTask>\\n <CreationTime>2014-11-27T08:23:22Z</CreationTime>\\n <ObjectPath>http://example.com/1.txt</ObjectPath>\\n <Status>Complete</Status>\\n <TaskId>704225667</TaskId>\\n <ObjectType>file</ObjectType>\\n <Process>100%</Process>\\n </CDNTask>\\n <CDNTask>\\n <CreationTime>2014-11-27T08:18:38Z</CreationTime>\\n <ObjectPath>http://aliyundoc.com/1.txt</ObjectPath>\\n <Status>Complete</Status>\\n <TaskId>704222904</TaskId>\\n <ObjectType>file</ObjectType>\\n <Process>100%</Process>\\n </CDNTask>\\n</Tasks>\\n<PageNumber>1</PageNumber>\\n<PageSize>10</PageSize>\\n<TotalCount>2</TotalCount>\\n<RequestId>174F6032-AA26-470D-B90E-36F0EB205BEE</RequestId>","errorExample":""}]', + 'title' => '查询刷新预热任务', + 'description' => '- 支持根据任务ID或URL查询。'."\n" + .'- 支持同时传入**TaskId**和**ObjectPath**参数，如果不指定**TaskId**和**ObjectPath**，默认查询最近3天内第一页的数据（20条）。'."\n" + .'- 只能查询最近3天内的数据。'."\n" + .'- 任务状态需要由API的调用请求来触发异步更新。'."\n" + .'- 如果您在OSS控制台开启了CDN缓存自动刷新，则无法通过DescribeRefreshTasks接口查看OSS上的缓存自动刷新任务。'."\n" + .'- 单用户调用频率：5次/秒。如果您需要更高的调用频率，请使用仅支持通过任务编号查询刷新预热任务信息的接口[DescribeRefreshTaskById](~~187709~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRefreshTaskById' => [ + 'summary' => '调用DescribeRefreshTaskById查询刷新状态和预热状态是否在全网生效。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111831', + 'abilityTreeNodes' => [ + 'FEATUREcdnW2530F', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的任务ID。'."\n" + ."\n" + .'您可以调用[RefreshObjectCaches](~~91164~~)接口，从其返回值中获取刷新预热的任务ID，并通过任务ID查询源站资源的刷新状态。'."\n" + ."\n" + .'支持同时传入多个任务ID，多个任务ID之间用英文逗号（,）分隔，最多支持同时传入10个任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12345678', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '任务总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B', + ], + 'Tasks' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：处理中。'."\n" + .'- **Timeout**：超时未执行。'."\n" + .'- **Canceled**：取消。'."\n" + .'- **Failed**：失败。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'CreationTime' => [ + 'description' => '任务对象创建时间，使用UTC时间表示。', + 'type' => 'string', + 'example' => '2020-08-03T08:54:23Z', + ], + 'ObjectType' => [ + 'description' => '任务类型。取值：'."\n" + .'- **file**：单文件刷新。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **preload**：单文件预热。'."\n" + .'- **regex**：正则刷新。', + 'type' => 'string', + 'example' => 'file', + ], + 'Process' => [ + 'description' => '任务完成进度百分比。', + 'type' => 'string', + 'example' => '100%', + ], + 'Description' => [ + 'description' => '刷新预热失败后返回的错误描述。取值：'."\n" + .'- **Internal Error**：内部错误。'."\n" + .'- **Origin Timeout**：源站响应超时。'."\n" + .'- **Origin Return StatusCode 5XX**：源站响应5xx错误码。', + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ObjectPath' => [ + 'description' => '刷新对象的路径。', + 'type' => 'string', + 'example' => 'http://example.com/abc.jpg', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '24840', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified TaskId is invalid.', + ], + [ + 'errorCode' => 'InvalidObjectPath.Malformed', + 'errorMessage' => 'The specified ObjectPath is invalid.', + ], + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.ValueNotSupported', + 'errorMessage' => 'The specified EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidObjectType.ValueNotSupported', + 'errorMessage' => 'The specified ObjectType is not supported.', + ], + [ + 'errorCode' => 'InvalidStatus.ValueNotSupported', + 'errorMessage' => 'The specified Status is not supported.', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + ], + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The parameters you provided are invalid.', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests, please try again later', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B\\",\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"Complete\\",\\n \\"CreationTime\\": \\"2020-08-03T08:54:23Z\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"Process\\": \\"100%\\",\\n \\"Description\\": \\"Internal Error\\",\\n \\"ObjectPath\\": \\"http://example.com/abc.jpg\\",\\n \\"TaskId\\": \\"24840\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeRefreshTaskByIdResponse>\\n<RequestId>E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B</RequestId>\\n<Tasks>\\n <CreationTime>2020-08-03T08:54:23Z</CreationTime>\\n <Description/>\\n <ObjectPath>http://example.com/abc.jpg</ObjectPath>\\n <ObjectType>file</ObjectType>\\n <Process>100%</Process>\\n <Status>Complete</Status>\\n <TaskId>12345678</TaskId>\\n</Tasks>\\n<Tasks>\\n <CreationTime>2020-08-03T09:12:44Z</CreationTime>\\n <Description/>\\n <ObjectPath>http://example.com/bcd.jpg</ObjectPath>\\n <ObjectType>file</ObjectType>\\n <Process>99.37%</Process>\\n <Status>Refreshing</Status>\\n <TaskId>23456789</TaskId>\\n</Tasks>\\n<TotalCount>2</TotalCount>\\n</DescribeRefreshTaskByIdResponse>","errorExample":""}]', + 'title' => '查询刷新预热任务-按ID', + 'description' => '- 支持查询3天内（包含3天）的数据。'."\n" + .'- 单用户调用频率为：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePreloadDetailById' => [ + 'summary' => '查询任务预热详情，包括任务下所有资源的预热进度。该接口需要申请白名单后才可以使用，带宽大于100Gbps的情况下，可以通过您的商务经理申请白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '165361', + 'abilityTreeNodes' => [ + 'FEATUREcdnKZKOWX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '按任务ID查询预热任务详情。'."\n" + .'支持单次查询一个任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '15423123921', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的总任务数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E9D3257A-1B7C-414C-90C1-8D07AC47BCAC', + ], + 'UrlDetails' => [ + 'description' => '任务详情。包括任务ID、起止时间、域名、成功率、状态、返回错误码、以及所有url资源的完成详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '待查询的任务ID。'."\n" + ."\n" + .'您可以调用PushObjectCache接口，从其返回值中获取预热任务的ID，并通过任务ID查询源站资源的预热状态。'."\n" + ."\n" + .'支持同时传入单个任务ID。', + 'type' => 'string', + 'example' => '14286878547', + ], + 'Domain' => [ + 'description' => '预热资源的域名', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CreationTime' => [ + 'description' => '任务对象创建时间，使用UTC时间表示。', + 'type' => 'string', + 'example' => '2022-11-23T02:26:56Z', + ], + 'EndTime' => [ + 'description' => '任务对象结束时间，使用UTC时间表示。', + 'type' => 'string', + 'example' => '2022-11-23T02:27:00Z', + ], + 'RetCode' => [ + 'description' => '返回的错误码，`0`表示成功。', + 'type' => 'string', + 'example' => '0', + ], + 'Process' => [ + 'description' => '任务完成进度百分比，代表预热任务在多少边缘节点上已结束。', + 'type' => 'string', + 'example' => '100%', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：进行中。'."\n" + .'- **Failed**：任务失败。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'Urls' => [ + 'description' => '该任务下所有url资源的完成详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '预热资源的url。', + 'type' => 'string', + 'example' => '/abc.jpg'."\n", + ], + 'Success' => [ + 'description' => '成功百分比。表示该资源在多少边缘节点上预热成功。', + 'type' => 'string', + 'example' => '47%', + ], + 'Description' => [ + 'description' => '资源预热详情。'."\n" + .'- 若全部边缘节点成功，则返回"Successfully preloaded"'."\n" + .'- 若存在边缘节点失败，则返回失败详情，用"|"分隔。', + 'type' => 'string', + 'example' => 'Successfully preloaded', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified TaskId is invalid.', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + ], + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'The parameters you provided are invalid.', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + ], + ], + 429 => [ + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => 'Too many requests, please try again later', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"E9D3257A-1B7C-414C-90C1-8D07AC47BCAC\\",\\n \\"UrlDetails\\": [\\n {\\n \\"TaskId\\": \\"14286878547\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"CreationTime\\": \\"2022-11-23T02:26:56Z\\",\\n \\"EndTime\\": \\"2022-11-23T02:27:00Z\\",\\n \\"RetCode\\": \\"0\\",\\n \\"Process\\": \\"100%\\",\\n \\"Status\\": \\"Complete\\",\\n \\"Urls\\": [\\n {\\n \\"Url\\": \\"/abc.jpg\\\\n\\",\\n \\"Success\\": \\"47%\\",\\n \\"Description\\": \\"Successfully preloaded\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询预热任务详情', + 'description' => '- 支持查询3天内（包含3天）的数据。'."\n" + .'- 单用户调用频率为：30次/秒。', + ], + 'DescribeCdnUserQuota' => [ + 'summary' => '调用DescribeCdnUserQuota查询用户配额上限和余量信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111751', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BlockQuota' => [ + 'description' => '封禁上限，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RefreshUrlRemain' => [ + 'description' => '刷新URL余量，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'DomainQuota' => [ + 'description' => '加速域名数上限，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'BlockRemain' => [ + 'description' => '封禁余量，单位：个。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PreloadRemain' => [ + 'description' => '预热URL余量，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EF4F084A-2F49-4E1C-9CA0-DC85BCE7F391', + ], + 'RefreshUrlQuota' => [ + 'description' => '刷新URL上限，单位：个。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'PreloadQuota' => [ + 'description' => '预热URL上限，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'RefreshDirQuota' => [ + 'description' => '刷新目录上限，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RefreshDirRemain' => [ + 'description' => '刷新目录余量，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'IgnoreParamsQuota' => [ + 'description' => '忽略参数刷新上限，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'IgnoreParamsRemain' => [ + 'description' => '忽略参数刷新余量，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BlockQuota\\": 100,\\n \\"RefreshUrlRemain\\": 2000,\\n \\"DomainQuota\\": 50,\\n \\"BlockRemain\\": 100,\\n \\"PreloadRemain\\": 100,\\n \\"RequestId\\": \\"EF4F084A-2F49-4E1C-9CA0-DC85BCE7F391\\",\\n \\"RefreshUrlQuota\\": 2000,\\n \\"PreloadQuota\\": 500,\\n \\"RefreshDirQuota\\": 100,\\n \\"RefreshDirRemain\\": 500,\\n \\"IgnoreParamsQuota\\": 100,\\n \\"IgnoreParamsRemain\\": 10\\n}","errorExample":"{\\n \\"DomainQuota\\" : 20,\\n \\"RefreshUrlQuota\\" : 1000,\\n \\"RefreshDirQuota\\" : 500,\\n \\"RefreshUrlRemain\\" : 500,\\n \\"RefreshDirRemain\\" : 300,\\n \\"PreloadQuota\\" : 300,\\n \\"PreloadRemain\\" : 100,\\n \\"BlockQuota\\" : 100,\\n \\"BlockRemain\\" : 100,\\n \\"RequestId\\" : \\"BFFCDFAD-DACC-484E-9BE6-0AF3B3A0DD23\\"\\n}"},{"type":"xml","example":"<DescribeCdnUserQuotaResponse>\\n <PreloadRemain>500</PreloadRemain>\\n <RefreshUrlRemain>2000</RefreshUrlRemain>\\n <DomainQuota>50</DomainQuota>\\n <RefreshDirRemain>100</RefreshDirRemain>\\n <RequestId>EF4F084A-2F49-4E1C-9CA0-DC85BCE7F391</RequestId>\\n <BlockRemain>100</BlockRemain>\\n <RefreshUrlQuota>2000</RefreshUrlQuota>\\n <BlockQuota>100</BlockQuota>\\n <PreloadQuota>500</PreloadQuota>\\n <RefreshDirQuota>100</RefreshDirQuota>\\n</DescribeCdnUserQuotaResponse>","errorExample":""}]', + 'title' => '查询用户配额', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainPathData' => [ + 'summary' => '调用DescribeDomainPathData按目录维度获取监控数据，包括流量和访问次数。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111783', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页。从**1**开始。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。'."\n" + .'取值：**1**~**1000**之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '路径，以正斜线（/）开头，不填表示查询所有路径。如果路径是目录，需要以正斜线（/）结尾。'."\n" + ."\n" + .'> 路径信息不支持模糊匹配，需要指定查询的目录深度，只能设置为一个固定值，例如设置一级目录/path/，表示数据统计时，固定统计一级目录的带宽。', + 'type' => 'string', + 'required' => false, + 'example' => '/path/', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-DDThh:mm:ssZ。'."\n" + .'例如：2016-10-20T04:00:00Z。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-10-20T04:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-DDThh:mm:ssZ。开始时间和结束时间，间隔小于30天。例如：2016-10-21T04:00:00Z。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-10-21T04:00:00Z', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。'."\n" + .'>仅支持单个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2017-09-30T17:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2017-09-30T16:00:00Z', + ], + 'PageSize' => [ + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '当前页码，从**1**开始计数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '路径带宽数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'PathDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '路径带宽数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => '路径。', + 'type' => 'string', + 'example' => '/path/', + ], + 'Time' => [ + 'description' => '时间点。', + 'type' => 'string', + 'example' => '2017-09-30T16:00:00Z', + ], + 'Acc' => [ + 'description' => '访问次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Traffic' => [ + 'description' => '流量（B）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '346', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'DE81639B-DAC1-4C76-AB72-F34B836837D5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'PageSize must be of type Integer', + ], + [ + 'errorCode' => 'InvalidPageSize.ExceedsMaximum', + 'errorMessage' => 'PageSize should be less than or equal to 1000', + ], + [ + 'errorCode' => 'InvalidPageSize.ExceedsMinimum', + 'errorMessage' => 'PageSize should be greater than or equal to 1', + ], + [ + 'errorCode' => 'InvalidPath.Malformed', + 'errorMessage' => 'Path must be of type String', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'StartTime must be of type String', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'EndTime must be of type String', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'DomainName must be of type String', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'DomainName is required', + ], + [ + 'errorCode' => 'InvalidDomainName.TooShort', + 'errorMessage' => 'DomainName should be at least 1 chars long', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'PageNumber must be of type Integer', + ], + [ + 'errorCode' => 'InvalidPageNumber.ExceedsMinimum', + 'errorMessage' => 'PageNumber should be greater than or equal to 1', + ], + [ + 'errorCode' => 'InvalidTime.OverRange', + 'errorMessage' => 'Specified StartTime or EndTime is over range', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2017-09-30T17:00:00Z\\",\\n \\"StartTime\\": \\"2017-09-30T16:00:00Z\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"PathDataPerInterval\\": {\\n \\"UsageData\\": [\\n {\\n \\"Path\\": \\"/path/\\",\\n \\"Time\\": \\"2017-09-30T16:00:00Z\\",\\n \\"Acc\\": 10,\\n \\"Traffic\\": 346\\n }\\n ]\\n },\\n \\"RequestId\\": \\"DE81639B-DAC1-4C76-AB72-F34B836837D5\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainPathDataResponse>\\n<DataInterval>300</DataInterval>\\n<EndTime>2017-09-30T17:00:00Z</EndTime>\\n<PageNumber>1</PageNumber>\\n<PageSize>20</PageSize>\\n<PathDataPerInterval>\\n <UsageData>\\n <Acc>10</Acc>\\n <Path>/path/</Path>\\n <Time>2017-09-30T16:00:00Z</Time>\\n <Traffic>346</Traffic>\\n </UsageData>\\n <UsageData>\\n <Acc>12</Acc>\\n <Path>/path/</Path>\\n <Time>2017-09-30T16:05:00Z</Time>\\n <Traffic>400</Traffic>\\n </UsageData>\\n</PathDataPerInterval>\\n<StartTime>2017-09-30T16:00:00Z</StartTime>\\n<TotalCount>2</TotalCount>\\n</DescribeDomainPathDataResponse>","errorExample":""}]', + 'title' => '按目录维度获取监控数据', + 'description' => '- 该接口仅支持白名单用户（域名峰值带宽10 Gbps以上）调用，需要<props="china">[提交工单](https://selfservice.console.aliyun.com/ticket/createIndex)</props><props="intl">[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.2020520001.aliyun_topbar.18.dbd44bd3e4f845#/ticket/createIndex)</props>申请，符合条件的情况下将在后台进行配置。'."\n" + .'- 单用户调用频率：6000次/分。'."\n" + .'- 目前仅支持对账号下的指定域名开启目录维度带宽统计，不支持对全部域名开启。'."\n" + .'- 域名下所有文件的平均大小需要大于1 MB。'."\n" + .'- 每个域名的目录数量不超过100个，超过100个目录的情况下，数据的精度将会降低，查询的不准确。'."\n" + .'- 不指定StartTime和EndTime时，默认读取过去24小时的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" + .'- 最多可获取最近30天的数据。'."\n" + ."\n\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainQpsData' => [ + 'summary' => '调用DescribeDomainQpsData获取5分钟计算粒度加速域名的每秒访问次数QPS，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111786', + 'abilityTreeNodes' => [ + 'FEATUREcdnL8FLP3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**接口说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B8333EDB-4595-46E0-AFE9-29BAA290D0E0', + ], + 'DomainName' => [ + 'description' => '加速域名信息。'."\n", + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'QpsDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的QPS数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccValue' => [ + 'description' => '总访问次数。', + 'type' => 'string', + 'example' => '0', + ], + 'AccDomesticValue' => [ + 'description' => '中国内地访问次数。', + 'type' => 'string', + 'example' => '0', + ], + 'AccOverseasValue' => [ + 'description' => '全球（不包含中国内地）访问次数。', + 'type' => 'string', + 'example' => '0', + ], + 'HttpsValue' => [ + 'description' => '节点HTTPS的QPS值。'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'HttpsOverseasValue' => [ + 'description' => '节点HTTPS全球（不包含中国内地）QPS值。'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'DomesticValue' => [ + 'description' => '中国内地QPS。', + 'type' => 'string', + 'example' => '0', + ], + 'HttpsAccOverseasValue' => [ + 'description' => '节点全球（不包含中国内地）HTTPS请求数。'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'HttpsDomesticValue' => [ + 'description' => '节点HTTPS中国内地QPS值。'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'HttpsAccValue' => [ + 'description' => '节点HTTPS请求数。'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Value' => [ + 'description' => '总QPS。', + 'type' => 'string', + 'example' => '0', + ], + 'OverseasValue' => [ + 'description' => '全球（不包含中国内地）QPS。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'HttpsAccDomesticValue' => [ + 'description' => '节点中国内地HTTPS请求数。'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2019-11-30T05:33:00Z\\",\\n \\"RequestId\\": \\"B8333EDB-4595-46E0-AFE9-29BAA290D0E0\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"QpsDataInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"AccValue\\": \\"0\\",\\n \\"AccDomesticValue\\": \\"0\\",\\n \\"AccOverseasValue\\": \\"0\\",\\n \\"HttpsValue\\": \\"1\\",\\n \\"HttpsOverseasValue\\": \\"1\\",\\n \\"DomesticValue\\": \\"0\\",\\n \\"HttpsAccOverseasValue\\": \\"1\\",\\n \\"HttpsDomesticValue\\": \\"1\\",\\n \\"HttpsAccValue\\": \\"1\\",\\n \\"Value\\": \\"0\\",\\n \\"OverseasValue\\": \\"0\\",\\n \\"TimeStamp\\": \\"2019-11-30T05:40:00Z\\",\\n \\"HttpsAccDomesticValue\\": \\"1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainQpsDataResponse>\\n <EndTime>2019-11-30T05:40:00Z</EndTime>\\n <StartTime>2019-11-30T05:33:00Z</StartTime>\\n <RequestId>B8333EDB-4595-46E0-AFE9-29BAA290D0E0</RequestId>\\n <DomainName>example.com</DomainName>\\n <DataInterval>300</DataInterval>\\n <QpsDataInterval>\\n <AccValue>0</AccValue>\\n <AccDomesticValue>0</AccDomesticValue>\\n <AccOverseasValue>0</AccOverseasValue>\\n <HttpsValue>1</HttpsValue>\\n <HttpsOverseasValue>1</HttpsOverseasValue>\\n <DomesticValue>0</DomesticValue>\\n <HttpsAccOverseasValue>1</HttpsAccOverseasValue>\\n <HttpsDomesticValue>1</HttpsDomesticValue>\\n <HttpsAccValue>1</HttpsAccValue>\\n <Value>0</Value>\\n <OverseasValue>0</OverseasValue>\\n <TimeStamp>2019-11-30T05:40:00Z</TimeStamp>\\n <HttpsAccDomesticValue>1</HttpsAccDomesticValue>\\n </QpsDataInterval>\\n</DescribeDomainQpsDataResponse>","errorExample":""}]', + 'title' => '查询QPS', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|366天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainQpsDataByLayer' => [ + 'summary' => '调用DescribeDomainQpsDataByLayer查询加速域名的每秒访问次数QPS，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111787', + 'abilityTreeNodes' => [ + 'FEATUREcdnL8FLP3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，默认查询所有地域。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + [ + 'name' => 'Layer', + 'in' => 'query', + 'schema' => [ + 'description' => '查询维度。取值：'."\n" + ."\n" + .'- **网络层**：**IPv4**、**IPv6**。'."\n" + ."\n" + .'- **应用层**：**http**、**https**、**quic**。'."\n" + ."\n" + .'- **all**（默认值）：包含网络层和应用层。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + ], + 'Layer' => [ + 'description' => '返回的查询维度。', + 'type' => 'string', + 'example' => 'all', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'QpsDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的QPS数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'QPS总数。', + 'type' => 'string', + 'example' => '0.56', + ], + 'AccValue' => [ + 'description' => '总请求次数。', + 'type' => 'string', + 'example' => '56', + ], + 'AccDomesticValue' => [ + 'description' => '中国内地请求数。', + 'type' => 'string', + 'example' => '12', + ], + 'OverseasValue' => [ + 'description' => '全球（不包含中国内地）QPS。', + 'type' => 'string', + 'example' => '0.44', + ], + 'AccOverseasValue' => [ + 'description' => '全球（不包含中国内地）请求数。', + 'type' => 'string', + 'example' => '44', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T21:00:00Z', + ], + 'DomesticValue' => [ + 'description' => '中国内地QPS。', + 'type' => 'string', + 'example' => '0.12', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2019-11-30T05:33:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Layer\\": \\"all\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"QpsDataInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0.56\\",\\n \\"AccValue\\": \\"56\\",\\n \\"AccDomesticValue\\": \\"12\\",\\n \\"OverseasValue\\": \\"0.44\\",\\n \\"AccOverseasValue\\": \\"44\\",\\n \\"TimeStamp\\": \\"2015-12-10T21:00:00Z\\",\\n \\"DomesticValue\\": \\"0.12\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainQpsDataByLayerResponse>\\n <EndTime>2019-11-30T05:40:00Z</EndTime>\\n <StartTime>2019-11-30T05:33:00Z</StartTime>\\n <RequestId>BEA5625F-8FCF-48F4-851B-CA63946DA664</RequestId>\\n <Layer>all</Layer>\\n <DomainName>example.com</DomainName>\\n <DataInterval>300</DataInterval>\\n <QpsDataInterval>\\n <Value>0.56</Value>\\n <AccValue>56</AccValue>\\n <AccDomesticValue>12</AccDomesticValue>\\n <OverseasValue>0.44</OverseasValue>\\n <AccOverseasValue>44</AccOverseasValue>\\n <TimeStamp>2015-12-10T21:00:00Z</TimeStamp>\\n <DomesticValue>0.12</DomesticValue>\\n </QpsDataInterval>\\n</DescribeDomainQpsDataByLayerResponse>","errorExample":""}]', + 'title' => '查询QPS-按协议', + 'description' => '- 单用户调用频率：20次/秒。'."\n" + .'- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|366天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainBpsData' => [ + 'summary' => '调用DescribeDomainBpsData查询带宽数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111764', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名使用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-05-14T09:50:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-05-14T10:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。'."\n" + ."\n" + .'默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。'."\n" + ."\n" + .'默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2015-12-10T20:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2020-05-14T09:50:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', + ], + 'IspNameEn' => [ + 'description' => '运营商英文名。', + 'type' => 'string', + 'example' => 'unicom', + ], + 'LocationNameEn' => [ + 'description' => '地域英文名。', + 'type' => 'string', + 'example' => 'beijing', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔。单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'BpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的网络带宽数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HttpsDomesticValue' => [ + 'description' => '边缘节点HTTPS中国内地带宽。当按区域运营商查询时，此值为空。', + 'type' => 'string', + 'example' => '11286111', + ], + 'Value' => [ + 'description' => '带宽。单位：bit/s。', + 'type' => 'string', + 'example' => '11288111', + ], + 'OverseasValue' => [ + 'description' => '全球（不包含中国内地）带宽。当按区域运营商查询时，此值为空。', + 'type' => 'string', + 'example' => '2000', + ], + 'HttpsValue' => [ + 'description' => '边缘节点HTTPS的带宽数据值。单位：bit/s。', + 'type' => 'string', + 'example' => '11288111', + ], + 'HttpsOverseasValue' => [ + 'description' => '边缘节点全球（不包含中国内地）HTTPS带宽。当按区域运营商查询时，此值为空。', + 'type' => 'string', + 'example' => '2000', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'DomesticValue' => [ + 'description' => '中国内地带宽。当按区域运营商查询时，此值为空。', + 'type' => 'string', + 'example' => '11286111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T20:00Z\\",\\n \\"StartTime\\": \\"2020-05-14T09:50:00Z\\",\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"IspNameEn\\": \\"unicom\\",\\n \\"LocationNameEn\\": \\"beijing\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"BpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"HttpsDomesticValue\\": \\"11286111\\",\\n \\"Value\\": \\"11288111\\",\\n \\"OverseasValue\\": \\"2000\\",\\n \\"HttpsValue\\": \\"11288111\\",\\n \\"HttpsOverseasValue\\": \\"2000\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"DomesticValue\\": \\"11286111\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainBpsDataResponse>\\n<RequestId>0AD87822-E8CE-436B-B434-C13F53B5B2D4</RequestId>\\n<EndTime>2020-05-14T10:00:00Z</EndTime>\\n<DataInterval>300</DataInterval>\\n<StartTime>2020-05-14T09:50:00Z</StartTime>\\n<BpsDataPerInterval>\\n <DataModule>\\n <OverseasValue>0</OverseasValue>\\n <HttpsValue>0</HttpsValue>\\n <Value>83.48266666666667</Value>\\n <HttpsDomesticValue>0</HttpsDomesticValue>\\n <TimeStamp>2020-05-14T09:50:00Z</TimeStamp>\\n <HttpsOverseasValue>0</HttpsOverseasValue>\\n <DomesticValue>83.48266666666667</DomesticValue>\\n </DataModule>\\n <DataModule>\\n <OverseasValue>0</OverseasValue>\\n <HttpsValue>0</HttpsValue>\\n <Value>83.424</Value>\\n <HttpsDomesticValue>0</HttpsDomesticValue>\\n <TimeStamp>2020-05-14T09:55:00Z</TimeStamp>\\n <HttpsOverseasValue>0</HttpsOverseasValue>\\n <DomesticValue>83.424</DomesticValue>\\n </DataModule>\\n</BpsDataPerInterval>\\n</DescribeDomainBpsDataResponse>","errorExample":""}]', + 'title' => '查询带宽', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|90天|366天|次日一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainBpsDataByLayer' => [ + 'summary' => '调用DescribeDomainBpsDataByLayer按协议分类获取带宽数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111765', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'> 不传该参数，默认返回所有加速域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-05-06T07:10:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-05-06T07:20:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。通过[DescribeCdnRegionAndIsp](~~DescribeCdnRegionAndIsp~~)接口获得，默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。通过[DescribeCdnRegionAndIsp](~~DescribeCdnRegionAndIsp~~)接口获得，默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + [ + 'name' => 'Layer', + 'in' => 'query', + 'schema' => [ + 'description' => '查询维度。'."\n" + .'- 网络层：**IPv4**、**IPv6**。'."\n" + .'- 应用层：**http**、**https**、**quic**。'."\n" + .'- **all**：包含网络层和应用层。'."\n" + ."\n" + .'默认值为**all**。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位为秒。', + 'type' => 'string', + 'example' => '300', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C565B910-BC3B-467B-9046-2A48566EA967', + ], + 'BpsDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的每秒访问次数Bps数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '峰值带宽，单位：bps。', + 'type' => 'string', + 'example' => '75.68', + ], + 'TrafficValue' => [ + 'description' => '总流量，单位：Byte。', + 'type' => 'string', + 'example' => '2838', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2020-05-06T07:10:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvaildParameter', + 'errorMessage' => 'The parameter you provided is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataInterval\\": \\"300\\",\\n \\"RequestId\\": \\"C565B910-BC3B-467B-9046-2A48566EA967\\",\\n \\"BpsDataInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"75.68\\",\\n \\"TrafficValue\\": \\"2838\\",\\n \\"TimeStamp\\": \\"2020-05-06T07:10:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainBpsDataByLayerResponse>\\n <RequestId>C565B910-BC3B-467B-9046-2A48566EA967</RequestId>\\n <DataInterval>300</DataInterval>\\n <BpsDataInterval>\\n <DataModule>\\n <Value>75.68</Value>\\n <TrafficValue>2838</TrafficValue>\\n <TimeStamp>2020-05-06T07:10:00Z</TimeStamp>\\n </DataModule>\\n <DataModule>\\n <Value>99138.85333333333</Value>\\n <TrafficValue>3717707</TrafficValue>\\n <TimeStamp>2020-05-06T07:15:00Z</TimeStamp>\\n </DataModule>\\n </BpsDataInterval>\\n</DescribeDomainBpsDataByLayerResponse>","errorExample":""}]', + 'title' => '查询带宽-按协议', + 'description' => '- 单用户调用频率：20次/秒。'."\n" + .'- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|90天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainBpsDataByTimeStamp' => [ + 'summary' => '调用DescribeDomainBpsDataByTimeStamp查询加速域名的在某个时刻不同运营商和区域的带宽数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111766', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的域名，仅支持查询单个。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'TimePoint', + 'in' => 'query', + 'schema' => [ + 'description' => '查询目标时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 查询数据粒度为5分钟。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'IspNames', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，多个用半角逗号（,）分隔。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~91077~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'unicom,telecom', + ], + ], + [ + 'name' => 'LocationNames', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，多个用半角逗号（,）隔开。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~91077~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'liaoning,guangxi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时刻。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'BpsDataList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BpsDataModel' => [ + 'description' => '每个地域、运营商对应的带宽数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocationName' => [ + 'description' => '地域英文名。', + 'type' => 'string', + 'example' => 'Liaoning', + ], + 'TimeStamp' => [ + 'description' => '时间片起始片刻。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'IspName' => [ + 'description' => '运营商英文名。', + 'type' => 'string', + 'example' => 'unicom', + ], + 'Bps' => [ + 'description' => '对应的带宽值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52119553', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TimeStamp\\": \\"2019-11-30T05:40:00Z\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"BpsDataList\\": {\\n \\"BpsDataModel\\": [\\n {\\n \\"LocationName\\": \\"Liaoning\\",\\n \\"TimeStamp\\": \\"2019-11-30T05:40:00Z\\",\\n \\"IspName\\": \\"unicom\\",\\n \\"Bps\\": 52119553\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainBpsDataByTimeStampResponse>\\r\\n <BpsDataList>\\r\\n\\t\\t<BpsDataModel>\\r\\n\\t\\t\\t<LocationName>Liaoning</LocationName>\\r\\n\\t\\t\\t<Bps>880996111</Bps>\\r\\n\\t\\t\\t<IspName>telecom</IspName>\\r\\n\\t\\t</BpsDataModel>\\r\\n\\t\\t<BpsDataModel>\\r\\n\\t\\t\\t<LocationName>Liaoning</LocationName>\\r\\n\\t\\t\\t<Bps>52119553</Bps>\\r\\n\\t\\t\\t<IspName>unicom</IspName>\\r\\n\\t\\t</BpsDataModel>\\r\\n\\t\\t<BpsDataModel>\\r\\n\\t\\t\\t<LocationName>Guangxi</LocationName>\\r\\n\\t\\t\\t<Bps>51295137</Bps>\\r\\n\\t\\t\\t<IspName>telecom</IspName>\\r\\n\\t\\t</BpsDataModel>\\r\\n\\t\\t<BpsDataModel>\\r\\n\\t\\t\\t<LocationName>Guangxi</LocationName>\\r\\n\\t\\t\\t<Bps>18673571</Bps>\\r\\n\\t\\t\\t<IspName>unicom</IspName>\\r\\n\\t\\t</BpsDataModel>\\r\\n <TimeStamp>2016-08-01T22:00Z</TimeStamp>\\r\\n\\t<RequestId>7682DE14-3B4D-48D0-9B7C-DD3C8C3E1C78</RequestId>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n </BpsDataList>\\r\\n</DescribeDomainBpsDataByTimeStampResponse>\\r\\n\\r\\n","errorExample":""}]', + 'title' => '查询带宽-按时间戳', + 'description' => '- 获取数据单位：bit/second。'."\n" + .'- 不支持批量域名查询。'."\n" + .'- 数据精确到5分钟粒度。'."\n" + .'- 单用户调用频率：20次/秒。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟 | 3天 |93天|15分钟|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainTrafficData' => [ + 'summary' => '调用DescribeDomainTrafficData查询加速域名的网络流量监控数据，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111814', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，通过[DescribeCdnRegionAndIsp](~~DescribeCdnRegionAndIsp~~)获得。'."\n" + ."\n" + .'默认查询所有运营商数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，通过[DescribeCdnRegionAndIsp](~~DescribeCdnRegionAndIsp~~)获得。'."\n" + ."\n" + .'默认查询所有地域数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。'."\n", + 'type' => 'string', + 'example' => '2015-12-10T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。'."\n", + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-B913-E0AC3D31693E', + ], + 'DomainName' => [ + 'description' => '加速域名信息。'."\n", + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'TrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的流量数据列表。单位：Byte。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HttpsDomesticValue' => [ + 'description' => 'L1节点的HTTPS流量（中国内地）。', + 'type' => 'string', + 'example' => '0', + ], + 'Value' => [ + 'description' => '总流量。'."\n", + 'type' => 'string', + 'example' => '423304182', + ], + 'OverseasValue' => [ + 'description' => '全球（不包含中国内地）流量。'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'HttpsValue' => [ + 'description' => 'L1节点的HTTPS总流量。'."\n", + 'type' => 'string', + 'example' => '423304182', + ], + 'HttpsOverseasValue' => [ + 'description' => 'L1节点的HTTPS流量（全球（不包含中国内地））。'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。'."\n", + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'DomesticValue' => [ + 'description' => '中国内地流量。'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"TrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"HttpsDomesticValue\\": \\"0\\",\\n \\"Value\\": \\"423304182\\",\\n \\"OverseasValue\\": \\"0\\",\\n \\"HttpsValue\\": \\"423304182\\",\\n \\"HttpsOverseasValue\\": \\"0\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"DomesticValue\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"TrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"Value\\": \\"423304182\\",\\n \\"DomesticValue\\": \\"0\\",\\n \\"OverseasValue\\": \\"0\\",\\n \\"HttpsValue\\": \\"423304182\\",\\n \\"HttpsDomesticValue\\": \\"0\\",\\n \\"HttpsOverseasValue\\": \\"0\\"\\n },\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:05:00Z\\",\\n \\"Value\\": \\"454680793\\",\\n \\"DomesticValue\\": \\"0\\",\\n \\"OverseasValue\\": \\"0\\",\\n \\"HttpsValue\\": \\"423304182\\",\\n \\"HttpsDomesticValue\\": \\"0\\",\\n \\"HttpsOverseasValue\\": \\"0\\"\\n },\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:10:00Z\\",\\n \\"Value\\": \\"501718342\\",\\n \\"DomesticValue\\": \\"0\\",\\n \\"OverseasValue\\": \\"0\\",\\n \\"HttpsValue\\": \\"423304182\\",\\n \\"HttpsDomesticValue\\": \\"0\\",\\n \\"HttpsOverseasValue\\": \\"0\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\"\\n}"},{"type":"xml","example":"<DescribeDomainTrafficDataResponse>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<DataInterval>300</DataInterval>\\r\\n\\t<TrafficDataPerInterval>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2015-12-10T20:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>423304182</Value>\\r\\n\\t\\t\\t<DomesticValue>0</DomesticValue>\\r\\n\\t\\t\\t<OverseasValue>0</OverseasValue>\\r\\n\\t\\t\\t<HttpsValue>423304182</HttpsValue>\\r\\n\\t\\t\\t<HttpsDomesticValue>0</HttpsDomesticValue>\\r\\n\\t\\t\\t<HttpsOverseasValue>0</HttpsOverseasValue>\\r\\n\\t\\t</DataModule>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2015-12-10T20:05:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>454680793</Value>\\r\\n\\t\\t\\t<DomesticValue>0</DomesticValue>\\r\\n\\t\\t\\t<OverseasValue>0</OverseasValue>\\r\\n\\t\\t\\t<HttpsValue>423304182</HttpsValue>\\r\\n\\t\\t\\t<HttpsDomesticValue>0</HttpsDomesticValue>\\r\\n\\t\\t\\t<HttpsOverseasValue>0</HttpsOverseasValue>\\r\\n\\t\\t</DataModule>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2015-12-10T20:10:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>501718342</Value>\\r\\n\\t\\t\\t<DomesticValue>0</DomesticValue>\\r\\n\\t\\t\\t<OverseasValue>0</OverseasValue>\\r\\n\\t\\t\\t<HttpsValue>423304182</HttpsValue>\\r\\n\\t\\t\\t<HttpsDomesticValue>0</HttpsDomesticValue>\\r\\n\\t\\t\\t<HttpsOverseasValue>0</HttpsOverseasValue>\\r\\n\\t\\t</DataModule>\\r\\n\\t</TrafficDataPerInterval>\\r\\n\\t<RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>\\r\\n\\t<StartTime>2015-12-10T20:00:00Z</StartTime>\\r\\n\\t<EndTime>2015-12-10T21:00:00Z</EndTime>\\r\\n</DescribeDomainTrafficDataResponse>","errorExample":""}]', + 'title' => '查询流量', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|366天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainHttpCodeData' => [ + 'summary' => '调用DescribeDomainHttpCodeData查询加速域名5分钟粒度的HTTP返回码总数和占比数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111775', + 'abilityTreeNodes' => [ + 'FEATUREcdn86PAS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-06-29T05:30:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-06-29T05:45:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，通过DescribeCdnRegionAndIsp接口获得。如不填该参数，则代表默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名，通过DescribeCdnRegionAndIsp接口获得。如不填该参数，则代表默认查询所有区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2021-06-29T05:45:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2021-06-29T05:30:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '时间间隔。', + 'type' => 'string', + 'example' => '300', + ], + 'HttpCodeData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '每个时间间隔的HTTP返回码占比数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。'."\n", + 'type' => 'string', + 'example' => '2021-06-29T05:40:00Z', + ], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CodeProportionData' => [ + 'description' => '各返回码占比使用数据列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Proportion' => [ + 'description' => '占比使用数据。', + 'type' => 'string', + 'example' => '66.046511627907', + ], + 'Count' => [ + 'description' => '总数。', + 'type' => 'string', + 'example' => '300', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-06-29T05:45:00Z\\",\\n \\"StartTime\\": \\"2021-06-29T05:30:00Z\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"HttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2021-06-29T05:40:00Z\\",\\n \\"Value\\": {\\n \\"CodeProportionData\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Proportion\\": \\"66.046511627907\\",\\n \\"Count\\": \\"300\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainHttpCodeDataResponse>\\n<RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>\\n<EndTime>2021-06-29T05:45:00Z</EndTime>\\n<DomainName>example.com</DomainName>\\n<DataInterval>300</DataInterval>\\n<StartTime>2021-06-29T05:30:00Z</StartTime>\\n<HttpCodeData>\\n <UsageData>\\n <Value>\\n <CodeProportionData>\\n <Proportion>64.26332288401254</Proportion>\\n <Count>205</Count>\\n <Code>200</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>22.570532915360502</Proportion>\\n <Count>72</Count>\\n <Code>403</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>10.344827586206897</Proportion>\\n <Count>33</Count>\\n <Code>499</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>2.8213166144200628</Proportion>\\n <Count>9</Count>\\n <Code>504</Code>\\n </CodeProportionData>\\n </Value>\\n <TimeStamp>2021-06-29T05:30:00Z</TimeStamp>\\n </UsageData>\\n <UsageData>\\n <Value>\\n <CodeProportionData>\\n <Proportion>66.96969696969697</Proportion>\\n <Count>221</Count>\\n <Code>200</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>18.787878787878785</Proportion>\\n <Count>62</Count>\\n <Code>403</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>12.121212121212121</Proportion>\\n <Count>40</Count>\\n <Code>499</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>2.1212121212121215</Proportion>\\n <Count>7</Count>\\n <Code>504</Code>\\n </CodeProportionData>\\n </Value>\\n <TimeStamp>2021-06-29T05:35:00Z</TimeStamp>\\n </UsageData>\\n <UsageData>\\n <Value>\\n <CodeProportionData>\\n <Proportion>79.6976241900648</Proportion>\\n <Count>369</Count>\\n <Code>200</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>15.118790496760258</Proportion>\\n <Count>70</Count>\\n <Code>403</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>4.535637149028078</Proportion>\\n <Count>21</Count>\\n <Code>499</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>0.21598272138228944</Proportion>\\n <Count>1</Count>\\n <Code>502</Code>\\n </CodeProportionData>\\n <CodeProportionData>\\n <Proportion>0.4319654427645789</Proportion>\\n <Count>2</Count>\\n <Code>504</Code>\\n </CodeProportionData>\\n </Value>\\n <TimeStamp>2021-06-29T05:40:00Z</TimeStamp>\\n </UsageData>\\n</HttpCodeData>\\n</DescribeDomainHttpCodeDataResponse>","errorExample":""}]', + 'title' => '查询HTTP状态码', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|366天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainHttpCodeDataByLayer' => [ + 'summary' => '调用DescribeDomainHttpCodeDataByLayer按协议分类获取HTTP状态码数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111776', + 'abilityTreeNodes' => [ + 'FEATUREcdn86PAS0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的加速域名。支持批量域名查询，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'若参数为空，默认返回所有加速域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-07-05T22:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-07-06T22:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。'."\n" + ."\n" + .'不传值代表所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。'."\n" + ."\n" + .'不传值代表所有区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'Layer', + 'in' => 'query', + 'schema' => [ + 'description' => '查询维度，可选应用层（**http**、**https**、**quic**）或 **all**。'."\n" + ."\n" + .'默认为**all**。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + ], + 'HttpCodeDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的HTTPCode分布情况列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '每个HTTPCode对应的响应次数。', + 'type' => 'string', + 'example' => '{ "200": 10, "206": 100}', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T20:35:00Z', + ], + 'TotalValue' => [ + 'description' => '总响应次数。', + 'type' => 'string', + 'example' => '110', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataInterval\\": \\"300\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"HttpCodeDataInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"{ \\\\\\"200\\\\\\": 10, \\\\\\"206\\\\\\": 100}\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:35:00Z\\",\\n \\"TotalValue\\": \\"110\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainHttpCodeDataByLayerResponse>\\n<HttpCodeDataInterval>\\n <DataModule>\\n <TimeStamp>2015-12-10T21:00:00Z</TimeStamp>\\n <Value>\\n <200>10</200>\\n <206>100</206>\\n </Value>\\n <TotalValue>110</TotalValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2015-12-10T20:35:00Z</TimeStamp>\\n <Value>\\n <200>12</200>\\n <206>120</206>\\n </Value>\\n <TotalValue>132</TotalValue>\\n </DataModule>\\n</HttpCodeDataInterval>\\n<DataInterval>300</DataInterval>\\n<RequestId>BEA5625F-8FCF-48F4-851B-CA63946DA664</RequestId>\\n</DescribeDomainHttpCodeDataByLayerResponse>","errorExample":""}]', + 'title' => '查询HTTP状态码-按协议', + 'description' => '- 单用户调用频率：20次/秒。'."\n" + .'- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'### 支持查询的时间粒度'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|90天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainHitRateData' => [ + 'summary' => '调用DescribeDomainHitRateData查询字节命中率（命中字节百分比）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111774', + 'abilityTreeNodes' => [ + 'FEATUREcdn3CRD2L', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-30T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-30T08:10:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-12-30T08:10:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-12-30T08:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'HitRateInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的字节命中百分占比数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '命中率信息。', + 'type' => 'string', + 'example' => '100.0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-12-30T08:00:00Z', + ], + 'HttpsValue' => [ + 'description' => 'HTTPS字节命中率。', + 'type' => 'string', + 'example' => '50.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-12-30T08:10:00Z\\",\\n \\"StartTime\\": \\"2019-12-30T08:00:00Z\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"HitRateInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"100.0\\",\\n \\"TimeStamp\\": \\"2019-12-30T08:00:00Z\\",\\n \\"HttpsValue\\": \\"50.0\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainHitRateDataResponse>\\n<DomainName>example.com</DomainName>\\n<DataInterval>300</DataInterval>\\n<RequestId>0A521165-99B6-41EF-B166-5B8B8068E1CF</RequestId>\\n<EndTime>2019-12-30T08:10:00Z</EndTime>\\n<StartTime>2019-12-30T08:00:00Z</StartTime>\\n<HitRateInterval>\\n <DataModule>\\n <TimeStamp>2019-12-30T08:00:00Z</TimeStamp>\\n <Value>74.82824427480917</Value>\\n <HttpsValue>0</HttpsValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2019-12-30T08:05:00Z</TimeStamp>\\n <Value>62.83283497081019</Value>\\n <HttpsValue>100</HttpsValue>\\n </DataModule>\\n</HitRateInterval>\\n</DescribeDomainHitRateDataResponse>\\n","errorExample":""}]', + 'title' => '查询字节命中率', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|366天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainReqHitRateData' => [ + 'summary' => '调用DescribeDomainReqHitRateData查询请求命中率（命中请求百分比）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111801', + 'abilityTreeNodes' => [ + 'FEATUREcdn3CRD2L', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2017-12-22T08:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2017-12-21T08:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'ReqHitRateInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的请求命中百分占比数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '命中率信息。', + 'type' => 'string', + 'example' => '100.0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2017-12-22T08:00:00:00Z', + ], + 'HttpsValue' => [ + 'description' => 'HTTPS请求命中率。', + 'type' => 'string', + 'example' => '50.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2017-12-22T08:00:00Z\\",\\n \\"StartTime\\": \\"2017-12-21T08:00:00Z\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"ReqHitRateInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"100.0\\",\\n \\"TimeStamp\\": \\"2017-12-22T08:00:00:00Z\\",\\n \\"HttpsValue\\": \\"50.0\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainReqHitRateDataResponse>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<DataInterval>300</DataInterval>\\r\\n\\t<RequestId>5ADA5190-EE5B-4EF2-BE00-DC441B8D81DD</RequestId>\\r\\n\\t<StartTime>2017-12-21T08:00:00Z</StartTime>\\r\\n\\t<EndTime>2017-12-22T08:00:00Z</EndTime>\\r\\n\\t<ReqHitRateInterval>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2015-12-10T21:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>100.0</Value>\\r\\n\\t\\t\\t<HttpsValue>50.0</HttpsValue>\\r\\n\\t\\t</DataModule>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2015-12-10T20:35:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>100.0</Value>\\r\\n\\t\\t\\t<HttpsValue>50.0</HttpsValue>\\r\\n\\t\\t</DataModule>\\r\\n\\t</ReqHitRateInterval>\\r\\n</DescribeDomainReqHitRateDataResponse>","errorExample":""}]', + 'title' => '查询请求命中率', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|90天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainsUsageByDay' => [ + 'summary' => '调用DescribeDomainsUsageByDay查询加速域名天粒度的监控统计数据，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111810', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，只支持填写一个域名。'."\n" + ."\n" + .'默认查询当前用户下所有域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-23T09:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-12-23T09:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-12-22T08:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C88EF8ED-72F0-45EA-9E86-95114E224FC5', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '86400', + ], + 'UsageTotal' => [ + 'description' => '汇总数据。', + 'type' => 'object', + 'properties' => [ + 'MaxSrcBpsTime' => [ + 'description' => '回源带宽峰值时刻。', + 'type' => 'string', + 'example' => '2019-12-23 11:45:00', + ], + 'RequestHitRate' => [ + 'description' => '请求命中率（百分比数据）。', + 'type' => 'string', + 'example' => '69.92610837438424', + ], + 'MaxBps' => [ + 'description' => '带宽峰值，单位：bps。', + 'type' => 'string', + 'example' => '1.0747912780000001E8', + ], + 'TotalAccess' => [ + 'description' => '总访问量。', + 'type' => 'string', + 'example' => '1319500', + ], + 'BytesHitRate' => [ + 'description' => '字节命中率（百分比数据）。', + 'type' => 'string', + 'example' => '97.03110726801242', + ], + 'TotalTraffic' => [ + 'description' => '总流量，单位：Byte。', + 'type' => 'string', + 'example' => '1117711832100', + ], + 'MaxBpsTime' => [ + 'description' => '带宽峰值时刻。', + 'type' => 'string', + 'example' => '2019-12-23 10:55:00', + ], + 'MaxSrcBps' => [ + 'description' => '回源带宽峰值，单位：bps。', + 'type' => 'string', + 'example' => '72584.072', + ], + ], + ], + 'UsageByDays' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageByDay' => [ + 'description' => '每个时间间隔统计数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MaxSrcBpsTime' => [ + 'description' => '回源带宽峰值时刻。', + 'type' => 'string', + 'example' => '2019-12-23 11:45:00', + ], + 'Qps' => [ + 'description' => '每秒访问量（次/秒）。', + 'type' => 'string', + 'example' => '7.466354166666667', + ], + 'RequestHitRate' => [ + 'description' => '请求命中率（百分比数据）。', + 'type' => 'string', + 'example' => '70.24770071912111', + ], + 'MaxBps' => [ + 'description' => '带宽峰值，单位：bps。', + 'type' => 'string', + 'example' => '306747.76', + ], + 'TotalAccess' => [ + 'description' => '总访问量。', + 'type' => 'string', + 'example' => '645093', + ], + 'TimeStamp' => [ + 'description' => '查询数据的时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-12-22', + ], + 'BytesHitRate' => [ + 'description' => '字节命中率（百分比数据）。', + 'type' => 'string', + 'example' => '97.46250599529726', + ], + 'TotalTraffic' => [ + 'description' => '总流量，单位：Byte。', + 'type' => 'string', + 'example' => '564300099309', + ], + 'MaxSrcBps' => [ + 'description' => '回源带宽峰值，单位：bps。', + 'type' => 'string', + 'example' => '72584.072', + ], + 'MaxBpsTime' => [ + 'description' => '带宽峰值时刻。', + 'type' => 'string', + 'example' => '2019-12-23 10:55:00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-12-23T09:00:00Z\\",\\n \\"StartTime\\": \\"2019-12-22T08:00:00Z\\",\\n \\"RequestId\\": \\"C88EF8ED-72F0-45EA-9E86-95114E224FC5\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"86400\\",\\n \\"UsageTotal\\": {\\n \\"MaxSrcBpsTime\\": \\"2019-12-23 11:45:00\\",\\n \\"RequestHitRate\\": \\"69.92610837438424\\",\\n \\"MaxBps\\": \\"1.0747912780000001E8\\",\\n \\"TotalAccess\\": \\"1319500\\",\\n \\"BytesHitRate\\": \\"97.03110726801242\\",\\n \\"TotalTraffic\\": \\"1117711832100\\",\\n \\"MaxBpsTime\\": \\"2019-12-23 10:55:00\\",\\n \\"MaxSrcBps\\": \\"72584.072\\"\\n },\\n \\"UsageByDays\\": {\\n \\"UsageByDay\\": [\\n {\\n \\"MaxSrcBpsTime\\": \\"2019-12-23 11:45:00\\",\\n \\"Qps\\": \\"7.466354166666667\\",\\n \\"RequestHitRate\\": \\"70.24770071912111\\",\\n \\"MaxBps\\": \\"306747.76\\",\\n \\"TotalAccess\\": \\"645093\\",\\n \\"TimeStamp\\": \\"2019-12-22\\",\\n \\"BytesHitRate\\": \\"97.46250599529726\\",\\n \\"TotalTraffic\\": \\"564300099309\\",\\n \\"MaxSrcBps\\": \\"72584.072\\",\\n \\"MaxBpsTime\\": \\"2019-12-23 10:55:00\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainsUsageByDayResponse>\\n<UsageTotal>\\n <RequestHitRate>0.46869615163699024</RequestHitRate>\\n <MaxSrcBpsTime>2019-12-23 11:45:00</MaxSrcBpsTime>\\n <MaxSrcBps>72584.072</MaxSrcBps>\\n <MaxBps>306747.76</MaxBps>\\n <TotalTraffic>220090843</TotalTraffic>\\n <TotalAccess>1741</TotalAccess>\\n <MaxBpsTime>2019-12-23 10:55:00</MaxBpsTime>\\n <BytesHitRate>0.9338625414779297</BytesHitRate>\\n</UsageTotal>\\n<UsageByDays>\\n <UsageByDay>\\n <TimeStamp>2019-12-23</TimeStamp>\\n <RequestHitRate>0.46869615163699024</RequestHitRate>\\n <MaxSrcBpsTime>2019-12-23 11:45:00</MaxSrcBpsTime>\\n <MaxSrcBps>72584.072</MaxSrcBps>\\n <MaxBps>306747.76</MaxBps>\\n <TotalTraffic>220090843</TotalTraffic>\\n <TotalAccess>1741</TotalAccess>\\n <MaxBpsTime>2019-12-23 10:55:00</MaxBpsTime>\\n <Qps>0.020150462962962964</Qps>\\n <BytesHitRate>0.9338625398107486</BytesHitRate>\\n </UsageByDay>\\n</UsageByDays>\\n<RequestId>0DE5531F-A7C2-4788-A35A-38883193B2D8</RequestId>\\n<EndTime>2019-12-23T09:00:00Z</EndTime>\\n<StartTime>2019-12-22T08:00:00Z</StartTime>\\n<DomainName>example.com</DomainName>\\n<DataInterval>86400</DataInterval>\\n</DescribeDomainsUsageByDayResponse>\\n","errorExample":""}]', + 'title' => '查询用量-按天', + 'description' => '- 单用户调用频率：10次/秒。'."\n" + .'- 如果您不指定StartTime和EndTime时，默认读取过去24小时的数据；指定StartTime和EndTime时，按指定的起止时间查询。'."\n" + .'- 您只能查询单个域名或当前用户下所有域名的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|1天|90天|366天|一般延迟4小时，不超过24小时。|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainDetailDataByLayer' => [ + 'summary' => '调用DescribeDomainDetailDataByLayer按协议类型获取加速域名的数据明细（域名维度）。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111771', + 'abilityTreeNodes' => [ + 'FEATUREcdnTN0ZSC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的指标。支持多指标查询，多个指标用英文逗号（,）分隔，包含**bps**、**qps**、**traf**、**acc**、**ipv6_traf**、**ipv6_bps**、**ipv6_acc**、**ipv6_qps**、**http_code**。', + 'type' => 'string', + 'required' => true, + 'example' => 'bps,ipv6_traf,traf,http_code,qps', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的域名。支持批量域名查询，多个域名用半角逗号（,）分隔，一次最多支持30个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2020-07-05T22:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间，且间隔不超过1小时。', + 'type' => 'string', + 'required' => true, + 'example' => '2020-07-05T22:05:00Z', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。'."\n" + ."\n" + .'不传值代表所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。'."\n" + ."\n" + .'不传值代表所有区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'Layer', + 'in' => 'query', + 'schema' => [ + 'description' => '查询维度，应用层（**http**、**https**、**quic**）或**all**。'."\n" + ."\n" + .'默认为**all**。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '查询的加速域名返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Traf' => [ + 'description' => '流量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '789756701818', + ], + 'Qps' => [ + 'description' => 'QPS（每秒请求次数）数据。', + 'type' => 'number', + 'format' => 'float', + 'example' => '5998.47', + ], + 'Ipv6Qps' => [ + 'description' => 'IPv6的QPS。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Ipv6Bps' => [ + 'description' => 'IPv6带宽，单位：bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Acc' => [ + 'description' => '请求数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Ipv6Traf' => [ + 'description' => 'IPv6流量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '141718944482', + ], + 'Ipv6Acc' => [ + 'description' => 'IPv6请求数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2020-07-05T22:00:00Z', + ], + 'HttpCode' => [ + 'description' => 'http状态码分布。', + 'type' => 'string', + 'example' => '200:44349|206:1753719|304:45|403:1095|416:1|499:332', + ], + 'Bps' => [ + 'description' => '带宽，单位：bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '21060178715.146667', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Data\\": {\\n \\"DataModule\\": [\\n {\\n \\"Traf\\": 789756701818,\\n \\"Qps\\": 5998.47,\\n \\"Ipv6Qps\\": 0,\\n \\"Ipv6Bps\\": 0,\\n \\"Acc\\": 2,\\n \\"Ipv6Traf\\": 141718944482,\\n \\"Ipv6Acc\\": 1,\\n \\"TimeStamp\\": \\"2020-07-05T22:00:00Z\\",\\n \\"HttpCode\\": \\"200:44349|206:1753719|304:45|403:1095|416:1|499:332\\",\\n \\"Bps\\": 21060178715.146667,\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainDetailDataByLayerResponse>\\n<Data>\\n <Acc>2</Acc>\\n <Ipv6Bps>0</Ipv6Bps>\\n <HttpCode>200:2</HttpCode>\\n <Ipv6Qps>0</Ipv6Qps>\\n <Bps>268.8986666666667</Bps>\\n <Traf>10083</Traf>\\n <Ipv6Acc>0</Ipv6Acc>\\n <DomainName>example.com</DomainName>\\n <Qps>0.006666666666666667</Qps>\\n <Ipv6Traf>0</Ipv6Traf>\\n <TimeStamp>2020-09-07T03:35:00Z</TimeStamp>\\n</Data>\\n<RequestId>BEA5625F-8FCF-48F4-851B-CA63946DA664</RequestId>\\n</DescribeDomainDetailDataByLayerResponse>","errorExample":""}]', + 'title' => '按协议类型获取详细数据', + 'description' => '单用户调用频率：20次/秒。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|1小时|93天|15分钟|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRangeDataByLocateAndIspService' => [ + 'summary' => '调用DescribeRangeDataByLocateAndIspService获取按运营商和地域获取带宽数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111826', + 'abilityTreeNodes' => [ + 'FEATUREcdnF7OM8K', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据开始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间大于开始时间，并且结束时间和开始时间相差不超过1小时。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'IspNames', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商名，每次只能传入一个参数。'."\n" + ."\n" + .'运营商名通过[DescribeCdnRegionAndIsp](~~91077~~)接口查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNames', + 'in' => 'query', + 'schema' => [ + 'description' => '地域名，多个地域名用英文逗号（,）分隔。'."\n" + ."\n" + .'地域名通过[DescribeCdnRegionAndIsp](~~91077~~)接口查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'liaoning,guangxi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JsonResult' => [ + 'description' => 'JSON格式的返回结果。'."\n" + .'从左到右依次为：unix时间，地区，运营商，HTTP状态码分布，响应时长，带宽（单位：bps），响应平均速率，页面浏览量，缓存命中率，请求命中率。'."\n" + .'><notice>地区、运营商维度不支持计算命中率，统一返回 0。></notice>', + 'type' => 'string', + 'example' => '{"1472659200":{"天津市":{"电信":{"http_codes":{"000":0,"200":6,"400":0},"rt":4183,"bandwidth":46639,"avg_speed":7773,"pv":6,"hit_rate":0.93,"request_hit_rate":0}}}}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JsonResult\\": \\"{\\\\\\"1472659200\\\\\\":{\\\\\\"天津市\\\\\\":{\\\\\\"电信\\\\\\":{\\\\\\"http_codes\\\\\\":{\\\\\\"000\\\\\\":0,\\\\\\"200\\\\\\":6,\\\\\\"400\\\\\\":0},\\\\\\"rt\\\\\\":4183,\\\\\\"bandwidth\\\\\\":46639,\\\\\\"avg_speed\\\\\\":7773,\\\\\\"pv\\\\\\":6,\\\\\\"hit_rate\\\\\\":0.93,\\\\\\"request_hit_rate\\\\\\":0}}}}\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeRangeDataByLocateAndIspServiceResponse>\\n<JsonResult>\\n <1472659200>\\n <天津市>\\n <电信>\\n <bandwidth>9889849.592</bandwidth>\\n <pv>5739</pv>\\n <hit_rate>0</hit_rate>\\n <http_codes>\\n <200>5675</200>\\n <206>5</206>\\n <302>5</302>\\n <304>45</304>\\n <400>1</400>\\n <403>8</403>\\n <404>0</404>\\n <405>0</405>\\n <408>0</408>\\n <412>0</412>\\n <416>0</416>\\n <500>0</500>\\n <501>0</501>\\n <502>0</502>\\n <503>0</503>\\n <504>0</504>\\n <000>0</000>\\n </http_codes>\\n <rt>0</rt>\\n </电信>\\n <联通/>\\n <移动/>\\n </天津市>\\n <北京市>\\n <电信>\\n <bandwidth>9889849.592</bandwidth>\\n <pv>5739</pv>\\n <hit_rate>0</hit_rate>\\n <http_codes>\\n <200>5675</200>\\n <206>5</206>\\n <302>5</302>\\n <304>45</304>\\n <400>1</400>\\n <403>8</403>\\n <404>0</404>\\n <405>0</405>\\n <408>0</408>\\n <412>0</412>\\n <416>0</416>\\n <500>0</500>\\n <501>0</501>\\n <502>0</502>\\n <503>0</503>\\n <504>0</504>\\n <000>0</000>\\n </http_codes>\\n <rt>0</rt>\\n </电信>\\n <联通/>\\n <移动/>\\n </北京市>\\n </1472659200>\\n <1472659500>\\n <天津市>\\n <电信>\\n <bandwidth>7024681.44</bandwidth>\\n <pv>5819</pv>\\n <hit_rate>0</hit_rate>\\n <http_codes>\\n <200>5716</200>\\n <206>11</206>\\n <302>3</302>\\n <304>72</304>\\n <400>1</400>\\n <403>16</403>\\n <404>0</404>\\n <405>0</405>\\n <408>0</408>\\n <412>0</412>\\n <416>0</416>\\n <500>0</500>\\n <501>0</501>\\n <502>0</502>\\n <503>0</503>\\n <504>0</504>\\n <000>0</000>\\n </http_codes>\\n <rt>0</rt>\\n </电信>\\n <联通/>\\n <移动/>\\n </天津市>\\n </1472659500>\\n</JsonResult>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DescribeRangeDataByLocateAndIspServiceResponse>","errorExample":""}]', + 'title' => '查询访问数据-按运营商和地域', + 'description' => '- 查询的数据时间粒度为5分钟。'."\n" + .'- 单用户调用频率：20次/秒。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|1小时|93天|15分钟|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainSrcBpsData' => [ + 'summary' => '调用DescribeDomainSrcBpsData查询加速域名的回源带宽监控数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111804', + 'abilityTreeNodes' => [ + 'FEATUREcdnE9OF3Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:30:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:30:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'SrcBpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的回源带宽数据列表。单位：bit/s。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '详细使用数据。', + 'type' => 'string', + 'example' => '500', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-12-10T20:00:00Z', + ], + 'HttpsValue' => [ + 'description' => 'Https回源带宽。', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'StartTime and EndTime can not be single.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainName.Overlimit', + 'errorMessage' => 'Too many DomainNames are specified.', + ], + [ + 'errorCode' => 'InvalidInterval.Malformed', + 'errorMessage' => 'Specified Interval is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-12-10T20:30:00Z\\",\\n \\"StartTime\\": \\"2019-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"SrcBpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"500\\",\\n \\"TimeStamp\\": \\"2019-12-10T20:00:00Z\\",\\n \\"HttpsValue\\": \\"10\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainSrcBpsDataResponse>\\n<SrcBpsDataPerInterval>\\n <DataModule>\\n <TimeStamp>2019-12-10T20:00:00Z</TimeStamp>\\n <Value>31.709333333333337</Value>\\n <HttpsValue>0</HttpsValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2019-12-10T20:05:00Z</TimeStamp>\\n <Value>31.709333333333337</Value>\\n <HttpsValue>0</HttpsValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2019-12-10T20:10:00Z</TimeStamp>\\n <Value>31.709333333333337</Value>\\n <HttpsValue>0</HttpsValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2019-12-10T20:15:00Z</TimeStamp>\\n <Value>31.709333333333337</Value>\\n <HttpsValue>0</HttpsValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2019-12-10T20:20:00Z</TimeStamp>\\n <Value>31.709333333333337</Value>\\n <HttpsValue>0</HttpsValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2019-12-10T20:25:00Z</TimeStamp>\\n <Value>43.32533333333333</Value>\\n <HttpsValue>0</HttpsValue>\\n </DataModule>\\n</SrcBpsDataPerInterval>\\n<DataInterval>300</DataInterval>\\n<RequestId>28B4EBA6-0AF4-407A-AAC9-6BC5F8D8158B</RequestId>\\n<EndTime>2019-12-10T20:30:00Z</EndTime>\\n<StartTime>2019-12-10T20:00:00Z</StartTime>\\n</DescribeDomainSrcBpsDataResponse>\\n","errorExample":""}]', + 'title' => '查询回源带宽', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|366天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainSrcHttpCodeData' => [ + 'summary' => '调用DescribeDomainSrcHttpCodeData查询加速域名回源HTTP返回码的总数和占比数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111806', + 'abilityTreeNodes' => [ + 'FEATUREcdnUQAZK1', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com,example.org', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。'."\n", + 'type' => 'string', + 'example' => '2015-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。'."\n", + 'type' => 'string', + 'example' => '2015-11-30T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + 'DomainName' => [ + 'description' => '加速域名信息。'."\n", + 'type' => 'string', + 'example' => 'example.com,example.org', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。'."\n", + 'type' => 'string', + 'example' => '300', + ], + 'HttpCodeData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '每个时间间隔的HTTP返回码占比数据。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。'."\n", + 'type' => 'string', + 'example' => '2015-11-30T05:30:00Z', + ], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CodeProportionData' => [ + 'description' => '各返回码占比使用数据列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Proportion' => [ + 'description' => '占比使用数据。', + 'type' => 'string', + 'example' => '67.1458998935037', + ], + 'Count' => [ + 'description' => '总数。'."\n", + 'type' => 'string', + 'example' => '2300', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2015-11-30T05:33:00Z\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"example.com,example.org\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"HttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:30:00Z\\",\\n \\"Value\\": {\\n \\"CodeProportionData\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Proportion\\": \\"67.1458998935037\\",\\n \\"Count\\": \\"2300\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainSrcHttpCodeDataResponse>\\t\\n<HttpCodeData>\\n <UsageData>\\n <TimeStamp>2019-11-30T05:35:00Z</TimeStamp>\\n <Value>\\n <CodeProportionData>\\n <Count>1</Count>\\n <Proportion>100</Proportion>\\n <Code>200</Code>\\n </CodeProportionData>\\n </Value>\\n </UsageData>\\n</HttpCodeData>\\n<DataInterval>300</DataInterval>\\n<RequestId>A2E05931-13B7-40C3-843F-ECD9423959C1</RequestId>\\n<EndTime>2019-11-30T05:40:00Z</EndTime>\\n<StartTime>2019-11-30T05:33:00Z</StartTime>\\n</DescribeDomainSrcHttpCodeDataResponse>\\t\\n","errorExample":""}]', + 'title' => '查询回源HTTP状态码', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|366天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainSrcTrafficData' => [ + 'summary' => '调用DescribeDomainSrcTrafficData查询加速域名的回源流量监控数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111809', + 'abilityTreeNodes' => [ + 'FEATUREcdnE9OF3Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2015-12-10T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A666D44F-19D6-490E-97CF-1A64AB962C57', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'SrcTrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的回源流量数据列表。单位：Byte。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '详细使用数据。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T20:35:00Z', + ], + 'HttpsValue' => [ + 'description' => 'Https回源流量。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'StartTime and EndTime can not be single.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainName.Overlimit', + 'errorMessage' => 'Too many DomainNames are specified.', + ], + [ + 'errorCode' => 'InvalidInterval.Malformed', + 'errorMessage' => 'Specified Interval is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"SrcTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:35:00Z\\",\\n \\"HttpsValue\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"SrcFlowDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2015-12-10T21:00:00Z\\",\\n \\"Value\\": \\"0\\",\\n \\"HttpsValue\\": \\"0\\"\\n },\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:35:00Z\\",\\n \\"Value\\": \\"0\\",\\n \\"HttpsValue\\": \\"0\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\"\\n}"},{"type":"xml","example":"<DescribeDomainSrcTrafficDataResponse>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<DataInterval>300</DataInterval>\\r\\n\\t<SrcFlowDataPerInterval>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2015-12-10T21:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>0</Value>\\r\\n\\t\\t\\t<HttpsValue>0</HttpsValue>\\r\\n\\t\\t</DataModule>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2015-12-10T20:35:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>0</Value>\\r\\n\\t\\t\\t<HttpsValue>0</HttpsValue>\\r\\n\\t\\t</DataModule>\\r\\n\\t</SrcFlowDataPerInterval>\\r\\n\\t<RequestId>A666D44F-19D6-490E-97CF-1A64AB962C57</RequestId>\\r\\n\\t<StartTime>2015-12-10T20:00:00Z</StartTime>\\r\\n\\t<EndTime>2015-12-10T21:00:00Z</EndTime>\\r\\n</DescribeDomainSrcTrafficDataResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询回源流量', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围|数据延迟|'."\n" + .'|---------------|--------|---|---|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|一般延迟3-4小时|'."\n" + .'|1天|366天|366天|一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainSrcQpsData' => [ + 'summary' => '调用DescribeDomainSrcQpsData查询回源QPS数据，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111807', + 'abilityTreeNodes' => [ + 'FEATUREcdnE9OF3Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的加速域名，多个域名用半角逗号（,）分隔。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-DDThh:mm:ssZ。'."\n" + ."\n" + .'默认读取过去24小时数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-DDThh:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见**使用说明**中支持查询的时间粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7CBCD6AD-B016-42E5-AE0B-B3731DE8F755', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，以秒为单位。', + 'type' => 'string', + 'example' => '300', + ], + 'SrcQpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的回源带宽数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '详细使用数据。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T21:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'StartTime and EndTime can not be single.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainName.Overlimit', + 'errorMessage' => 'Too many DomainNames are specified.', + ], + [ + 'errorCode' => 'InvalidInterval.Malformed', + 'errorMessage' => 'Specified Interval is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2019-11-30T05:33:00Z\\",\\n \\"RequestId\\": \\"7CBCD6AD-B016-42E5-AE0B-B3731DE8F755\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"SrcQpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2015-12-10T21:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainSrcQpsDataResponse>\\n<DomainName>example.com</DomainName>\\n<DataInterval>300</DataInterval>\\n<SrcQpsDataPerInterval>\\n <DataModule>\\n <TimeStamp>2019-11-30T05:33:00Z</TimeStamp>\\n <Value>0</Value>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2019-11-30T05:34:00Z</TimeStamp>\\n <Value>0</Value>\\n </DataModule>\\n</SrcQpsDataPerInterval>\\n<RequestId>7CBCD6AD-B016-42E5-AE0B-B3731DE8F755</RequestId>\\n<StartTime>2019-11-30T05:33:00Z</StartTime>\\n<EndTime>2019-11-30T05:40:00Z</EndTime>\\n</DescribeDomainSrcQpsDataResponse>\\n","errorExample":""}]', + 'title' => '查询回源QPS', + 'description' => '- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'### 支持查询的时间粒度'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'| 时间粒度 | 单次查询的最大时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| -------------- | -------------- | ------ |-----|'."\n" + .'| 5分钟 | 3天 | 93天 | 15分钟 |'."\n" + .'| 1小时 | 31天 | 186天 | 一般延迟3-4小时 |'."\n" + .'| 1天 | 366天 | 366天 | 一般延迟4小时，不超过24小时 |', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeTrafficData' => [ + 'summary' => '调用DescribeDomainRealTimeTrafficData查询加速域名的流量监控数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111799', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。'."\n" + ."\n" + .'您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取。不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。'."\n" + ."\n" + .'您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取。不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:01:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '参数解释。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:01:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A666D44F-19D6-490E-97CF-1A64AB962C57', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数固定返回60（1分钟）、300（5分钟）或3600（1小时），具体请参见使用说明中返回数据时间粒度。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeTrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的流量数据，单位：Byte。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的流量数据。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '详细使用数据。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-12-10T20:01:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'StartTime and EndTime can not be single.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainName.Overlimit', + 'errorMessage' => 'Too many DomainNames are specified.', + ], + [ + 'errorCode' => 'InvalidInterval.Malformed', + 'errorMessage' => 'Specified Interval is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-12-10T20:01:00Z\\",\\n \\"StartTime\\": \\"2019-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2019-12-10T20:01:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"Value\\": \\"0\\"\\n },\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:01:00Z\\",\\n \\"Value\\": \\"0\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-10T20:01:00Z\\"\\n} "},{"type":"xml","example":"<DescribeDomainRealTimeTrafficDataResponse>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<DataInterval>60</DataInterval>\\r\\n\\t<RealTimeTrafficDataPerInterval>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2019-12-10T20:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>0</Value>\\r\\n\\t\\t</DataModule>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2019-12-10T20:01:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>0</Value>\\r\\n\\t\\t</DataModule>\\r\\n\\t</RealTimeTrafficDataPerInterval>\\r\\n\\t<RequestId>A666D44F-19D6-490E-97CF-1A64AB962C57</RequestId>\\r\\n\\t<StartTime>2019-12-10T20:00:00Z</StartTime>\\r\\n\\t<EndTime>2019-12-10T20:01:00Z</EndTime>\\r\\n</DescribeDomainRealTimeTrafficDataResponse>","errorExample":""}]', + 'title' => '查询实时流量', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeBpsData' => [ + 'summary' => '调用DescribeDomainRealTimeBpsData查询加速域名的带宽数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111788', + 'abilityTreeNodes' => [ + 'FEATUREcdn5DW324', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔。'."\n" + ."\n" + .'> 一次最多可以传500个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。'."\n" + ."\n" + .'您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取。不传该参数默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。'."\n" + ."\n" + .'您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取。不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B49E6DDA-F413-422B-B58E-2FA23F286726', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BpsModel' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Bps' => [ + 'description' => '带宽数据，单位：bit/s。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16710625.733333332', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:41:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B49E6DDA-F413-422B-B58E-2FA23F286726\\",\\n \\"Data\\": {\\n \\"BpsModel\\": [\\n {\\n \\"Bps\\": 16710625.733333332,\\n \\"TimeStamp\\": \\"2019-11-30T05:41:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainRealTimeBpsDataResponse>\\n<Data>\\n <BpsModel>\\n <TimeStamp>2019-11-30T05:41:00Z</TimeStamp>\\n <Bps>16710625.733333332</Bps>\\n </BpsModel>\\n <BpsModel>\\n <TimeStamp>2019-11-30T05:42:00Z</TimeStamp>\\n <Bps>59392614.8</Bps>\\n </BpsModel>\\n</Data>\\n<RequestId>B49E6DDA-F413-422B-B58E-2FA23F286726</RequestId>\\n</DescribeDomainRealTimeBpsDataResponse>","errorExample":""}]', + 'title' => '查询实时带宽', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeHttpCodeData' => [ + 'summary' => '调用DescribeDomainRealTimeHttpCodeData查询加速域名HTTP返回码的总数和占比数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111791', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔。'."\n" + ."\n" + .'> 一次最多可以传100个域名。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com,example.org', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:39:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。通过[DescribeCdnRegionAndIsp](~~91077~~)获得，默认查询所有运营商。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。通过[DescribeCdnRegionAndIsp](~~91077~~)获得，默认查询所有地域。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-11-29T05:42:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-11-29T05:39:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com,example.org', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数固定返回60（1分钟）、300（5分钟）或3600（1小时），具体请参见使用说明中返回数据时间粒度。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeHttpCodeData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '每个时间间隔的HTTP返回码占比数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-11-29T05:39:00Z', + ], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RealTimeCodeProportionData' => [ + 'description' => '各返回码占比使用数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP返回码。', + 'type' => 'string', + 'example' => '500', + ], + 'Proportion' => [ + 'description' => '占比使用数据。', + 'type' => 'string', + 'example' => '28.4496124031008', + ], + 'Count' => [ + 'description' => '总数。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-11-29T05:42:00Z\\",\\n \\"StartTime\\": \\"2019-11-29T05:39:00Z\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"example.com,example.org\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeHttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2019-11-29T05:39:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeCodeProportionData\\": [\\n {\\n \\"Code\\": \\"500\\",\\n \\"Proportion\\": \\"28.4496124031008\\",\\n \\"Count\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RealTimeHttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:40:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeCodeProportionData\\": [\\n {\\n \\"Proportion\\": \\"66.046511627907\\",\\n \\"Code\\": \\"200\\"\\n },\\n {\\n \\"Proportion\\": \\"4.72868217054264\\",\\n \\"Code\\": \\"206\\"\\n },\\n {\\n \\"Proportion\\": \\"0.155038759689922\\",\\n \\"Code\\": \\"302\\"\\n },\\n {\\n \\"Proportion\\": \\"0.62015503875969\\",\\n \\"Code\\": \\"304\\"\\n },\\n {\\n \\"Proportion\\": \\"28.4496124031008\\",\\n \\"Code\\": \\"500\\"\\n }\\n ]\\n }\\n },\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:39:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeCodeProportionData\\": [\\n {\\n \\"Proportion\\": \\"66.046511627907\\",\\n \\"Code\\": \\"200\\"\\n },\\n {\\n \\"Proportion\\": \\"4.72868217054264\\",\\n \\"Code\\": \\"206\\"\\n },\\n {\\n \\"Proportion\\": \\"0.155038759689922\\",\\n \\"Code\\": \\"302\\"\\n },\\n {\\n \\"Proportion\\": \\"0.62015503875969\\",\\n \\"Code\\": \\"304\\"\\n },\\n {\\n \\"Proportion\\": \\"28.4496124031008\\",\\n \\"Code\\": \\"500\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DataInterval\\": \\"60\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"example1.com,example2.com\\",\\n \\"EndTime\\": \\"2015-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2015-11-30T05:33:00Z\\"\\n}\\n\\t\\t\\t"},{"type":"xml","example":"<DescribeDomainRealTimeHttpCodeDataResponse>\\n<DataInterval>60</DataInterval>\\n<RequestId>99E690FC-86A3-4533-8F61-CF9E319141A4</RequestId>\\n<DomainName>example.com,example.org</DomainName>\\n<EndTime>2019-11-29T05:42:00Z</EndTime>\\n<StartTime>2019-11-29T05:39:00Z</StartTime>\\n<RealTimeHttpCodeData>\\n <UsageData>\\n <TimeStamp>2019-11-29T05:39:00Z</TimeStamp>\\n <Value>\\n <RealTimeCodeProportionData>\\n <Count>2</Count>\\n <Proportion>100</Proportion>\\n <Code>200</Code>\\n </RealTimeCodeProportionData>\\n </Value>\\n </UsageData>\\n <UsageData>\\n <TimeStamp>2019-11-29T05:40:00Z</TimeStamp>\\n <Value>\\n <RealTimeCodeProportionData>\\n <Count>1</Count>\\n <Proportion>50</Proportion>\\n <Code>200</Code>\\n </RealTimeCodeProportionData>\\n <RealTimeCodeProportionData>\\n <Count>1</Count>\\n <Proportion>50</Proportion>\\n <Code>304</Code>\\n </RealTimeCodeProportionData>\\n </Value>\\n </UsageData>\\n <UsageData>\\n <TimeStamp>2019-11-29T05:41:00Z</TimeStamp>\\n <Value>\\n <RealTimeCodeProportionData>\\n <Count>11</Count>\\n <Proportion>91.66666666666666</Proportion>\\n <Code>200</Code>\\n </RealTimeCodeProportionData>\\n <RealTimeCodeProportionData>\\n <Count>1</Count>\\n <Proportion>8.333333333333332</Proportion>\\n <Code>206</Code>\\n </RealTimeCodeProportionData>\\n </Value>\\n </UsageData>\\n</RealTimeHttpCodeData>\\n</DescribeDomainRealTimeHttpCodeDataResponse>","errorExample":""}]', + 'title' => '查询实时状态码', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeQpsData' => [ + 'summary' => '调用DescribeDomainRealTimeQpsData查询加速域名每秒访问次数数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111793', + 'abilityTreeNodes' => [ + 'FEATUREcdnL8FLP3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔。'."\n" + ."\n" + .'> 一次最多可以传500个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。'."\n" + ."\n" + .'您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取，不传该参数默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。'."\n" + ."\n" + .'您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取，不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-02T11:25:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-02T11:26:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '32DC9806-E9F9-4490-BBDC-B3A9E32FCC1D', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'QpsModel' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Qps' => [ + 'description' => 'QPS（每秒访问次数）数据。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1851.25', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2019-12-02T11:25:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"32DC9806-E9F9-4490-BBDC-B3A9E32FCC1D\\",\\n \\"Data\\": {\\n \\"QpsModel\\": [\\n {\\n \\"Qps\\": 1851.25,\\n \\"TimeStamp\\": \\"2019-12-02T11:25:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainRealTimeQpsDataResponse>\\r\\n\\t<Data>\\r\\n\\t\\t<QpsModel>\\r\\n\\t\\t\\t<TimeStamp>2019-12-02T11:26:00Z</TimeStamp>\\r\\n\\t\\t\\t<Qps>1851.25</Qps>\\r\\n\\t\\t</QpsModel>\\r\\n\\t\\t<QpsModel>\\r\\n\\t\\t\\t<TimeStamp>2019-12-02T11:25:00Z</TimeStamp>\\r\\n\\t\\t\\t<Qps>8967.7</Qps>\\r\\n\\t\\t</QpsModel>\\r\\n\\t</Data>\\r\\n\\t<RequestId>32DC9806-E9F9-4490-BBDC-B3A9E32FCC1D</RequestId>\\r\\n</DescribeDomainRealTimeQpsDataResponse>","errorExample":""}]', + 'title' => '查询实时QPS', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeReqHitRateData' => [ + 'summary' => '调用DescribeDomainRealTimeReqHitRateData查询加速域名请求命中率数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111794', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-01-02T11:23:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-01-02T11:26:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70A26B11-3673-479C-AEA8-E03FC5D3496D', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReqHitRateDataModel' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReqHitRate' => [ + 'description' => '请求命中率数据。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8956940476262277', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳，日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2018-01-02T11:26:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70A26B11-3673-479C-AEA8-E03FC5D3496D\\",\\n \\"Data\\": {\\n \\"ReqHitRateDataModel\\": [\\n {\\n \\"ReqHitRate\\": 0.8956940476262277,\\n \\"TimeStamp\\": \\"2018-01-02T11:26:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainRealTimeReqHitRateDataResponse>\\r\\n\\t<Data>\\r\\n\\t\\t<ReqHitRateDataModel>\\r\\n\\t\\t\\t<TimeStamp>2018-01-02T11:26:00Z</TimeStamp>\\r\\n\\t\\t\\t<ReqHitRate>0.8956940476262277</ReqHitRate>\\r\\n\\t\\t</ReqHitRateDataModel>\\r\\n\\t\\t<ReqHitRateDataModel>\\r\\n\\t\\t\\t<TimeStamp>2018-01-02T11:25:00Z</TimeStamp>\\r\\n\\t\\t\\t<ReqHitRate>0.8429129920796812</ReqHitRate>\\r\\n\\t\\t</ReqHitRateDataModel>\\r\\n\\t</Data>\\r\\n\\t<RequestId>70A26B11-3673-479C-AEA8-E03FC5D3496D</RequestId>\\r\\n</DescribeDomainRealTimeReqHitRateDataResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询实时请求命中率', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + .'- Go语言默认是用POST方式请求，需手动修改使用GET方式请求，声明request.Method="GET"。'."\n" + .'- 由于存在多域名合并存储的情况，可能会导致命中率数据不准确，具体情况请您以实际配置为准。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeByteHitRateData' => [ + 'summary' => '调用DescribeDomainRealTimeByteHitRateData查询域名字节命中率数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111789', + 'abilityTreeNodes' => [ + 'FEATUREcdn3CRD2L', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-05-15T09:13:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-05-15T09:15:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70A26B11-3673-479C-AEA8-E03FC5D3496D', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ByteHitRateDataModel' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ByteHitRate' => [ + 'description' => '字节命中率（百分比数据）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8956940476262277', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70A26B11-3673-479C-AEA8-E03FC5D3496D\\",\\n \\"Data\\": {\\n \\"ByteHitRateDataModel\\": [\\n {\\n \\"ByteHitRate\\": 0.8956940476262277,\\n \\"TimeStamp\\": \\"2019-11-30T05:40:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainRealTimeByteHitRateDataResponse>\\n<RequestId>95C90452-100B-4226-A63D-2D570CE2A971</RequestId>\\n<Data>\\n <ByteHitRateDataModel>\\n <ByteHitRate>0.8956940476262277</ByteHitRate>\\n <TimeStamp>2020-05-15T09:13:00Z</TimeStamp>\\n </ByteHitRateDataModel>\\n <ByteHitRateDataModel>\\n <ByteHitRate>0.8429129920796812</ByteHitRate>\\n <TimeStamp>2020-05-15T09:14:00Z</TimeStamp>\\n </ByteHitRateDataModel>\\n</Data>\\n</DescribeDomainRealTimeByteHitRateDataResponse>\\n","errorExample":""}]', + 'title' => '查询实时字节命中率', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + .'- 由于存在多个域名合并存储的情况，可能会导致查询的命中率数据不准确，具体情况请您以实际配置为准。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeSrcBpsData' => [ + 'summary' => '调用DescribeDomainRealTimeSrcBpsData查询域名回源带宽数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111795', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:01:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:01:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7CBCD6AD-B016-42E5-AE0B-B3731DE8F755', + ], + 'DomainName' => [ + 'description' => '加速域名。'."\n", + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数固定返回60（1分钟）、300（5分钟）或3600（1小时），具体请参见**使用说明**中返回数据时间粒度。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeSrcBpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的回源带宽数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '详细使用数据，单位：bit/s。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-12-10T20:01:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-12-10T20:01:00Z\\",\\n \\"StartTime\\": \\"2019-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"7CBCD6AD-B016-42E5-AE0B-B3731DE8F755\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeSrcBpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2019-12-10T20:01:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeSrcBpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"Value\\": \\"821\\"\\n },\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:01:00Z\\",\\n \\"Value\\": \\"0\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7CBCD6AD-B016-42E5-AE0B-B3731DE8F755\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-10T20:01:00Z\\"\\n}\\n\\t\\t\\t"},{"type":"xml","example":"<DescribeDomainRealTimeSrcBpsDataResponse>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<DataInterval>60</DataInterval>\\r\\n\\t<RealTimeSrcBpsDataPerInterval>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2019-12-10T20:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>821</Value>\\r\\n\\t\\t</DataModule>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2019-12-10T20:01:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>0</Value>\\r\\n\\t\\t</DataModule>\\r\\n\\t</RealTimeSrcBpsDataPerInterval>\\r\\n\\t<RequestId>7CBCD6AD-B016-42E5-AE0B-B3731DE8F755</RequestId>\\r\\n\\t<StartTime>2019-12-10T20:00:00Z</StartTime>\\r\\n\\t<EndTime>2019-12-10T20:01:00Z</EndTime>\\r\\n</DescribeDomainRealTimeSrcBpsDataResponse>\\t\\r\\n","errorExample":""}]', + 'title' => '查询实时回源带宽', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeSrcHttpCodeData' => [ + 'summary' => '调用DescribeDomainRealTimeSrcHttpCodeData查询加速域名回源HTTP返回码的总数和占比数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111797', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T04:40:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeSrcHttpCodeData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '每个时间间隔的HTTP返回码占比数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-11-30T05:40:00Z', + ], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RealTimeSrcCodeProportionData' => [ + 'description' => '各返回码占比使用数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Proportion' => [ + 'description' => '占比使用数据。', + 'type' => 'string', + 'example' => '0.62015503875969', + ], + 'Count' => [ + 'description' => '总数。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2019-11-30T05:33:00Z\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeSrcHttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:40:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeSrcCodeProportionData\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Proportion\\": \\"0.62015503875969\\",\\n \\"Count\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RealTimeSrcHttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:40:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeSrcCodeProportionData\\": [\\n {\\n \\"Proportion\\": \\"66.046511627907\\",\\n \\"Code\\": \\"200\\"\\n },\\n {\\n \\"Proportion\\": \\"4.72868217054264\\",\\n \\"Code\\": \\"206\\"\\n },\\n {\\n \\"Proportion\\": \\"0.155038759689922\\",\\n \\"Code\\": \\"302\\"\\n },\\n {\\n \\"Proportion\\": \\"0.62015503875969\\",\\n \\"Code\\": \\"304\\"\\n },\\n {\\n \\"Proportion\\": \\"28.4496124031008\\",\\n \\"Code\\": \\"500\\"\\n }\\n ]\\n }\\n },\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:39:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeSrcCodeProportionData\\": [\\n {\\n \\"Proportion\\": \\"66.046511627907\\",\\n \\"Code\\": \\"200\\"\\n },\\n {\\n \\"Proportion\\": \\"4.72868217054264\\",\\n \\"Code\\": \\"206\\"\\n },\\n {\\n \\"Proportion\\": \\"0.155038759689922\\",\\n \\"Code\\": \\"302\\"\\n },\\n {\\n \\"Proportion\\": \\"0.62015503875969\\",\\n \\"Code\\": \\"304\\"\\n },\\n {\\n \\"Proportion\\": \\"28.4496124031008\\",\\n \\"Code\\": \\"500\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DataInterval\\": \\"60\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"example1.com,example2.com\\",\\n \\"EndTime\\": \\"2015-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2015-11-30T05:33:00Z\\"\\n}"},{"type":"xml","example":"<DescribeDomainRealTimeSrcHttpCodeDataResesponse>\\r\\n\\t<RealTimeSrcHttpCodeData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2019-11-30T05:40:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>66.046511627907</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>200</Code>\\r\\n <Count>100</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>4.72868217054264</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>206</Code>\\r\\n <Count>101</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>0.155038759689922</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>302</Code>\\r\\n <Count>112</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>0.62015503875969</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>304</Code>\\r\\n <Count>120</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>28.4496124031008</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>500</Code>\\r\\n <Count>200</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2019-11-30T05:39:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>66.046511627907</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>200</Code>\\r\\n <Count>100</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>4.72868217054264</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>206</Code>\\r\\n <Count>101</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>0.155038759689922</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>302</Code>\\r\\n <Count>112</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>0.62015503875969</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>304</Code>\\r\\n <Count>120</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t<RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t\\t\\t<Proportion>28.4496124031008</Proportion>\\r\\n\\t\\t\\t\\t\\t<Code>500</Code>\\r\\n <Count>200</Count>\\r\\n\\t\\t\\t\\t</RealTimeSrcCodeProportionData>\\r\\n\\t\\t\\t</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t</RealTimeSrcHttpCodeData>\\r\\n\\t<DataInterval>60</DataInterval>\\r\\n\\t<RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>\\r\\n\\t<DomainName>example.com,example.org</DomainName>\\r\\n\\t<EndTime>2019-11-30T05:40:00Z</EndTime>\\r\\n\\t<StartTime>2019-11-30T05:33:00Z</StartTime>\\r\\n</DescribeDomainRealTimeSrcHttpCodeDataResesponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询实时回源状态码', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。'."\n" + .'- 最多支持查询过去7天内的数据，单次查询时间跨度最多一小时。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeSrcTrafficData' => [ + 'summary' => '调用DescribeDomainRealTimeSrcTrafficData查询加速域名1分钟粒度的回源流量监控数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111798', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:01:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:01:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A666D44F-19D6-490E-97CF-1A64AB962C57', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，该参数固定返回60（1分钟）、300（5分钟）或3600（1小时），具体请参见使用说明中返回数据时间粒度。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeSrcTrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的回源流量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '详细使用数据。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-12-10T20:01:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'StartTime and EndTime can not be single.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainName.Overlimit', + 'errorMessage' => 'Too many DomainNames are specified.', + ], + [ + 'errorCode' => 'InvalidInterval.Malformed', + 'errorMessage' => 'Specified Interval is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-12-10T20:01:00Z\\",\\n \\"StartTime\\": \\"2019-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeSrcTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2019-12-10T20:01:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeSrcTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"Value\\": \\"0\\"\\n },\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:01:00Z\\",\\n \\"Value\\": \\"0\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-10T20:01:00Z\\"\\n}\\n\\t\\t\\t"},{"type":"xml","example":"<DescribeDomainRealTimeSrcTrafficDataResponse>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<DataInterval>60</DataInterval>\\r\\n\\t<RealTimeSrcTrafficDataPerInterval>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2019-12-10T20:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>0</Value>\\r\\n\\t\\t</DataModule>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2019-12-10T20:01:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>0</Value>\\r\\n\\t\\t</DataModule>\\r\\n\\t</RealTimeSrcTrafficDataPerInterval>\\r\\n\\t<RequestId>A666D44F-19D6-490E-97CF-1A64AB962C57</RequestId>\\r\\n\\t<StartTime>2019-12-10T20:00:00Z</StartTime>\\r\\n\\t<EndTime>2019-12-10T20:01:00Z</EndTime>\\r\\n</DescribeDomainRealTimeSrcTrafficDataResponse>","errorExample":""}]', + 'title' => '查询实时回源流量', + 'description' => '- 如果您不指定StartTime和EndTime，该接口默认返回过去1小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEsExecuteData' => [ + 'summary' => '调用DescribeEsExecuteData查询ES规则的运行情况。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111818', + 'abilityTreeNodes' => [ + 'FEATUREcdnT7HAK0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。日期格式按照ISO8601表示法，并使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-02-17T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-02-18T20:00:00Z', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。您可以调用[DescribeCdnDomainConfigs](~~90924~~)接口获取规则ID。', + 'type' => 'string', + 'required' => true, + 'example' => '212896**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '99D61AB3-6164-4CF2-A0DE-129C9B07618B', + ], + 'Contents' => [ + 'description' => 'ES规则内容。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'ES规则运行情况图表的表名。', + 'type' => 'string', + 'example' => 'Exception', + ], + 'Points' => [ + 'description' => '图表对应列的时间和数值的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '图表对应列的时间和数值。', + 'type' => 'string', + 'example' => '2021-02-18T19:05:00Z,8', + ], + ], + 'Columns' => [ + 'description' => 'ES规则运行情况图表的时间和列名的列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ES规则运行情况图表的时间和列名。', + 'type' => 'string', + 'example' => 'time,Exception', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99D61AB3-6164-4CF2-A0DE-129C9B07618B\\",\\n \\"Contents\\": [\\n {\\n \\"Name\\": \\"Exception\\",\\n \\"Points\\": [\\n \\"2021-02-18T19:05:00Z,8\\"\\n ],\\n \\"Columns\\": [\\n \\"time,Exception\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeEsExecuteDataResponse>\\n<Contents>\\n <Columns>time</Columns>\\n <Columns>Exception</Columns>\\n <Name>Exception</Name>\\n <Points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>6</1>\\n </Points>\\n <Points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>6</1>\\n </Points>\\n <Points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>8</1>\\n </Points>\\n</Contents>\\n<Contents>\\n <Columns>time</Columns>\\n <Columns>ExecutedAndHit</Columns>\\n <Name>ExecutedAndHit</Name>\\n <Points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </Points>\\n <Points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </Points>\\n <Points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </Points>\\n</Contents>\\n<RequestId>99D61AB3-6164-4CF2-A0DE-129C9B07618B</RequestId>\\n</DescribeEsExecuteDataResponse>","errorExample":""}]', + 'title' => '查询ES规则的运行情况', + 'description' => '- 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEsExceptionData' => [ + 'summary' => '调用DescribeEsExceptionData查询ES规则执行的异常情况。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111817', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-02-17T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-02-18T20:00:00Z', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。您可以调用[DescribeCdnDomainConfigs](~~90924~~)接口获取规则ID。', + 'type' => 'string', + 'required' => true, + 'example' => '212896**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '99D61AB3-6164-4CF2-A0DE-129C9B07618B', + ], + 'Contents' => [ + 'description' => 'ES执行异常情况的规则内容。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'ES规则执行异常情况图表的表名。', + 'type' => 'string', + 'example' => '401', + ], + 'Points' => [ + 'description' => '图表对应列的时间和数值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '图表对应列的时间和数值。', + 'type' => 'string', + 'example' => '2021-02-18T19:05:00Z,0', + ], + ], + 'Columns' => [ + 'description' => 'ES规则执行异常情况图表的时间和列名列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ES规则执行异常情况图表的时间和列名。', + 'type' => 'string', + 'example' => 'time,401', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99D61AB3-6164-4CF2-A0DE-129C9B07618B\\",\\n \\"Contents\\": [\\n {\\n \\"Name\\": \\"401\\",\\n \\"Points\\": [\\n \\"2021-02-18T19:05:00Z,0\\"\\n ],\\n \\"Columns\\": [\\n \\"time,401\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeEsExceptionDataResponse>\\n<content>\\n <columns>time</columns>\\n <columns>401</columns>\\n <name>401</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>402</columns>\\n <name>402</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>403</columns>\\n <name>403</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>404</columns>\\n <name>404</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>405</columns>\\n <name>405</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>406</columns>\\n <name>406</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>407</columns>\\n <name>407</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>6</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>6</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>8</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>408</columns>\\n <name>408</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>409</columns>\\n <name>409</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>410</columns>\\n <name>410</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<content>\\n <columns>time</columns>\\n <columns>499</columns>\\n <name>499</name>\\n <points>\\n <0>2021-02-18T19:07:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:06:00Z</0>\\n <1>0</1>\\n </points>\\n <points>\\n <0>2021-02-18T19:05:00Z</0>\\n <1>0</1>\\n </points>\\n</content>\\n<RequestId>99D61AB3-6164-4CF2-A0DE-129C9B07618B</RequestId>\\n</DescribeEsExceptionDataResponse>","errorExample":""}]', + 'title' => '查询ES规则的异常情况', + 'description' => '- 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnUserBillHistory' => [ + 'summary' => '调用DescribeCdnUserBillHistory查询用户历史账单。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111746', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取历史账单起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'最小数据粒度为5分钟。', + 'type' => 'string', + 'required' => true, + 'example' => '2018-09-30T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取历史账单结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2018-10-31T16:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ED61C6C3-8241-4187-AAA7-5157AE175CEC', + ], + 'BillHistoryData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BillHistoryDataItem' => [ + 'description' => '历史计费数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Dimension' => [ + 'description' => '维度。', + 'type' => 'string', + 'example' => 'flow', + ], + 'BillType' => [ + 'description' => '计费模式。', + 'type' => 'string', + 'example' => 'month_4th_day_bandwidth', + ], + 'BillTime' => [ + 'description' => '计费周期起始时间。', + 'type' => 'string', + 'example' => '2018-09-30T16:00:00Z', + ], + 'BillingData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BillingDataItem' => [ + 'description' => '计费数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量，单位为字节。', + 'type' => 'number', + 'format' => 'float', + 'example' => '24567', + ], + 'Bandwidth' => [ + 'description' => '带宽，单位为Bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4041', + ], + 'Count' => [ + 'description' => '请求个数，单位为个。', + 'type' => 'number', + 'format' => 'float', + 'example' => '203601', + ], + 'CdnRegion' => [ + 'description' => '计费大区。取值：'."\n" + .'- **CN**：中国内地。'."\n" + .'- **OverSeas**：全球（不包含中国内地）。'."\n" + .'- **AP1**：亚太1区。'."\n" + .'- **AP2**：亚太2区。'."\n" + .'- **AP3**：亚太3区。'."\n" + .'- **NA**：北美。'."\n" + .'- **SA** ：南美。'."\n" + .'- **EU**：欧洲。'."\n" + .'- **MEAA**：中东、非洲。', + 'type' => 'string', + 'example' => 'AP1', + ], + 'ChargeType' => [ + 'description' => '计费类型。取值：'."\n" + .'- **StaticHttp**：静态HTTP。'."\n" + .'- **DynamicHttp**：动态HTTP。'."\n" + .'- **DynamicHttps**：动态HTTPS。', + 'type' => 'string', + 'example' => 'DynamicHttp', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ED61C6C3-8241-4187-AAA7-5157AE175CEC\\",\\n \\"BillHistoryData\\": {\\n \\"BillHistoryDataItem\\": [\\n {\\n \\"Dimension\\": \\"flow\\",\\n \\"BillType\\": \\"month_4th_day_bandwidth\\",\\n \\"BillTime\\": \\"2018-09-30T16:00:00Z\\",\\n \\"BillingData\\": {\\n \\"BillingDataItem\\": [\\n {\\n \\"Flow\\": 24567,\\n \\"Bandwidth\\": 4041,\\n \\"Count\\": 203601,\\n \\"CdnRegion\\": \\"AP1\\",\\n \\"ChargeType\\": \\"DynamicHttp\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnUserBillHistoryResponse>\\n<BillHistoryData>\\n <BillHistoryDataItem>\\n <BillType>month_4th_day_bandwidth</BillType>\\n <BillingData>\\n <BillingDataItem>\\n <Bandwidth>4041</Bandwidth>\\n <CdnRegion>AP1</CdnRegion>\\n <FLOW>24567</FLOW>\\n </BillingDataItem>\\n <BillingDataItem>\\n <Bandwidth>3819</Bandwidth>\\n <CdnRegion>NA</CdnRegion>\\n </BillingDataItem>\\n <BillingDataItem>\\n <Bandwidth>272113</Bandwidth>\\n <CdnRegion>CN</CdnRegion>\\n </BillingDataItem>\\n </BillingData>\\n <Dimension>flow</Dimension>\\n <BillTime>2018-09-30T16:00:00Z</BillTime>\\n </BillHistoryDataItem>\\n <BillHistoryDataItem>\\n <BillType>month_avg_day_bandwidth</BillType>\\n <BillingData>\\n <BillingDataItem>\\n <Bandwidth>4389</Bandwidth>\\n <CdnRegion>AP1</CdnRegion>\\n </BillingDataItem>\\n <BillingDataItem>\\n <Bandwidth>4302</Bandwidth>\\n <CdnRegion>NA</CdnRegion>\\n </BillingDataItem>\\n <BillingDataItem>\\n <Bandwidth>291641</Bandwidth>\\n <CdnRegion>CN</CdnRegion>\\n </BillingDataItem>\\n </BillingData>\\n <Dimension>flow</Dimension>\\n <BillTime>2018-09-30T16:00:00Z</BillTime>\\n </BillHistoryDataItem>\\n <BillHistoryDataItem>\\n <BillType>hour_vas</BillType>\\n <BillingData>\\n <BillingDataItem>\\n <Count>205624</Count>\\n <ChargeType>DynamicHttp</ChargeType>\\n </BillingDataItem>\\n </BillingData>\\n <Dimension>vas</Dimension>\\n <BillTime>2018-09-30T16:00:00Z</BillTime>\\n </BillHistoryDataItem>\\n <BillHistoryDataItem>\\n <BillType>hour_vas</BillType>\\n <BillingData>\\n <BillingDataItem>\\n <Count>203601</Count>\\n <ChargeType>DynamicHttp</ChargeType>\\n </BillingDataItem>\\n </BillingData>\\n <Dimension>vas</Dimension>\\n <BillTime>2018-09-30T17:00:00Z</BillTime>\\n </BillHistoryDataItem>\\n</BillHistoryData>\\n<RequestId>ED61C6C3-8241-4187-AAA7-5157AE175CEC</RequestId>\\n</DescribeCdnUserBillHistoryResponse>","errorExample":""}]', + 'title' => '查询历史账单', + 'description' => '- 最多查询一个月内的数据。'."\n" + .'- 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnUserBillType' => [ + 'summary' => '调用DescribeCdnUserBillType查询用户计费类型，最多查询一个月的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111748', + 'abilityTreeNodes' => [ + 'FEATUREcdnYC0IJ0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'最小数据粒度为5分钟。', + 'type' => 'string', + 'required' => true, + 'example' => '2018-09-30T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2018-10-31T16:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + 'BillTypeData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BillTypeDataItem' => [ + 'description' => '用户计费类型返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '计费模式结束时间。', + 'type' => 'string', + 'example' => '2018-10-31T16:00:00Z', + ], + 'StartTime' => [ + 'description' => '计费模式起始时间。', + 'type' => 'string', + 'example' => '2018-10-30T16:00:00Z', + ], + 'BillingCycle' => [ + 'description' => '计费周期。', + 'type' => 'string', + 'example' => 'month', + ], + 'Product' => [ + 'description' => '产品。', + 'type' => 'string', + 'example' => 'cdn', + ], + 'BillType' => [ + 'description' => '计费模式。'."\n" + ."\n" + .'> 带**_overseas**后缀表示海外不分大区计费，例如："BillType": "month\\_avg\\_day\\_bandwidth\\_overseas" 则表明该计费方式为月均日峰值海外不分区计费。'."\n" + ."\n" + .'计费模式取值如下所示：'."\n" + .'- hour_flow：按小时流量计费。'."\n" + .'- day_bandwidth：按日带宽计费。'."\n" + .'- month_95：按月结95峰值带宽计费。'."\n" + .'- month_avg_day_bandwidth：按月均日峰值带宽计费。'."\n" + .'- month_4th_day_bandwidth：按月第四日峰值带宽计费。'."\n" + .'- month_avg_day_95：按月均日95峰值带宽计费。'."\n" + .'- month_95_night_half：按夜间半价95峰值带宽计费。'."\n" + .'- hour_vas：按小时增值服务计费。'."\n" + .'- quic_hour_count：按小时QUIC请求数计费。'."\n" + .'- day_count：按日请求次数计费。'."\n" + .'- hour_count：按小时请求次数计费。'."\n" + .'- day_95：按日95峰值带宽计费.', + 'type' => 'string', + 'example' => 'month_avg_day_bandwidth_overseas', + ], + 'Dimension' => [ + 'description' => '维度。取值如下所示：'."\n" + .'- flow：流量带宽。'."\n" + .'- vas：增值服务（https、动态请求）。'."\n" + .'- quic：QUIC 请求数。'."\n" + .'- websocket：websocket通信协议。'."\n" + .'- rtlog2sls：实时日志推送sls。'."\n" + .'- stationflow：流量内网化计费。', + 'type' => 'string', + 'example' => 'flow', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterProduct', + 'errorMessage' => 'Invalid Parameter Product.', + ], + [ + 'errorCode' => 'InvalidParameterAliuid', + 'errorMessage' => 'Invalid Parameter Aliuid.', + ], + [ + 'errorCode' => 'InvalidParameterStartTime', + 'errorMessage' => 'The parameter StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterEndTime', + 'errorMessage' => 'The parameter EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeRange', + 'errorMessage' => 'Invalid StartTime and EndTime range.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"BillTypeData\\": {\\n \\"BillTypeDataItem\\": [\\n {\\n \\"EndTime\\": \\"2018-10-31T16:00:00Z\\",\\n \\"StartTime\\": \\"2018-10-30T16:00:00Z\\",\\n \\"BillingCycle\\": \\"month\\",\\n \\"Product\\": \\"cdn\\",\\n \\"BillType\\": \\"month_avg_day_bandwidth_overseas\\",\\n \\"Dimension\\": \\"flow\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C370DAF1-C838-4288-A1A0-9A87633D248E</RequestId>\\n<BillTypeData>\\n <BillTypeDataItem>\\n <BillingCycle>month</BillingCycle>\\n <Product>cdn</Product>\\n <Dimension>flow</Dimension>\\n <EndTime>2018-10-31T16:00:00Z</EndTime>\\n <StartTime>2018-10-30T16:00:00Z</StartTime>\\n <BillType>month_avg_day_bandwidth_overseas</BillType>\\n </BillTypeDataItem>\\n <BillTypeDataItem>\\n <BillingCycle>hour</BillingCycle>\\n <Product>cdn</Product>\\n <Dimension>flow</Dimension>\\n <EndTime>2018-10-30T16:00:00Z</EndTime>\\n <StartTime>2018-10-10T16:00:00Z</StartTime>\\n <BillType>hour_flow</BillType>\\n </BillTypeDataItem>\\n <BillTypeDataItem>\\n <BillingCycle>hour</BillingCycle>\\n <Product>cdn</Product>\\n <Dimension>vas</Dimension>\\n <EndTime>2018-10-31T16:00:00Z</EndTime>\\n <StartTime>2018-09-30T16:00:00Z</StartTime>\\n <BillType>hour_vas</BillType>\\n </BillTypeDataItem>\\n <BillTypeDataItem>\\n <BillingCycle>day</BillingCycle>\\n <Product>cdn</Product>\\n <Dimension>flow</Dimension>\\n <EndTime>2018-10-10T16:00:00Z</EndTime>\\n <StartTime>2018-09-30T16:00:00Z</StartTime>\\n <BillType>day_bandwidth</BillType>\\n </BillTypeDataItem>\\n</BillTypeData>","errorExample":""}]', + 'title' => '查询计费类型', + 'description' => '- 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnUserBillPrediction' => [ + 'summary' => '调用DescribeCdnUserBillPrediction预测用户当月的用量数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111747', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '默认为月初第一天的零点整, 日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-09-30T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '默认为当前时间, 日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-10-25T10:00:00Z', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'schema' => [ + 'description' => '获取计费类型的维度，flow表示流量带宽。', + 'type' => 'string', + 'required' => false, + 'example' => 'flow', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'schema' => [ + 'description' => '计费大区。取值：'."\n" + ."\n" + .'- **CN**：中国内地。'."\n" + .'- **OverSeas**：全球（不包含中国内地）。'."\n" + .'- **AP1**：亚太1区。'."\n" + .'- **AP2**：亚太2区。'."\n" + .'- **AP3**：亚太3区。'."\n" + .'- **NA**：北美。'."\n" + .'- **SA**：南美。'."\n" + .'- **EU**：欧洲。'."\n" + .'- **MEAA**：中东、非洲。'."\n" + ."\n" + .'默认按用户当前计费模式决定，如果是海外分大区则为**CN**，**OverSeas**，否则为**CN**，**AP1**，**AP2**，**AP3**，**NA**，**SA**，**EU**或**MEAA**。'."\n" + ."\n" + .'> 各区域包含的具体国家地区，请参见[计费概述](~~142221~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'CN,OverSeas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '预测结束时间。', + 'type' => 'string', + 'example' => '2018-10-25T10:00:00Z', + ], + 'StartTime' => [ + 'description' => '预测开始时间。', + 'type' => 'string', + 'example' => '2018-09-30T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + 'BillType' => [ + 'description' => '用户计费类型。'."\n" + ."\n" + .'> 带**_overseas**后缀表示海外不分大区计费，例如： "BillType": "month_avg_day_bandwidth_overseas" 则表明该计费方式为月均日峰值海外不分区计费。'."\n" + ."\n" + .'计费模式取值如下所示：'."\n" + ."\n" + .'- hour_flow：按小时流量计费。'."\n" + .'- day_bandwidth：按日带宽计费。'."\n" + .'- month_95：按月95峰值带宽计费。'."\n" + .'- month_avg_day_bandwidth：按月均日峰值带宽计费。'."\n" + .'- month_4th_day_bandwidth：按月第四日峰值带宽计费。'."\n" + .'- month_avg_day_95：按月均日95峰值带宽计费。'."\n" + .'- month_95_night_half： 按夜间半价95峰值带宽计费。'."\n" + .'- hour_vas：按小时增值服务计费。'."\n" + .'- day_count：按日请求次数计费。', + 'type' => 'string', + 'example' => 'month_95_overseas', + ], + 'BillPredictionData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BillPredictionDataItem' => [ + 'description' => '账单预测数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '预测值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10000', + ], + 'TimeStp' => [ + 'description' => '预测值对应的时刻，仅95、夜间半价95和月第四日峰值有这个字段。', + 'type' => 'string', + 'example' => '2018-10-15T16:00:00Z', + ], + 'Area' => [ + 'description' => '计费大区。', + 'type' => 'string', + 'example' => 'CN', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'BillTypeNotFound', + 'errorMessage' => 'The user billing type is not found or the billing type of this user is not the monthly billing type.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified Time is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2018-10-25T10:00:00Z\\",\\n \\"StartTime\\": \\"2018-09-30T16:00:00Z\\",\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"BillType\\": \\"month_95_overseas\\",\\n \\"BillPredictionData\\": {\\n \\"BillPredictionDataItem\\": [\\n {\\n \\"Value\\": 10000,\\n \\"TimeStp\\": \\"2018-10-15T16:00:00Z\\",\\n \\"Area\\": \\"CN\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnUserBillPredictionResponse>\\n<RequestId>C370DAF1-C838-4288-A1A0-9A87633D248E</RequestId>\\n<StartTime>2018-09-30T16:00:00Z</StartTime>\\n<EndTime>2018-10-25T10:00:00Z</EndTime>\\n<BillType>month_95_overseas</BillType>\\n<BillPredictionData>\\n <BillPredictionDataItem>\\n <Value>10000</Value>\\n <Area>CN</Area>\\n <TimeStp>2018-10-15T16:00:00Z</TimeStp>\\n </BillPredictionDataItem>\\n <BillPredictionDataItem>\\n <Value>5000</Value>\\n <Area>OverSeas</Area>\\n <TimeStp>2018-10-10T:00:00Z</TimeStp>\\n </BillPredictionDataItem>\\n</BillPredictionData>\\n</DescribeCdnUserBillPredictionResponse>","errorExample":""}]', + 'title' => '查询预测用量', + 'description' => '用于预测用户当月的用量数据，按用户月初第一天的计费模式计算，只支持月度计费模式的预测，只支持用户粒度。 起始时间为月初1号0点，结束时间为当前时间前两个小时。'."\n" + ."\n" + .'- 月95：开始时间至结束时间内，去掉最高5%点后的最高点，为预测值。 '."\n" + .'- 月均日峰值：每日峰值带宽求和/时间天数，不计算当天的数据。 '."\n" + .'- 月第四日峰值：请求时间内，第四高的峰值为预测值，如果请求时间小于4天，返回预测值为0。 '."\n" + .'- 月均日95：每日日95峰值求和/时间天数，不计算当天的数据。 '."\n" + .'- 夜间半价95：开始时间至结束时间内，去掉最高5%点后的最高点，为预测值。'."\n" + ."\n" + .'> 单用户调用频率：1次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateUserUsageDataExportTask' => [ + 'summary' => '调用CreateUserUsageDataExportTask创建账号历史用量数据导出任务，将历史用量生成PDF文件用于下载。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111698', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，数据粒度为5分钟。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点，结束时间需大于起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => '刷新', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '导出文件的语言。'."\n" + ."\n" + .'- **zh-cn**（默认值）：简体中文。'."\n" + ."\n" + .'- **en-us**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2015-12-10T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ED61C6C3-8241-4187-AAA7-5157AE175CEC', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '129456', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidParameterProduct', + 'errorMessage' => 'Invalid Parameter Product.', + ], + [ + 'errorCode' => 'InvalidParameterAliuid', + 'errorMessage' => 'Invalid Parameter Aliuid.', + ], + [ + 'errorCode' => 'InvalidParameterStartTime', + 'errorMessage' => 'The parameter StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterEndTime', + 'errorMessage' => 'The parameter EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeRange', + 'errorMessage' => 'Invalid StartTime and EndTime range.', + ], + [ + 'errorCode' => 'InvalidParameterOperator', + 'errorMessage' => 'Invalid Parameter Operator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"ED61C6C3-8241-4187-AAA7-5157AE175CEC\\",\\n \\"TaskId\\": \\"129456\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"ED61C6C3-8241-4187-AAA7-5157AE175CEC\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\",\\n \\"TaskId\\": \\"129456\\"\\n}"},{"type":"xml","example":"<CreateUserUsageDataExportTaskResponse>\\r\\n\\t<RequestId>ED61C6C3-8241-4187-AAA7-5157AE175CEC</RequestId>\\r\\n\\t<StartTime>2015-12-10T20:00:00Z</StartTime>\\r\\n\\t<EndTime>2015-12-10T21:00:00Z</EndTime>\\r\\n\\t<TaskId>129456</TaskId>\\r\\n</CreateUserUsageDataExportTaskResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '创建用量数据导出任务', + 'description' => '- 最长可创建查询近一年数据的任务，单次导出任务跨度最长为一个月。'."\n" + .'- 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserUsageDataExportTask' => [ + 'summary' => '调用DescribeUserUsageDataExportTask查询用户最近三个月的用量导出任务信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111844', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**20**；最大值：**50**。'."\n" + ."\n" + .'取值：**1**~**50**之间的任意整数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围：**1**~**100000**。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A91BE91F-0B34-4CBF-8E0F-A2977E15AA52', + ], + 'UsageDataPerPage' => [ + 'description' => '每页的用量数据。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataItem' => [ + 'description' => '任务信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + .'- created：创建中。'."\n" + .'- success：成功。'."\n" + .'- failed：失败。'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'UpdateTime' => [ + 'description' => '任务最后更新时间。', + 'type' => 'string', + 'example' => '2019-12-31T08:45:02Z', + ], + 'DownloadUrl' => [ + 'description' => '下载地址。', + 'type' => 'string', + 'example' => 'https://cdn-polaris.xxxx', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2019-12-31T08:43:21Z', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => '刷新', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'A91BE91F-0B34-4CBF-8E0F-A2977', + ], + 'TaskConfig' => [ + 'description' => '任务配置。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '用量结束时间。', + 'type' => 'string', + 'example' => '2019-12-30T15:59:59Z', + ], + 'StartTime' => [ + 'description' => '用量起始时刻。', + 'type' => 'string', + 'example' => '2019-12-29T16:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterProduct', + 'errorMessage' => 'Invalid Parameter Product.', + ], + [ + 'errorCode' => 'InvalidParameterOperator', + 'errorMessage' => 'Invalid Parameter Operator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A91BE91F-0B34-4CBF-8E0F-A2977E15AA52\\",\\n \\"UsageDataPerPage\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 10,\\n \\"Data\\": {\\n \\"DataItem\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"UpdateTime\\": \\"2019-12-31T08:45:02Z\\",\\n \\"DownloadUrl\\": \\"https://cdn-polaris.xxxx\\",\\n \\"CreateTime\\": \\"2019-12-31T08:43:21Z\\",\\n \\"TaskName\\": \\"刷新\\",\\n \\"TaskId\\": \\"A91BE91F-0B34-4CBF-8E0F-A2977\\",\\n \\"TaskConfig\\": {\\n \\"EndTime\\": \\"2019-12-30T15:59:59Z\\",\\n \\"StartTime\\": \\"2019-12-29T16:00:00Z\\"\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"A91BE91F-0B34-4CBF-8E0F-A2977E15AA52\\",\\n \\"UsageDataPerPage\\": {\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Data\\": {\\n \\"DataItem\\": [\\n {\\n \\"TaskId\\": 11,\\n \\"UpdateTime\\": \\"2018-10-09T06:35:01Z\\",\\n \\"DownloadUrl\\": \\"example.com\\",\\n \\"UpdateTime\\": \\"2018-10-09T06:35:46Z\\",\\n \\"CreateTime\\": \\"2018-10-09T06:33:38Z\\",\\n \\"Status\\": \\"success\\"\\n \\"TaskConfig\\": {\\n \\"StartTime\\": \\"2018-07-31T16:00:00Z\\",\\n \\"EndTime\\": \\"2018-08-31T15:59:59Z\\"\\n },\\n }\\n ]\\n }\\n }\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DescribeUserUsageDataExportTaskResponse>\\r\\n\\t<UsageDataPerPage>\\r\\n\\t\\t<Data>\\r\\n\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t<Status>success</Status>\\r\\n\\t\\t\\t\\t<TaskConfig>\\r\\n\\t\\t\\t\\t\\t<EndTime>2019-12-30T15:59:59Z</EndTime>\\r\\n\\t\\t\\t\\t\\t<StartTime>2019-12-29T16:00:00Z</StartTime>\\r\\n\\t\\t\\t\\t</TaskConfig>\\r\\n\\t\\t\\t\\t<CreateTime>2019-12-31T08:43:21Z</CreateTime>\\r\\n\\t\\t\\t\\t<DownloadUrl>https://cdn-polaris.xxxx</DownloadUrl>\\r\\n\\t\\t\\t\\t<UpdateTime>2019-12-31T08:45:02Z</UpdateTime>\\r\\n\\t\\t\\t\\t<TaskId>11584</TaskId>\\r\\n\\t\\t\\t\\t<TaskName></TaskName>\\r\\n\\t\\t\\t</DataItem>\\r\\n\\t\\t</Data>\\r\\n\\t\\t<PageNumber>1</PageNumber>\\r\\n\\t\\t<TotalCount>1</TotalCount>\\r\\n\\t\\t<PageSize>10</PageSize>\\r\\n\\t</UsageDataPerPage>\\r\\n\\t<RequestId>FB7EC32A-356A-4B33-BA59-6DB1FFF61FD2</RequestId>\\r\\n </DescribeUserUsageDataExportTaskResponse>","errorExample":""}]', + 'title' => '查询用量数据导出任务', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteUserUsageDataExportTask' => [ + 'summary' => '调用DeleteUserUsageDataExportTask删除账号历史用量数据导出任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111713', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterProduct', + 'errorMessage' => 'Invalid Parameter Product.', + ], + [ + 'errorCode' => 'InvalidParameterAliuid', + 'errorMessage' => 'Invalid Parameter Aliuid.', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'Specified TaskId is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterOperator', + 'errorMessage' => 'Invalid Parameter Operator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteUserUsageDataExportTaskResponse>\\r\\n\\t<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>\\r\\n</DeleteUserUsageDataExportTaskResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '删除用量数据导出任务', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateUsageDetailDataExportTask' => [ + 'summary' => '调用CreateUsageDetailDataExportTask创建用量明细数据导出任务，将详细用量生成Excel文件用于下载。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111697', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需晚于起始时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => '域名组信息。如果该信息不为空，则忽略**DomainNames**字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '如果域名组为空，则以该字段提供的域名为准导出数据。'."\n" + ."\n" + .'如果未填写该参数，则导出用户维度数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '需要获取的用量类型。取值：'."\n" + .'- **flow**：流量带宽数据。'."\n" + ."\n" + .'- **vas**：请求数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'flow', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => '刷新', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '导出文件的语言。取值：'."\n" + .'- **zh-cn**（默认值）：简体中文。'."\n" + .'- **en-us**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'en-us', + 'default' => 'zh-cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2015-12-10T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'ED61C6C3-8241-4187-AAA7-5157AE175CEC', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '123456', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidParameterProduct', + 'errorMessage' => 'Invalid Parameter Product.', + ], + [ + 'errorCode' => 'InvalidParameterDimension', + 'errorMessage' => 'The parameter Dimension is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterBillType', + 'errorMessage' => 'The parameter BillType is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterAliuid', + 'errorMessage' => 'Invalid Parameter Aliuid.', + ], + [ + 'errorCode' => 'InvalidParameterStartTime', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterEndTime', + 'errorMessage' => 'The specified EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeRange', + 'errorMessage' => 'Invalid StartTime and EndTime range.', + ], + [ + 'errorCode' => 'InvalidParameterOperator', + 'errorMessage' => 'Invalid Parameter Operator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"ED61C6C3-8241-4187-AAA7-5157AE175CEC\\",\\n \\"TaskId\\": \\"123456\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"ED61C6C3-8241-4187-AAA7-5157AE175CEC\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\",\\n \\"TaskId\\": \\"123456\\"\\n}"},{"type":"xml","example":"<CreateUsageDetailDataExportTaskResponse>\\r\\n\\t<RequestId>ED61C6C3-8241-4187-AAA7-5157AE175CEC</RequestId>\\r\\n\\t<StartTime>2015-12-10T20:00:00Z</StartTime>\\r\\n\\t<EndTime>2015-12-10T21:00:00Z</EndTime>\\r\\n\\t<TaskId>123456</TaskId>\\r\\n</CreateUsageDetailDataExportTaskResponse>","errorExample":""}]', + 'title' => '创建用量明细数据导出任务', + 'description' => '- 最长可创建查询近一年数据的任务，单次导出任务跨度最长为一个月。'."\n" + .'- 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserUsageDetailDataExportTask' => [ + 'summary' => '调用DescribeUserUsageDetailDataExportTask查询您账户下单个或多个域名5分钟明细数据的导出任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111845', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：**20**；最大值：**50**。'."\n" + ."\n" + .'取值：**1**~**50**之间的任意整数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围：**1**~**100000**。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A91BE91F-0B34-4CBF-8E0F-A2977E15AA52', + ], + 'UsageDataPerPage' => [ + 'description' => '每页的用量数据。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataItem' => [ + 'description' => '任务信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'UpdateTime' => [ + 'description' => '任务最后更新时间。', + 'type' => 'string', + 'example' => '2018-10-09T06:35:46Z', + ], + 'DownloadUrl' => [ + 'description' => '下载地址。', + 'type' => 'string', + 'example' => 'https://test.oss-cn-beijing.aliyuncs.com/billing_data/xxx', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2018-10-09T06:33:38Z', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => '刷新', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '11', + ], + 'TaskConfig' => [ + 'description' => '任务配置。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '查询用量数据的结束时间。', + 'type' => 'string', + 'example' => '2018-08-31T15:59:59Z', + ], + 'StartTime' => [ + 'description' => '查询用量数据的起始时间。', + 'type' => 'string', + 'example' => '2018-07-31T16:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterProduct', + 'errorMessage' => 'Invalid Parameter Product.', + ], + [ + 'errorCode' => 'InvalidParameterOperator', + 'errorMessage' => 'Invalid Parameter Operator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A91BE91F-0B34-4CBF-8E0F-A2977E15AA52\\",\\n \\"UsageDataPerPage\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Data\\": {\\n \\"DataItem\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"UpdateTime\\": \\"2018-10-09T06:35:46Z\\",\\n \\"DownloadUrl\\": \\"https://test.oss-cn-beijing.aliyuncs.com/billing_data/xxx\\",\\n \\"CreateTime\\": \\"2018-10-09T06:33:38Z\\",\\n \\"TaskName\\": \\"刷新\\",\\n \\"TaskId\\": \\"11\\",\\n \\"TaskConfig\\": {\\n \\"EndTime\\": \\"2018-08-31T15:59:59Z\\",\\n \\"StartTime\\": \\"2018-07-31T16:00:00Z\\"\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"UsageDataPerPage\\": {\\n \\"UsageData\\": [\\n {\\n \\"StartTime\\": \\"2017-12-10T00:00:00Z\\",\\n \\"EndTime\\": \\"2017-12-11T00:00:00Z\\",\\n \\"CreateTime\\": \\"2017-12-15T12:33:10Z\\",\\n \\"ModifyTime\\": \\"2017-12-15T12:38:49Z\\",\\n \\"TaskName\\":\\"测试任务\\",\\n \\"TaskId\\":\\"34230590834\\"\\n \\"Status\\": \\"Success\\",\\n \\"DownloadUrl\\":\\"http://example.com/xxxx/xxxx.pdf\\",\\n \\"UpdateTime\\": \\"2017-12-15T12:41:49Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\"\\n}"},{"type":"xml","example":"<DescribeUserUsageDetailDataExportTaskResponse>\\n<RequestId>A91BE91F-0B34-4CBF-8E0F-A2977E15AA52</RequestId>\\n<UsageDataPerPage>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n <PageNumber>1</PageNumber>\\n <Data>\\n <DataItem>\\n <TaskId>11</TaskId>\\n <UpdateTime>2018-10-09T06:35:46Z</UpdateTime>\\n <DownloadUrl>https://test.oss-cn-beijing.aliyuncs.com/billing_data/xxx</DownloadUrl>\\n <CreateTime>2018-10-09T06:33:38Z</CreateTime>\\n <Status>success</Status>\\n <TaskConfig>\\n <StartTime>2018-07-31T16:00:00Z</StartTime>\\n <EndTime>2018-08-31T15:59:59Z</EndTime>\\n </TaskConfig>\\n </DataItem>\\n </Data>\\n</UsageDataPerPage>\\n</DescribeUserUsageDetailDataExportTaskResponse>","errorExample":""}]', + 'title' => '查询用量明细导出任务详情', + 'description' => '- 该功能从2018年7月20日开始，最长可查询近三个月的数据。'."\n" + .'- 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteUsageDetailDataExportTask' => [ + 'summary' => '调用DeleteUsageDetailDataExportTask删除用量明细数据导出任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111712', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，可调用[DescribeUserUsageDataExportTask](~~91062~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterProduct', + 'errorMessage' => 'Invalid Parameter Product.', + ], + [ + 'errorCode' => 'InvalidParameterAliuid', + 'errorMessage' => 'Invalid Parameter Aliuid.', + ], + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'Specified TaskId is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterOperator', + 'errorMessage' => 'Invalid Parameter Operator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteUsageDetailDataExportTaskResponse>\\r\\n\\t<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>\\r\\n</DeleteUsageDetailDataExportTaskResponse>","errorExample":""}]', + 'title' => '删除用量明细数据导出任务', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainMax95BpsData' => [ + 'summary' => '调用DescribeDomainMax95BpsData查询加速域名95带宽峰值监控数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111780', + 'abilityTreeNodes' => [ + 'FEATUREcdn5DW324', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的加速域名。若参数为空，默认返回所有加速域名合并后的数据。'."\n" + ."\n" + .'> 不支持批量域名查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'TimePoint', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T10:00:00Z', + ], + ], + [ + 'name' => 'Cycle', + 'in' => 'query', + 'schema' => [ + 'description' => '95带宽峰值周期，默认值为**day**。取值：'."\n" + ."\n" + .'- **day**：按日查询95峰值。'."\n" + .'- **month**：按月查询95峰值。', + 'type' => 'string', + 'required' => false, + 'example' => 'month', + 'enum' => [ + 'day', + 'month', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'EndTime' => [ + 'description' => '获取数据的结束时间。', + 'type' => 'string', + 'example' => '2015-12-11T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '获取数据的开始时间。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'DomesticMax95Bps' => [ + 'description' => '中国内地95带宽峰值。', + 'type' => 'string', + 'example' => '16777590.28', + ], + 'OverseasMax95Bps' => [ + 'description' => '全球（不含中国内地）95带宽峰值。', + 'type' => 'string', + 'example' => '0', + ], + 'Max95Bps' => [ + 'description' => '95带宽峰值。', + 'type' => 'string', + 'example' => '16777590.28', + ], + 'DetailData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Max95Detail' => [ + 'description' => '95带宽明细数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-11T21:00:00Z', + ], + 'Area' => [ + 'description' => '95带宽对应的区域。', + 'type' => 'string', + 'example' => 'CN', + ], + 'Max95BpsPeakTime' => [ + 'description' => '95带宽峰值时间。', + 'type' => 'string', + 'example' => '2015-12-11T21:05:00Z', + ], + 'Max95Bps' => [ + 'description' => '95带宽峰值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16777590.28', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidTimePoint.Malformed', + 'errorMessage' => 'Specified TimePoint is malformed.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"EndTime\\": \\"2015-12-11T21:00:00Z\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"DomesticMax95Bps\\": \\"16777590.28\\",\\n \\"OverseasMax95Bps\\": \\"0\\",\\n \\"Max95Bps\\": \\"16777590.28\\",\\n \\"DetailData\\": {\\n \\"Max95Detail\\": [\\n {\\n \\"TimeStamp\\": \\"2015-12-11T21:00:00Z\\",\\n \\"Area\\": \\"CN\\",\\n \\"Max95BpsPeakTime\\": \\"2015-12-11T21:05:00Z\\",\\n \\"Max95Bps\\": 16777590.28\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainMax95BpsDataResponse>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>\\r\\n\\t<StartTime>2015-12-10T20:00:00Z</StartTime>\\r\\n\\t<EndTime>2015-12-11T21:00:00Z</EndTime>\\r\\n\\t<Max95Bps>16777590.28</Max95Bps>\\r\\n\\t<DomesticMax95Bps>16777590.28</DomesticMax95Bps>\\r\\n\\t<OverseasMax95Bps>0</OverseasMax95Bps>\\r\\n </DescribeDomainMax95BpsDataResponse>","errorExample":""}]', + 'title' => '查询95带宽峰值', + 'description' => '**分三种方式查询：**'."\n" + .'- 当同时指定StartTime和EndTime时，若EndTime与StartTime差值在24小时内，则查询StartTime所在当天的95峰值，否则查询StartTime所在月份的95峰值。'."\n" + .'- 当同时指定TimePoint和Cycle时，返回TimePoint所在周期的95峰值。'."\n" + .'- 当指定StartTime和EndTime时，若额外指定了Cycle，可以返回查询范围内所有指定cycle对应的95峰值。<br>'."\n" + .'<br>'."\n" + .'当这三种方式都不指定时，默认返回过去24小时的95峰值。<br>'."\n" + .'<br>'."\n" + .'* 数据最大查询跨度：90天'."\n" + .'* 数据最小查询粒度：1天'."\n" + .'* 数据最大查询范围：90天<br>'."\n" + .'<br>'."\n" + .'- 单用户调用频率：100次/秒。'."\n" + .'- 获取数据单位：bit/s。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainUsageData' => [ + 'summary' => '调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111815', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的加速域名。支持批量查询，多个域名用英文逗号（,）分隔，一次最多可以查询100个域名。'."\n" + ."\n" + .'> 如果参数为空，默认返回账号下所有加速域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO 8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 查询数据时间粒度为5分钟。', + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO 8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需晚于起始时间，且时间相差不能超过31天。', + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T22:00:00Z', + ], + ], + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据类型。取值：'."\n" + .'- **bps**：带宽。'."\n" + .'- **traf**：流量。'."\n" + .'- **acc**：请求数。'."\n" + ."\n" + .'> **acc**不支持根据**Area**参数查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'bps', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '需要获取的用量类型。取值：'."\n" + .'- **static**：静态。'."\n" + .'- **dynamic**：动态。'."\n" + .'- **all**（默认）：全部。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + 'default' => 'all', + ], + ], + [ + 'name' => 'DataProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '需要获取的数据的协议。取值：'."\n" + .'- **http**：HTTP协议。'."\n" + .'- **https**：HTTPS协议。'."\n" + .'- **quic**：QUIC协议。'."\n" + .'- **all**（默认）：以上全部协议。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'default' => 'all', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'schema' => [ + 'description' => '区域代号。取值：'."\n" + ."\n" + .'- **CN**（默认）：中国内地。'."\n" + .'- **OverSeas**：全球（不包含中国内地）。'."\n" + .'- **AP1**：亚太1区。'."\n" + .'- **AP2**：亚太2区。'."\n" + .'- **AP3**：亚太3区。'."\n" + .'- **NA**：北美。'."\n" + .'- **SA**：南美。'."\n" + .'- **EU**：欧洲。'."\n" + .'- **MEAA**：中东、非洲。'."\n" + .'- **all**：以上全部区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'default' => 'CN', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '强制指定获取指定时间粒度的数据，单位为秒。支持**300**（5分钟）、**3600**（1小时）和**86400**（1天）。'."\n" + .'- **Interval**=**300**：最长可查询最近半年的数据，单次查询的时间跨度最长为3天。'."\n" + .'- **Interval**=**3600**或**86400**：最长可查询最近1年的数据。'."\n" + .'- 不指定**Interval**：单次查询跨度最长为1个月。当查询时间为1~3天时，数据按小时粒度返回；当查询时间为4天及以上时，数据按天粒度返回。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-B913-E0AC3D31693E', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2015-12-10T22:00:00Z', + ], + 'Type' => [ + 'description' => '用量类型。', + 'type' => 'string', + 'example' => 'bps', + ], + 'Area' => [ + 'description' => '用量区域。', + 'type' => 'string', + 'example' => 'CN', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位为秒。', + 'type' => 'string', + 'example' => '300', + ], + 'UsageDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的流量数据。', + 'type' => 'array', + 'items' => [ + 'description' => ' '."\n" + .'每个时间间隔的流量数据解释。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '用量。', + 'type' => 'string', + 'example' => '423304182', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。'."\n" + ."\n" + .'> 返回数据中包含的多个**TimeStamp**称为时间片。', + 'type' => 'string', + 'example' => '2015-12-10T21:30:00Z', + ], + 'PeakTime' => [ + 'description' => '当**Field**为**bps**时，该值为峰值带宽时刻，否则值和**TimeStamp**相同。', + 'type' => 'string', + 'example' => '2015-12-10T21:30:00Z', + ], + 'SpecialValue' => [ + 'description' => '特殊用量。'."\n" + ."\n" + .'> 用来标记特殊情况下的用量值，没有特殊计费可忽略该参数。', + 'type' => 'string', + 'example' => '423304182', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterType', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterField', + 'errorMessage' => 'The specified Field is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterStartTime', + 'errorMessage' => 'The parameter StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterEndTime', + 'errorMessage' => 'The parameter EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidIntervalParameter', + 'errorMessage' => 'The specified Interval is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-10T22:00:00Z\\",\\n \\"Type\\": \\"bps\\",\\n \\"Area\\": \\"CN\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"UsageDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"423304182\\",\\n \\"TimeStamp\\": \\"2015-12-10T21:30:00Z\\",\\n \\"PeakTime\\": \\"2015-12-10T21:30:00Z\\",\\n \\"SpecialValue\\": \\"423304182\\"\\n }\\n ]\\n }\\n}","errorExample":"http://cdn.aliyuncs.com?Action=DescribeDomainUsageData&DomainName=example.com\\n&StartTime=2015-12-10T20:00:00Z\\n&EndTime=2015-12-10T22:00:00Z\\n&Field=bps\\n&Area=EU\\n&<公共请求参数>"},{"type":"xml","example":"<DescribeDomainUsageDataResponse>\\n<DomainName>example.com</DomainName>\\n<UsageDataPerInterval>\\n <DataModule>\\n <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>\\n <PeakTime>2015-12-10T20:05:00Z</PeakTime>\\n <Value>423304182</Value>\\n <SpecialValue>423304182</SpecialValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2015-12-10T21:00:00Z</TimeStamp>\\n <PeakTime>2015-12-10T21:30:00Z</PeakTime>\\n <Value>454680793</Value>\\n <SpecialValue>423304182</SpecialValue>\\n </DataModule>\\n</UsageDataPerInterval>\\n<RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>\\n<StartTime>2015-12-10T20:00Z</StartTime>\\n<EndTime>2015-12-10T21:00Z</EndTime>\\n<Area>CN</Area>\\n<Type>traf</Type>\\n</DescribeDomainUsageDataResponse>","errorExample":"http://cdn.aliyuncs.com?Action=DescribeDomainUsageData&DomainName=example.com\\n&StartTime=2015-12-10T20:00:00Z\\n&EndTime=2015-12-10T22:00:00Z\\n&Type=static\\n&DataProtocol=https\\n&Field=acc\\n&Area=all\\n&<公共请求参数>"}]', + 'title' => '查询用量数据', + 'description' => '- 单用户调用频率：10次/秒。'."\n" + .'- 支持查询的时间粒度：根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'| 时间粒度 | 单次查询的最大时间跨度 | 可查询历史数据时间范围 | 数据延迟'."\n" + .'| -------------- | -------------- | ------ | ------ |'."\n" + .'| 5分钟 | 3天 | 93天 | 15分钟|'."\n" + .'| 1小时 | 7天 | 186天 | 一般延迟3-4小时|'."\n" + .'| 1天 | 31天 | 366天 | 一般延迟4小时，不超过24小时|', + 'requestParamsDescription' => '### 参数组合说明'."\n" + ."\n" + .'计费数据和参数取值的对应关系如下表，具体调用方法可参见请求示例。'."\n" + ."\n" + .'| 计费数据 | DataProtocol参数取值 | Type参数取值 | Field参数取值 | Area参数取值 |'."\n" + .'|-----------------|----------------------|--------------|---------------|---------------------------------------|'."\n" + .'| 流量 | all或不传 | all或不传 | traf | CN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA |'."\n" + .'| 带宽 | all或不传 | all或不传 | bps | CN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA |'."\n" + .'| 静态HTTPS请求数 | https | static | acc | all |'."\n" + .'| 动态HTTP请求数 | http | dynamic | acc | all |'."\n" + .'| 动态HTTPS请求数 | https | dynamic | acc | all |'."\n" + .'| 动态QUIC请求数 | quic | dynamic | acc | all |'."\n" + .'| 静态QUIC请求数 | quic | static | acc | all |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnUserResourcePackage' => [ + 'summary' => '调用DescribeCdnUserResourcePackage查询CDN用户当前资源包信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111752', + 'abilityTreeNodes' => [ + 'FEATUREcdnG9C3XR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包状态，默认值为valid。取值：'."\n" + ."\n" + .'- **valid**：有效。'."\n" + ."\n" + .'- **closed**：无效。'."\n" + ."\n" + .'- **exhaust**：耗尽。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'valid', + 'default' => 'valid', + 'enum' => [ + 'valid', + 'closed', + 'exhaust', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84839536-2B7E-457D-9D8C-82E6C7D4E1A3', + ], + 'ResourcePackageInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourcePackageInfo' => [ + 'description' => '由ResourcePackageInfo组成的数组格式。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '失效时间。', + 'type' => 'string', + 'example' => '2018-07-01T08:00:00Z', + ], + 'Status' => [ + 'description' => '资源包状态。取值：'."\n" + ."\n" + .'- **valid**：有效。'."\n" + ."\n" + .'- **closed**：无效。'."\n" + ."\n" + .'- **exhaust**：耗尽。', + 'type' => 'string', + 'example' => 'valid', + ], + 'DisplayName' => [ + 'description' => '套餐包名称。', + 'type' => 'string', + 'example' => 'Data Transfer Plan in Asia Pacific 1', + ], + 'StartTime' => [ + 'description' => '生效时间。', + 'type' => 'string', + 'example' => '2017-12-05T19:10:58Z', + ], + 'CommodityCode' => [ + 'description' => '资源包商品编码。', + 'type' => 'string', + 'example' => 'cdnflowbag', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'FP-ilttxc23a', + ], + 'TemplateName' => [ + 'description' => '模版名称。', + 'type' => 'string', + 'example' => 'FPT_cdn_bag_intl_deadlineAcc_1569491944', + ], + 'CurrCapacity' => [ + 'description' => '实例当前剩余容量。'."\n" + .'- 流量包单位：Byte。'."\n" + ."\n" + .'- 请求数包单位：次。', + 'type' => 'string', + 'example' => '53661095687', + ], + 'InitCapacity' => [ + 'description' => '资源包总量。'."\n" + .'- 流量包单位：Byte。'."\n" + ."\n" + .'- 请求数包单位：次。', + 'type' => 'string', + 'example' => '107374182400', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'CN', + ], + 'CurrCapacityShowValue' => [ + 'description' => '实例当前显示剩余容量。', + 'type' => 'string', + 'example' => '49.975789', + ], + 'CurrCapacityShowUnit' => [ + 'description' => '实例当前显示剩余容量单位。', + 'type' => 'string', + 'example' => 'GB', + ], + 'CurrCapacityBaseUnit' => [ + 'description' => '实例当前剩余容量单位。', + 'type' => 'string', + 'example' => 'Byte', + ], + 'InitCapacityShowValue' => [ + 'description' => '资源包显示总量。', + 'type' => 'string', + 'example' => '100.000000', + ], + 'InitCapacityShowUnit' => [ + 'description' => '资源包显示总量单位。', + 'type' => 'string', + 'example' => 'GB', + ], + 'InitCapacityBaseUnit' => [ + 'description' => '资源包总量单位。', + 'type' => 'string', + 'example' => 'Byte', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'CdnServiceNotFound', + 'errorMessage' => 'Your account does not open CDN service yet.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84839536-2B7E-457D-9D8C-82E6C7D4E1A3\\",\\n \\"ResourcePackageInfos\\": {\\n \\"ResourcePackageInfo\\": [\\n {\\n \\"EndTime\\": \\"2018-07-01T08:00:00Z\\",\\n \\"Status\\": \\"valid\\",\\n \\"DisplayName\\": \\"Data Transfer Plan in Asia Pacific 1\\",\\n \\"StartTime\\": \\"2017-12-05T19:10:58Z\\",\\n \\"CommodityCode\\": \\"cdnflowbag\\",\\n \\"InstanceId\\": \\"FP-ilttxc23a\\",\\n \\"TemplateName\\": \\"FPT_cdn_bag_intl_deadlineAcc_1569491944\\",\\n \\"CurrCapacity\\": \\"53661095687\\",\\n \\"InitCapacity\\": \\"107374182400\\",\\n \\"Region\\": \\"CN\\",\\n \\"CurrCapacityShowValue\\": \\"49.975789\\",\\n \\"CurrCapacityShowUnit\\": \\"GB\\",\\n \\"CurrCapacityBaseUnit\\": \\"Byte\\",\\n \\"InitCapacityShowValue\\": \\"100.000000\\",\\n \\"InitCapacityShowUnit\\": \\"GB\\",\\n \\"InitCapacityBaseUnit\\": \\"Byte\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"ResourcePackageInfos\\": {\\n \\"ResourcePackageInfo\\": [\\n {\\n \\"Status\\": \\"closed\\",\\n \\"InstanceId\\": \\"FP-mkqgwsyui\\",\\n \\"CommodityCode\\": \\"cdnflowbag\\",\\n \\"InitCapacity\\": \\"10995116277760\\",\\n \\"EndTime\\": \\"2017-01-30T08:00:00Z\\",\\n \\"StartTime\\": \\"2016-01-30T03:40:06Z\\",\\n \\"DisplayName\\": \\"CDN流量包（国内版）\\",\\n \\"CurrCapacity\\": \\"10995089554629\\"\\n },\\n {\\n \\"Status\\": \\"valid\\",\\n \\"InstanceId\\": \\"FP-ilttxc23a\\",\\n \\"CommodityCode\\": \\"cdnflowbag\\",\\n \\"InitCapacity\\": \\"536870912000\\",\\n \\"EndTime\\": \\"2018-07-01T08:00:00Z\\",\\n \\"StartTime\\": \\"2017-07-01T01:26:41Z\\",\\n \\"DisplayName\\": \\"CDN流量包（国内版）\\",\\n \\"CurrCapacity\\": \\"0\\"\\n },\\n {\\n \\"Status\\": \\"valid\\",\\n \\"InstanceId\\": \\"CDNHTTPSBAG-cn-v0h0dnlq4000m9\\",\\n \\"CommodityCode\\": \\"cdnhttpsbag\\",\\n \\"InitCapacity\\": \\"10000000\\",\\n \\"EndTime\\": \\"2018-12-06T08:00:00Z\\",\\n \\"StartTime\\": \\"2017-12-05T19:10:58Z\\",\\n \\"DisplayName\\": \\"CDN HTTPS请求数资源包\\",\\n \\"CurrCapacity\\": \\"9999645\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"84839536-2B7E-457D-9D8C-82E6C7D4E1A3\\"\\n}"},{"type":"xml","example":"<DescribeCdnUserResourcePackageResponse>\\r\\n\\t<ResourcePackageInfos>\\r\\n\\t\\t<ResourcePackageInfo>\\r\\n\\t\\t\\t<Status>closed</Status>\\r\\n\\t\\t\\t<InstanceId>FP-mkqgwsyui</InstanceId>\\r\\n\\t\\t\\t<CommodityCode>cdnflowbag</CommodityCode>\\r\\n\\t\\t\\t<InitCapacity>10995116277760</InitCapacity>\\r\\n\\t\\t\\t<EndTime>2017-01-30T08:00:00Z</EndTime>\\r\\n\\t\\t\\t<StartTime>2016-01-30T03:40:06Z</StartTime>\\r\\n\\t\\t\\t<DisplayName>CDN流量包（中国内地版）</DisplayName>\\r\\n\\t\\t\\t<CurrCapacity>10995089554629</CurrCapacity>\\r\\n\\t\\t</ResourcePackageInfo>\\r\\n\\t\\t<ResourcePackageInfo>\\r\\n\\t\\t\\t<Status>valid</Status>\\r\\n\\t\\t\\t<InstanceId>FP-ilttxc23a</InstanceId>\\r\\n\\t\\t\\t<CommodityCode>cdnflowbag</CommodityCode>\\r\\n\\t\\t\\t<InitCapacity>536870912000</InitCapacity>\\r\\n\\t\\t\\t<EndTime>2018-07-01T08:00:00Z</EndTime>\\r\\n\\t\\t\\t<StartTime>2017-07-01T01:26:41Z</StartTime>\\r\\n\\t\\t\\t<DisplayName>CDN流量包（中国内地版）</DisplayName>\\r\\n\\t\\t\\t<CurrCapacity>0</CurrCapacity>\\r\\n\\t\\t</ResourcePackageInfo>\\r\\n\\t\\t<ResourcePackageInfo>\\r\\n\\t\\t\\t<Status>valid</Status>\\r\\n\\t\\t\\t<InstanceId>CDNHTTPSBAG-cn-v0h0dnlq4000m9</InstanceId>\\r\\n\\t\\t\\t<CommodityCode>cdnhttpsbag</CommodityCode>\\r\\n\\t\\t\\t<InitCapacity>10000000</InitCapacity>\\r\\n\\t\\t\\t<EndTime>2018-12-06T08:00:00Z</EndTime>\\r\\n\\t\\t\\t<StartTime>2017-12-05T19:10:58Z</StartTime>\\r\\n\\t\\t\\t<DisplayName>CDN HTTPS请求数资源包</DisplayName>\\r\\n\\t\\t\\t<CurrCapacity>9999645</CurrCapacity>\\r\\n\\t\\t</ResourcePackageInfo>\\r\\n\\t</ResourcePackageInfos>\\r\\n\\t<RequestId>84839536-2B7E-457D-9D8C-82E6C7D4E1A3</RequestId>\\r\\n</DescribeCdnUserResourcePackageResponse>","errorExample":""}]', + 'title' => '查询资源包', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRealTimeLogLogstore' => [ + 'summary' => '调用DeleteRealTimeLogLogstore删除实时日志推送的Logstore。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111709', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'required' => true, + 'example' => 'ProjectName', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的LogStoreName。', + 'type' => 'string', + 'required' => true, + 'example' => 'LogstoreName', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的地域，详情请参见[实时日志投递用户Region列表](~~144883~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service is not authorized.', + ], + [ + 'errorCode' => 'DomainDeliveryConfigExist', + 'errorMessage' => 'Domain delivery configuration existed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRealTimeLogLogstoreResponse>\\n <RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\n</DeleteRealTimeLogLogstoreResponse>","errorExample":""}]', + 'title' => '删除实时日志推送的Logstore', + 'description' => '> 单用户调用频率：100次/秒。', + ], + 'CreateRealTimeLogDelivery' => [ + 'summary' => '调用CreateRealTimeLogDelivery创建域名实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '111696', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的ProjectName。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ProjectName', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的LogStoreName。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'LogstoreName', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的地域，详情请参见[实时日志投递用户Region列表](~~144883~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '开启实时日志投递服务域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F5A19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain does not exist, or it does not belong to you.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F32C57AA-7BF8-49AE-A2CC-9F42390F5A19\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"F32C57AA-7BF8-49AE-A2CC-9F42390F5A19\\",\\n}"},{"type":"xml","example":"<CreateRealTimeLogDeliveryResponse>\\r\\n\\t<RequestId>F32C57AA-7BF8-49AE-A2CC-9F42390F5A19</RequestId>\\r\\n</CreateRealTimeLogDeliveryResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '创建实时日志投递', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyRealtimeLogDelivery' => [ + 'summary' => '调用ModifyRealtimeLogDelivery更改域名实时日志投递，一个域名仅支持投递单个Logstore。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111875', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的ProjectName。', + 'type' => 'string', + 'required' => true, + 'example' => 'testProject', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的LogStoreName。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestLog', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的地域，详情请参见[实时日志服务推送地域](~~144883~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'ch-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '修改实时日志投递的域名，仅支持修改单个。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Internal occasional exception, please try again later.', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n}"},{"type":"xml","example":"<ModifyRealtimeLogDeliveryResponse>\\r\\n\\t<RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\r\\n</ModifyRealtimeLogDeliveryResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '修改实时日志投递', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRealtimeLogDelivery' => [ + 'summary' => '调用DeleteRealtimeLogDelivery删除实时日志推送域名。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111708', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '删除实时日志投递服务域名，多个用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的ProjectName。', + 'type' => 'string', + 'required' => true, + 'example' => 'ProjectName', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的LogStoreName。', + 'type' => 'string', + 'required' => true, + 'example' => 'LogstoreName', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的地域，详情请参见[实时日志投递用户Region列表](~~144883~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service is not authorized.', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n}"},{"type":"xml","example":"<DeleteRealtimeLogDeliveryResponse>\\r\\n\\t<RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\r\\n</DeleteRealtimeLogDeliveryResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '删除实时日志投递', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableRealtimeLogDelivery' => [ + 'summary' => '调用DisableRealtimeLogDelivery暂停域名实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111855', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '暂停实时日志投递服务域名，多个用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的ProjectName。', + 'type' => 'string', + 'required' => false, + 'example' => 'ProjectName', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的LogStoreName。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LogstoreName', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的地域，详情请参见[实时日志投递用户Region列表](~~144883~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'Domain.NotFound', + 'errorMessage' => 'Domain not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n}"},{"type":"xml","example":"<DisableRealtimeLogDeliveryResponse>\\r\\n\\t<RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\r\\n</DisableRealtimeLogDeliveryResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '暂停实时日志投递', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableRealtimeLogDelivery' => [ + 'summary' => '调用EnableRealtimeLogDelivery开启域名实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111857', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '开启实时日志投递服务域名，多个域名之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的ProjectName。', + 'type' => 'string', + 'required' => false, + 'example' => 'ProjectName', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的LogStoreName。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LogstoreName', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的地域，详情请参见[实时日志投递用户Region列表](~~144883~~)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'Domain.NotFound', + 'errorMessage' => 'Domain not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n}"},{"type":"xml","example":"<EnableRealtimeLogDeliveryResponse>\\r\\n\\t<RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\r\\n</EnableRealtimeLogDeliveryResponse>\\r\\n\\r\\n","errorExample":""}]', + 'title' => '开启实时日志投递', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListRealtimeLogDelivery' => [ + 'summary' => '查询用户下所有实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111862', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30559C03-86C9-4EEC-B840-0DC5F5A2189B', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RealtimeLogDeliveryInfo' => [ + 'description' => '日志信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。取值：'."\n" + .'- online：正在服务。'."\n" + .'- offline：停止服务。', + 'type' => 'string', + 'example' => 'online', + ], + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DmId' => [ + 'description' => '域名ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1001010', + ], + 'Region' => [ + 'description' => '实时投递sls的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Logstore' => [ + 'description' => '实时投递sls的LogStoreName。', + 'type' => 'string', + 'example' => 'test', + ], + 'Project' => [ + 'description' => '实时投递sls的ProjectName。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30559C03-86C9-4EEC-B840-0DC5F5A2189B\\",\\n \\"Content\\": {\\n \\"RealtimeLogDeliveryInfo\\": [\\n {\\n \\"Status\\": \\"online\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"DmId\\": 1001010,\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Logstore\\": \\"test\\",\\n \\"Project\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取实时日志投递', + ], + 'DescribeDomainRealtimeLogDelivery' => [ + 'summary' => '调用DescribeDomainRealtimeLogDelivery查询域名实时日志投递信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111792', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '开启实时日志投递服务域名，仅支持查询单个。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '域名实时投递状态。取值：'."\n" + ."\n" + .'- **online**：投递中。'."\n" + .'- **offline**：停止投递。', + 'type' => 'string', + 'example' => 'online', + ], + 'Logstore' => [ + 'description' => '实时投递sls的LogStoreName。', + 'type' => 'string', + 'example' => 'LogstoreName', + ], + 'Project' => [ + 'description' => '实时投递sls的ProjectName。', + 'type' => 'string', + 'example' => 'ProjectName', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2F8F3852-912F-42AC-80EB-F1CF4284DE93', + ], + 'Region' => [ + 'description' => '实时投递sls的地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service is not authorized.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"online\\",\\n \\"Logstore\\": \\"LogstoreName\\",\\n \\"Project\\": \\"ProjectName\\",\\n \\"RequestId\\": \\"2F8F3852-912F-42AC-80EB-F1CF4284DE93\\",\\n \\"Region\\": \\"cn-shanghai\\"\\n}","errorExample":"{\\n \\"Project\\":\\"test\\",\\n \\"Logstore\\":\\"test\\",\\n \\"Region\\":\\"cn-shanghai\\",\\n \\"Status\\":\\"online\\",\\n \\"RequestId\\":\\"2F8F3852-912F-42AC-80EB-F1CF4284DE93\\"\\n}"},{"type":"xml","example":"<DescribeDomainRealtimeLogDeliveryResponse>\\r\\n\\t<Project>test</Project>\\r\\n\\t<Logstore>test</Logstore>\\r\\n\\t<Region>cn-shanghai</Region>\\r\\n\\t<Status>online</Status>\\r\\n\\t<RequestId>2F8F3852-912F-42AC-80EB-F1CF4284DE93</RequestId>\\r\\n</DescribeDomainRealtimeLogDeliveryResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询实时日志投递信息', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRealtimeDeliveryAcc' => [ + 'summary' => '调用DescribeRealtimeDeliveryAcc查询实时日志投递次数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111827', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志起始时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-10-20T04:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-10-20T05:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度，单位：秒。根据您指定**StartTime**和**EndTime**两者的时间跨度，该参数取值如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持**300**、**3600**、 **86400**，如果不传该参数，默认值为**300**。'."\n" + ."\n" + .'- 3-31天（不包含31天整）支持**3600**和**86400**，如果不传该参数，默认值为**3600**。'."\n" + ."\n" + .'- 31天及以上支持**86400**，如果不传该参数，默认值为**86400**。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时日志投递的Project。默认查询所有Project。', + 'type' => 'string', + 'required' => false, + 'example' => 'Project', + ], + ], + [ + 'name' => 'LogStore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时日志投递的Logstore。默认查询所有Logstore。', + 'type' => 'string', + 'required' => false, + 'example' => 'LogStore', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '684306D2-2511-4977-991D-CE97E91FD7C0', + ], + 'ReatTimeDeliveryAccData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccData' => [ + 'description' => '实时日志信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2018-09-03T06:00:00Z', + ], + 'FailedNum' => [ + 'description' => '实时日志投递失败次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SuccessNum' => [ + 'description' => '实时日志投递成功次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not math the specified start time.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"684306D2-2511-4977-991D-CE97E91FD7C0\\",\\n \\"ReatTimeDeliveryAccData\\": {\\n \\"AccData\\": [\\n {\\n \\"TimeStamp\\": \\"2018-09-03T06:00:00Z\\",\\n \\"FailedNum\\": 2,\\n \\"SuccessNum\\": 2\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"684306D2-2511-4977-991D-CE97E91FD7C0\\",\\n \\"ReatTimeDeliveryAccData\\": {\\n \\"AccData\\": [\\n {\\n \\"TimeStamp\\": \\"2018-09-03T06:00:00Z\\",\\n \\"FailedNum\\": 0,\\n \\"SuccessNum\\": 321321\\n },\\n {\\n \\"TimeStamp\\": \\"2018-09-03T07:00:00Z\\",\\n \\"FailedNum\\": 0,\\n \\"SuccessNum\\": 32943\\n }\\n ...\\n ]\\n }\\n}"},{"type":"xml","example":"<DescribeRealtimeDeliveryAccResponse>\\r\\n\\t<RequestId>684306D2-2511-4977-991D-CE97E91FD7C0</RequestId>\\r\\n\\t<ReatTimeDeliveryAccData>\\r\\n\\t\\t<AccData>\\r\\n\\t\\t\\t<TimeStamp>2018-09-03T06:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<FailedNum>0</FailedNum>\\r\\n\\t\\t\\t<SuccessNum>321321</SuccessNum>\\r\\n\\t\\t</AccData>\\r\\n\\t\\t<AccData>\\r\\n\\t\\t\\t<TimeStamp>2018-09-03T07:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<FailedNum>0</FailedNum>\\r\\n\\t\\t\\t<SuccessNum>32943</SuccessNum>\\r\\n\\t\\t</AccData>\\r\\n\\t</ReatTimeDeliveryAccData>\\r\\n</DescribeRealtimeDeliveryAccResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询实时日志投递次数', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListRealtimeLogDeliveryInfos' => [ + 'summary' => '调用ListRealtimeLogDeliveryInfos查询所有实时日志投递服务信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111864', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '95D5B69F-8AEC-419B-8F3A-612B35032B0D', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RealtimeLogDeliveryInfos' => [ + 'description' => '日志信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Logstore' => [ + 'description' => '实时投递sls的LogstoreName。', + 'type' => 'string', + 'example' => 'LogstoreName', + ], + 'Project' => [ + 'description' => '实时投递sls的ProjectName。', + 'type' => 'string', + 'example' => 'ProjectName', + ], + 'Region' => [ + 'description' => '实时投递sls的地域，详情请参见[实时日志投递用户Region列表](~~144883~~)。', + 'type' => 'string', + 'example' => 'ch-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service is not authorized.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95D5B69F-8AEC-419B-8F3A-612B35032B0D\\",\\n \\"Content\\": {\\n \\"RealtimeLogDeliveryInfos\\": [\\n {\\n \\"Logstore\\": \\"LogstoreName\\",\\n \\"Project\\": \\"ProjectName\\",\\n \\"Region\\": \\"ch-shanghai\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListRealtimeLogDeliveryInfosResponse>\\r\\n\\t<Content>\\r\\n\\t\\t<RealtimeLogDeliveryInfos>\\r\\n\\t\\t\\t<Project>test</Project>\\r\\n\\t\\t\\t<Logstore>test</Logstore>\\r\\n\\t\\t\\t<Region>cn-shanghai</Region>\\r\\n\\t\\t</RealtimeLogDeliveryInfos>\\r\\n\\t\\t<RealtimeLogDeliveryInfos>\\r\\n\\t\\t\\t<Project>test1</Project>\\r\\n\\t\\t\\t<Logstore>test2</Logstore>\\r\\n\\t\\t\\t<Region>cn-shanghai</Region>\\r\\n\\t\\t</RealtimeLogDeliveryInfos>\\r\\n\\t</Content>\\r\\n\\t<RequestId>95D5B69F-8AEC-419B-8F3A-612B35032B0D</RequestId>\\r\\n</ListRealtimeLogDeliveryInfosResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询实时日志投递信息列表', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListRealtimeLogDeliveryDomains' => [ + 'summary' => '调用ListRealtimeLogDeliveryDomains查询实时日志投递服务下所有域名。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111863', + 'abilityTreeNodes' => [ + 'FEATUREcdnXDFG0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的ProjectName，多个用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'ProjectName', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的LogStoreName，多个用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'LogstoreName', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递sls的地域，多个用英文逗号（,）分隔。'."\n" + ."\n" + .'地域详情请参见[实时日志投递用户Region列表](~~144883~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'ch-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '95D5B69F-8AEC-419B-8F3A-612B35032B0D', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Domains' => [ + 'description' => '域名信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- **online**：正在服务。'."\n" + ."\n" + .'- **offline**：停止服务。', + 'type' => 'string', + 'example' => 'online', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com ', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service is not authorized.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95D5B69F-8AEC-419B-8F3A-612B35032B0D\\",\\n \\"Content\\": {\\n \\"Domains\\": [\\n {\\n \\"Status\\": \\"online\\",\\n \\"DomainName\\": \\"example.com \\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"Content\\":{\\n \\"Domains\\":[\\n { \\n \\"DomainName\\":\\"a.xxx.com\\",\\n \\"Status\\":\\"online\\"\\n },\\n { \\n \\"DomainName\\":\\"b.xxx.com\\",\\n \\"Status\\":\\"offline\\"\\n }\\n ...\\n ]\\n },\\n \\"RequestId\\":\\"95D5B69F-8AEC-419B-8F3A-612B35032B0D\\"\\n}"},{"type":"xml","example":"<Content>\\n <Domains>\\n <DomainName>example.com</DomainName>\\n <Status>online</Status>\\n </Domains>\\n <Domains>\\n <DomainName>aliyundoc.com</DomainName>\\n <Status>offline</Status>\\n </Domains>\\n</Content>\\n<RequestId>95D5B69F-8AEC-419B-8F3A-612B35032B0D</RequestId>","errorExample":""}]', + 'title' => '查询实时日志投递域名', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainCustomLogConfig' => [ + 'summary' => '调用DescribeDomainCustomLogConfig查询域名自定义日志格式配置信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111770', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名，只支持单个查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => '日志配置ID。', + 'type' => 'string', + 'example' => '123', + ], + 'Tag' => [ + 'description' => '日志配置tag信息。', + 'type' => 'string', + 'example' => 'book', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '94E3559F-7B6A-4A5E-AFFD-44E2A208A249', + ], + 'Remark' => [ + 'description' => '具体配置格式。', + 'type' => 'string', + 'example' => '$time_iso8601_$request_method_$', + ], + 'Sample' => [ + 'description' => '样例。', + 'type' => 'string', + 'example' => '[9/Jun/2015:01:58:09+0800]188.165.15.75-1542\\"-\\"\\"GET http://www.aliyun.com/index.html\\', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'Config.NotFound', + 'errorMessage' => 'The domain provided doesn\'t apply any custom log config, please refer to the standard log config.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigId\\": \\"123\\",\\n \\"Tag\\": \\"book\\",\\n \\"RequestId\\": \\"94E3559F-7B6A-4A5E-AFFD-44E2A208A249\\",\\n \\"Remark\\": \\"$time_iso8601_$request_method_$\\",\\n \\"Sample\\": \\"[9/Jun/2015:01:58:09+0800]188.165.15.75-1542\\\\\\\\\\\\\\"-\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"GET http://www.aliyun.com/index.html\\\\\\\\\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainCustomLogConfigResponse>\\r\\n\\t<ConfigId>25473b84-d598-498e-b148-f23d0a27df52</ConfigId>\\r\\n\\t<Tag>book</Tag>\\r\\n\\t<Remark>$time_iso8601_$request_method_$server_protocol.....</Remark>\\r\\n\\t<Sample>[9/Jun/2015:01:58:09+0800]188.165.15.75-1542"-""GET http://www.aliyun.com/index.html"2001912830MISS"Mozilla/5.0 (compatible; AhrefsBot/5.0; +http://ahrefs.com/robot/)</Sample>\\r\\n\\t<RequestId>1805F349-0A2B-41D9-B4AD-33632AFC27F1</RequestId>\\r\\n</DescribeDomainCustomLogConfigResponse>","errorExample":""}]', + 'title' => '查询自定义日志配置-按域名', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCustomLogConfig' => [ + 'summary' => '调用DescribeCustomLogConfig根据configId查询自定义日志配置详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111761', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => '日志配置tag信息。', + 'type' => 'string', + 'example' => 'img1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '94E3559F-7B6A-4A5E-AFFD-44E2A208A249', + ], + 'Remark' => [ + 'description' => '具体配置格式。', + 'type' => 'string', + 'example' => '$time_iso8601_$request_method_$', + ], + 'Sample' => [ + 'description' => '样例。', + 'type' => 'string', + 'example' => '"[9/Jun/2015:01:58:09 +0800] 188.165.15.75 - 1542 \\"-\\" \\"GEThttp: //www.aliyun.com/index.html\\" 200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'Illegal ConfigId', + ], + ], + [ + [ + 'errorCode' => 'Config.NotFound', + 'errorMessage' => 'Config does not exist or does not belong to the current user ', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Tag\\": \\"img1\\",\\n \\"RequestId\\": \\"94E3559F-7B6A-4A5E-AFFD-44E2A208A249\\",\\n \\"Remark\\": \\"$time_iso8601_$request_method_$\\",\\n \\"Sample\\": \\"\\\\\\"[9/Jun/2015:01:58:09 +0800] 188.165.15.75 - 1542 \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"GEThttp: //www.aliyun.com/index.html\\\\\\\\\\\\\\" 200\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomLogConfigResponse>\\n <Tag>img1</Tag>\\n <RequestId>94E3559F-7B6A-4A5E-AFFD-44E2A208A249</RequestId>\\n <Remark>$time_iso8601_$request_method_$</Remark>\\n <Sample>\\"[9/Jun/2015:01:58:09 +0800] 188.165.15.75 - 1542 \\\\\\"-\\\\\\" \\\\\\"GEThttp: //www.aliyun.com/index.html\\\\\\" 200</Sample>\\n</DescribeCustomLogConfigResponse>","errorExample":""}]', + 'title' => '查询自定义日志配置-按日志配置ID', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnDomainLogs' => [ + 'summary' => '调用DescribeCdnDomainLogs查询域名的离线日志下载地址。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111729', + 'abilityTreeNodes' => [ + 'FEATUREcdnGZSOSW', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名，只支持单个查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认**300**，最大**1000**，取值：**1**~**1000**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1000', + 'example' => '300', + 'default' => '300', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围：大于**1**的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需晚于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'DomainLogDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainLogDetail' => [ + 'description' => 'DomainLogDetail组成的数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogCount' => [ + 'description' => '本页返回的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'LogInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfoDetail' => [ + 'description' => 'LogInfoDetail组成的数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。'."\n", + 'type' => 'string', + 'example' => '2015-05-23T14:00:00Z', + ], + 'LogSize' => [ + 'description' => '日志大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '258', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2015-05-23T13:00:00Z', + ], + 'LogName' => [ + 'description' => '日志名称。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com_2015_05_23_2100_2200.gz', + ], + 'LogPath' => [ + 'description' => '日志路径。', + 'type' => 'string', + 'example' => 'guide.aliyundoc.com-hangzhou.xxx', + ], + ], + ], + ], + ], + ], + 'PageInfos' => [ + 'description' => 'PageInfoDetail组成的数据。', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"DomainLogDetails\\": {\\n \\"DomainLogDetail\\": [\\n {\\n \\"LogCount\\": 10,\\n \\"DomainName\\": \\"example.com\\",\\n \\"LogInfos\\": {\\n \\"LogInfoDetail\\": [\\n {\\n \\"EndTime\\": \\"2015-05-23T14:00:00Z\\",\\n \\"LogSize\\": 258,\\n \\"StartTime\\": \\"2015-05-23T13:00:00Z\\",\\n \\"LogName\\": \\"demo.aliyundoc.com_2015_05_23_2100_2200.gz\\",\\n \\"LogPath\\": \\"guide.aliyundoc.com-hangzhou.xxx\\"\\n }\\n ]\\n },\\n \\"PageInfos\\": {\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 20\\n }\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeCdnDomainLogsResponse>\\n<RequestId>077D0284-F041-4A41-A932-B48377FDAA25</RequestId>\\n<DomainLogDetails>\\n <DomainLogDetail>\\n <LogInfos>\\n <LogInfoDetail>\\n <LogName>demo.aliyundoc.com_2018_03_25_180000_190000.gz</LogName>\\n <LogPath>guide.aliyundoc.com/image.example.com/2018_03_25/demo.aliyundoc.com_2018_03_25_180000_190000.gz?xxx</LogPath>\\n <EndTime>2018-05-31T04:00:00Z</EndTime>\\n <StartTime>2018-05-31T03:00:00Z</StartTime>\\n <LogSize>2645401</LogSize>\\n </LogInfoDetail>\\n <LogInfoDetail>\\n <LogName>demo.aliyundoc.com_2018_03_25_190000_200000.gz</LogName>\\n <LogPath>guide.aliyundoc.com/demo.example.com/2018_03_25/demo.aliyundoc.com_2018_03_25_190000_200000.gz?xxx</LogPath>\\n <EndTime>2018-05-31T06:00:00Z</EndTime>\\n <StartTime>2018-05-31T05:00:00Z</StartTime>\\n <LogSize>2653965</LogSize>\\n </LogInfoDetail>\\n </LogInfos>\\n <LogCount>20</LogCount>\\n <PageInfos>\\n <PageIndex>1</PageIndex>\\n <PageSize>20</PageSize>\\n <Total>20</Total>\\n </PageInfos>\\n <DomainName>example.com</DomainName>\\n </DomainLogDetail>\\n</DomainLogDetails>\\n</DescribeCdnDomainLogsResponse>","errorExample":""}]', + 'title' => '查询离线日志下载地址', + 'description' => '- 如果不指定**StartTime**和**EndTime**，该接口默认读取过去24小时的数据；指定**StartTime**和**EndTime**时，按指定的起止时间查询。'."\n" + .'- 查询数据的时间粒度为一小时。'."\n" + .'- 单个用户的调用频率为：100次/秒。'."\n" + .'- 仅支持查询最近一个月的日志记录（开始时间和当前时间跨度不大于31天）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDomainsByLogConfigId' => [ + 'summary' => '调用ListDomainsByLogConfigId按日志配置ID查询域名列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '111859', + 'abilityTreeNodes' => [ + 'FEATUREcdnGZSOSW', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + 'Domains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Domain' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidConfigId', + 'errorMessage' => 'Illegal ConfigId', + ], + ], + [ + [ + 'errorCode' => 'Domains.NotFound', + 'errorMessage' => 'No domain used in this log config', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n \\"Domains\\": {\\n \\"Domain\\": [\\n \\"example.com\\"\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<ListDomainsByLogConfigIdResponse>\\r\\n\\t<RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\r\\n\\t<Domains>\\r\\n\\t\\t<Domain>example.com</Domain>\\r\\n\\t\\t<Domain>image.developer.aliyundoc.com</Domain>\\r\\n\\t</Domains>\\r\\n</ListDomainsByLogConfigIdResponse>","errorExample":""}]', + 'title' => '查询域名列表-按日志配置ID', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUserCustomLogConfig' => [ + 'summary' => '调用ListUserCustomLogConfig查询用户下所有自定义日志配置信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '111866', + 'abilityTreeNodes' => [ + 'FEATUREcdnGZSOSW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '95D5B69F-8AEC-419B-8F3A-612B35032B0D', + ], + 'ConfigIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConfigId' => [ + 'description' => '日志配置ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '日志配置ID。', + 'type' => 'string', + 'example' => 'c3bb2c78-2915-4d5a-b6a1-557789255555', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ConfgIds.NotFound', + 'errorMessage' => 'You don\'t have any custom log config, please add first.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95D5B69F-8AEC-419B-8F3A-612B35032B0D\\",\\n \\"ConfigIds\\": {\\n \\"ConfigId\\": [\\n \\"c3bb2c78-2915-4d5a-b6a1-557789255555\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListUserCustomLogConfigResponse>\\r\\n\\t<RequestId>95D5B69F-8AEC-419B-8F3A-612B35032B0D</RequestId>\\r\\n\\t<ConfigIds>\\r\\n\\t\\t<ConfigId>c3bb2c78-2915-4d5a-b6a1-557789255555</ConfigId>\\r\\n\\t\\t<ConfigId>25473b84-d598-498e-b148-f23d0a255555</ConfigId>\\r\\n\\t\\t<ConfigId>1f1e6c6e-6701-4193-ae4d-54bf3e555555</ConfigId>\\r\\n\\t</ConfigIds>\\r\\n</ListUserCustomLogConfigResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询自定义日志配置ID', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OpenCdnService' => [ + 'summary' => '调用OpenCdnService开通CDN服务。开通服务后才能进行域名操作。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111877', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '开通服务的计费类型。取值为**PayByTraffic**，表示按流量计费。', + 'type' => 'string', + 'required' => true, + 'example' => 'PayByTraffic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '97C68796-EB7F-4D41-9D5B-12B909D76508', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInternetChargeType.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter InternetChargeType is not valid.', + ], + [ + 'errorCode' => 'CdnService.HasOpened', + 'errorMessage' => 'Your cdn service has opened.', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account does not have enough balance.', + ], + [ + 'errorCode' => 'NoRealNameAuthentication', + 'errorMessage' => 'Real name authentication is needed.', + ], + [ + 'errorCode' => 'VertifyFailInvalidPayMethod', + 'errorMessage' => 'INVALID PAY METHOD', + ], + [ + 'errorCode' => 'VertifyFailUserProfileComplete', + 'errorMessage' => 'MISSING USERPROFILE', + ], + [ + 'errorCode' => 'CreateOrderFailed', + 'errorMessage' => 'Create order failed', + ], + [ + 'errorCode' => 'QueryInfoError', + 'errorMessage' => 'Create order failed', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The input parameter OwnerId or OwnerAccount that is mandatory for processing this request is not supplied.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.Intl', + 'errorMessage' => 'User not authorized to open Intl service.', + ], + [ + 'errorCode' => 'Forbidden.BidUser', + 'errorMessage' => 'Bid user is limited to open service.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"97C68796-EB7F-4D41-9D5B-12B909D76508\\"\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<OpenCdnServiceResponse>\\r\\n <RequestId>97C68796-EB7F-4D41-9D5B-12B909D76508</RequestId>\\r\\n</OpenCdnServiceResponse>","errorExample":""}]', + 'title' => '开通CDN服务', + 'description' => '- 一个用户只能开通一次，且要求阿里云账号已通过实名认证。'."\n" + .'- 单用户调用频率：5次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnRegionAndIsp' => [ + 'summary' => '调用DescribeCdnRegionAndIsp查询地域和运营商列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111736', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2387C335-932C-4E1E-862C-1C4363B6DE72', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NameEn' => [ + 'description' => '英文名称。', + 'type' => 'string', + 'example' => 'liaoning', + ], + 'NameZh' => [ + 'description' => '中文名称。', + 'type' => 'string', + 'example' => '辽宁省', + ], + ], + ], + ], + ], + ], + 'Isps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Isp' => [ + 'description' => '运营商列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NameEn' => [ + 'description' => '英文名称。', + 'type' => 'string', + 'example' => 'unicom', + ], + 'NameZh' => [ + 'description' => '中文名称。', + 'type' => 'string', + 'example' => '联通', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2387C335-932C-4E1E-862C-1C4363B6DE72\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"NameEn\\": \\"liaoning\\",\\n \\"NameZh\\": \\"辽宁省\\"\\n }\\n ]\\n },\\n \\"Isps\\": {\\n \\"Isp\\": [\\n {\\n \\"NameEn\\": \\"unicom\\",\\n \\"NameZh\\": \\"联通\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<Isps>\\n <Isp>\\n <NameZh>电信</NameZh>\\n <NameEn>telecom</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>移动</NameZh>\\n <NameEn>mobile</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>教育网</NameZh>\\n <NameEn>cernet</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>铁通</NameZh>\\n <NameEn>tietong</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>其他</NameZh>\\n <NameEn>other</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>鹏博士</NameZh>\\n <NameEn>drpeng</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>联通</NameZh>\\n <NameEn>unicom</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>阿里巴巴</NameZh>\\n <NameEn>alibaba</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>中信网络</NameZh>\\n <NameEn>citic</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>方正宽带</NameZh>\\n <NameEn>dounder</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>海外ISP</NameZh>\\n <NameEn>overseas</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>有线通</NameZh>\\n <NameEn>ocn</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>华数</NameZh>\\n <NameEn>wasu</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>湖北广电</NameZh>\\n <NameEn>hrtn</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>重庆有线</NameZh>\\n <NameEn>cqccn</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>歌华有线</NameZh>\\n <NameEn>bjctv</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>天威视讯</NameZh>\\n <NameEn>topway</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>中国香港宽频</NameZh>\\n <NameEn>hkbn</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>澳大利亚电信</NameZh>\\n <NameEn>telstra</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>江西广电</NameZh>\\n <NameEn>jxsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>湖南广电</NameZh>\\n <NameEn>gbs</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>中国澳门电讯</NameZh>\\n <NameEn>ctm</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>黑龙江广电</NameZh>\\n <NameEn>ljwl</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>中华电信</NameZh>\\n <NameEn>cht</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>陕西广电</NameZh>\\n <NameEn>sxbctv</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>广电</NameZh>\\n <NameEn>ccn</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>长城宽带</NameZh>\\n <NameEn>gwbn</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>华数传媒</NameZh>\\n <NameEn>wasumedia</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>广东广电</NameZh>\\n <NameEn>gcable</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>辽宁广电</NameZh>\\n <NameEn>lnsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>河南广电</NameZh>\\n <NameEn>hensarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>山东广电</NameZh>\\n <NameEn>sdsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>江苏广电</NameZh>\\n <NameEn>jssarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>四川艾普</NameZh>\\n <NameEn>aipu</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>吉视传媒</NameZh>\\n <NameEn>jilincatv</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>四川广电</NameZh>\\n <NameEn>sicsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>安徽广电</NameZh>\\n <NameEn>anhuicatv</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>福建广电</NameZh>\\n <NameEn>fujiancatv</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>新疆广电</NameZh>\\n <NameEn>xjsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>贵州广电</NameZh>\\n <NameEn>guizhoucatv</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>局域网</NameZh>\\n <NameEn>local area network</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>湖南巨亚</NameZh>\\n <NameEn>hunanjy</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>珠江数码</NameZh>\\n <NameEn>zhujiangsm</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>北京宝联之星</NameZh>\\n <NameEn>baolian</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>印尼Telin</NameZh>\\n <NameEn>telin</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>印尼Indosat</NameZh>\\n <NameEn>indosat</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>上海驰联</NameZh>\\n <NameEn>shchilian</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>上海企舜</NameZh>\\n <NameEn>shqishun</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>皓宽网络</NameZh>\\n <NameEn>cnix</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>印度Sify</NameZh>\\n <NameEn>sify</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>印尼Zenlayer</NameZh>\\n <NameEn>zenlayer</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>印度TATA</NameZh>\\n <NameEn>tata</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>印度AirTel</NameZh>\\n <NameEn>airtel</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Telstra Global</NameZh>\\n <NameEn>telstraglobal</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Maxis</NameZh>\\n <NameEn>maxis</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>内蒙古广电</NameZh>\\n <NameEn>nmgcatv</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>JasTel</NameZh>\\n <NameEn>jastel</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Taiwan Fixed Network</NameZh>\\n <NameEn>taiwanfixednetwork</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Digital United</NameZh>\\n <NameEn>digitalunited</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>NTT</NameZh>\\n <NameEn>ntt</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>KDDI</NameZh>\\n <NameEn>kddi</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Korea Telecom</NameZh>\\n <NameEn>koreatelecom</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>TM Net</NameZh>\\n <NameEn>tmnet</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>True Internet</NameZh>\\n <NameEn>trueinternet</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>PT Aplikanusa Lintasarta</NameZh>\\n <NameEn>ptaplikanusalintasarta</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>VNPT</NameZh>\\n <NameEn>vnpt</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>EITC-DU</NameZh>\\n <NameEn>eitcdu</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Rostelecom</NameZh>\\n <NameEn>rostelecom</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>GLOBALNET</NameZh>\\n <NameEn>globalnet</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>ER-Telecom Holding</NameZh>\\n <NameEn>ertelecomholding</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Business Network Ltd</NameZh>\\n <NameEn>businessnetworkltd</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Vodafone</NameZh>\\n <NameEn>vodafone</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Level</NameZh>\\n <NameEn>level</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>TATA Communications(America)</NameZh>\\n <NameEn>tatacommunications</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>ENTER S.r.l.</NameZh>\\n <NameEn>entersrl</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Vodacom ENS</NameZh>\\n <NameEn>vodacomens</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Hurricane Electric</NameZh>\\n <NameEn>hurricaneelectric</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>CTA</NameZh>\\n <NameEn>cta</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Telefonica USA</NameZh>\\n <NameEn>telefonicausa</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Verizon Business</NameZh>\\n <NameEn>verizonbusiness</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Telefonica Data S.A.</NameZh>\\n <NameEn>telefonicadatasa</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>PLDT</NameZh>\\n <NameEn>pldt</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Viettel</NameZh>\\n <NameEn>viettel</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>RETN</NameZh>\\n <NameEn>retn</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>AIMS</NameZh>\\n <NameEn>aims</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>广西广电</NameZh>\\n <NameEn>guangxsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>河北广电</NameZh>\\n <NameEn>hebsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>湖南有线</NameZh>\\n <NameEn>hunsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>山东青岛广电</NameZh>\\n <NameEn>sdqdsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Level3</NameZh>\\n <NameEn>level3</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>宁夏广电</NameZh>\\n <NameEn>nxsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Zain</NameZh>\\n <NameEn>zain</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Singtel</NameZh>\\n <NameEn>singtel</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>BBIX</NameZh>\\n <NameEn>bbix</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>MSK-IX</NameZh>\\n <NameEn>mskix</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>TPIX</NameZh>\\n <NameEn>tpix</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Equinix</NameZh>\\n <NameEn>equinix</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>台湾之星</NameZh>\\n <NameEn>taiwanstar</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>阿里云</NameZh>\\n <NameEn>aliyun</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>TelekomMalaysia</NameZh>\\n <NameEn>telekommalaysia</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>KINX</NameZh>\\n <NameEn>kinx</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>SKBB</NameZh>\\n <NameEn>skbb</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>CAT</NameZh>\\n <NameEn>cat</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Ooredoo</NameZh>\\n <NameEn>ooredoo</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>Fareastone</NameZh>\\n <NameEn>fareastone telecom</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>全部</NameZh>\\n <NameEn>all</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>JIO</NameZh>\\n <NameEn>jio</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>甘肃广电</NameZh>\\n <NameEn>gssarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>天津广电</NameZh>\\n <NameEn>tjsarft</NameEn>\\n </Isp>\\n <Isp>\\n <NameZh>大连理工大学</NameZh>\\n <NameEn>dlut</NameEn>\\n </Isp>\\n</Isps>\\n<RequestId>9CEF1678-CAE9-4173-88C9-31DA0931BBAF</RequestId>\\n<Regions>\\n <Region>\\n <NameZh>河北省</NameZh>\\n <NameEn>hebei</NameEn>\\n </Region>\\n <Region>\\n <NameZh>宁夏回族自治区</NameZh>\\n <NameEn>ningxia</NameEn>\\n </Region>\\n <Region>\\n <NameZh>贵州省</NameZh>\\n <NameEn>guizhou</NameEn>\\n </Region>\\n <Region>\\n <NameZh>新疆维吾尔自治区</NameZh>\\n <NameEn>xinjiang</NameEn>\\n </Region>\\n <Region>\\n <NameZh>北京市</NameZh>\\n <NameEn>beijing</NameEn>\\n </Region>\\n <Region>\\n <NameZh>福建省</NameZh>\\n <NameEn>fujian</NameEn>\\n </Region>\\n <Region>\\n <NameZh>海南省</NameZh>\\n <NameEn>hainan</NameEn>\\n </Region>\\n <Region>\\n <NameZh>黑龙江省</NameZh>\\n <NameEn>heilongjiang</NameEn>\\n </Region>\\n <Region>\\n <NameZh>广东省</NameZh>\\n <NameEn>guangdong</NameEn>\\n </Region>\\n <Region>\\n <NameZh>广西壮族自治区</NameZh>\\n <NameEn>guangxi</NameEn>\\n </Region>\\n <Region>\\n <NameZh>浙江省</NameZh>\\n <NameEn>zhejiang</NameEn>\\n </Region>\\n <Region>\\n <NameZh>青海省</NameZh>\\n <NameEn>qinghai</NameEn>\\n </Region>\\n <Region>\\n <NameZh>江苏省</NameZh>\\n <NameEn>jiangsu</NameEn>\\n </Region>\\n <Region>\\n <NameZh>山西省</NameZh>\\n <NameEn>shanxi</NameEn>\\n </Region>\\n <Region>\\n <NameZh>河南省</NameZh>\\n <NameEn>henan</NameEn>\\n </Region>\\n <Region>\\n <NameZh>云南省</NameZh>\\n <NameEn>yunnan</NameEn>\\n </Region>\\n <Region>\\n <NameZh>西藏自治区</NameZh>\\n <NameEn>xizang</NameEn>\\n </Region>\\n <Region>\\n <NameZh>辽宁省</NameZh>\\n <NameEn>liaoning</NameEn>\\n </Region>\\n <Region>\\n <NameZh>湖南省</NameZh>\\n <NameEn>hunan</NameEn>\\n </Region>\\n <Region>\\n <NameZh>中国香港</NameZh>\\n <NameEn>China(Hong Kong)</NameEn>\\n </Region>\\n <Region>\\n <NameZh>陕西省</NameZh>\\n <NameEn>shaanxi</NameEn>\\n </Region>\\n <Region>\\n <NameZh>中国澳门</NameZh>\\n <NameEn>China(Macao)</NameEn>\\n </Region>\\n <Region>\\n <NameZh>安徽省</NameZh>\\n <NameEn>anhui</NameEn>\\n </Region>\\n <Region>\\n <NameZh>天津市</NameZh>\\n <NameEn>tianjin</NameEn>\\n </Region>\\n <Region>\\n <NameZh>江西省</NameZh>\\n <NameEn>jiangxi</NameEn>\\n </Region>\\n <Region>\\n <NameZh>湖北省</NameZh>\\n <NameEn>hubei</NameEn>\\n </Region>\\n <Region>\\n <NameZh>重庆市</NameZh>\\n <NameEn>chongqing</NameEn>\\n </Region>\\n <Region>\\n <NameZh>甘肃省</NameZh>\\n <NameEn>gansu</NameEn>\\n </Region>\\n <Region>\\n <NameZh>中国台湾</NameZh>\\n <NameEn>China(Taiwan)</NameEn>\\n </Region>\\n <Region>\\n <NameZh>山东省</NameZh>\\n <NameEn>shandong</NameEn>\\n </Region>\\n <Region>\\n <NameZh>吉林省</NameZh>\\n <NameEn>jilin</NameEn>\\n </Region>\\n <Region>\\n <NameZh>上海市</NameZh>\\n <NameEn>shanghai</NameEn>\\n </Region>\\n <Region>\\n <NameZh>四川省</NameZh>\\n <NameEn>sichuan</NameEn>\\n </Region>\\n <Region>\\n <NameZh>内蒙古自治区</NameZh>\\n <NameEn>neimenggu</NameEn>\\n </Region>\\n</Regions>","errorExample":""}]', + 'title' => '查询地域和运营商列表', + 'description' => '- CDN支持的地域及运营商列表会不定时更新，请您及时关注官网最新信息。'."\n" + .'- 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnOrderCommodityCode' => [ + 'summary' => '调用DescribeCdnOrderCommodityCode查询客户UID对应的商品Code。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '137446', + 'abilityTreeNodes' => [ + 'FEATUREcdnYC0IJ0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '原始商品Code。', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderCommodityCode' => [ + 'description' => '包含多组织单位OU（Organizational Unit）售卖的商品Code。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BFFCDFAD-DACC-484E-9BE6-0AF3B3A0DD23', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderCommodityCode\\": \\"xxx\\",\\n \\"RequestId\\": \\"BFFCDFAD-DACC-484E-9BE6-0AF3B3A0DD23\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnOrderCommodityCodeResponse>\\n <OrderCommodityCode>xxx</OrderCommodityCode>\\n <RequestId>BFFCDFAD-DACC-484E-9BE6-0AF3B3A0DD23</RequestId>\\n</DescribeCdnOrderCommodityCodeResponse>","errorExample":""}]', + 'title' => '查询商品Code', + ], + 'DescribeCdnService' => [ + 'summary' => '调用DescribeCdnService查询CDN服务状态。包括：当前计费类型、服务开通时间、下次生效的计费类型、当前业务状态等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111740', + 'abilityTreeNodes' => [ + 'FEATUREcdnYC0IJ0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ChangingAffectTime' => [ + 'description' => '下次计费类型生效时间，GMT时间。', + 'type' => 'string', + 'example' => '2019-11-27T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'ChangingChargeType' => [ + 'description' => '下次生效的计费类型。'."\n" + ."\n" + .'- **PayByTraffic**：流量。'."\n" + ."\n" + .'- **PayByBandwidth**：带宽峰值。', + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'OpeningTime' => [ + 'description' => '开通服务时间，ISO 8601时间格式。', + 'type' => 'string', + 'example' => '2019-02-28T13:11:49Z', + ], + 'InternetChargeType' => [ + 'description' => '当前计费类型。'."\n" + ."\n" + .'- **PayByTraffic**：流量。'."\n" + ."\n" + .'- **PayByBandwidth**：带宽峰值。', + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'aliuidxx', + ], + 'OperationLocks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LockReason' => [ + 'description' => '业务锁定状态。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LockReason' => [ + 'description' => '业务锁定的原因。financial：欠费。', + 'type' => 'string', + 'example' => 'financial', + ], + ], + ], + ], + ], + ], + 'ChangingDynamicBillingType' => [ + 'description' => '下次生效的动态加速计费方式。', + 'type' => 'string', + 'example' => 'DynamicHourTraffic', + ], + 'DynamicBillingType' => [ + 'description' => '动态加速计费方式。', + 'type' => 'string', + 'example' => 'DynamicHourTraffic', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnsupportedParameter', + 'errorMessage' => 'There is unsupported parameters', + ], + [ + 'errorCode' => 'InternetChargeTypeInvalid', + 'errorMessage' => 'The specified InternetChargeType is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ChangingAffectTime\\": \\"2019-11-27T16:00:00Z\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ChangingChargeType\\": \\"PayByTraffic\\",\\n \\"OpeningTime\\": \\"2019-02-28T13:11:49Z\\",\\n \\"InternetChargeType\\": \\"PayByTraffic\\",\\n \\"InstanceId\\": \\"aliuidxx\\",\\n \\"OperationLocks\\": {\\n \\"LockReason\\": [\\n {\\n \\"LockReason\\": \\"financial\\"\\n }\\n ]\\n },\\n \\"ChangingDynamicBillingType\\": \\"DynamicHourTraffic\\",\\n \\"DynamicBillingType\\": \\"DynamicHourTraffic\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnServiceResponse>\\n <ChangingAffectTime>2019-11-27T16:00:00Z</ChangingAffectTime>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <ChangingChargeType>PayByTraffic</ChangingChargeType>\\n <OpeningTime>2019-02-28T13:11:49Z</OpeningTime>\\n <InternetChargeType>PayByTraffic</InternetChargeType>\\n <InstanceId>aliuidxx</InstanceId>\\n <OperationLocks>\\n <LockReason>financial</LockReason>\\n </OperationLocks>\\n</DescribeCdnServiceResponse>","errorExample":""}]', + 'title' => '查询CDN服务状态', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnDomainByCertificate' => [ + 'summary' => '调用DescribeCdnDomainByCertificate根据证书信息获取加速域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111726', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + ], + 'parameters' => [ + [ + 'name' => 'SSLPub', + 'in' => 'query', + 'schema' => [ + 'description' => '证书公钥，需要base64编码后再进行encodeURIComponent。'."\n" + ."\n" + .'支持pem格式。', + 'type' => 'string', + 'required' => true, + 'example' => '******', + ], + ], + [ + 'name' => 'SSLStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '表示返回的域名列表只包含开启或关闭HTTPS的域名。'."\n" + ."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Exact', + 'in' => 'query', + 'schema' => [ + 'description' => '表示返回的域名列表是否与证书精准匹配。'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D', + ], + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => '证书信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CertStartTime' => [ + 'description' => '证书开始时间。', + 'type' => 'string', + 'example' => 'Nov 29 23:59:59 2017 GMT', + ], + 'CertExpireTime' => [ + 'description' => '证书过期时间。', + 'type' => 'string', + 'example' => 'Nov 29 00:00:00 2016 GMT', + ], + 'CertCaIsLegacy' => [ + 'description' => '证书CA废弃状态。取值：'."\n" + ."\n" + .'- **yes**：已废弃。'."\n" + ."\n" + .'- **no**：正常，未废弃。', + 'type' => 'string', + 'example' => 'yes', + ], + 'CertSubjectCommonName' => [ + 'description' => '证书所有者名称。', + 'type' => 'string', + 'example' => 'owner', + ], + 'CertType' => [ + 'description' => '证书类型，取值：**RSA**、**DSA**、**ECDSA**。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'DomainNames' => [ + 'description' => '证书匹配的域名（DNS字段），多个用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '*.example.com,aliyundoc.com', + ], + 'CertExpired' => [ + 'description' => '证书过期状态。 取值：'."\n" + ."\n" + .'- **yes**：已过期。'."\n" + ."\n" + .'- **no**：未过期。', + 'type' => 'string', + 'example' => 'yes', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1', + ], + 'DomainList' => [ + 'description' => '如果该返回值不为空，则将该列表与证书做匹配，多个用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => 'example.com,aliyundoc.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.FormatError', + 'errorMessage' => 'The format of the certificate is invalid.', + ], + [ + 'errorCode' => 'SSLPub.MissingParameter', + 'errorMessage' => 'The Cert parameter is required.', + ], + [ + 'errorCode' => 'Decode.Error', + 'errorMessage' => 'Error decoding the SSLPub certificate.', + ], + [ + 'errorCode' => 'Certificate.DecodeError', + 'errorMessage' => 'An error occurred while decoding the certificate.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D\\",\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"CertStartTime\\": \\"Nov 29 23:59:59 2017 GMT\\",\\n \\"CertExpireTime\\": \\"Nov 29 00:00:00 2016 GMT\\",\\n \\"CertCaIsLegacy\\": \\"yes\\",\\n \\"CertSubjectCommonName\\": \\"owner\\",\\n \\"CertType\\": \\"RSA\\",\\n \\"DomainNames\\": \\"*.example.com,aliyundoc.com\\",\\n \\"CertExpired\\": \\"yes\\",\\n \\"Issuer\\": \\"C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1\\",\\n \\"DomainList\\": \\"example.com,aliyundoc.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnDomainByCertificateResponse>\\n<RequestId>ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D</RequestId>\\n<content>\\n <Issuer>C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1</Issuer>\\n <CertType>RSA</CertType>\\n <CertSubjectCommonName>example.com</CertSubjectCommonName>\\n <CertStartTime>Nov 29 23:59:59 2017 GMT</CertStartTime>\\n <CertExpireTime>Nov 29 00:00:00 2016 GMT</CertExpireTime>\\n <DomainNames>*.example.com,aliyundoc.com</DomainNames>\\n <DomainList>example.com,aliyundoc.com</DomainList>\\n <CertExpired>yes</CertExpired>\\n <CertCaIsLegacy>yes</CertCaIsLegacy>\\n</content>\\n</DescribeCdnDomainByCertificateResponse>","errorExample":""}]', + 'title' => '查询域名-按证书', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainCertificateInfo' => [ + 'summary' => '调用DescribeDomainCertificateInfo查询指定加速域名证书信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111768', + 'abilityTreeNodes' => [ + 'FEATUREcdnD4PEWG', + 'FEATUREcdn4R6KLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持单个查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5C1E43DC-9E51-4771-82C0-7D5ECEB547A1', + ], + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => '证书信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CertExpireTime' => [ + 'description' => '证书过期时间。', + 'type' => 'string', + 'example' => '2018-06-03T22:03:39Z', + ], + 'CertLife' => [ + 'description' => '证书时长单位。'."\n" + ."\n" + .'- **months**：月。'."\n" + .'- **years**：年。', + 'type' => 'string', + 'example' => 'months', + ], + 'Status' => [ + 'description' => '证书状态。'."\n" + ."\n" + .'- **success**：已生效。'."\n" + .'- **checking**：检测域名是否在阿里云CDN。'."\n" + .'- **cname_error**：域名没有切到阿里云CDN。'."\n" + .'- **top\\_domain\\_cname\\_error**：顶级域名没有切到阿里云CDN。'."\n" + .'- **domain\\_invalid**：域名包含非法字符。'."\n" + .'- **unsupport\\_wildcard**：不支持泛域名。'."\n" + .'- **applying**：证书申请中。'."\n" + .'- **get\\_token\\_timeout**：证书申请超时。'."\n" + .'- **check\\_token\\_timeout**：校验超时。'."\n" + .'- **get\\_cert\\_timeout**：获取证书超时。'."\n" + .'- **failed**：证书申请失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'CertUpdateTime' => [ + 'description' => '证书更新时间。', + 'type' => 'string', + 'example' => '2018-06-03T22:03:39Z', + ], + 'CertDomainName' => [ + 'description' => '证书匹配的域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'ServerCertificateStatus' => [ + 'description' => 'https开启状态。'."\n" + ."\n" + .'- **on**：已开启。'."\n" + ."\n" + .'- **off**：未开启。', + 'type' => 'string', + 'example' => 'on', + ], + 'CertOrg' => [ + 'description' => '该证书签发的CA名称。', + 'type' => 'string', + 'example' => 'Let\'s Encrypt', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CertStartTime' => [ + 'description' => '证书开始时间。', + 'type' => 'string', + 'example' => '2018-06-03T22:03:39Z', + ], + 'CertType' => [ + 'description' => '证书类型。'."\n" + ."\n" + .'- **free**：免费证书。'."\n" + ."\n" + .'- **cas**：云盾证书。'."\n" + ."\n" + .'- **upload**：自定义上传。', + 'type' => 'string', + 'example' => 'free', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DomainCnameStatus' => [ + 'description' => '域名CNAME状态。'."\n" + ."\n" + .'- **ok**：域名CNAME已切到阿里云CDN。'."\n" + ."\n" + .'- **cname_error**：域名CNAME错误，没有切到阿里云CDN。'."\n" + ."\n" + .'- **top_domain_cname_error**：顶级域名CNAME错误，没有切到阿里云CDN。'."\n" + ."\n" + .'- **unsupport_wildcard**：不支持泛域名。', + 'type' => 'string', + 'example' => 'ok', + ], + 'ServerCertificate' => [ + 'description' => '证书公钥。', + 'type' => 'string', + 'example' => 'asdadaxxxx', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => '9002448', + ], + 'CertRegion' => [ + 'description' => '证书区域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SignatureDoesNotMatch', + 'errorMessage' => 'The signature we calculated does not match the one you provided. Please refer to the API reference about authentication for details.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to internal error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5C1E43DC-9E51-4771-82C0-7D5ECEB547A1\\",\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"CertExpireTime\\": \\"2018-06-03T22:03:39Z\\",\\n \\"CertLife\\": \\"months\\",\\n \\"Status\\": \\"success\\",\\n \\"CertUpdateTime\\": \\"2018-06-03T22:03:39Z\\",\\n \\"CertDomainName\\": \\"example.com\\",\\n \\"ServerCertificateStatus\\": \\"on\\",\\n \\"CertOrg\\": \\"Let\'s Encrypt\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"CertStartTime\\": \\"2018-06-03T22:03:39Z\\",\\n \\"CertType\\": \\"free\\",\\n \\"CertName\\": \\"example.com\\",\\n \\"DomainCnameStatus\\": \\"ok\\",\\n \\"ServerCertificate\\": \\"asdadaxxxx\\",\\n \\"CertId\\": \\"9002448\\",\\n \\"CertRegion\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainCertificateInfoResponse>\\n <RequestId>5C1E43DC-9E51-4771-82C0-7D5ECEB547A1</RequestId>\\n <CertInfos>\\n <CertExpireTime>2018-06-03T22:03:39Z</CertExpireTime>\\n <CertLife>months</CertLife>\\n <Status>success</Status>\\n <CertUpdateTime>2018-06-03T22:03:39Z</CertUpdateTime>\\n <CertDomainName>example.com</CertDomainName>\\n <ServerCertificateStatus>on</ServerCertificateStatus>\\n <CertOrg>Let\'s Encrypt</CertOrg>\\n <DomainName>example.com</DomainName>\\n <CertStartTime>2018-06-03T22:03:39Z</CertStartTime>\\n <CertType>free</CertType>\\n <CertName>example.com</CertName>\\n <DomainCnameStatus>ok</DomainCnameStatus>\\n <ServerCertificate>asdadaxxxx</ServerCertificate>\\n </CertInfos>\\n</DescribeDomainCertificateInfoResponse>","errorExample":""}]', + 'title' => '查询域名证书信息', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnCertificateDetail' => [ + 'summary' => '调用DescribeCdnCertificateDetail查询CDN证书详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111721', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '证书名称，仅支持查询单个。', + 'type' => 'string', + 'required' => true, + 'example' => 'cert-15480655xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'cert-15480655xxxx', + ], + 'Key' => [ + 'description' => '证书KEY。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Cert' => [ + 'description' => '证书。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\nMIIFzDCCBLSgAwIBxxxx', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '881049', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvaildParameter', + 'errorMessage' => 'The parameter you provided is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertName\\": \\"cert-15480655xxxx\\",\\n \\"Key\\": \\"xxxx\\",\\n \\"Cert\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\nMIIFzDCCBLSgAwIBxxxx\\",\\n \\"CertId\\": 881049,\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnCertificateDetailResponse>\\n <CertName>cert-15480655xxxx</CertName>\\n <Key>xxxx</Key>\\n <Cert>-----BEGIN CERTIFICATE-----\\\\nMIIFzDCCBLSgAwIBxxxx</Cert>\\n <CertId>881049</CertId>\\n <RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>\\n</DescribeCdnCertificateDetailResponse>","errorExample":""}]', + 'title' => '查询证书详情', + 'description' => '> 单用户调用频率：20次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnCertificateList' => [ + 'summary' => '调用DescribeCdnCertificateList按照域名查询证书列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111722', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用英文逗号（,）分隔。'."\n" + ."\n" + .'如果不传入该参数，默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FC0E34AC-0239-44A7-AB0E-800DE522C8DA', + ], + 'CertificateListModel' => [ + 'description' => 'CertificateListModel类型。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '证书个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CertList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Cert' => [ + 'description' => '证书列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LastTime' => [ + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1512388610', + ], + 'Fingerprint' => [ + 'description' => '证书指纹。', + 'type' => 'string', + 'example' => '2ED68FD33786C5B42950D40A6C50353575BB****', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => '证书1', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => 'CO****', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Common' => [ + 'description' => '证书中的CN属性，一般是一个域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FlowControlError', + 'errorMessage' => 'The request was denied due to flow control.', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Cdn::2018-05-10::DescribeCdnSSLCertificateList', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FC0E34AC-0239-44A7-AB0E-800DE522C8DA\\",\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": {\\n \\"Cert\\": [\\n {\\n \\"LastTime\\": 1512388610,\\n \\"Fingerprint\\": \\"2ED68FD33786C5B42950D40A6C50353575BB****\\",\\n \\"CertName\\": \\"证书1\\",\\n \\"Issuer\\": \\"CO****\\",\\n \\"CertId\\": 1,\\n \\"Common\\": \\"example.com\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":"{\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": {\\n \\"Cert\\": [\\n {\\n \\"CertName\\": \\"证书1\\",\\n \\"Issuer\\": \\"xxx\\",\\n \\"LastTime\\": 1512388610,\\n \\"CertId\\": xxx,\\n \\"Common\\": \\"test\\",\\n \\"Fingerprint\\": \\"xxx\\"\\n },\\n {\\n \\"CertName\\": \\"证书2\\",\\n \\"Issuer\\": \\"xxx\\",\\n \\"LastTime\\": 1512388659,\\n \\"CertId\\": xxx,\\n \\"Common\\": \\"test\\",\\n \\"Fingerprint\\": \\"xxx\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"FC0E34AC-0239-44A7-AB0E-800DE522C8DA\\"\\n}"},{"type":"xml","example":"<DescribeCdnCertificateListResponse>\\n<Count>2</Count>\\n<CertList>\\n <Cert>\\n <CertName>证书1</CertName>\\n <Issuer>CO****</Issuer>\\n <LastTime>1512388610</LastTime>\\n <CertId>1</CertId>\\n <Common>test</Common>\\n <Fingerprint>2ED68FD33786C5B42950D40A6C50353575BB****</Fingerprint>\\n </Cert>\\n <Cert>\\n <CertName>证书2</CertName>\\n <Issuer>CO****</Issuer>\\n <LastTime>1512388659</LastTime>\\n <CertId>2</CertId>\\n <Common>test</Common>\\n <Fingerprint>2ED68FD33786C5B42950D40A6C50353575BB****</Fingerprint>\\n </Cert>\\n</CertList>\\n<RequestId>FC0E34AC-0239-44A7-AB0E-800DE522C8DA</RequestId>\\n<DescribeCdnCertificateListResponse>","errorExample":""}]', + 'title' => '查询证书列表-按域名', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnSSLCertificateList' => [ + 'summary' => '调用DescribeCdnSSLCertificateList按照域名查询证书列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '168239', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持查询单个域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com'."\n", + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：**1** 。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。'."\n" + .'取值：**1**~**1000**之间的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + 'default' => '1000', + ], + ], + [ + 'name' => 'SearchKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '证书名称模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'certabc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E9D3257A-1B7C-414C-90C1-8D07AC47BCAC', + ], + 'CertificateListModel' => [ + 'description' => '证书列表信息。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '证书数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CertList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Cert' => [ + 'description' => '证书列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '证书列表信息。', + 'type' => 'object', + 'properties' => [ + 'LastTime' => [ + 'description' => '证书过期时间。单位：毫秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1679896965', + ], + 'Fingerprint' => [ + 'description' => '证书指纹。', + 'type' => 'string', + 'example' => '933c6ddee95c9c41a40f9f50493d82be03ad87bf', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => '证书1', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => 'yourCertIssuer', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9128192', + ], + 'Common' => [ + 'description' => '证书中的CN属性，一般是一个域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CertRegion' => [ + 'description' => '证书所在地域。支持**cn-hangzhou**和**ap-southeast-1**，默认**cn-hangzhou** 。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前页数，起始值为1，默认为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '每页大小，取值：1~1000之间的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotFoundCertList', + 'errorMessage' => 'The certList is null.', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'Internal occasional exception, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9D3257A-1B7C-414C-90C1-8D07AC47BCAC\\",\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": {\\n \\"Cert\\": [\\n {\\n \\"LastTime\\": 1679896965,\\n \\"Fingerprint\\": \\"933c6ddee95c9c41a40f9f50493d82be03ad87bf\\",\\n \\"CertName\\": \\"证书1\\",\\n \\"Issuer\\": \\"yourCertIssuer\\",\\n \\"CertId\\": 9128192,\\n \\"Common\\": \\"example.com\\",\\n \\"CertRegion\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]', + 'title' => '查询证书列表-按域名', + ], + 'DescribeCdnHttpsDomainList' => [ + 'summary' => '调用DescribeCdnHttpsDomainList查询用户所有证书信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111731', + 'abilityTreeNodes' => [ + 'FEATUREcdnD4PEWG', + 'FEATUREcdn4R6KLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围为：**1**~**100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5E8DF64-7175-4186-9B06-F002C0BBD0C5', + ], + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => '证书信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CertStartTime' => [ + 'description' => '证书开始时间。', + 'type' => 'string', + 'example' => '2018-11-26 14:45:09', + ], + 'CertExpireTime' => [ + 'description' => '证书过期时间。', + 'type' => 'string', + 'example' => '2018-12-26 14:45:09', + ], + 'CertUpdateTime' => [ + 'description' => '证书更新时间。', + 'type' => 'string', + 'example' => '2019-01-08 18:33:16', + ], + 'CertType' => [ + 'description' => '证书类型。'."\n" + .'- **free**：免费证书。'."\n" + ."\n" + .'- **cas**：云盾证书。'."\n" + ."\n" + .'- **upload**：自定义上传。'."\n", + 'type' => 'string', + 'example' => 'free', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CertStatus' => [ + 'description' => '证书状态。'."\n" + .'- **ok**：正常。'."\n" + .'- **mismatch**：域名与证书不匹配。'."\n" + .'- **expired**：已过期。'."\n" + .'- **expire_soon**：即将过期。', + 'type' => 'string', + 'example' => 'mismatch', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CertCommonName' => [ + 'description' => '证书主域名。', + 'type' => 'string', + 'example' => 'example.org', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoHttpsDomain', + 'errorMessage' => 'Your account doesn\'t have https domain.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 16,\\n \\"RequestId\\": \\"F5E8DF64-7175-4186-9B06-F002C0BBD0C5\\",\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"CertStartTime\\": \\"2018-11-26 14:45:09\\",\\n \\"CertExpireTime\\": \\"2018-12-26 14:45:09\\",\\n \\"CertUpdateTime\\": \\"2019-01-08 18:33:16\\",\\n \\"CertType\\": \\"free\\",\\n \\"CertName\\": \\"test\\",\\n \\"CertStatus\\": \\"mismatch\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"CertCommonName\\": \\"example.org\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnHttpsDomainListResponse>\\n <CertInfos>\\n <CertInfo>\\n <CertUpdateTime>2019-01-08 18:33:16</CertUpdateTime>\\n <CertType>free</CertType>\\n <CertName>test</CertName>\\n <DomainName>example.com</DomainName>\\n <CertStatus>mismatch</CertStatus>\\n <CertExpireTime>2018-12-26 14:45:09</CertExpireTime>\\n <CertStartTime>2018-11-26 14:45:09</CertStartTime>\\n <CertCommonName>example.org</CertCommonName>\\n </CertInfo>\\n </CertInfos>\\n <TotalCount>16</TotalCount>\\n <RequestId>F5E8DF64-7175-4186-9B06-F002C0BBD0C5</RequestId>\\n</DescribeCdnHttpsDomainListResponse>","errorExample":""}]', + 'title' => '查询证书列表', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCertificateInfoByID' => [ + 'summary' => '调用DescribeCertificateInfoByID按照证书ID查询指定证书信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111756', + 'abilityTreeNodes' => [ + 'FEATUREcdnD4PEWG', + 'FEATUREcdn4R6KLH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CertId', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID，仅支持查询单个。', + 'type' => 'string', + 'required' => true, + 'example' => '1644xx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5C1E43DC-9E51-4771-82C0-7D5ECEB547A1', + ], + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => '证书信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CertExpireTime' => [ + 'description' => '证书过期时间。', + 'type' => 'string', + 'example' => '2098-02-08 08:02:07 +0000 UTC', + ], + 'CreateTime' => [ + 'description' => '证书开始时间。', + 'type' => 'string', + 'example' => '2015-12-21 08:02:07 +0000 UTC', + ], + 'CertType' => [ + 'description' => '证书类型。'."\n" + .'- free：免费证书。'."\n" + ."\n" + .'- cas：云盾证书。'."\n" + ."\n" + .'- upload：自定义上传。', + 'type' => 'string', + 'example' => 'cas', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'example_cert', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => '1644xx', + ], + 'DomainList' => [ + 'description' => '使用此证书的域名列表。', + 'type' => 'string', + 'example' => '["example.com"]', + ], + 'HttpsCrt' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----\\nxxx-----END CERTIFICATE-----\\n', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CertNotExisted', + 'errorMessage' => 'The Cert doesn\'t exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'SignatureDoesNotMatch', + 'errorMessage' => 'The signature we calculated does not match the one you provided. Please refer to the API reference about authentication for details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5C1E43DC-9E51-4771-82C0-7D5ECEB547A1\\",\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"CertExpireTime\\": \\"2098-02-08 08:02:07 +0000 UTC\\",\\n \\"CreateTime\\": \\"2015-12-21 08:02:07 +0000 UTC\\",\\n \\"CertType\\": \\"cas\\",\\n \\"CertName\\": \\"example_cert\\",\\n \\"CertId\\": \\"1644xx\\",\\n \\"DomainList\\": \\"[\\\\\\"example.com\\\\\\"]\\",\\n \\"HttpsCrt\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\nxxx-----END CERTIFICATE-----\\\\\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCertificateInfoByIDResponse>\\n <RequestId>5C1E43DC-9E51-4771-82C0-7D5ECEB547A1</RequestId>\\n <CertInfos>\\n <CertExpireTime>2098-02-08 08:02:07 +0000 UTC</CertExpireTime>\\n <CreateTime>2015-12-21 08:02:07 +0000 UTC</CreateTime>\\n <CertType>cas</CertType>\\n <CertName>example_cert</CertName>\\n <CertId>1644xx</CertId>\\n <DomainList>[\\"example.com\\"]</DomainList>\\n <HttpsCrt>-----BEGIN CERTIFICATE-----\\\\nxxx-----END CERTIFICATE-----\\\\n</HttpsCrt>\\n </CertInfos>\\n</DescribeCertificateInfoByIDResponse>","errorExample":""}]', + 'title' => '查询证书信息-按ID', + 'description' => '- 单用户调用频率：100次/秒。'."\n" + .'- 域名绑定证书后，但证书未启用时，通过该接口查询会提示证书不存在。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnCertificateDetailById' => [ + 'summary' => '调用DescribeCdnCertificateDetailById根据证书ID获取证书详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '168240', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CertId', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'CertRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '证书Region。取值：'."\n" + .'- **ap-southeast-1**（新加坡）'."\n" + .'- **cn-hangzhou**（杭州）'."\n" + ."\n" + .'默认值为**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ap-southeast-1' => 'ap-southeast-1', + 'cn-hangzhou' => 'cn-hangzhou', + ], + 'example' => 'cn-hangzhou'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName'."\n", + ], + 'Key' => [ + 'description' => '证书公钥。', + 'type' => 'string', + 'example' => '587f6db37e3a2f01047b032b739cbe31'."\n", + ], + 'Cert' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGINCERTIFICATE-----xxx-----END CERTIFICATE-----'."\n", + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCertId.NotFound', + 'errorMessage' => 'The certId does not exist.', + ], + [ + 'errorCode' => 'Abs.CertRegion.ValueNotSupported', + 'errorMessage' => 'CertRegion is not supported.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertName\\": \\"yourCertName\\\\n\\",\\n \\"Key\\": \\"587f6db37e3a2f01047b032b739cbe31\\\\n\\",\\n \\"Cert\\": \\"-----BEGINCERTIFICATE-----xxx-----END CERTIFICATE-----\\\\n\\",\\n \\"CertId\\": 12345,\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\\\n\\"\\n}","type":"json"}]', + 'title' => '查询证书详情-按ID', + ], + 'DescribeUserCertificateExpireCount' => [ + 'summary' => '调用DescribeUserCertificateExpireCount查询用户证书过期的域名数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111840', + 'abilityTreeNodes' => [ + 'FEATUREcdnD4PEWG', + 'FEATUREcdn4R6KLH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ExpireWithin30DaysCount' => [ + 'description' => '30天内证书即将过期的域名数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5E8DF64-7175-4186-9B06-F002C0BBD0C5', + ], + 'ExpiredCount' => [ + 'description' => '证书已过期的域名数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoHttpsDomain', + 'errorMessage' => 'Your account doesn\'t have https domain.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ExpireWithin30DaysCount\\": 0,\\n \\"RequestId\\": \\"F5E8DF64-7175-4186-9B06-F002C0BBD0C5\\",\\n \\"ExpiredCount\\": 6\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserCertificateExpireCountResponse>\\n <ExpireWithin30DaysCount>0</ExpireWithin30DaysCount>\\n <RequestId>F5E8DF64-7175-4186-9B06-F002C0BBD0C5</RequestId>\\n <ExpiredCount>6</ExpiredCount>\\n</DescribeUserCertificateExpireCountResponse>","errorExample":""}]', + 'title' => '查询证书过期的域名数', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCdnCertificateSigningRequest' => [ + 'summary' => '调用CreateCdnCertificateSigningRequest创建 CSR（证书签名请求）文件。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '111691', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CommonName', + 'in' => 'query', + 'schema' => [ + 'description' => '证书通用名称CN字段。', + 'type' => 'string', + 'required' => true, + 'example' => 'CommonName', + ], + ], + [ + 'name' => 'SANs', + 'in' => 'query', + 'schema' => [ + 'description' => '证书扩展字段，绑定的域名，多个域名用逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Organization', + 'in' => 'query', + 'schema' => [ + 'description' => '机构名称，默认：Alibaba Inc。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alibaba Inc', + 'default' => 'Alibaba Inc.', + ], + ], + [ + 'name' => 'OrganizationUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '部门名称，默认：Aliyun CDN。', + 'type' => 'string', + 'required' => false, + 'example' => 'Aliyun CDN', + 'default' => 'Aliyun CDN', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => '所属国家，默认：CN。', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'default' => 'CN', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '省级地区，默认：Zhejiang。', + 'type' => 'string', + 'required' => false, + 'example' => 'Zhejiang', + 'default' => 'Zhejiang', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => [ + 'description' => '市级地区，默认：Hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hangzhou', + 'default' => 'Hangzhou', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '邮箱。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + 'PubMd5' => [ + 'description' => '证书公钥信息Md5值。', + 'type' => 'string', + 'example' => '629bf4fd8104eda171135bcb0f77****', + ], + 'Csr' => [ + 'description' => '证书签名请求文件内容。', + 'type' => 'string', + 'example' => 'CSRName', + ], + 'CommonName' => [ + 'description' => '证书通用名称。', + 'type' => 'string', + 'example' => 'CommonName', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidValue.Malformed', + 'errorMessage' => 'Country must be 2 characters.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Internal.KeyError', + 'errorMessage' => 'Failed to generate rsa key.', + ], + [ + 'errorCode' => 'Internal.CreateCSRError', + 'errorMessage' => 'Failed to create CSR.', + ], + [ + 'errorCode' => 'Internal.EncodeCSRError', + 'errorMessage' => 'Failed to encode CSR.', + ], + [ + 'errorCode' => 'Internal.EncodeKeyError', + 'errorMessage' => 'Failed to encode private key.', + ], + [ + 'errorCode' => 'Internal.Error', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"PubMd5\\": \\"629bf4fd8104eda171135bcb0f77****\\",\\n \\"Csr\\": \\"CSRName\\",\\n \\"CommonName\\": \\"CommonName\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>\\n<CommonName>CommonName</CommonName>\\n<Csr>-----BEGIN CERTIFICATE REQUEST-----\\nMIIC/zqT****\\n-----END CERTIFICATE REQUEST-----\\n</Csr>\\n<PubMd5>629bf4fd8104eda171135bcb0f77****</PubMd5>","errorExample":""}]', + 'title' => '创建证书签名请求', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetCdnDomainCSRCertificate' => [ + 'summary' => '调用SetCdnDomainCSRCertificate设置指定域名下的HTTPS证书。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111887', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServerCertificate', + 'in' => 'query', + 'schema' => [ + 'description' => '证书内容。该证书必须是通过[CreateCdnCertificateSigningRequest](~~144478~~)接口创建的CSR对应的签名证书，内部必须是PEM格式的证书，Base64编码后再通过encodeURIComponent。', + 'type' => 'string', + 'required' => true, + 'example' => '----BEGIN CERTIFICATE----- MIIFz****-----END CERTIFICATE-----', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要设置的加速域名，需属于HTTPS加速类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.MissingParameter', + 'errorMessage' => 'You must specify the Certificate parameter.', + ], + [ + 'errorCode' => 'Certificate.EncodeError', + 'errorMessage' => 'An error occurred while encoding the certificate.', + ], + [ + 'errorCode' => 'Certificate.DecodeError', + 'errorMessage' => 'An error occurred while decoding the certificate.', + ], + [ + 'errorCode' => 'Certificate.FormatError', + 'errorMessage' => 'The format of the certificate is invalid.', + ], + [ + 'errorCode' => 'Certificate.MissMatch', + 'errorMessage' => 'The certificate does not match the domain.', + ], + [ + 'errorCode' => 'Certificate.NoPrivateKey', + 'errorMessage' => 'The private key of the certificate does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Internal.ForbidError', + 'errorMessage' => 'You cannot modify the configurations when some features of the domain are in a canary deployment.', + ], + [ + 'errorCode' => 'Internal.ConfigError', + 'errorMessage' => 'An error occurred while configuring the certificate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","errorExample":""},{"type":"xml","example":"<SetCdnDomainCSRCertificateResponse>\\r\\n<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>\\r\\n</SetCdnDomainCSRCertificateResponse>","errorExample":""}]', + 'title' => '设置CSR证书', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetCdnDomainSMCertificate' => [ + 'summary' => '调用SetCdnDomainSMCertificate设置某域名下国密证书功能是否启用。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111888', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '证书所属的加速域名。'."\n" + ."\n" + .'> 证书需属于HTTPS加速类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => '国密证书ID。'."\n" + .'证书ID+"-cn-hangzhou"。'."\n" + .'如果证书ID=123，CertIdentifier="123-cn-hangzhou"', + 'type' => 'string', + 'required' => true, + 'example' => '1234****-cn-hangzhou', + ], + ], + [ + 'name' => 'SSLProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTPS证书是否启用。取值：'."\n" + ."\n" + .'- **on**：启用。'."\n" + .'- **off**：不启用。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCertIdentifier.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter CertIdentifier is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C8\\"\\n}","errorExample":""},{"type":"xml","example":"<SetCdnDomainSMCertificateResponse>\\n <RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C8</RequestId>\\n</SetCdnDomainSMCertificateResponse>","errorExample":""}]', + 'title' => '设置国密证书', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnSMCertificateList' => [ + 'summary' => '调用DescribeCdnSMCertificateList查询指定加速域名下国密证书列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111742', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持查询单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DC0E34AC-0239-44A7-AB0E-800DE522C8DC', + ], + 'CertificateListModel' => [ + 'description' => '证书信息类型。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '证书个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CertList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Cert' => [ + 'description' => '证书列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => 'yourCertIssuer', + ], + 'CertIdentifier' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => 'yourCertldentifier', + ], + 'Common' => [ + 'description' => '证书公用名。', + 'type' => 'string', + 'example' => 'yourCertCommon', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC0E34AC-0239-44A7-AB0E-800DE522C8DC\\",\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": {\\n \\"Cert\\": [\\n {\\n \\"CertName\\": \\"yourCertName\\",\\n \\"Issuer\\": \\"yourCertIssuer\\",\\n \\"CertIdentifier\\": \\"yourCertldentifier\\",\\n \\"Common\\": \\"yourCertCommon\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnSMCertificateListResponse>\\n<CertificateListModel>\\n <Count>2</Count>\\n <CertList>\\n <Cert>\\n <CertName>yourCertName1</CertName>\\n <Issuer>yourCertIssuer1</Issuer>\\n <CertIdentifier>yourCertIdentifier1</CertIdentifier>\\n <Common>yourCertCommon1</Common>\\n </Cert>\\n <Cert>\\n <CertName>yourCertName2</CertName>\\n <Issuer>yourCertIssuer2</Issuer>\\n <CertIdentifier>yourCertIdentifier2</CertIdentifier>\\n <Common>yourCertCommon2</Common>\\n </Cert>\\n </CertList>\\n</CertificateListModel>\\n<RequestId>DC0E34AC-0239-44A7-AB0E-800DE522C8DC</RequestId>\\n</DescribeCdnSMCertificateListResponse>","errorExample":""}]', + 'title' => '查询国密证书列表', + 'description' => '>单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnSMCertificateDetail' => [ + 'summary' => '调用DescribeCdnSMCertificateDetail查询国密证书的详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111741', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => '648****-cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CertExpireTime' => [ + 'description' => '证书到期时间，GMT时间。', + 'type' => 'string', + 'example' => '2022-08-31T09:42:28Z', + ], + 'CertIdentifier' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => '648****-cn-hangzhou', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7C69682-7F88-40DD-A198-10D0309E439D', + ], + 'CommonName' => [ + 'description' => '通用域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'yourCertName', + ], + 'Sans' => [ + 'description' => '扩展域名。', + 'type' => 'string', + 'example' => '***.example.com', + ], + 'SignCertificate' => [ + 'description' => '签名证书内容。', + 'type' => 'string', + 'example' => '--BEGIN CERTIFICATE-----***-----END CERTIFICATE--', + ], + 'CertOrg' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'DigiCert Inc', + ], + 'EncryptCertificate' => [ + 'description' => '加密证书内容。', + 'type' => 'string', + 'example' => '-BEGIN CERTIFICATE-----***-----END CERTIFICATE--', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCertIdentifier.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter CertIdentifier is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertExpireTime\\": \\"2022-08-31T09:42:28Z\\",\\n \\"CertIdentifier\\": \\"648****-cn-hangzhou\\",\\n \\"RequestId\\": \\"A7C69682-7F88-40DD-A198-10D0309E439D\\",\\n \\"CommonName\\": \\"example.com\\",\\n \\"CertName\\": \\"yourCertName\\",\\n \\"Sans\\": \\"***.example.com\\",\\n \\"SignCertificate\\": \\"--BEGIN CERTIFICATE-----***-----END CERTIFICATE--\\",\\n \\"CertOrg\\": \\"DigiCert Inc\\",\\n \\"EncryptCertificate\\": \\"-BEGIN CERTIFICATE-----***-----END CERTIFICATE--\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnSMCertificateDetailResponse>\\n<SignCertificate>--BEGIN CERTIFICATE-----***-----END CERTIFICATE--</SignCertificate>\\n<EncryptCertificate>--BEGIN CERTIFICATE-----***-----END CERTIFICATE--</EncryptCertificate>\\n<CertName>yourCerName</CertName>\\n<CertIdentifier>648****-cn-hangzhou</CertIdentifier>\\n<CommonName>example.com</CommonName>\\n<Sans>***.example.com</Sans>\\n<CertOrg>DigiCert Inc</CertOrg>\\n<CertExpireTime>2022-08-31T09:42:28Z</CertExpireTime>\\n<RequestId>A7C69682-7F88-40DD-A198-10D0309E439D</RequestId>\\n</DescribeCdnSMCertificateDetailResponse>","errorExample":""}]', + 'title' => '查询国密证书详情', + 'description' => '>单用户调用频率：20次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetCdnDomainSSLCertificate' => [ + 'summary' => '调用SetCdnDomainSSLCertificate用于设置某域名下证书功能是否启用及更新证书信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168241', + 'abilityTreeNodes' => [ + 'FEATUREcdn4R6KLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定证书所属加速域名，需属于HTTPS加速类型。仅支持单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com'."\n", + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '证书名称，目前只支持单个证书名称。'."\n" + .'CertType=upload时选填，给新证书的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourCertName'."\n", + ], + ], + [ + 'name' => 'CertId', + 'in' => 'query', + 'schema' => [ + 'description' => '证书ID。'."\n" + .'CertType=cas时必填，表示选择已有证书。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8089870'."\n", + ], + ], + [ + 'name' => 'CertType', + 'in' => 'query', + 'schema' => [ + 'description' => '证书类型。'."\n" + ."\n" + .'- **upload**：上传证书。'."\n" + .'- **cas**：证书中心证书。', + 'type' => 'string', + 'required' => false, + 'example' => 'upload', + 'enum' => [ + 'cas', + 'upload', + ], + ], + ], + [ + 'name' => 'SSLProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTPS证书是否启用。'."\n" + ."\n" + .'- **on**：启用。'."\n" + .'- **off**：不启用。', + 'type' => 'string', + 'required' => true, + 'example' => 'off', + ], + ], + [ + 'name' => 'SSLPub', + 'in' => 'query', + 'schema' => [ + 'description' => '安全证书内容，不启用证书则无需输入，配置证书请输入证书内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx'."\n", + ], + ], + [ + 'name' => 'SSLPri', + 'in' => 'query', + 'schema' => [ + 'description' => '私钥内容，不启用证书则无需输入，配置证书请输入私钥内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'y****'."\n", + ], + ], + [ + 'name' => 'CertRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '证书所在地域，只有**CertType=cas**时生效。支持**cn-hangzhou**和**ap-southeast-1**，默认**cn-hangzhou**。国际站用户建议使用**ap-southeast-1**。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ap-southeast-1' => 'ap-southeast-1', + 'cn-hangzhou' => 'cn-hangzhou', + ], + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7C69682-7F88-40DD-A198-10D0309E439D'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSSLProtocol.ValueNotSupported', + 'errorMessage' => 'The specified SSLProtocol is invalid.', + ], + [ + 'errorCode' => 'SSLPub.MissingParameter', + 'errorMessage' => 'The SSLPub parameter is required.', + ], + [ + 'errorCode' => 'SSLPri.MissingParameter', + 'errorMessage' => 'The SSLPri parameter is required.', + ], + [ + 'errorCode' => 'InvalidSSLPub', + 'errorMessage' => 'The specified SSLPub is invalid.', + ], + [ + 'errorCode' => 'InvalidSSLPri', + 'errorMessage' => 'The specified SSLPri is invalid.', + ], + [ + 'errorCode' => 'Certificate.MissMatch', + 'errorMessage' => 'The SSLPri does not match the certificate.', + ], + [ + 'errorCode' => 'InvalidCertificate.TooLong', + 'errorMessage' => 'The maximum length of the certificate is exceeded.', + ], + [ + 'errorCode' => 'InvalidCertName.TooLong', + 'errorMessage' => 'The length of the certificate name cannot exceed 128 characters.', + ], + [ + 'errorCode' => 'AuthenticationFailed', + 'errorMessage' => 'Error performing verification.', + ], + [ + 'errorCode' => 'SetDomainCertificate.ParameterError', + 'errorMessage' => 'The specified parameters are invalid.', + ], + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + ], + [ + 'errorCode' => 'DeleteFailed', + 'errorMessage' => 'Error deleting the certificate.', + ], + [ + 'errorCode' => 'Certificate.NotFind', + 'errorMessage' => 'The certificate does not exist.', + ], + [ + 'errorCode' => 'Certificate.Duplicated', + 'errorMessage' => 'The certificate name already exists.', + ], + [ + 'errorCode' => 'Certificate.FormatError', + 'errorMessage' => 'The format of the certificate is invalid.', + ], + [ + 'errorCode' => 'Certificate.KeyNull', + 'errorMessage' => 'The private key is required.', + ], + [ + 'errorCode' => 'Key.Malformed', + 'errorMessage' => 'The specified Key format is invalid.', + ], + [ + 'errorCode' => 'CertStorage.failed', + 'errorMessage' => 'Error saving the certificate.', + ], + [ + 'errorCode' => 'CertificateContent.Duplicated', + 'errorMessage' => 'The certificate has been uploaded; do not upload again.', + ], + [ + 'errorCode' => 'Certificate.Expired', + 'errorMessage' => 'The certificate has expired.', + ], + [ + 'errorCode' => 'InvalidDomain.notOnline', + 'errorMessage' => 'The domain is offline. Check the status of the domain and try again later.', + ], + [ + 'errorCode' => 'Decode.Error', + 'errorMessage' => 'Error decoding the SSLPub or SSLPri certificate.', + ], + [ + 'errorCode' => 'sslPub.Error', + 'errorMessage' => 'Error encoding SSLPub.', + ], + [ + 'errorCode' => 'sslPri.Error', + 'errorMessage' => 'Error encoding SSLPri.', + ], + [ + 'errorCode' => 'DomainInSafeMode', + 'errorMessage' => 'The domain is in safe mode. To request permission, contact Customer Service.', + ], + [ + 'errorCode' => 'CreateCertificateFailed', + 'errorMessage' => 'Create certificate failed,please try again.', + ], + [ + 'errorCode' => 'Abs.CertRegion.ValueNotSupported', + 'errorMessage' => 'CertRegion is not supported.', + ], + [ + 'errorCode' => 'CertNameAlreadyExists', + 'errorMessage' => 'The CertName already exists.', + ], + [ + 'errorCode' => 'InvalidDomain.Offline', + 'errorMessage' => 'The domain provided is offline.', + ], + [ + 'errorCode' => 'InvalidEnv', + 'errorMessage' => 'The specified Env is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DomainInProtectedMode', + 'errorMessage' => 'The domain is in protection mode. To request permission, contact Customer Service.', + ], + ], + [ + [ + 'errorCode' => 'CertName.MissingParameter', + 'errorMessage' => 'You must specify CertName.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7C69682-7F88-40DD-A198-10D0309E439D\\\\n\\"\\n}","type":"json"}]', + 'title' => '设置CDN域名证书', + 'description' => '- 单用户调用频率：30次/秒。'."\n" + .'- 调用方式：POST。', + ], + 'TagResources' => [ + 'summary' => '调用TagResources添加资源标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111918', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。固定值：**DOMAIN**。', + 'type' => 'string', + 'required' => true, + 'example' => 'DOMAIN', + 'enum' => [ + 'DOMAIN', + ], + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。列表元素数量最大：50。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID（Cdn为加速域名）。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => true, + 'example' => '1', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。列表元素数量最大：20。', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '97C68796-EB7F-4D41-9D5B-12B909D76508', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified RegionId is invalid.', + ], + [ + 'errorCode' => 'Resource.NotExist', + 'errorMessage' => 'Resources does not exist.', + ], + [ + 'errorCode' => 'TagKeyIsInvalid', + 'errorMessage' => 'The specified TagKey is invalid.', + ], + [ + 'errorCode' => 'TooManyTags', + 'errorMessage' => 'Too many tags.', + ], + [ + 'errorCode' => 'InvalidTagKey', + 'errorMessage' => 'The key should not be null, start with "acs:" or "aliyun", contain "http://" or "https://" or have special symbols:.!@#$%?/^&*)(+={}[]",\'<>~·`?;.', + ], + [ + 'errorCode' => 'InvalidTagValue', + 'errorMessage' => 'The tag value cannot contain these special symbols:http://, https://', + ], + [ + 'errorCode' => 'ReservedTagKey', + 'errorMessage' => 'The tag key is used internally as a reserved field and is not allowed to be used.', + ], + [ + 'errorCode' => 'TagValueIsInvalid', + 'errorMessage' => 'The specified TagValue is invalid.', + ], + [ + 'errorCode' => 'TagKeyRepeated', + 'errorMessage' => 'The specified TagKey is duplicated.', + ], + [ + 'errorCode' => 'TagIsInvalid', + 'errorMessage' => 'The number of Tag exceeds 20.', + ], + [ + 'errorCode' => 'ResourceIdIsInvalid', + 'errorMessage' => 'The number of ResourceId exceeds 50.', + ], + [ + 'errorCode' => 'SystemTagIsInvalid', + 'errorMessage' => 'The number of System Tag exceeds 50.', + ], + [ + 'errorCode' => 'CustomTagIsInvalid', + 'errorMessage' => 'The number of Custom Tag exceeds 20.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"97C68796-EB7F-4D41-9D5B-12B909D76508\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>97C68796-EB7F-4D41-9D5B-12B909D76508</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => '添加资源标签', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTagResources' => [ + 'summary' => '调用DescribeTagResources查询资源对应的标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111837', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '固定值：**DOMAIN**。', + 'type' => 'string', + 'required' => true, + 'example' => 'DOMAIN', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表，最大元素数量：50。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID，CDN为加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => true, + 'example' => '1', + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签组合列表。最大元素数量：20。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34AB41F1-04A5-496F-8C8D-634BDBE6A9FB', + ], + 'TagResources' => [ + 'description' => '标签资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签解释。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签解释。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'product', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34AB41F1-04A5-496F-8C8D-634BDBE6A9FB\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"example.com\\",\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"product\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeTagResourcesResponse>\\n <RequestId>34AB41F1-04A5-496F-8C8D-634BDBE6A9FB</RequestId>\\n <TagResources>\\n <ResourceId>example.com</ResourceId>\\n <Tag>\\n <Key>env</Key>\\n <Value>product</Value>\\n </Tag>\\n </TagResources>\\n</DescribeTagResourcesResponse>","errorExample":""}]', + 'title' => '查询资源标签', + 'description' => '> 单用户调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserTags' => [ + 'summary' => '调用DescribeUserTags查询用户标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111843', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34AB41F1-04A5-496F-8C8D-634BDBE6A9FB', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'product', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34AB41F1-04A5-496F-8C8D-634BDBE6A9FB\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": [\\n \\"product\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserTagsResponse>\\n <Tags>\\n <Key>env</Key>\\n <Value>product</Value>\\n <Value>pre</Value>\\n <Value>daily</Value>\\n </Tags>\\n <Tags>\\n <Key>region</Key>\\n <Value>hangzhou</Value>\\n </Tags>\\n <RequestId>34AB41F1-04A5-496F-8C8D-634BDBE6A9FB</RequestId>\\n</DescribeUserTagsResponse>","errorExample":""}]', + 'title' => '查询用户标签', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => '调用UntagResources删除资源标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111919', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。固定值：**DOMAIN**。', + 'type' => 'string', + 'required' => true, + 'example' => 'DOMAIN', + 'enum' => [ + 'DOMAIN', + ], + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '删除所有标签。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'默认取值为**false**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。列表元素数量最多50个。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-res.dutenews.com', + ], + 'required' => true, + 'example' => 'example.com', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键列表。列表元素数量最大20个。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'required' => false, + 'example' => 'env', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '97C68796-EB7F-4D41-9D5B-12B909D76508', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TagIsInvalid', + 'errorMessage' => 'The number of Tag exceeds 20.', + ], + [ + 'errorCode' => 'ResourceIdIsInvalid', + 'errorMessage' => 'The number of ResourceId exceeds 50.', + ], + [ + 'errorCode' => 'TagKeyRepeated', + 'errorMessage' => 'The specified TagKey is duplicated.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"97C68796-EB7F-4D41-9D5B-12B909D76508\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>97C68796-EB7F-4D41-9D5B-12B909D76508</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => '删除资源标签', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => '调用ListTagResources查询资源标签列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111865', + 'abilityTreeNodes' => [ + 'FEATUREcdnFGPKCB', + ], + ], + 'parameters' => [ + [ + 'name' => 'TagOwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '标签所属阿里云账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123xxxx', + ], + ], + [ + 'name' => 'TagOwnerBid', + 'in' => 'query', + 'schema' => [ + 'description' => '标签拥有者Bid。', + 'type' => 'string', + 'required' => false, + 'example' => '26842', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。固定值：**DOMAIN**。', + 'type' => 'string', + 'required' => true, + 'example' => 'DOMAIN', + 'enum' => [ + 'DOMAIN', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'QpgBAAAAAABsb2dzL2RzLw==', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID，N取值[1,50]。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签组合。', + 'type' => 'array', + 'items' => [ + 'description' => '标签组合。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'testKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => 'QpgBAAAAAABsb2dzL2RzLw==', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64D28B53-5902-409B-94F6-FD46680144FE', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '资源和标签的关系列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源和标签的关系列表。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'testValue', + ], + 'ResourceType' => [ + 'description' => '资源类型。固定值：**DOMAIN**。', + 'type' => 'string', + 'example' => 'DOMAIN', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'testKey', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified RegionId is invalid.', + ], + [ + 'errorCode' => 'MissParameter.TagOrResourceId', + 'errorMessage' => 'Either Tag or ResourceId must be specified.', + ], + [ + 'errorCode' => 'TagIsInvalid', + 'errorMessage' => 'The number of Tag exceeds 20.', + ], + [ + 'errorCode' => 'ResourceIdIsInvalid', + 'errorMessage' => 'The number of ResourceId exceeds 50.', + ], + [ + 'errorCode' => 'TagKeyIsInvalid', + 'errorMessage' => 'The specified TagKey is invalid.', + ], + [ + 'errorCode' => 'TagValueIsInvalid', + 'errorMessage' => 'The specified TagValue is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"QpgBAAAAAABsb2dzL2RzLw==\\",\\n \\"RequestId\\": \\"64D28B53-5902-409B-94F6-FD46680144FE\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"testValue\\",\\n \\"ResourceType\\": \\"DOMAIN\\",\\n \\"ResourceId\\": \\"example.com\\",\\n \\"TagKey\\": \\"testKey\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询资源标签列表', + ], + 'CreateCdnSubTask' => [ + 'summary' => '调用CreateCdnSubTask定制运营报表，定制后可查看定制报表数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '111694', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '支持定制的报表ID列表，多个用英文逗号（,）分隔。取值：'."\n" + .'- **1**：热门URL（按请求数排序）。'."\n" + .'- **3**：热门URL（按流量排序）。'."\n" + .'- **5**：热门Referer（按请求数排序）。'."\n" + .'- **7**：热门Referer（按流量排序）。'."\n" + .'- **9**：回源热门URL（按请求数排序）。'."\n" + .'- **11**：回源热门URL（按流量排序）。'."\n" + .'- **13**：Top客户端IP（按请求数排序）。'."\n" + .'- **15**：Top客户端IP（按流量排序）。'."\n" + .'- **17**：域名排行（按流量排序）。'."\n" + .'- **19**：PV和UV。'."\n" + .'- **21**：访问区域分布。'."\n" + .'- **23**：运营商分布。', + 'type' => 'string', + 'required' => true, + 'example' => '1,3,5', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'formData', + 'schema' => [ + 'description' => '<props="china">待订阅的域名列表，多个域名用半角逗号（,）分隔</props>'."\n" + ."\n" + .'<props="intl">待订阅的域名列表，多个域名用半角逗号（,）分隔</props>'."\n" + .'> 不传该参数，默认为账号下的所有域名订阅报表交付任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example1.com,www.example2.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCdnSubTaskResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</CreateCdnSubTaskResponse>","errorExample":""}]', + 'title' => '创建报表定制任务', + 'description' => '- 定制可精确到报表和域名粒度，定制成功后可供您日常查看定制的报表数据。'."\n" + .'- 单用户调用频率：3次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnSubList' => [ + 'summary' => '调用DescribeCdnSubList查询已定制的报表任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111743', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '已定制的报表任务。', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'title' => '运营报表定制信息主体', + 'description' => '运营报表定制信息主体', + 'type' => 'array', + 'items' => [ + 'title' => '运营报表定制信息主体', + 'description' => '运营报表定制信息主体', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'title' => '定制的创建时间', + 'description' => '定制的创建时间', + 'type' => 'string', + 'example' => '2024-05-16T09:43:38Z', + ], + 'domains' => [ + 'title' => '定制域名，all表示全部域名', + 'description' => '定制域名，all表示全部域名', + 'type' => 'array', + 'items' => [ + 'title' => '定制域名，all表示全部域名', + 'description' => '定制域名，all表示全部域名', + 'type' => 'string', + 'example' => 'a.b.com', + ], + ], + 'effectiveEnd' => [ + 'title' => '定制有效截止时间', + 'description' => '定制有效截止时间', + 'type' => 'string', + 'example' => '2024-05-16T09:43:38Z', + ], + 'effectiveFrom' => [ + 'title' => '定制有效开始时间', + 'description' => '定制有效开始时间', + 'type' => 'string', + 'example' => '2024-05-16T09:43:38Z', + ], + 'reportId' => [ + 'title' => '定制的报表ID列表', + 'description' => '定制的报表ID列表', + 'type' => 'array', + 'items' => [ + 'title' => '定制的报表ID列表', + 'description' => '定制的报表ID列表', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'status' => [ + 'title' => '定制状态', + 'description' => '定制状态', + 'type' => 'string', + 'example' => 'enable', + ], + 'subId' => [ + 'title' => '定制记录ID', + 'description' => '定制记录ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'example' => '{"RequestId":"3250A51D-C11D-46BA-B6B3-95348EEDE652","Description":"成功","Content":{"data":[{"subId":5,"reportId":[1,2,3],"createTime":"2020-09-25T09:39:33Z","domains"["all"],"effectiveFrom":"2020-09-17T00:00:00Z","effectiveEnd":"2020-11-17T00:00:00Z","status":"enable"}]}}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3250A51D-C11D-46BA-B6B3-95348EEDE652', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Content\\": {\\n \\"data\\": [\\n {\\n \\"createTime\\": \\"2024-05-16T09:43:38Z\\",\\n \\"domains\\": [\\n \\"a.b.com\\"\\n ],\\n \\"effectiveEnd\\": \\"2024-05-16T09:43:38Z\\",\\n \\"effectiveFrom\\": \\"2024-05-16T09:43:38Z\\",\\n \\"reportId\\": [\\n 1\\n ],\\n \\"status\\": \\"enable\\",\\n \\"subId\\": 1\\n }\\n ]\\n },\\n \\"RequestId\\": \\"3250A51D-C11D-46BA-B6B3-95348EEDE652\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnSubListResponse>\\n <RequestId>3250A51D-C11D-46BA-B6B3-95348EEDE652</RequestId>\\n <Description>成功</Description>\\n <Content>\\n <data>\\n <subId>5</subId>\\n <reportId>1</reportId>\\n <reportId>2</reportId>\\n <reportId>3</reportId>\\n <createTime>2020-09-25T09:39:33Z</createTime>\\n <domains>www.example.com</domains>\\n <domains>www.example.com</domains>\\n <effectiveFrom>2020-09-17T00:00:00Z</effectiveFrom>\\n <effectiveEnd>2020-11-17T00:00:00Z</effectiveEnd>\\n <status>enable</status>\\n </data>\\n </Content>\\n</DescribeCdnSubListResponse>","errorExample":""}]', + 'title' => '查询报表定制任务', + 'description' => '- 调用该接口默认返回所有已定制的报表，但目前只支持展示单个定制任务，因此调用结果只会返回一个定制报表任务。'."\n" + .'- 单用户调用频率：3次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**data数据说明**'."\n" + ."\n" + .'|参数|类型|描述|'."\n" + .'|--------|------|------------|'."\n" + .'|subId|Long|任务的请求ID。|'."\n" + .'|reportId|Long[]|报表ID列表。|'."\n" + .'|createTime|String|报表创建时间。|'."\n" + .'|domains|String[]|定制报表的域名列表。|'."\n" + .'|effectiveFrom|String|定制任务开始时间。|'."\n" + .'|effectiveEnd|String|定制任务结束时间。|'."\n" + .'|status|String|定制任务状态。取值：<br>**enable**：启用。<br>**disable**：关闭。|', + 'extraInfo' => ' ', + ], + 'UpdateCdnSubTask' => [ + 'summary' => '调用UpdateCdnSubTask更新已定制的运营报表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111921', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '新定制的报表ID列表，多个用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'formData', + 'schema' => [ + 'description' => '待订阅的域名列表，支持批量查询域名，多个域名用英文逗号（,）分隔'."\n" + .'如果不传该参数，默认为账号下的所有域名订阅报表交付任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '定制任务的开始时间。使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-09-17T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '定制任务的结束时间。使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-17T00:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateCdnSubTaskResponse>\\r\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</UpdateCdnSubTaskResponse>","errorExample":""}]', + 'title' => '更新报表定制任务', + 'description' => '>单用户调用频率：3次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCdnSubTask' => [ + 'summary' => '调用DeleteCdnSubTask删除所有已定制的运营报表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '111703', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCdnSubTaskResponse>\\r\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</DeleteCdnSubTaskResponse>","errorExample":""}]', + 'title' => '删除报表定制任务', + 'description' => '> 单用户调用频率：3次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnReport' => [ + 'summary' => '调用DescribeCdnReport查询已定制的报表数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111737', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的域名列表，多个域名用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example1.com,example2.com', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的报表ID，每次调用仅支持传入单个报表ID。您可以调用[DescribeCdnSubList](~~271655~~)接口查询报表ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取地域英文名。'."\n" + ."\n" + .'- 如果不传该参数，默认查询全部地域。'."\n" + .'- 如果传入指定地域，则按照指定的地域获取相应数据。支持传入多个地域，多个地域用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + [ + 'name' => 'IsOverseas', + 'in' => 'query', + 'schema' => [ + 'description' => '是否为中国内地以外的区域。取值：'."\n" + .'- **1**：中国内地以外的区域。'."\n" + .'- **0**：中国内地。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'HttpCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP状态码。取值：'."\n" + ."\n" + .'- **2xx**：2xx状态码。'."\n" + .'- **3xx**：3xx状态码。'."\n" + .'- **4xx**：4xx状态码。'."\n" + .'- **5xx**：5xx状态码。'."\n" + ."\n" + .'如果不传该参数，默认查询以上全部HTTP状态码。', + 'type' => 'string', + 'required' => false, + 'example' => '2xx', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2020-09-17T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。使用UTC+0时间表示，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2020-09-17T01:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '查询到的报表数据。', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'title' => '报表主体', + 'description' => '报表主体', + 'type' => 'array', + 'items' => [ + 'title' => '报表', + 'description' => '报表', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'title' => '报表具体数据', + 'description' => '报表具体数据', + 'type' => 'array', + 'items' => [ + 'title' => '每行数据内容', + 'description' => '每行数据内容', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '数据值', + 'description' => '数据值', + 'type' => 'string', + ], + ], + ], + 'deliver' => [ + 'title' => '交付方式', + 'description' => '交付方式', + 'type' => 'object', + 'properties' => [ + 'report' => [ + 'title' => '报表相关信息', + 'description' => '报表相关信息', + 'type' => 'object', + 'properties' => [ + 'format' => [ + 'title' => '报表格式', + 'description' => '报表格式', + 'type' => 'string', + 'example' => 'table', + ], + 'header' => [ + 'title' => '表头', + 'description' => '表头', + 'type' => 'array', + 'items' => [ + 'title' => '表头', + 'description' => '表头', + 'type' => 'string', + 'example' => 'acc', + ], + ], + 'outLine' => [ + 'title' => '输出行数', + 'description' => '输出行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'outSize' => [ + 'title' => '输出大小', + 'description' => '输出大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'shape' => [ + 'title' => '图表图形', + 'description' => '图表图形', + 'type' => 'string', + 'example' => 'line', + ], + 'title' => [ + 'title' => '报表标题', + 'description' => '报表标题', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'example' => '{'."\n" + .' "data": ['."\n" + .' {'."\n" + .' "deliver": {'."\n" + .' "report": {'."\n" + .' "title": "TopUrlByAcc",'."\n" + .' "format": "table",'."\n" + .' "shape": "",'."\n" + .' "header": ['."\n" + .' "url",'."\n" + .' "traf",'."\n" + .' "traf_rate",'."\n" + .' "acc",'."\n" + .' "acc_rate"'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' "data": ['."\n" + .' {'."\n" + .' "acc": 440,'."\n" + .' "acc_rate": "0.200%",'."\n" + .' "traf": 22,'."\n" + .' "url": "http://demo.com",'."\n" + .' "traf_rate": "0.100%"'."\n" + .' },'."\n" + .' {'."\n" + .' "acc": 440,'."\n" + .' "acc_rate": "0.200%",'."\n" + .' "traf": 22,'."\n" + .' "url": "http://demo.com",'."\n" + .' "traf_rate": "0.100%"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Content\\": {\\n \\"data\\": [\\n {\\n \\"data\\": [\\n {\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"deliver\\": {\\n \\"report\\": {\\n \\"format\\": \\"table\\",\\n \\"header\\": [\\n \\"acc\\"\\n ],\\n \\"outLine\\": 0,\\n \\"outSize\\": 0,\\n \\"shape\\": \\"line\\",\\n \\"title\\": \\"test\\"\\n }\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnReportResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <Description>成功</Description>\\n <Content>\\n <data>\\n <deliver>\\n <report>\\n <title>TopUrlByAcc</title>\\n <format>table</format>\\n <shape/>\\n <header>url</header>\\n <header>traf</header>\\n <header>traf_rate</header>\\n <header>acc</header>\\n <header>acc_rate</header>\\n </report>\\n </deliver>\\n <data>\\n <acc>440</acc>\\n <acc_rate>0.200%</acc_rate>\\n <traf>22</traf>\\n <url>http://demo.com</url>\\n <traf_rate>0.100%</traf_rate>\\n </data>\\n <data>\\n <acc>440</acc>\\n <acc_rate>0.200%</acc_rate>\\n <traf>22</traf>\\n <url>http://demo.com</url>\\n <traf_rate>0.100%</traf_rate>\\n </data>\\n </data>\\n </Content>\\n</DescribeCdnReportResponse>","errorExample":""}]', + 'title' => '查询报表定制数据', + 'description' => '> 单用户调用频率：3次/秒。', + 'requestParamsDescription' => '**各报表必传的请求参数说明**'."\n" + .'|报表名称|必传参数|说明|'."\n" + .'|--------|------------------|-----|'."\n" + .'|PV和UV|Action、ReportId、DomainName、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|Top客户端IP（按流量排序）|Action、ReportId、DomainName、Area、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|Top客户端IP（按请求数排序）|Action、ReportId、DomainName、Area、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|访问区域分布|Action、ReportId、DomainName、IsOverseas、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|运营商分布|Action、ReportId、DomainName、IsOverseas、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|热门Referer（按流量排序）|Action、ReportId、DomainName、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|热门Referer（按请求数排序）|Action、ReportId、DomainName、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|热门URL（按流量排序）|Action、ReportId、DomainName、HttpCode、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|热门URL（按请求数排序）|Action、ReportId、DomainName、HttpCode、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|回源热门URL（按流量排序）|Action、ReportId、DomainName、HttpCode、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|回源热门URL（按请求数排序）|Action、ReportId、DomainName、HttpCode、StartTime、EndTime。|不支持其他参数。|'."\n" + .'|域名排行（按流量排序）|Action、ReportId、StartTime、EndTime。|不支持其他参数。|', + 'responseParamsDescription' => '**data数据说明**'."\n" + .'|参数|类型|描述|'."\n" + .'|--------|------------------|-----|'."\n" + .'|deliver|report|报表样式。|'."\n" + .'|data|String[]|报表中的数据，例如：[{"表头字段1":"value1","表头字段2":"value2"}, {"表头字段1":"value3","表头字段2":"value4"}]。|'."\n" + ."\n" + .'**report数据说明**'."\n" + .'|参数|类型|描述|'."\n" + .'|--------|------------------|--------|'."\n" + .'|title|String|报表标题。|'."\n" + .'|format|String|报表类型。取值如下：<br>chart：图表。<br>table：表格。|'."\n" + .'|shape|String|图表类型。当format为table时，请忽略此字段。取值如下：<br>line：曲线图。<br>pie：饼状图。<br>bar：柱状图。|'."\n" + .'|header|String[]|报表的表头字段。|'."\n" + .'|legend|String|图形的图例字段。|'."\n" + .'|xAxis|String|图形x轴，没有则为空。|'."\n" + .'|yAxis|String|图形y轴，没有则为空。|', + 'extraInfo' => ' ', + ], + 'DescribeCdnReportList' => [ + 'summary' => '查询所有的定制报表列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111738', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的报表ID。如果不传该参数，默认查询所有报表。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回主体', + 'description' => '返回主体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Content' => [ + 'description' => '报表列表。', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '返回报表主体', + 'type' => 'array', + 'items' => [ + 'title' => '返回报表主体', + 'description' => '返回报表主体', + 'type' => 'object', + 'properties' => [ + 'deliver' => [ + 'title' => '报表展示形式', + 'description' => '报表展示形式', + 'type' => 'object', + 'properties' => [ + 'report' => [ + 'title' => '报表信息', + 'description' => '报表信息', + 'type' => 'object', + 'properties' => [ + 'format' => [ + 'title' => '展示形式', + 'description' => '展示形式', + 'type' => 'string', + 'example' => 'table', + ], + 'header' => [ + 'title' => '表格表头列表', + 'description' => '表格表头列表', + 'type' => 'array', + 'items' => [ + 'title' => '表头', + 'description' => '表头', + 'type' => 'string', + 'example' => 'url', + ], + ], + 'outLine' => [ + 'title' => '输出行数', + 'description' => '输出行数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'outSize' => [ + 'title' => '输出大小', + 'description' => '输出大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'shape' => [ + 'title' => '报表展示图形', + 'description' => '报表展示图形', + 'type' => 'string', + 'example' => 'line', + ], + 'title' => [ + 'title' => '报表标题', + 'description' => '报表标题', + 'type' => 'string', + 'example' => 'TopUrlByAcc', + ], + ], + ], + ], + ], + 'reportId' => [ + 'title' => '报表ID', + 'description' => '报表ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'example' => '"data":[{"reportId":1,"deliver":{"report":{"title":"DomainPvUv","format":"chart","shape":"line","xAxis":"ds","yAxis":"cnt","legend":"cnt_type","header":["ds","cnt_type","cnt"]}}}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Content\\": {\\n \\"data\\": [\\n {\\n \\"deliver\\": {\\n \\"report\\": {\\n \\"format\\": \\"table\\",\\n \\"header\\": [\\n \\"url\\"\\n ],\\n \\"outLine\\": 0,\\n \\"outSize\\": 0,\\n \\"shape\\": \\"line\\",\\n \\"title\\": \\"TopUrlByAcc\\"\\n }\\n },\\n \\"reportId\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnReportListResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <Description>成功</Description>\\n <Content>\\n <data>\\n <reportId>1</reportId>\\n <deliver>\\n <report>\\n <title>DomainPvUv</title>\\n <format>chart</format>\\n <shape>line</shape>\\n <xAxis>ds</xAxis>\\n <yAxis>cnt</yAxis>\\n <legend>cnt_type</legend>\\n <header>ds</header>\\n <header>cnt_type</header>\\n <header>cnt</header>\\n </report>\\n </deliver>\\n </data>\\n <data>\\n <reportId>2</reportId>\\n <deliver>\\n <report>\\n <format>table</format>\\n <shape>line</shape>\\n <header>url</header>\\n <header>traf</header>\\n <header>traf_rate</header>\\n <header>acc</header>\\n <header>acc_rate</header>\\n <title>TopUrlByAcc</title>\\n </report>\\n </deliver>\\n </data>\\n </Content>\\n</DescribeCdnReportListResponse>","errorExample":""}]', + 'title' => '查询报表定制列表', + 'description' => '- 该接口将返回所有定制报表的元数据，不包含具体报表的统计数据。'."\n" + .'- 单用户调用频率：3次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**data数据说明**'."\n" + .'|参数|类型|描述|'."\n" + .'|--------|------------------|----|'."\n" + .'|reportId|Long|任务的请求ID。|'."\n" + .'|deliver|report|报表样式。|'."\n" + ."\n" + .'**report数据说明**'."\n" + .'|参数|类型|描述|'."\n" + .'|--------|------------------|-----|'."\n" + .'|title|String|报表标题。|'."\n" + .'|format|String|报表类型。取值：<br>chart：图表。<br>table：表格。|'."\n" + .'|shape|String|图表类型。当format为table时，请忽略此字段。取值：<br>line：曲线图。<br>pie：饼状图。<br>bar：柱状图。|'."\n" + .'|header|String[]|报表的表头字段。|'."\n" + .'|legend|String|图形的图例字段。|'."\n" + .'|xAxis|String|图形x轴，没有则为空。|'."\n" + .'|yAxis|String|图形y轴，没有则为空。|', + 'extraInfo' => ' ', + ], + 'CreateCdnDeliverTask' => [ + 'summary' => '调用CreateCdnDeliverTask创建报表订阅任务，订阅成功后系统会周期性地以邮件方式向您发送报表统计数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '111692', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅交付任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => '域名订阅', + ], + ], + [ + 'name' => 'Reports', + 'in' => 'formData', + 'schema' => [ + 'description' => '待订阅的报表列表，需进行JSON转义。', + 'type' => 'string', + 'required' => true, + 'example' => '[{\\"reportId\\":1,\\"conditions\\":[{\\"field\\":\\"prov\\",\\"op\\":\\"in\\",\\"value\\":[\\"黑龙江\\",\\"北京\\"]}]}]', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'formData', + 'schema' => [ + 'description' => '<props="china">待订阅的域名列表，多个域名用半角逗号（,）分隔，订阅域名数量上限为500个，超过500个请[填写信息](https://page.aliyun.com/form/act2017566026/index.htm)申请。</props>'."\n" + ."\n" + .'<props="intl">待订阅的域名列表，多个域名用半角逗号（,）分隔，订阅域名数量上限为500个，超过500个请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.2020520001.aliyun_topbar.18.dbd44bd3e4f845#/ticket/createIndex)申请。</props>'."\n" + .'> 不传该参数，默认为账号下的所有域名订阅报表交付任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example1.com,www.example2.com', + ], + ], + [ + 'name' => 'Deliver', + 'in' => 'formData', + 'schema' => [ + 'description' => '报表发送方式，仅支持邮件发送，需进行JSON转义。', + 'type' => 'string', + 'required' => true, + 'example' => '{"email":{"subject":"主题名称","to":["[email protected]","[email protected]"]}}', + ], + ], + [ + 'name' => 'Schedule', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅周期相关参数，需进行JSON转义。', + 'type' => 'string', + 'required' => true, + 'example' => '{\\"schedName\\":\\"周期任务名称\\",\\"description\\":\\"描述\\",\\"crontab\\":\\"000**?\\",\\"frequency\\":\\"d\\",\\"status\\":\\"enable\\",\\"effectiveFrom\\":\\"2020-09-17T00:00:00Z\\",\\"effectiveEnd\\":\\"2020-11-17T00:00:00Z\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeliverId' => [ + 'description' => '订阅任务ID。', + 'type' => 'string', + 'example' => '1025', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeliverId\\": \\"1025\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCdnDeliverTaskResponse>\\n <DeliverId>1025</DeliverId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</CreateCdnDeliverTaskResponse>","errorExample":""}]', + 'title' => '创建报表订阅任务', + 'description' => '> 单用户调用频率：3次/秒。', + 'requestParamsDescription' => '**ReDatas数据说明**'."\n" + ."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|-------|-----|------|'."\n" + .'|reportId|String|是|报表ID。|'."\n" + .'|conditions|ConDatas[]|否|报表过滤条件。|'."\n" + ."\n" + .'**ConDatas数据说明**'."\n" + ."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|----|-----|---------|'."\n" + .'|field|String|否|过滤字段。|'."\n" + .'|op|String|否|过滤操作。|'."\n" + .'|value|String[]|否|字段值数组。|'."\n" + ."\n" + .'**email数据说明**'."\n" + ."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|-----|------|-------|'."\n" + .'|subject|String|是|订阅主题。|'."\n" + .'|to|String[]|是|收件邮箱列表数组。|'."\n" + ."\n" + .'**Deliver数据说明**'."\n" + ."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|-----------|---|---|'."\n" + .'|subject|String|否|订阅主题。|'."\n" + .'|to|String[]|是|收件邮箱列表数组。|'."\n" + ."\n" + .'**Schedule数据说明**'."\n" + ."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|-----------|----|---|'."\n" + .'|schedName|String|否|订阅任务名称。|'."\n" + .'|description|String|否|订阅任务描述。|'."\n" + .'|crontab|String|是|订阅任务执行周期。|'."\n" + .'|frequency|String|是|执行频率。取值：<br>**h**：小时<br>**d**：天<br>**w**：周|'."\n" + .'|status|String|否|订阅任务状态。取值：<br>**enable**：启用。<br>**disable**：关闭。|'."\n" + .'|effectiveFrom|String|否|订阅交付任务开始时间。|'."\n" + .'|effectiveEnd|String|否|订阅交付任务结束时间。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCdnDeliverList' => [ + 'summary' => '调用DescribeCdnDeliverList查询报表订阅任务列表，系统将返回该用户所有的订阅任务列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111724', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DeliverId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的订阅任务ID。如果不传该参数，默认返回所有的订阅任务。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回主体', + 'description' => '返回主体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '12345', + ], + 'Content' => [ + 'description' => '订阅任务列表数据。', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'title' => '订阅内容主体', + 'description' => '订阅内容主体', + 'type' => 'array', + 'items' => [ + 'title' => '订阅内容主体', + 'description' => '订阅内容主体', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-12-30T10:29:29Z', + ], + 'crontab' => [ + 'title' => '定时任务配置', + 'description' => '定时任务配置', + 'type' => 'string', + 'example' => '00 00 08 * * ?', + ], + 'deliver' => [ + 'title' => '订阅形式', + 'description' => '订阅形式', + 'type' => 'object', + 'properties' => [ + 'email' => [ + 'title' => '邮件订阅内容', + 'description' => '邮件订阅内容', + 'type' => 'object', + 'properties' => [ + 'to' => [ + 'title' => '收件人', + 'description' => '收件人', + 'type' => 'array', + 'items' => [ + 'title' => '邮箱地址', + 'description' => '邮箱地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + ], + ], + 'deliverId' => [ + 'title' => '订阅ID', + 'description' => '订阅ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'dmList' => [ + 'title' => '域名列表', + 'description' => '域名列表', + 'type' => 'array', + 'items' => [ + 'title' => '域名', + 'description' => '域名', + 'type' => 'string', + 'example' => 'a.b.c', + ], + ], + 'frequency' => [ + 'title' => '订阅发送频率', + 'description' => '订阅发送频率', + 'type' => 'string', + 'example' => 'd', + ], + 'name' => [ + 'title' => '订阅名称', + 'description' => '订阅名称', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'reports' => [ + 'title' => '订阅的报表列表', + 'description' => '订阅的报表列表', + 'type' => 'array', + 'items' => [ + 'title' => '报表', + 'description' => '报表', + 'type' => 'object', + 'properties' => [ + 'reportId' => [ + 'title' => '报表ID', + 'description' => '报表ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'status' => [ + 'title' => '订阅状态', + 'description' => '订阅状态', + 'type' => 'string', + 'example' => 'enable', + ], + 'timeEndFormat' => [ + 'title' => '订阅生效截止时间', + 'description' => '订阅生效截止时间', + 'type' => 'string', + 'example' => '-1d', + ], + 'timeFromFormat' => [ + 'title' => '订阅生效开始时间', + 'description' => '订阅生效开始时间', + 'type' => 'string', + 'example' => '-1d', + ], + ], + ], + ], + ], + 'example' => '"data": [{"deliverId": 1,"status": "enable","createTime": "2020-10-14T11:19:26Z","crontab": "0 0 0 * * ?","frequency": "d","name": "域名订阅","dmList": ["www.example.com"],"reports": [{"reportId": 1,"conditions": [{"op": "in","field": "prov","value": ["黑龙江","北京"]}]},{"reportId": 2}],"deliver": {"email": {"subject": "主题","to": ["[email protected]","[email protected]"]}}}]}}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"12345\\",\\n \\"Content\\": {\\n \\"data\\": [\\n {\\n \\"createTime\\": \\"2021-12-30T10:29:29Z\\",\\n \\"crontab\\": \\"00 00 08 * * ?\\",\\n \\"deliver\\": {\\n \\"email\\": {\\n \\"to\\": [\\n \\"[email protected]\\"\\n ]\\n }\\n },\\n \\"deliverId\\": 1,\\n \\"dmList\\": [\\n \\"a.b.c\\"\\n ],\\n \\"frequency\\": \\"d\\",\\n \\"name\\": \\"xxxx\\",\\n \\"reports\\": [\\n {\\n \\"reportId\\": 1\\n }\\n ],\\n \\"status\\": \\"enable\\",\\n \\"timeEndFormat\\": \\"-1d\\",\\n \\"timeFromFormat\\": \\"-1d\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCdnDeliverListResponse>\\n <RequestId>12345</RequestId>\\n <Content>\\n <data>\\n <deliverId>1</deliverId>\\n <status>enable</status>\\n <createTime>2020-10-14T11:19:26Z</createTime>\\n <crontab>0 0 0 * * ?</crontab>\\n <frequency>d</frequency>\\n <name>域名订阅</name>\\n <dmList>www.example.com</dmList>\\n <reports>\\n <reportId>1</reportId>\\n <conditions>\\n <op>in</op>\\n <field>prov</field>\\n <value>黑龙江</value>\\n <value>北京</value>\\n </conditions>\\n </reports>\\n <reports>\\n <reportId>2</reportId>\\n </reports>\\n <deliver>\\n <email>\\n <subject>主题</subject>\\n <to>[email protected]</to>\\n <to>[email protected]</to>\\n </email>\\n </deliver>\\n </data>\\n </Content>\\n</DescribeCdnDeliverListResponse>","errorExample":""}]', + 'title' => '查询报表订阅列表', + 'description' => '> 单用户调用频率：3次/秒。', + 'responseParamsDescription' => '**data数据说明**'."\n" + ."\n" + .'|参数|类型|描述|'."\n" + .'|--------|-------|-----------|'."\n" + .'|deliverId|Long|订阅任务ID。|'."\n" + .'|status|String|订阅任务状态。取值：<br>**enable**：启用。<br>**disable**：关闭。|'."\n" + .'|createTime|String|订阅任务创建时间。|'."\n" + .'|crontab|String|订阅任务执行周期。|'."\n" + .'|frequency|String|执行频率。取值：<br>**h**：小时<br>**d**：天<br>**M**：月|'."\n" + .'|name|String|订阅任务名称。|'."\n" + .'|dmList|String[]|订阅任务的域名过滤列表。|'."\n" + .'|reports|String[]|订阅报表列表。包含以下参数：<br>reportId：报表ID。<br>conditions：报表过滤条件（包含过滤操作、过滤字段和过滤值），没有则为空。op：过滤操作，目前只支持**in**；field：过滤字段；value：过滤值。|'."\n" + .'|deliver|String|交付模块，包含邮件主题、收件人等信息。<br>email：邮件交付。<br>subject：邮件主题。<br>to：发送邮件列表。<br>copy：抄送邮件列表。|'."\n" + ."\n" + .'**reports数据说明**'."\n" + ."\n" + .'|参数|类型|描述|'."\n" + .'|--------|---------|---------|'."\n" + .'|deliverId|Long|订阅任务ID。|'."\n" + .'|status|String|订阅任务状态。取值：<br>**enable**：启用。<br>**disable**：关闭。|', + ], + 'UpdateCdnDeliverTask' => [ + 'summary' => '调用UpdateCdnDeliverTask根据订阅任务ID更新已订阅的报表任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111920', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeliverId', + 'in' => 'formData', + 'schema' => [ + 'description' => '待更新的订阅任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => '域名订阅', + ], + ], + [ + 'name' => 'Reports', + 'in' => 'formData', + 'schema' => [ + 'description' => '待订阅的报表列表，需进行JSON转义。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"reportId\\":1,\\"conditions\\":[{\\"field\\":\\"prov\\",\\"op\\":\\"in\\",\\"value\\":[\\"黑龙江\\",\\"北京\\"]}]}]', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'formData', + 'schema' => [ + 'description' => '待订阅的域名列表，支持批量查询域名，多个域名用英文逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'如果不传该参数，默认为账号下的所有域名订阅报表交付任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'Deliver', + 'in' => 'formData', + 'schema' => [ + 'description' => '报表发送方式，仅支持邮件发送，需进行JSON转义。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"email\\":{\\"subject\\":\\"主题名称\\",\\"to\\":[\\"[email protected]\\",\\"[email protected]\\"]}}"', + ], + ], + [ + 'name' => 'Schedule', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅周期相关参数，需进行JSON转义。', + 'type' => 'string', + 'required' => false, + 'example' => '"{\\"schedName\\":\\"周期任务名称\\",\\"description\\":\\"描述\\",\\"crontab\\":\\"000**?\\",\\"frequency\\":\\"d\\",\\"status\\":\\"enable\\",\\"effectiveFrom\\":\\"2020-09-17T00:00:00Z\\",\\"effectiveEnd\\":\\"2020-11-17T00:00:00Z\\"}"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateCdnDeliverTaskResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateCdnDeliverTaskResponse>","errorExample":""}]', + 'title' => '更新报表订阅任务', + 'description' => '> 单用户调用频率：3次/秒。'."\n", + 'requestParamsDescription' => '**ReDatas数据说明**'."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|--------|------|----|'."\n" + .'|reportId|String|是|报表ID。|'."\n" + .'|conditions|ConDatas[]|否|报表过滤条件。|'."\n" + ."\n" + .'**ConDatas数据说明**'."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|------|------|------|'."\n" + .'|field|String|否|过滤字段。|'."\n" + .'|op|String|否|过滤操作。|'."\n" + .'|value|String[]|否|字段值数组。|'."\n" + ."\n" + .'**email数据说明**'."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|-------|------|-----|'."\n" + .'|subject|String|是|订阅主题。|'."\n" + .'|to|String[]|是|收件邮箱列表。|'."\n" + ."\n" + .'**Deliver数据说明**'."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|-----|------|-------|'."\n" + .'|subject|String|否|订阅主题。|'."\n" + .'|to|String[]|是|收件邮箱列表。|'."\n" + ."\n" + .'**Schedule数据说明**'."\n" + .'|参数|类型|是否必须|描述|'."\n" + .'|--------|--------|-----|-----|'."\n" + .'|schedName|String|否|订阅任务名称。|'."\n" + .'|description|String|否|订阅任务描述。|'."\n" + .'|crontab|String|是|订阅任务执行周期。|'."\n" + .'|frequency|String|是|执行频率。取值：<br>**h**：小时<br>**d**：天<br>**w**：周|'."\n" + .'|status|String|否|订阅任务状态。取值：<br>**enable**：启用。<br>**disable**：关闭。|'."\n" + .'|effectiveFrom|String|否|订阅交付任务开始时间。|'."\n" + .'|effectiveEnd|String|否|订阅交付任务结束时间。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCdnDeliverTask' => [ + 'summary' => '调用DeleteCdnDeliverTask根据任务ID删除已订阅的报表任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '111701', + 'abilityTreeNodes' => [ + 'FEATUREcdnEK7SNH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DeliverId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的订阅任务ID。您可以调用[DescribeCdnDeliverList](~~270877~~)接口查询订阅任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'TimeParseFailed', + 'errorMessage' => 'Failed to parse the time parameter.', + ], + [ + 'errorCode' => 'SubscriptionAlreadyExists', + 'errorMessage' => 'The subscription already exists.', + ], + [ + 'errorCode' => 'SubscriptionNotFound', + 'errorMessage' => 'The subscription is not found.', + ], + [ + 'errorCode' => 'NameAlreadyExists', + 'errorMessage' => 'The name already exists.', + ], + [ + 'errorCode' => 'DeliverExceedLimit', + 'errorMessage' => 'The maximum number of subscribed tasks is exceeded.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCdnDeliverTaskResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteCdnDeliverTaskResponse>","errorExample":""}]', + 'title' => '删除报表订阅任务', + 'description' => '> 单用户调用频率：3次/秒。', + ], + 'DescribeIpInfo' => [ + 'summary' => '调用DescribeIpInfo验证指定的IP是否为阿里云CDN节点的IP地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111823', + 'abilityTreeNodes' => [ + 'FEATUREcdnNSUDKT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IP', + 'in' => 'query', + 'schema' => [ + 'description' => '指定IP地址，不支持批量。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CdnIp' => [ + 'description' => '是否属于阿里云CDN节点。'."\n" + ."\n" + .'- **True**：属于。'."\n" + ."\n" + .'- **False**：不属于。', + 'type' => 'string', + 'example' => 'True', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '123847FA-9A00-4426-83B8-B4B45D475930', + ], + 'RegionEname' => [ + 'description' => '所属地域英文名称。', + 'type' => 'string', + 'example' => 'China-Guizhou-guiyang', + ], + 'Region' => [ + 'description' => '所属地域中文名称。', + 'type' => 'string', + 'example' => '中国-贵州省-贵阳市', + ], + 'IspEname' => [ + 'description' => '所属运营商英文名称。', + 'type' => 'string', + 'example' => 'telecom', + ], + 'ISP' => [ + 'description' => '所属运营商中文名称。', + 'type' => 'string', + 'example' => '电信', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidIP.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter IP is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CdnIp\\": \\"True\\",\\n \\"RequestId\\": \\"123847FA-9A00-4426-83B8-B4B45D475930\\",\\n \\"RegionEname\\": \\"China-Guizhou-guiyang\\",\\n \\"Region\\": \\"中国-贵州省-贵阳市\\",\\n \\"IspEname\\": \\"telecom\\",\\n \\"ISP\\": \\"电信\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeIpInfoResponse>\\n <CdnIp>True</CdnIp>\\n <RequestId>123847FA-9A00-4426-83B8-B4B45D475930</RequestId>\\n <RegionEname>China-Guizhou-guiyang</RegionEname>\\n <Region>中国-贵州省-贵阳市</Region>\\n <IspEname>telecom</IspEname>\\n <ISP>电信</ISP>\\n</DescribeIpInfoResponse>","errorExample":""}]', + 'title' => '查询IP是否为CDN节点', + 'description' => '> 单用户调用频率：50次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeStagingIp' => [ + 'summary' => '调用DescribeStagingIp查询模拟环境的节点IP地址。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111836', + 'abilityTreeNodes' => [ + 'FEATUREcdnD8A1YM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1B9E0E83-24AC-49F4-9EE0-BF5EB03E8381', + ], + 'IPV4s' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IPV4' => [ + 'description' => 'IPv4格式的IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPv4地址。', + 'type' => 'string', + 'example' => 'xx.xx.xx.xx', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B9E0E83-24AC-49F4-9EE0-BF5EB03E8381\\",\\n \\"IPV4s\\": {\\n \\"IPV4\\": [\\n \\"xx.xx.xx.xx\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeStagingIpResponse>\\n<IPV4s>\\n <IPV4>xx.xx.xx.xx</IPV4>\\n <IPV4>xx.xx.xx.xx</IPV4>\\n <IPV4>xx.xx.xx.xx</IPV4>\\n</IPV4s>\\n<RequestId>1B9E0E83-24AC-49F4-9EE0-BF5EB03E8381</RequestId>\\n</DescribeStagingIpResponse>","errorExample":""}]', + 'title' => '查询节点IP列表-模拟环境-L1', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeL2VipsByDomain' => [ + 'summary' => '调用DescribeL2VipsByDomain查询指定域名的L2节点的IP地址。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111825', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持查询单个域名。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Vips' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Vip' => [ + 'description' => 'VIP列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VIP地址。', + 'type' => 'string', + 'example' => '1.1.1.1/25', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => 'Illegal domain operate is not permitted.', + ], + [ + 'errorCode' => 'SingleRequest.OverLimit', + 'errorMessage' => 'A maximum of 1 DomainName is supported for each request.', + ], + ], + 403 => [ + [ + 'errorCode' => 'SystemBusy', + 'errorMessage' => 'The system is busy, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Vips\\": {\\n \\"Vip\\": [\\n \\"1.1.1.1/25\\"\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeL2VipsByDomainResponse>\\r\\n\\t<Vips>\\r\\n\\t\\t<Vip>xxx.111.111/25</Vip>\\r\\n\\t\\t<Vip>xxx.112.112/25</Vip>\\r\\n\\t\\t<Vip>xxx.33.190/25</Vip>\\r\\n\\t\\t<Vip>xxx.96.109/25</Vip>\\r\\n\\t\\t<Vip>xxx.20.226/25</Vip>\\r\\n\\t\\t<Vip>xxx.19.140/25</Vip>\\r\\n\\t\\t<Vip>xxx.215.140/25</Vip>\\r\\n\\t</Vips>\\r\\n\\t<RequestId>820E7900-5CA9-4AEF-B0DD-20ED5F64BE55</RequestId>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n</DescribeL2VipsByDomainResponse>\\t\\r\\n","errorExample":""}]', + 'title' => '查询节点IP地址-L2', + 'description' => '该接口仅支持日峰值带宽为1Gbps以上的用户调用，如果您符合该条件，请提交工单申请该接口的调用权限。 '."\n" + .'- 单用户调用频率：40次/秒。'."\n" + .'- 本接口的返回结果仅支持CDN控制台接入域名查询相关L2节点地址，DCDN控制台接入域名不适用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserVipsByDomain' => [ + 'summary' => '调用DescribeUserVipsByDomain查询域名的IP列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111846', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名，只支持单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Available', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询健康VIP。取值：'."\n" + ."\n" + .'- **on**：健康VIP。'."\n" + .'- **off**：全部VIP。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => '全部VIP', + 'on' => '健康VIP', + ], + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '820E7900-5CA9-4AEF-B0DD-20ED5F64BE55', + ], + 'Vips' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Vip' => [ + 'description' => 'VIP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VIP地址。', + 'type' => 'string', + 'example' => '122.72.xxx.xxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified value of parameter "DomainName" can not be empty.', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided is offline or not exist.', + ], + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => 'Illegal domain operate is not permitted.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"RequestId\\": \\"820E7900-5CA9-4AEF-B0DD-20ED5F64BE55\\",\\n \\"Vips\\": {\\n \\"Vip\\": [\\n \\"122.72.xxx.xxx\\"\\n ]\\n }\\n}","errorExample":"{\\n \\"Vips\\": {\\n \\"Vip\\": [\\n \\"122.72.xxx.xxx\\",\\n \\"119.14.xxx.xxx\\",\\n \\"221.13.xxx.xxx\\",\\n \\"124.95.xxx.xxx\\",\\n \\"58.211.xxx.xxx\\"\\n ]\\n },\\n \\"RequestId\\": \\"820E7900-5CA9-4AEF-B0DD-20ED5F64BE55\\",\\n \\"DomainName\\": \\"example.com\\"\\n}"},{"type":"xml","example":"<DescribeUserVipsByDomainResponse>\\r\\n\\t<Vips>\\r\\n\\t\\t<Vip>122.72.xxx.xxx</Vip>\\r\\n\\t\\t<Vip>119.14.xxx.xxx</Vip>\\r\\n\\t\\t<Vip>221.13.xxx.xxx</Vip>\\r\\n\\t\\t<Vip>124.95.xxx.xxx</Vip>\\r\\n\\t\\t<Vip>58.211.xxx.xxx</Vip>\\r\\n\\t</Vips>\\r\\n\\t<RequestId>820E7900-5CA9-4AEF-B0DD-20ED5F64BE55</RequestId>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n</DescribeUserVipsByDomainResponse>","errorExample":""}]', + 'title' => '查询节点IP列表-L1', + 'description' => '> 单用户调用频率：30次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeIpStatus' => [ + 'summary' => '调用DescribeIpStatus查询节点IP可用状态，进而根据节点IP可用状态来了解节点加速服务的可用状态。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111824', + 'abilityTreeNodes' => [ + 'FEATUREcdnNSUDKT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Ips', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的IP地址列表，最多支持批量查询20个IP地址，IP地址之间使用下划线_分隔，如：ip1_ip2_ip3。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1_10.10.10.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', + ], + 'IpStatus' => [ + 'description' => '节点IP地址状态列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ip' => [ + 'description' => '节点IP地址。', + 'type' => 'string', + 'example' => '10.10.10.10', + ], + 'status' => [ + 'description' => '状态。'."\n" + ."\n" + .'- **nonali**：非阿里云CDN节点。'."\n" + .'- **normal**：阿里云CDN节点，正常状态。'."\n" + .'- **abnormal**：阿里云CDN节点，异常状态。', + 'type' => 'string', + 'example' => 'abnormal', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidArgIps.Malformed', + 'errorMessage' => 'The specified ips is invalid.', + ], + [ + 'errorCode' => 'InvalidArgIps.IpCanNotFound', + 'errorMessage' => 'The ips can not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"IpStatus\\": [\\n {\\n \\"ip\\": \\"10.10.10.10\\",\\n \\"status\\": \\"abnormal\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeIpStatusResponse>\\n<Content>\\n <status>abnormal</status>\\n <ip>10.10.10.10</ip>\\n</Content>\\n<Content>\\n <status>normal</status>\\n <ip>192.168.0.1</ip>\\n</Content>\\n<Content>\\n <status>nonali</status>\\n <ip>172.16.0.1</ip>\\n</Content>\\n<Content>\\n <status>normal</status>\\n <ip>192.0.2.1</ip>\\n</Content>\\n<RequestId>F61CDR30-E83C-4FDA-BF73-9A94CDD44229</RequestId>\\n</DescribeIpStatusResponse>","errorExample":""}]', + 'title' => '查询节点IP状态', + 'description' => '> 单用户调用频率：50次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddFCTrigger' => [ + 'summary' => '调用AddFCTrigger添加指定的函数计算触发器。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '111678', + 'abilityTreeNodes' => [ + 'FEATUREcdnCG0XWT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TriggerARN', + 'in' => 'query', + 'schema' => [ + 'description' => '函数计算服务对应的触发器。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:fc:cn-beijing: 1234567890:services/FCTestService/functions/printEvent/triggers/testtrigger', + ], + ], + [ + 'name' => 'EventMetaName', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'LogFileCreated', + ], + ], + [ + 'name' => 'EventMetaVersion', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'SourceARN', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件侦听的资源和过滤器。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:cdn:*:1234567890:domain/example.com', + ], + ], + [ + 'name' => 'FunctionARN', + 'in' => 'formData', + 'schema' => [ + 'description' => '功能触发器。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:fc:1223455566666:123:services/myservice/functions/myfunction', + ], + ], + [ + 'name' => 'RoleARN', + 'in' => 'formData', + 'schema' => [ + 'description' => 'RAM授权的角色。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ram:: 1234567890:role/aliyuncdneventnotificationrole', + ], + ], + [ + 'name' => 'Notes', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC046C5D-8CB4-4B6B-B7F8-B335E51EF90', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotFound.EventMeta', + 'errorMessage' => 'EventMeta not found.', + ], + [ + 'errorCode' => 'Duplicated.FCTrigger', + 'errorMessage' => 'FCTrigger has already existed.', + ], + [ + 'errorCode' => 'InvalidParameter.TriggerARN', + 'errorMessage' => 'The specified parameter TriggerARN is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.SourceARN', + 'errorMessage' => 'The specified parameter SourceARN is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionARN', + 'errorMessage' => 'The specified parameter FunctionARN is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.RoleARN', + 'errorMessage' => 'The specified parameter RoleARN is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDeny', + 'errorMessage' => 'No permission to operate this FCTrigger.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC046C5D-8CB4-4B6B-B7F8-B335E51EF90\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EC046C5D-8CB4-4B6B-B7F8-B335E51EF90</RequestId>","errorExample":""}]', + 'title' => '添加函数计算触发器', + 'requestParamsDescription' => '## 数据类型TriggerARN'."\n" + .'TriggerARN的格式为`acs:cdn:{RegionID}:{AccountID}:{Filter}`。'."\n" + ."\n" + .'- Filter表示资源和过滤器，具体格式为： `{FilterName}/{FilterValue}`。当FilterValue为多个枚举值时，需要使用大括号{}括起来，值之间通过半角逗号（,）分割。'."\n" + ."\n" + .'- 对于LogFileCreated事件当前支持基于域名（FilterName为domain）过滤，如果只需要对`example.com`域名触发函数计算，则Filter为`domain/example.com`，如果需要多个域名触发函数计算，则Filter为`domain/{example.com,aliyundoc.com}`。'."\n" + ."\n" + .'- 多个过滤器之间通过正斜线（/）连接，是逻辑与的关系，格式如下所示：`acs:cdn:{RegionID}:{AccountID}:{Filter1}/{Filter2}/{Filter3}...`。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateFCTrigger' => [ + 'summary' => '调用UpdateFCTrigger更新指定的函数计算触发器。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111922', + 'abilityTreeNodes' => [ + 'FEATUREcdnCG0XWT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TriggerARN', + 'in' => 'query', + 'schema' => [ + 'description' => '函数计算服务对应的的触发器。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:fc:cn-beijing: 1234567890:services/FCTestService/functions/printEvent/triggers/testtrigger', + ], + ], + [ + 'name' => 'SourceARN', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件侦听的资源和过滤器。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:cdn:*:1234567890:domain/example.com', + ], + ], + [ + 'name' => 'FunctionARN', + 'in' => 'formData', + 'schema' => [ + 'description' => '功能触发器。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:fc:1223455566666:123:services/myservice/functions/myfunction', + ], + ], + [ + 'name' => 'RoleARN', + 'in' => 'formData', + 'schema' => [ + 'description' => 'RAM授权的角色。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram:: 1234567890:role/aliyuncdneventnotificationrole', + ], + ], + [ + 'name' => 'Notes', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.TriggerARN', + 'errorMessage' => 'The specified parameter TriggerARN is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.SourceARN', + 'errorMessage' => 'The specified parameter SourceARN is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.FunctionARN', + 'errorMessage' => 'The specified parameter FunctionARN is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.RoleARN', + 'errorMessage' => 'The specified parameter RoleARN is not valid.', + ], + [ + 'errorCode' => 'NotFound.FCTrigger', + 'errorMessage' => 'FCTrigger not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDeny', + 'errorMessage' => 'No permission to operate this FCTrigger.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateFCTriggerResponse>\\n <RequestId>EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E</RequestId>\\n</UpdateFCTriggerResponse>","errorExample":""}]', + 'title' => '更新函数计算触发器', + 'requestParamsDescription' => '## 数据类型SourceARN'."\n" + ."\n" + .'SourceARN的格式为`acs:cdn:{RegionID}:{AccountID}:{Filter}`。'."\n" + ."\n" + .'- 其中Filter表示资源和过滤器，具体格式为：` {FilterName}/{FilterValue}`。当FilterValue为多个枚举值时，需要使用大括号{}括起来，值之间通过半角逗号（,）分割。'."\n" + ."\n" + .'- 对于LogFileCreated事件当前支持基于域名（FilterName为domain）的过滤，如果只需要对example.com域名触发函数计算，则Filter为`domain/example.com`，如果需要多个域名触发函数计算，则Filter为`domain/{example.com,aliyun.com}`。'."\n" + ."\n" + .'- 多个过滤器之间通过正斜线（/）连接，是逻辑与的关系，格式如下所示：`acs:cdn:{RegionID}:{AccountID}:{Filter1}/{Filter2}/{Filter3}...`。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeFCTrigger' => [ + 'summary' => '调用DescribeFCTrigger查询指定的函数计算触发器。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111820', + 'abilityTreeNodes' => [ + 'FEATUREcdnCG0XWT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TriggerARN', + 'in' => 'query', + 'schema' => [ + 'description' => '函数计算服务对应的触发器。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:cdn:{RegionID}:{AccountID}:{Filter}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E', + ], + 'FCTrigger' => [ + 'description' => 'FCT触发器。', + 'type' => 'object', + 'properties' => [ + 'TriggerARN' => [ + 'description' => '函数计算服务对应的触发器。', + 'type' => 'string', + 'example' => 'acs:fc:cn-beijing: 1234567890:services/FCTestService/functions/printEvent/triggers/testtrigger', + ], + 'RoleARN' => [ + 'description' => 'RAM授权的角色。', + 'type' => 'string', + 'example' => 'acs:ram:: 1234567890:role/aliyuncdneventnotificationrole', + ], + 'SourceArn' => [ + 'description' => '事件侦听的资源和过滤器。', + 'type' => 'string', + 'example' => 'acs:cdn:*:1234567890:domain/example.com', + ], + 'Notes' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'EventMetaName' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'LogFileCreated', + ], + 'EventMetaVersion' => [ + 'description' => '事件版本。', + 'type' => 'string', + 'example' => '1.0.0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'PermissionDeny', + 'errorMessage' => 'No permission to operate this FCTrigger.', + ], + ], + [ + [ + 'errorCode' => 'NotFound.FCTrigger', + 'errorMessage' => 'FCTrigger not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E\\",\\n \\"FCTrigger\\": {\\n \\"TriggerARN\\": \\"acs:fc:cn-beijing: 1234567890:services/FCTestService/functions/printEvent/triggers/testtrigger\\",\\n \\"RoleARN\\": \\"acs:ram:: 1234567890:role/aliyuncdneventnotificationrole\\",\\n \\"SourceArn\\": \\"acs:cdn:*:1234567890:domain/example.com\\",\\n \\"Notes\\": \\"test\\",\\n \\"EventMetaName\\": \\"LogFileCreated\\",\\n \\"EventMetaVersion\\": \\"1.0.0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E</RequestId>\\n<FCTrigger>\\n <TriggerARN>acs:fc:cn-beijing: 1234567890:services/FCTestService/functions/printEvent/triggers/testtrigger</TriggerARN>\\n <SourceArn>acs:cdn:*:1234567890:domain/example.com</SourceArn>\\n <EventMetaName>LogFileCreated</EventMetaName>\\n <EventMetaVersion>1.0.0</EventMetaVersion>\\n <Notes>test</Notes>\\n <RoleARN>acs:ram:: 1234567890:role/aliyuncdneventnotificationrole</RoleARN>\\n</FCTrigger>","errorExample":""}]', + 'title' => '查询函数计算触发器', + 'responseParamsDescription' => '## 数据类型SourceArn'."\n" + .'SourceArn的格式为`acs:cdn:{RegionID}:{AccountID}:{Filter}`。'."\n" + ."\n" + .'- **Filter**表示资源和过滤器，具体格式为： `{FilterName}/{FilterValue}`。当FilterValue为多个枚举值时，需要使用大括号{}括起来，值之间通过半角逗号（,）分割。'."\n" + ."\n" + .'- 对于LogFileCreated事件当前支持基于域名（FilterName为domain）过滤，如果只需要对example.com域名触发函数计算，则Filter为`domain/example.com`，如果需要多个域名触发函数计算，则Filter为`domain/{example.com,aliyundoc.com}`。'."\n" + ."\n" + .'- 多个过滤器之间通过正斜线（/）连接，是逻辑与的关系，格式如下所示：`acs:cdn:{RegionID}:{AccountID}:{Filter1}/{Filter2}/{Filter3}...`。', + 'extraInfo' => ' ', + ], + 'DeleteFCTrigger' => [ + 'summary' => '调用DeleteFCTrigger删除指定的函数计算触发器。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '111706', + 'abilityTreeNodes' => [ + 'FEATUREcdnCG0XWT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TriggerARN', + 'in' => 'query', + 'schema' => [ + 'description' => '函数计算服务对应的触发器。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:cdn:{RegionID}:{AccountID}:{Filter}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.TriggerARN', + 'errorMessage' => 'The specified parameter TriggerARN is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDeny', + 'errorMessage' => 'No permission to operate this FCTrigger.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteFCTriggerResponse>\\r\\n<RequestId>EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E</RequestId>\\r\\n</DeleteFCTriggerResponse>","errorExample":""}]', + 'title' => '删除函数计算触发器', + 'requestParamsDescription' => '## 数据类型SourceARN'."\n" + .'SourceARN的格式为`acs:cdn:{RegionID}:{AccountID}:{Filter}`。'."\n" + ."\n" + .'- 其中Filter表示资源和过滤器，具体格式为：`{FilterName}/{FilterValue}`。当FilterValue为多个枚举值时，需要使用大括号{}括起来，值之间通过半角逗号（,）分割。'."\n" + ."\n" + .'- 对于LogFileCreated事件当前支持基于域名（FilterName为domain）的过滤，如果只需要对`example.com`域名触发函数计算，则Filter为`domain/example.com`，如果需要多个域名触发函数计算，则Filter为`domain/{example.com,aliyundoc.com}`。'."\n" + ."\n" + .'- 多个过滤器之间通过正斜线（/）连接，是逻辑与的关系，格式如下所示：`acs:cdn:{RegionID}:{AccountID}:{Filter1}/{Filter2}/{Filter3}...`。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFCTrigger' => [ + 'summary' => '调用ListFCTrigger查询指定事件的函数计算触发器列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111861', + 'abilityTreeNodes' => [ + 'FEATUREcdnCG0XWT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EventMetaName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。仅支持传单个名称。'."\n" + ."\n" + .'<props="china">事件名称请参见[CDN事件触发器](~~73333~~)。</props>'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'LogFileCreated', + ], + ], + [ + 'name' => 'EventMetaVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '事件版本号。仅支持传单个版本号。'."\n" + ."\n" + .'<props="china">事件版本请参见[CDN事件触发器](~~73333~~)。</props>'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E', + ], + 'FCTriggers' => [ + 'description' => '获取指定事件的函数计算触发器列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TriggerARN' => [ + 'description' => '函数计算服务对应的触发器。', + 'type' => 'string', + 'example' => 'acs:fc:cn-beijing: 1234567890:services/FCTestService/functions/printEvent/triggers/testtrigger', + ], + 'RoleARN' => [ + 'description' => 'RAM（访问控制）授权的角色。', + 'type' => 'string', + 'example' => 'acs:ram:: 1234567890:role/aliyuncdneventnotificationrole', + ], + 'SourceArn' => [ + 'description' => '事件侦听的资源和过滤器。', + 'type' => 'string', + 'example' => 'acs:cdn:*:1234567890:domain/example.com', + ], + 'Notes' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => '测试', + ], + 'EventMetaName' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'LogFileCreated', + ], + 'EventMetaVersion' => [ + 'description' => '事件版本。', + 'type' => 'string', + 'example' => '1.0.0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotFound.EventMeta', + 'errorMessage' => 'EventMeta not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E\\",\\n \\"FCTriggers\\": [\\n {\\n \\"TriggerARN\\": \\"acs:fc:cn-beijing: 1234567890:services/FCTestService/functions/printEvent/triggers/testtrigger\\",\\n \\"RoleARN\\": \\"acs:ram:: 1234567890:role/aliyuncdneventnotificationrole\\",\\n \\"SourceArn\\": \\"acs:cdn:*:1234567890:domain/example.com\\",\\n \\"Notes\\": \\"测试\\",\\n \\"EventMetaName\\": \\"LogFileCreated\\",\\n \\"EventMetaVersion\\": \\"1.0.0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListFCTriggerResponse>\\r\\n\\t<FCTriggers>\\r\\n\\t\\t<Notes>测试</Notes>\\r\\n\\t\\t<SourceArn>acs:cdn:*:1234567890:domain/example.com</SourceArn>\\r\\n\\t\\t<EventMetaVersion>1.0.0</EventMetaVersion>\\r\\n\\t\\t<EventMetaName>LogFileCreated</EventMetaName>\\r\\n\\t\\t<RoleARN>acs:ram:: 1234567890:role/aliyuncdneventnotificationrole</RoleARN>\\r\\n\\t\\t<TriggerARN>acs:fc:cn-beijing: 1234567890:services/FCTestService/functions/printEvent/triggers/testtrigger</TriggerARN>\\r\\n\\t</FCTriggers>\\r\\n\\t<RequestId>EC046C5D-8CB4-4B6B-B7F8-B335E51EF90E</RequestId>\\r\\n</ListFCTriggerResponse>","errorExample":""}]', + 'title' => '查询函数计算的触发器列表', + 'description' => '> 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**SourceARN**的格式为```acs:cdn:{RegionID}:{AccountID}:{Filter}```'."\n" + ."\n" + .'其中**Filter**表示资源和过滤器，具体格式为**{FilterName}/{FilterValue}**。当**FilterValue**为多个枚举值时，需要使用**{}**包括起来，值之间通过逗号（,）分割。'."\n" + ."\n" + .'例如：对于LogFileCreated事件当前支持基于域名**FilterName**为**domain**的过滤，如果只需要**example.com**域名触发函数计算，则**Filter**为 **domain/example.com**，如果需要多个域名触发，则**Filter**为```domain/{example.com,aliyundoc.com}```'."\n" + ."\n" + .'多个过滤器之间通过正斜线（/）连接，之间是**逻辑与**的关系，即此时SourceARN的格式为```acs:cdn:{RegionID}:{AccountID}:{Filter1}/{Filter2}...```', + 'extraInfo' => ' ', + ], + 'DescribeDomainCcActivityLog' => [ + 'summary' => '调用DescribeDomainCcActivityLog查询频次控制规则拦截日志。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111767', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的加速域名。支持批量域名查询，多个域名用英文逗号（,）分隔。'."\n" + ."\n" + .'若参数为空，默认返回所有加速域名合并后的数据。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'最小数据粒度为5分钟。'."\n" + ."\n" + .'若该参数为空，默认读取过去24小时数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'TriggerObject', + 'in' => 'query', + 'schema' => [ + 'description' => '触发对象。'."\n" + ."\n" + .'若该参数为空，则查询所有拦截事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'IP', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '触发对象值'."\n" + ."\n" + .'若该参数为空，则查询所有拦截事件。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.3.4', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则名。取值：'."\n" + .'- 正常模式规则：default_normal。'."\n" + .'- 紧急模式规则：default_attack。'."\n" + ."\n" + .'若该参数为空，则查询所有拦截事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'test2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页显示数量。默认值：**30**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：**1** 。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageIndex' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', + ], + 'PageSize' => [ + 'description' => '单页显示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ActivityLog' => [ + 'description' => '拦截事件日志列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '触发对象值。', + 'type' => 'string', + 'example' => '1.2.3.4', + ], + 'Ttl' => [ + 'description' => '生效时长，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'Action' => [ + 'description' => '拦截动作。', + 'type' => 'string', + 'example' => 'deny', + ], + 'TriggerObject' => [ + 'description' => '触发对象。', + 'type' => 'string', + 'example' => 'Ip', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RuleName' => [ + 'description' => '拦截自定义规则名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageIndex\\": 1,\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"PageSize\\": 30,\\n \\"Total\\": 20,\\n \\"ActivityLog\\": [\\n {\\n \\"Value\\": \\"1.2.3.4\\",\\n \\"Ttl\\": 300,\\n \\"Action\\": \\"deny\\",\\n \\"TriggerObject\\": \\"Ip\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"RuleName\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainCcActivityLogResponse>\\n<Total>20</Total>\\n<PageSize>30</PageSize>\\n<PageIndex>1</PageIndex>\\n<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>\\n<ActivityLog>\\n <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>\\n <Value>1.2.3.4</Value>\\n <TriggerObject>Ip</TriggerObject>\\n <DomainName>example.com</DomainName>\\n <Ttl>300</Ttl>\\n <Action>deny</Action>\\n <RuleName>test2</RuleName>\\n</ActivityLog>\\n<ActivityLog>\\n <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>\\n <Value>safari 5.1 – Windows</Value>\\n <TriggerObject>Header_UserAgent</TriggerObject>\\n <DomainName>example.com</DomainName>\\n <Ttl>300</Ttl>\\n <Action>deny</Action>\\n <RuleName>test2</RuleName>\\n</ActivityLog>\\n</DescribeDomainCcActivityLogResponse>","errorExample":""}]', + 'title' => '查询频次控制规则拦截日志', + 'description' => '- 不指定StartTime和EndTime时，该接口默认读取过去24小时的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" + .'- 支持批量查询域名，多个域名用半角逗号（,）分隔，一次最多支持20个域名查询。'."\n" + .'- 最多可获取30天的数据。'."\n" + .'- 单用户调用频率：50次/秒。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainPvData' => [ + 'summary' => '调用DescribeDomainPvData按小时粒度获取加速域名的PV页面访问统计，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111785', + 'abilityTreeNodes' => [ + 'FEATUREcdnF7OM8K', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持查询一个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-11-28T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2015-11-29T00:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。'."\n", + 'type' => 'string', + 'example' => '2015-11-28T04:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。'."\n", + 'type' => 'string', + 'example' => '2015-11-28T03:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'BCD7D917-76F1-442F-BB75-C810DE34C761', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位为秒。', + 'type' => 'string', + 'example' => '3600', + ], + 'PvDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '每个时间间隔的页面访问次数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '详细使用数据。'."\n", + 'type' => 'string', + 'example' => '9292', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。'."\n", + 'type' => 'string', + 'example' => '2015-11-28T03:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-11-28T04:00:00Z\\",\\n \\"StartTime\\": \\"2015-11-28T03:00:00Z\\",\\n \\"RequestId\\": \\"BCD7D917-76F1-442F-BB75-C810DE34C761\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"PvDataInterval\\": {\\n \\"UsageData\\": [\\n {\\n \\"Value\\": \\"9292\\",\\n \\"TimeStamp\\": \\"2015-11-28T03:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainPvDataResponse>\\r\\n\\t<DataInterval>3600</DataInterval>\\r\\n\\t<RequestId>BCD7D917-76F1-442F-BB75-C810DE34C761</RequestId>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<EndTime>2015-11-29T00:00:00Z</EndTime>\\r\\n\\t<PvDataInterval>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T03:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9292</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T23:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9239</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T07:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9464</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T12:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9379</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T22:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9243</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T10:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>10063</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T15:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9068</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T14:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9353</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T04:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9513</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T02:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9377</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T08:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9579</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T20:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9109</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T09:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>10631</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T06:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9587</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T01:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9108</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T16:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9454</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T21:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9285</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T19:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9059</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T00:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9470</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T05:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>11830</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T13:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9992</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T17:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9529</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T18:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9203</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t\\t<UsageData>\\r\\n\\t\\t\\t<TimeStamp>2015-11-28T11:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>9604</Value>\\r\\n\\t\\t</UsageData>\\r\\n\\t</PvDataInterval>\\r\\n\\t<StartTime>2015-11-28T00:00:00Z</StartTime>\\r\\n</DescribeDomainPvDataResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '获取PV页面访问统计', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + ."\n" + .' >- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，返回起止时间的数据。'."\n" + .'- 单用户调用频率：50次/秒。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainUvData' => [ + 'summary' => '调用DescribeDomainUvData按小时粒度获取加速域名的UV页面独立访问统计，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111816', + 'abilityTreeNodes' => [ + 'FEATUREcdnF7OM8K', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持查询一个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-29T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-29T04:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '获取数据结束时间点。', + 'type' => 'string', + 'example' => '2019-11-29T04:00:00Z', + ], + 'StartTime' => [ + 'description' => '获取数据起始时间点。', + 'type' => 'string', + 'example' => '2019-11-29T00:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E9D3257A-1B7C-414C-90C1-8D07AC47BCAC', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '3600', + ], + 'UvDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '每个时间间隔的页面独立访问次数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '详细使用数据。', + 'type' => 'string', + 'example' => '318', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2019-11-29T00:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-11-29T04:00:00Z\\",\\n \\"StartTime\\": \\"2019-11-29T00:00:00Z\\",\\n \\"RequestId\\": \\"E9D3257A-1B7C-414C-90C1-8D07AC47BCAC\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"UvDataInterval\\": {\\n \\"UsageData\\": [\\n {\\n \\"Value\\": \\"318\\",\\n \\"TimeStamp\\": \\"2019-11-29T00:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainUvDataResponse>\\n<DataInterval>3600</DataInterval>\\n<RequestId>17276F0E-66F4-4547-B9C6-42E2547362D4</RequestId>\\n<DomainName>example.com</DomainName>\\n<EndTime>2019-11-29T04:00:00Z</EndTime>\\n<StartTime>2019-11-29T00:00:00Z</StartTime>\\n<UvDataInterval>\\n <UsageData>\\n <TimeStamp>2019-11-29T00:00:00Z</TimeStamp>\\n <Value>2</Value>\\n </UsageData>\\n <UsageData>\\n <TimeStamp>2019-11-29T01:00:00Z</TimeStamp>\\n <Value>12</Value>\\n </UsageData>\\n <UsageData>\\n <TimeStamp>2019-11-29T02:00:00Z</TimeStamp>\\n <Value>6</Value>\\n </UsageData>\\n <UsageData>\\n <TimeStamp>2019-11-29T03:00:00Z</TimeStamp>\\n <Value>7</Value>\\n </UsageData>\\n <UsageData>\\n <TimeStamp>2019-11-29T04:00:00Z</TimeStamp>\\n <Value>5</Value>\\n </UsageData>\\n</UvDataInterval>\\n</DescribeDomainUvDataResponse>\\n","errorExample":""}]', + 'title' => '获取UV页面独立访问统计', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + ."\n\n" + .'>- 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，返回起止时间的数据。'."\n" + .'- 您只可以查询一个域名或当前用户下所有域名的数据。'."\n" + .'- 单用户调用频率：100次/秒。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainTopUrlVisit' => [ + 'summary' => '获取加速域名某个指定时间段内的热门URL列表（TOP100）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111813', + 'abilityTreeNodes' => [ + 'FEATUREcdnB3I7MU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的域名。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始获取数据的时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'查询某天的数据，建议传参格式为yyyy-MM-ddT16:00:00Z。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-10-04T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于开始时间，并且结束时间和开始时间相差不超过7天。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-10-04T16:00:00Z', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认值为**pv**。取值：'."\n" + ."\n" + .'- **traf**：流量。'."\n" + ."\n" + .'- **pv**：访问量。', + 'type' => 'string', + 'required' => false, + 'example' => 'pv', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '查询指定日期。', + 'type' => 'string', + 'example' => '2019-10-03T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64D28B53-5902-409B-94F6-FD46680144FE', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'AllUrlList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '全部热门URL列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/a0.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '访问次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + 'Url200List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '返回为2xx的URL列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/aWQ9SE5KU0bGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '访问次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + 'Url300List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '返回为3xx的URL列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/a0.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + 'Url400List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '返回为4xx的URL列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUhbGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '次数。', + 'type' => 'string', + 'example' => '1884', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + 'Url500List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '返回为5xx的URL列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + [ + 'errorCode' => 'InvalidDomainName.Mismatch', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"StartTime\\": \\"2019-10-03T16:00:00Z\\",\\n \\"RequestId\\": \\"64D28B53-5902-409B-94F6-FD46680144FE\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"AllUrlList\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/a0.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n },\\n \\"Url200List\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/aWQ9SE5KU0bGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n },\\n \\"Url300List\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/a0.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n },\\n \\"Url400List\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUhbGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"1884\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n },\\n \\"Url500List\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainTopUrlVisitResponse>\\n<Url300List>\\n</Url300List>\\n<AllUrlList>\\n <UrlList>\\n <Flow>9304</Flow>\\n <VisitProportion>0</VisitProportion>\\n <VisitData>2</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/a0.m3u8</UrlDetail>\\n <FlowProportion>0</FlowProportion>\\n </UrlList>\\n <UrlList>\\n <Flow>3986</Flow>\\n <VisitProportion>0</VisitProportion>\\n <VisitData>1</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/a0.m3u8</UrlDetail>\\n <FlowProportion>0</FlowProportion>\\n </UrlList>\\n <UrlList>\\n <Flow>784</Flow>\\n <VisitProportion>0</VisitProportion>\\n <VisitData>1</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/a0.m3u8</UrlDetail>\\n <FlowProportion>0</FlowProportion>\\n </UrlList>\\n</AllUrlList>\\n<Url400List>\\n <UrlList>\\n <Flow>3986</Flow>\\n <VisitProportion>0</VisitProportion>\\n <VisitData>1</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/a0.m3u8</UrlDetail>\\n <FlowProportion>0</FlowProportion>\\n </UrlList>\\n <UrlList>\\n <Flow>784</Flow>\\n <VisitProportion>0</VisitProportion>\\n <VisitData>1</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/a0.m3u8</UrlDetail>\\n <FlowProportion>0</FlowProportion>\\n </UrlList>\\n</Url400List>\\n<RequestId>8E7A2ABF-1BB0-4E46-AE3E-58DB3151080C</RequestId>\\n<DomainName>example.com</DomainName>\\n<Url200List>\\n <UrlList>\\n <Flow>9304</Flow>\\n <VisitProportion>0</VisitProportion>\\n <VisitData>2</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/a0.m3u8</UrlDetail>\\n <FlowProportion>0</FlowProportion>\\n </UrlList>\\n</Url200List>\\n<StartTime>2019-10-04T00:00:00Z</StartTime>\\n<Url500List>\\n</Url500List>\\n</DescribeDomainTopUrlVisitResponse>","errorExample":""}]', + 'title' => '获取热门URL列表', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + .'>- 如果您不指定StartTime和EndTime，该接口默认读取过去24小时的数据；指定StartTime和EndTime时，按指定的起止时间查询。'."\n" + .'- 支持获取最近90天的数据。'."\n" + .'- 该接口仅支持单个域名查询。'."\n" + .'- 单用户调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainTopClientIpVisit' => [ + 'summary' => '调用DescribeDomainTopClientIpVisit查询加速域名在指定时间范围内按照访问次数或流量排序的客户端IP排行，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111811', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，多个用半角逗号（,）分隔，默认查询全部地域。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~91077~~)获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-09-30T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-10-01T16:00:00Z', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值：'."\n" + ."\n" + .'- **traf**（默认值）：流量。'."\n" + .'- **acc**：访问次数。', + 'type' => 'string', + 'required' => false, + 'example' => 'traf', + 'default' => 'traf', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '返回数据条目，最大值为100。'."\n" + ."\n" + .'默认为20，即返回TOP 20的数据条目。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64D28B53-5902-409B-94F6-FD46680144FE', + ], + 'ClientIpList' => [ + 'description' => '客户端IP列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Rank' => [ + 'description' => '代表该条记录是TopN。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ClientIp' => [ + 'description' => 'IP地址，目前仅支持IPv4。', + 'type' => 'string', + 'example' => '1.1.xxx', + ], + 'Acc' => [ + 'description' => '总请求次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '256', + ], + 'Traffic' => [ + 'description' => '总流量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64D28B53-5902-409B-94F6-FD46680144FE\\",\\n \\"ClientIpList\\": [\\n {\\n \\"Rank\\": 2,\\n \\"ClientIp\\": \\"1.1.xxx\\",\\n \\"Acc\\": 256,\\n \\"Traffic\\": 1024\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainTopClientIpVisitResponse>\\n<RequestId>64D28B53-5902-409B-94F6-FD46680144FE</RequestId>\\n<ClientIpList>\\n <Rank>1</Rank>\\n <ClientIp>1.1.xx</ClientIp>\\n <Traffic>1024</Traffic>\\n <Acc>128</Acc>\\n</ClientIpList>\\n<ClientIpList>\\n <Rank>2</Rank>\\n <ClientIp>2.2.xx</ClientIp>\\n <Traffic>2048</Traffic>\\n <Acc>256</Acc>\\n</ClientIpList>\\n</DescribeDomainTopClientIpVisitResponse>\\n","errorExample":""}]', + 'title' => '获取Client IP列表排序数据', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + .'> - 如果您不指定StartTime和EndTime，该接口默认读取过去24小时的数据；指定StartTime和EndTime时，按照指定的时间查询。'."\n" + .'> - 该接口计算的数据粒度为1小时。'."\n" + .'> - 单用户调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainTopReferVisit' => [ + 'summary' => '调用DescribeDomainTopReferVisit获取加速域名某天的热门页面引用次数排名，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111812', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-21T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-22T12:00:00Z', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值：'."\n" + ."\n" + .'- **traf**：流量。'."\n" + ."\n" + .'- **pv**（默认值）：访问次数。', + 'type' => 'string', + 'required' => false, + 'example' => 'pv', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '查询指定日期。', + 'type' => 'string', + 'example' => '2019-12-21T12:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '95994621-8382-464B-8762-C708E73568D1', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TopReferList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReferList' => [ + 'description' => '全部热门页面列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '200', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'VisitData' => [ + 'description' => '访问次数。', + 'type' => 'string', + 'example' => '3', + ], + 'ReferDetail' => [ + 'description' => '完整的热门页面地址。', + 'type' => 'string', + 'example' => 'learn.aliyundoc.com', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"StartTime\\": \\"2019-12-21T12:00:00Z\\",\\n \\"RequestId\\": \\"95994621-8382-464B-8762-C708E73568D1\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TopReferList\\": {\\n \\"ReferList\\": [\\n {\\n \\"Flow\\": \\"200\\",\\n \\"FlowProportion\\": 0.5,\\n \\"VisitData\\": \\"3\\",\\n \\"ReferDetail\\": \\"learn.aliyundoc.com\\",\\n \\"VisitProportion\\": 0.5\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainTopReferVisitResponse>\\n<TopReferList>\\n <ReferList>\\n <Flow>1557043</Flow>\\n <VisitProportion>0.9078341013824884</VisitProportion>\\n <VisitData>591</VisitData>\\n <ReferDetail>-</ReferDetail>\\n <FlowProportion>0.07801388057582173</FlowProportion>\\n </ReferList>\\n <ReferList>\\n <Flow>18397394</Flow>\\n <VisitProportion>0.08602150537634409</VisitProportion>\\n <VisitData>56</VisitData>\\n <ReferDetail>learn.aliyundoc.com</ReferDetail>\\n <FlowProportion>0.9217806434519402</FlowProportion>\\n </ReferList>\\n <ReferList>\\n <Flow>4101</Flow>\\n <VisitProportion>0.006144393241167435</VisitProportion>\\n <VisitData>4</VisitData>\\n <ReferDetail>learn.aliyundoc.com</ReferDetail>\\n <FlowProportion>0.00020547597223804668</FlowProportion>\\n </ReferList>\\n</TopReferList>\\n<RequestId>BA64068A-D73C-4613-8AAB-E9374F78FB95</RequestId>\\n<DomainName>example.com</DomainName>\\n<StartTime>2019-12-21T12:00:00Z</StartTime>\\n</DescribeDomainTopReferVisitResponse>\\n","errorExample":""}]', + 'title' => '获取热门页面引用次数排名', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + .'> - 如果您不指定StartTime和EndTime，该接口默认读取过去24小时的数据；指定StartTime和EndTime时，按指定的起止时间查询。'."\n" + .'> - 该接口的数据计算粒度为5分钟。'."\n" + .'> - 单用户调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainSrcTopUrlVisit' => [ + 'summary' => '调用DescribeDomainSrcTopUrlVisit获取加速域名的回源热门URL。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111808', + 'abilityTreeNodes' => [ + 'FEATUREcdnE9OF3Y', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 如果不指定StartTime，默认读取前一天的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-10-03T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间，并且结束时间和开始时间相差不超过7天。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-10-03T20:00:00Z', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，默认值为**pv**。取值：'."\n" + ."\n" + .'- **traf**：流量。'."\n" + ."\n" + .'- **pv**：访问量。', + 'type' => 'string', + 'required' => false, + 'example' => 'pv', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '查询指定日期。', + 'type' => 'string', + 'example' => '2018-10-03T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64D28B53-5902-409B-94F6-FD46680144FE', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'AllUrlList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '全部热门URL列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。'."\n", + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/a0.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '访问次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + 'Url200List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '返回为2xx的URL列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/a0.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '访问次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + 'Url300List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '返回为3xx的URL列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/a0.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '访问次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + 'Url400List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '返回为4xx的URL列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量。单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/a0.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '访问次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + 'Url500List' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UrlList' => [ + 'description' => '返回为5xx的URL列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Flow' => [ + 'description' => '流量，单位：byte。', + 'type' => 'string', + 'example' => '460486880', + ], + 'UrlDetail' => [ + 'description' => '完整的URL地址。', + 'type' => 'string', + 'example' => 'http://example.com/nn_live/nn_x64/a0.m3u8', + ], + 'FlowProportion' => [ + 'description' => '流量占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + 'VisitData' => [ + 'description' => '访问次数。', + 'type' => 'string', + 'example' => '161673', + ], + 'VisitProportion' => [ + 'description' => '访问占比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.35', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + [ + 'errorCode' => 'InvalidDomainName.Mismatch', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"StartTime\\": \\"2018-10-03T16:00:00Z\\",\\n \\"RequestId\\": \\"64D28B53-5902-409B-94F6-FD46680144FE\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"AllUrlList\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/a0.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n },\\n \\"Url200List\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/a0.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n },\\n \\"Url300List\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/a0.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n },\\n \\"Url400List\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/a0.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n },\\n \\"Url500List\\": {\\n \\"UrlList\\": [\\n {\\n \\"Flow\\": \\"460486880\\",\\n \\"UrlDetail\\": \\"http://example.com/nn_live/nn_x64/a0.m3u8\\",\\n \\"FlowProportion\\": 0.35,\\n \\"VisitData\\": \\"161673\\",\\n \\"VisitProportion\\": 0.35\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainSrcTopUrlVisitResponse>\\n<AllUrlList>\\n <UrlList>\\n <VisitData>161673</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/a0.m3u8</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n <UrlList>\\n <VisitData>37</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/ZXg9MQ,,/HNJSMPP360.ts</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n</AllUrlList>\\n<Url300List>\\n <UrlList>\\n <VisitData>161673</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n <UrlList>\\n <VisitData>3</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n</Url300List>\\n<Url400List>\\n <UrlList>\\n <VisitData>1884</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUhb,,/HNJSMPP360.m3u8</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n <UrlList>\\n <VisitData>1</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SEEwODgm,/HNJSMPP360.ts</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n</Url400List>\\n<RequestId>64D28B53-5902-409B-94F6-FD46680144FE</RequestId>\\n<DomainName>example.com</DomainName>\\n<Url200List>\\n <UrlList>\\n <VisitData>161673</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU0bGxfcG,,/HNJSMPP360.m3u8</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n <UrlList>\\n <VisitData>3</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KDMlPTIwMTQ,,/HNJSMPP360.ts</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n</Url200List>\\n<StartTime>2018-10-03T16:00:00Z</StartTime>\\n<Url500List>\\n <UrlList>\\n <VisitData>161673</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n <UrlList>\\n <VisitData>3</VisitData>\\n <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts</UrlDetail>\\n <VisitProportion>0.35</VisitProportion>\\n <Flow>460486880</Flow>\\n <FlowProportion>0.35</FlowProportion>\\n </UrlList>\\n</Url500List>\\n</DescribeDomainSrcTopUrlVisitResponse>\\n","errorExample":""}]', + 'title' => '获取回源热门URL', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + .'> - 查询的时间粒度为5分钟。'."\n" + .'> - 单用户调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTopDomainsByFlow' => [ + 'summary' => '调用DescribeTopDomainsByFlow获取用户按流量排名的域名，支持获取最近30天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111838', + 'abilityTreeNodes' => [ + 'FEATUREcdnGZSOSW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> StartTime必须设置为北京时间0点对应的UTC时间，例如：北京时间06月01日0点，需要设置为UTC时间“2021-05-31T16:00:00Z”。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-23T08:00:00Z', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '域名获取数量限制，默认为**20**，取值**1**~**100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainOnlineCount' => [ + 'description' => '账号下状态为**正在运行**的域名总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '68', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-12-23T08:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-12-22T08:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4E09C5D7-E1CF-4CAA-A45E-8727F4C8FD70', + ], + 'DomainCount' => [ + 'description' => '账号下的域名总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '68', + ], + 'TopDomains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TopDomain' => [ + 'description' => '排名域名列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MaxBps' => [ + 'description' => '带宽峰值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '22139626', + ], + 'Rank' => [ + 'description' => '排名。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalAccess' => [ + 'description' => '访问次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '107784230', + ], + 'TrafficPercent' => [ + 'description' => '流量占比。', + 'type' => 'string', + 'example' => '30.64191989360235', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TotalTraffic' => [ + 'description' => '总流量。', + 'type' => 'string', + 'example' => '2043859876683.9001', + ], + 'MaxBpsTime' => [ + 'description' => '带宽峰值时刻。', + 'type' => 'string', + 'example' => '1457111400', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainOnlineCount\\": 68,\\n \\"EndTime\\": \\"2019-12-23T08:00:00Z\\",\\n \\"StartTime\\": \\"2019-12-22T08:00:00Z\\",\\n \\"RequestId\\": \\"4E09C5D7-E1CF-4CAA-A45E-8727F4C8FD70\\",\\n \\"DomainCount\\": 68,\\n \\"TopDomains\\": {\\n \\"TopDomain\\": [\\n {\\n \\"MaxBps\\": 22139626,\\n \\"Rank\\": 1,\\n \\"TotalAccess\\": 107784230,\\n \\"TrafficPercent\\": \\"30.64191989360235\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TotalTraffic\\": \\"2043859876683.9001\\",\\n \\"MaxBpsTime\\": \\"1457111400\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeTopDomainsByFlowResponse>\\n<DomainCount>4</DomainCount>\\n<DomainOnlineCount>4</DomainOnlineCount>\\n<RequestId>6796A2B4-15A7-4142-85C0-5A93406034B5</RequestId>\\n<TopDomains>\\n <TopDomain>\\n <MaxBps>26.752000000000002</MaxBps>\\n <Rank>3</Rank>\\n <TrafficPercent>0.000910078753253719</TrafficPercent>\\n <TotalTraffic>2003</TotalTraffic>\\n <TotalAccess>2</TotalAccess>\\n <DomainName>example.com</DomainName>\\n <MaxBpsTime>2019-12-22T20:50:00Z</MaxBpsTime>\\n </TopDomain>\\n</TopDomains>\\n<EndTime>2019-12-23T08:00:00Z</EndTime>\\n<StartTime>2019-12-22T08:00:00Z</StartTime>\\n</DescribeTopDomainsByFlowResponse>","errorExample":""}]', + 'title' => '获取按流量排名的加速域名', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + .'>- 如果您不指定**StartTime**和**EndTime**，该接口返回当月数据；指定**StartTime**和**EndTime**，返回起止时间的数据。'."\n" + .'- 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRegionData' => [ + 'summary' => '调用DescribeDomainRegionData获取加速域名天粒度的用户区域分布数据统计，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111800', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用英文逗号（,）分隔。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-05T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-07T12:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '获取数据结束时间。', + 'type' => 'string', + 'example' => '2015-12-07T12:00:00Z', + ], + 'StartTime' => [ + 'description' => '获取数据起始时间。', + 'type' => 'string', + 'example' => '2015-12-05T12:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2E5AD83F-BD7B-462E-8319-2E30E305519A', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '86400', + ], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionProportionData' => [ + 'description' => '各地域访问占比数据列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TotalQuery' => [ + 'description' => '总请求次数。', + 'type' => 'string', + 'example' => '3', + ], + 'TotalBytes' => [ + 'description' => '总流量，单位：Byte。', + 'type' => 'string', + 'example' => '2400057', + ], + 'AvgResponseRate' => [ + 'description' => '平均响应速度，单位：Bps。', + 'type' => 'string', + 'example' => '154.3345765545624', + ], + 'AvgResponseTime' => [ + 'description' => '平均响应时间，单位：毫秒。', + 'type' => 'string', + 'example' => '5183.666666666667', + ], + 'ReqErrRate' => [ + 'description' => '请求错误率，例如返回90即为90%。', + 'type' => 'string', + 'example' => '0.0', + ], + 'AvgObjectSize' => [ + 'description' => '响应平均大小，单位：Byte。', + 'type' => 'string', + 'example' => '800019.0', + ], + 'Bps' => [ + 'description' => '带宽。', + 'type' => 'string', + 'example' => '380.9614285714286', + ], + 'Qps' => [ + 'description' => '每秒查询率。', + 'type' => 'string', + 'example' => '5.9523809523809524E-5', + ], + 'RegionEname' => [ + 'description' => '地区英文名称。', + 'type' => 'string', + 'example' => 'japan', + ], + 'Region' => [ + 'description' => '地域信息。', + 'type' => 'string', + 'example' => '日本', + ], + 'Proportion' => [ + 'description' => '访问占比数据，例如返回90即为90%。', + 'type' => 'string', + 'example' => '0.01155980271270037', + ], + 'BytesProportion' => [ + 'description' => '总流量占比，例如返回90即为90%。', + 'type' => 'string', + 'example' => '0.003544181046236794', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-07T12:00:00Z\\",\\n \\"StartTime\\": \\"2015-12-05T12:00:00Z\\",\\n \\"RequestId\\": \\"2E5AD83F-BD7B-462E-8319-2E30E305519A\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"86400\\",\\n \\"Value\\": {\\n \\"RegionProportionData\\": [\\n {\\n \\"TotalQuery\\": \\"3\\",\\n \\"TotalBytes\\": \\"2400057\\",\\n \\"AvgResponseRate\\": \\"154.3345765545624\\",\\n \\"AvgResponseTime\\": \\"5183.666666666667\\",\\n \\"ReqErrRate\\": \\"0.0\\",\\n \\"AvgObjectSize\\": \\"800019.0\\",\\n \\"Bps\\": \\"380.9614285714286\\",\\n \\"Qps\\": \\"5.9523809523809524E-5\\",\\n \\"RegionEname\\": \\"japan\\",\\n \\"Region\\": \\"日本\\",\\n \\"Proportion\\": \\"0.01155980271270037\\",\\n \\"BytesProportion\\": \\"0.003544181046236794\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainRegionDataResponse>\\r\\n\\t<Value>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>380.9614285714286</Bps>\\r\\n\\t\\t\\t<Proportion>0.01155980271270037</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2400057</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.003544181046236794</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>3</TotalQuery>\\r\\n\\t\\t\\t<RegionEname></RegionEname>\\r\\n\\t\\t\\t<Region>日本</Region>\\r\\n\\t\\t\\t<AvgResponseRate>154.3345765545624</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>800019.0</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>5.9523809523809524E-5</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>5183.666666666667</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>25110.431412698414</Bps>\\r\\n\\t\\t\\t<Proportion>0.31211467324291</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>158195717</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.23360872886644055</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>81</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>xizang</RegionEname>\\r\\n\\t\\t\\t<Region>西藏自治区</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1397.1430909315718</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>1953033.5543209878</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.0016071428571428571</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1397.8765432098764</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>40343.86242857143</Bps>\\r\\n\\t\\t\\t<Proportion>0.33908754623921084</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>254166333</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.37532921137846464</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>88</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>zhongqing</RegionEname>\\r\\n\\t\\t\\t<Region>重庆市</Region>\\r\\n\\t\\t\\t<AvgResponseRate>787.8073097249128</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2888253.7875</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.001746031746031746</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>3666.193181818182</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>38835.2834920635</Bps>\\r\\n\\t\\t\\t<Proportion>0.37376695437731194</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>244662286</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.3612945179094354</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>97</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>tianjin</RegionEname>\\r\\n\\t\\t\\t<Region>天津市</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1711.4277340197823</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2522291.608247423</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.0019246031746031746</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1473.7938144329896</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>69358.64117460318</Bps>\\r\\n\\t\\t\\t<Proportion>0.5895499383477188</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.34640522875817</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>436959439</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.6452610763393265</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99291705425965</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>153</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>qinghai</RegionEname>\\r\\n\\t\\t\\t<Region>青海省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1210.9708048576356</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2855944.0483660134</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.0030357142857142857</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2358.392156862745</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>66239.68633333335</Bps>\\r\\n\\t\\t\\t<Proportion>0.6473489519112207</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>417310023</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.6162446463192347</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99999999999999</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>168</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Hainan</RegionEname>\\r\\n\\t\\t\\t<Region>海南省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>324.9427676080411</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2483988.2375000003</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.0033333333333333335</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>7644.386904761905</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>62071.644380952384</Bps>\\r\\n\\t\\t\\t<Proportion>0.7745067817509248</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.50248756218906</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>391051359</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.5774682921278322</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99983347455928</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>201</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>shanghai</RegionEname>\\r\\n\\t\\t\\t<Region>上海市</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1319.43005273653</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>1945529.152238806</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.0039880952380952385</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1474.5223880597016</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>86967.5461111111</Bps>\\r\\n\\t\\t\\t<Proportion>0.9286374845869297</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>96.2655601659751</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>547895540</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.8090811968039774</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>98.60251863101267</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>241</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>beijing</RegionEname>\\r\\n\\t\\t\\t<Region>北京市</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1223.3552235839977</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2273425.479253112</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.004781746031746032</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1858.3526970954356</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>228242.86641269844</Bps>\\r\\n\\t\\t\\t<Proportion>1.9690197287299631</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>1437930058</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>2.1234014270475434</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>511</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>ningxia</RegionEname>\\r\\n\\t\\t\\t<Region>宁夏回族自治区</Region>\\r\\n\\t\\t\\t<AvgResponseRate>512.8134924297486</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2813953.1475538164</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.010138888888888888</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>5487.283757338552</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>219378.5598888889</Bps>\\r\\n\\t\\t\\t<Proportion>2.250308261405672</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>1382084927</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>2.040934529315853</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.00000000000001</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>584</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Jilin</RegionEname>\\r\\n\\t\\t\\t<Region>吉林省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1152.4327405034373</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2366583.779623288</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.011587301587301587</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2053.554794520548</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>181938.64595238096</Bps>\\r\\n\\t\\t\\t<Proportion>2.3273736128236746</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>1146213469</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>1.6926214892159708</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>604</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Gansu</RegionEname>\\r\\n\\t\\t\\t<Region>甘肃省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>476.60455862620415</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>1897704.4197019867</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.011984126984126984</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>3981.7168874172185</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>302711.6698571429</Bps>\\r\\n\\t\\t\\t<Proportion>2.8013255240443895</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.8624484181568</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>1907083520</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>2.816203642467227</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99996931440107</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>727</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>xinjiang</RegionEname>\\r\\n\\t\\t\\t<Region>新疆维吾尔自治区</Region>\\r\\n\\t\\t\\t<AvgResponseRate>786.5196031941114</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2623223.5489683636</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.014424603174603175</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>3335.2297111416783</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>330366.9671587302</Bps>\\r\\n\\t\\t\\t<Proportion>2.847564734895191</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.86468200270636</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2081311893</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>3.0734879058423363</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99996955766207</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>739</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>neimenggu</RegionEname>\\r\\n\\t\\t\\t<Region>内蒙古自治区</Region>\\r\\n\\t\\t\\t<AvgResponseRate>537.274830290738</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2816389.5711772665</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.014662698412698412</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>5241.9905277401895</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>296377.9758412699</Bps>\\r\\n\\t\\t\\t<Proportion>2.8552712700369915</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>1867181247</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>2.7572796764166547</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>741</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Guizhou</RegionEname>\\r\\n\\t\\t\\t<Region>贵州省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>784.3618585093111</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2519812.7500674766</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.014702380952380953</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>3212.5641025641025</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>359904.2652857143</Bps>\\r\\n\\t\\t\\t<Proportion>3.0749075215782984</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2267396871</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>3.348280901477785</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>798</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>shanxixian</RegionEname>\\r\\n\\t\\t\\t<Region>陕西省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>936.6710791561273</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2841349.462781955</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.015833333333333335</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>3033.4548872180453</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>351643.65639682545</Bps>\\r\\n\\t\\t\\t<Proportion>3.101880394574599</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>98.88198757763975</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2215355035</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>3.2714303563604967</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.8809108401154</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>805</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Jiangxi</RegionEname>\\r\\n\\t\\t\\t<Region>江西省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1809.5402913913995</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2751993.832670808</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.01597222222222222</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1520.824844720497</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>337654.18080952385</Bps>\\r\\n\\t\\t\\t<Proportion>3.313810110974106</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.4186046511628</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2127221339</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>3.141282707530976</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99985277977696</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>860</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Fujian</RegionEname>\\r\\n\\t\\t\\t<Region>福建省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1154.391434785841</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2473513.185</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.017063492063492062</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2142.6988372093024</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>359782.1130793651</Bps>\\r\\n\\t\\t\\t<Proportion>3.4525277435265105</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.55357142857143</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2266627312</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>3.3471444884395347</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.88374126237764</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>896</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>shanxi</RegionEname>\\r\\n\\t\\t\\t<Region>山西省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1235.7418245535987</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2529717.982589286</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.017777777777777778</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2047.125</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>400389.1932857143</Bps>\\r\\n\\t\\t\\t<Proportion>3.5103267570900125</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2522451917</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>3.7249224817393896</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>911</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>yunnan</RegionEname>\\r\\n\\t\\t\\t<Region>云南省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1662.686634908582</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2768882.4563117456</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.018075396825396824</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1665.3062568605928</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>396200.5617777778</Bps>\\r\\n\\t\\t\\t<Proportion>3.695283600493218</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2496063539</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>3.685954577676852</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>959</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Hebei</RegionEname>\\r\\n\\t\\t\\t<Region>河北省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1028.303387588414</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2602777.413138686</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.01902777777777778</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2531.1376433785194</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>487959.9617619048</Bps>\\r\\n\\t\\t\\t<Proportion>4.188501849568434</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.72401103955842</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>3074147759</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>4.5396156096015785</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99993802509998</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1087</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Hubei</RegionEname>\\r\\n\\t\\t\\t<Region>湖北省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>884.3783424312907</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2828102.81425943</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.02156746031746032</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>3197.8426862925485</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>451918.7006190476</Bps>\\r\\n\\t\\t\\t<Proportion>4.296393341553637</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.64125560538116</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2847087813</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>4.2043145921101575</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.91296907710742</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1115</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>zhejiang</RegionEname>\\r\\n\\t\\t\\t<Region>浙江省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1127.3220113227628</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2553441.9855605382</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.022123015873015874</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2265.0511210762334</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>508989.9772222223</Bps>\\r\\n\\t\\t\\t<Proportion>4.37345869297164</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.64757709251101</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>3206636856</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>4.73526319123739</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.7790833225895</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1135</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Jiangsu</RegionEname>\\r\\n\\t\\t\\t<Region>江苏省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1330.4354698914951</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2825230.7105726874</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.02251984126984127</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2123.5383259911896</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>488243.6136984127</Bps>\\r\\n\\t\\t\\t<Proportion>4.37731196054254</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.03169014084507</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>3075934766</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>4.54225449569792</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99857147165532</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1136</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Hunan</RegionEname>\\r\\n\\t\\t\\t<Region>湖南省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1339.8235569585188</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2707689.0548415496</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.02253968253968254</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2020.9295774647887</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>508313.40790476196</Bps>\\r\\n\\t\\t\\t<Proportion>4.465937114673243</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>3202374469</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>4.728968894829482</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1159</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Heilongjiang</RegionEname>\\r\\n\\t\\t\\t<Region>黑龙江省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1397.6178986771317</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2763049.585677308</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.022996031746031747</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1976.9706643658326</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>490651.66979365086</Bps>\\r\\n\\t\\t\\t<Proportion>4.519882860665844</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>3091105519</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>4.564657253906334</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99999999999999</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1173</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Liaoning</RegionEname>\\r\\n\\t\\t\\t<Region>辽宁省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1452.8561771775414</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2635213.5717817564</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.023273809523809523</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1813.8158567774935</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>493617.2470952381</Bps>\\r\\n\\t\\t\\t<Proportion>4.519882860665844</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.65899403239557</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>3109788656</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>4.592246773671759</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.962662755313</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1173</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>anhui</RegionEname>\\r\\n\\t\\t\\t<Region>安徽省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1502.2255494727121</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2651141.2248081844</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.023273809523809523</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1764.8090366581416</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>544321.7694444446</Bps>\\r\\n\\t\\t\\t<Proportion>4.778051787916153</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>98.79032258064517</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>3429227147</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>5.063963838946395</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.3034652219695</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1240</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Guangxi</RegionEname>\\r\\n\\t\\t\\t<Region>广西壮族自治区</Region>\\r\\n\\t\\t\\t<AvgResponseRate>469.5304824766785</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2765505.7641129037</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.024603174603174603</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>5889.938709677419</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>518272.7902698413</Bps>\\r\\n\\t\\t\\t<Proportion>5.725955610357583</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.93270524899057</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>3265118578</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>4.821623561583812</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99678589314689</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1486</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>sichuan</RegionEname>\\r\\n\\t\\t\\t<Region>四川省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>720.671411528823</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2197253.41769852</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.029484126984126984</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>3048.897711978466</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>688129.0886031748</Bps>\\r\\n\\t\\t\\t<Proportion>6.022657213316893</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>4335213258</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>6.4018398984302864</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1563</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>shandong</RegionEname>\\r\\n\\t\\t\\t<Region>山东省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>2216.86197693452</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2773648.9175943704</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.03101190476190476</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1251.1599488163788</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>650147.539904762</Bps>\\r\\n\\t\\t\\t<Proportion>6.149815043156597</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.93734335839599</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>4095929501</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>6.048487892405889</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.99998447727191</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1596</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Henan</RegionEname>\\r\\n\\t\\t\\t<Region>河南省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1091.8003744598548</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2566371.868045113</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.03166666666666667</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2350.5870927318297</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t\\t<RegionProportionData>\\r\\n\\t\\t\\t<Bps>764462.3847142858</Bps>\\r\\n\\t\\t\\t<Proportion>7.405980271270037</Proportion>\\r\\n\\t\\t\\t<ReqHitRate>99.37565036420395</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>4816113023</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>7.111987963257421</BytesProportion>\\r\\n\\t\\t\\t<ByteHitRate>99.82548062184921</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1922</TotalQuery>\\r\\n\\t\\t\\t<RegionEname>Guangdong</RegionEname>\\r\\n\\t\\t\\t<Region>广东省</Region>\\r\\n\\t\\t\\t<AvgResponseRate>1040.446859646019</AvgResponseRate>\\r\\n\\t\\t\\t<AvgObjectSize>2505782.0102497404</AvgObjectSize>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.03813492063492063</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2408.3709677419356</AvgResponseTime>\\r\\n\\t\\t</RegionProportionData>\\r\\n\\t</Value>\\r\\n\\t<DataInterval>86400</DataInterval>\\r\\n\\t<RequestId>2E5AD83F-BD7B-462E-8319-2E30E305519A</RequestId>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<EndTime>2015-12-07T12:00:00Z</EndTime>\\r\\n\\t<StartTime>2015-12-05T12:00:00Z</StartTime>\\r\\n</DescribeDomainRegionDataResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '获取用户区域分布数据统计', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + .'> - 如果不指定**StartTime**和**EndTime**，该接口返回过去**24**小时的数据；指定**StartTime**和**EndTime**，返回起止时间的数据。'."\n" + .'> - 获取数据有一定延时，如果需要获取前一天的数据，建议您隔天获取。'."\n" + .'> - 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainISPData' => [ + 'summary' => '调用DescribeDomainISPData查询加速域名天粒度的用户运营商分布数据统计，支持获取最近90天的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111778', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，仅支持查询单个域名。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-29T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '获取数据结束时间点。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '获取数据起始时间点。', + 'type' => 'string', + 'example' => '2019-11-29T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE81639B-DAC1-4C76-AB72-F34B836837D5', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '时间间隔，单位：秒。', + 'type' => 'string', + 'example' => '86400', + ], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ISPProportionData' => [ + 'description' => '各运营商访问占比数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TotalQuery' => [ + 'description' => '总请求次数。', + 'type' => 'string', + 'example' => '1', + ], + 'TotalBytes' => [ + 'description' => '总流量。', + 'type' => 'string', + 'example' => '7081884', + ], + 'AvgResponseRate' => [ + 'description' => '平均响应速度，单位：byte/毫秒。', + 'type' => 'string', + 'example' => '88.92594866772144', + ], + 'AvgResponseTime' => [ + 'description' => '平均响应时间，单位：毫秒。', + 'type' => 'string', + 'example' => '79638.0', + ], + 'ReqErrRate' => [ + 'description' => '请求错误率。', + 'type' => 'string', + 'example' => '0.0', + ], + 'AvgObjectSize' => [ + 'description' => '响应平均大小，单位：byte。', + 'type' => 'string', + 'example' => '7081884.7', + ], + 'Bps' => [ + 'description' => '带宽。', + 'type' => 'string', + 'example' => '1311.4601296296296', + ], + 'Qps' => [ + 'description' => '每秒查询率。', + 'type' => 'string', + 'example' => '2.3148148148148147E-5', + ], + 'Proportion' => [ + 'description' => '占比使用数据。', + 'type' => 'string', + 'example' => '0.004509176173513099', + ], + 'IspEname' => [ + 'description' => '运营商英文名称。', + 'type' => 'string', + 'example' => 'alibaba', + ], + 'ISP' => [ + 'description' => '运营商信息。', + 'type' => 'string', + 'example' => '阿里巴巴', + ], + 'BytesProportion' => [ + 'description' => '总流量占比。', + 'type' => 'string', + 'example' => '0.012220518530445479', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2019-11-29T05:33:00Z\\",\\n \\"RequestId\\": \\"DE81639B-DAC1-4C76-AB72-F34B836837D5\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"86400\\",\\n \\"Value\\": {\\n \\"ISPProportionData\\": [\\n {\\n \\"TotalQuery\\": \\"1\\",\\n \\"TotalBytes\\": \\"7081884\\",\\n \\"AvgResponseRate\\": \\"88.92594866772144\\",\\n \\"AvgResponseTime\\": \\"79638.0\\",\\n \\"ReqErrRate\\": \\"0.0\\",\\n \\"AvgObjectSize\\": \\"7081884.7\\",\\n \\"Bps\\": \\"1311.4601296296296\\",\\n \\"Qps\\": \\"2.3148148148148147E-5\\",\\n \\"Proportion\\": \\"0.004509176173513099\\",\\n \\"IspEname\\": \\"alibaba\\",\\n \\"ISP\\": \\"阿里巴巴\\",\\n \\"BytesProportion\\": \\"0.012220518530445479\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\"HostId\\":\\"cdn.aliyuncs.com\\",\\"Code\\":\\"InternalError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}"},{"type":"xml","example":"<DescribeDomainISPDataResponse>\\r\\n\\t<Value>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>1</TotalQuery>\\r\\n\\t\\t\\t<Bps>1311.4601296296296</Bps>\\r\\n\\t\\t\\t<Proportion>0.004509176173513099</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>88.92594866772144</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>alibaba</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>7081884.7</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>阿里巴巴</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>2.3148148148148147E-5</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>79638.0</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>7081884</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.012220518530445479</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>3</TotalQuery>\\r\\n\\t\\t\\t<Bps>444.455</Bps>\\r\\n\\t\\t\\t<Proportion>0.013527528520539298</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>154.3345765545624</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>overseas</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>800019.0</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>海外ISP</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>6.944444444444444E-5</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>5183.666666666667</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>2400057</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.004141544558417533</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>82</TotalQuery>\\r\\n\\t\\t\\t<Bps>45838.64816666667</Bps>\\r\\n\\t\\t\\t<Proportion>0.3697524462280741</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>1025.5028528460102</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>drpeng</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>3018642.684146342</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>鹏博士</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.0018981481481481482</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2943.5731707317073</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>247528700</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.42713616424581613</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>99.99999999999999</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>114</TotalQuery>\\r\\n\\t\\t\\t<Bps>65933.51396296297</Bps>\\r\\n\\t\\t\\t<Proportion>0.5140460837804933</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>484.6396117340071</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>cernet</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>3123166.4508771934</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>教育网</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.002638888888888889</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>6444.30701754386</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>356040975</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.6143852267848392</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>100.0</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>207</TotalQuery>\\r\\n\\t\\t\\t<Bps>81128.73735185186</Bps>\\r\\n\\t\\t\\t<Proportion>0.9333994679172115</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>752.2096624205244</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>tietong</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>2116401.843961353</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>铁通</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.004791666666666666</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2813.5797101449275</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>438095181</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>0.7559781771177001</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>100.00000000000001</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>256</TotalQuery>\\r\\n\\t\\t\\t<Bps>129137.37100000001</Bps>\\r\\n\\t\\t\\t<Proportion>1.1543491004193533</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>321.5924922592767</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>other</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>2723991.4195312504</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>其他</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.005925925925925926</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>8470.3203125</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>100.0</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>697341803</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>1.2033348171432345</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>99.14745652563326</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>2866</TotalQuery>\\r\\n\\t\\t\\t<Bps>879955.1972037038</Bps>\\r\\n\\t\\t\\t<Proportion>12.923298913288543</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>1004.5513789924338</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>mobile</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>1657975.598360084</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>移动</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.06634259259259259</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>1650.463712491277</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>97.3831123517097</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>4751758064</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>8.19964599032574</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>99.99981717005271</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>6534</TotalQuery>\\r\\n\\t\\t\\t<Bps>3194660.60262963</Bps>\\r\\n\\t\\t\\t<Proportion>29.46295711773459</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>1171.525957981939</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>unicom</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>2640215.374074074</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>联通</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.15125</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2253.6550352004897</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>99.96939087848179</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>17251167254</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>29.768658772680293</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t\\t<ISPProportionData>\\r\\n\\t\\t\\t<ByteHitRate>99.99968869093071</ByteHitRate>\\r\\n\\t\\t\\t<TotalQuery>12114</TotalQuery>\\r\\n\\t\\t\\t<Bps>6333214.260796296</Bps>\\r\\n\\t\\t\\t<Proportion>54.62416016593768</Proportion>\\r\\n\\t\\t\\t<AvgResponseRate>984.184264638081</AvgResponseRate>\\r\\n\\t\\t\\t<IspEname>telecom</IspEname>\\r\\n\\t\\t\\t<AvgObjectSize>2823126.71357933</AvgObjectSize>\\r\\n\\t\\t\\t<ISP>电信</ISP>\\r\\n\\t\\t\\t<ReqErrRate>0.0</ReqErrRate>\\r\\n\\t\\t\\t<Qps>0.28041666666666665</Qps>\\r\\n\\t\\t\\t<AvgResponseTime>2868.494056463596</AvgResponseTime>\\r\\n\\t\\t\\t<ReqHitRate>99.97523526498266</ReqHitRate>\\r\\n\\t\\t\\t<TotalBytes>34199357008</TotalBytes>\\r\\n\\t\\t\\t<BytesProportion>59.01449878861353</BytesProportion>\\r\\n\\t\\t</ISPProportionData>\\r\\n\\t</Value>\\r\\n\\t<DataInterval>86400</DataInterval>\\r\\n\\t<RequestId>DE81639B-DAC1-4C76-AB72-F34B836837D5</RequestId>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<EndTime>2019-11-29T05:33:00Z</EndTime>\\r\\n\\t<StartTime>2019-11-29T05:33:00Z</StartTime>\\r\\n</DescribeDomainISPDataResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '查询用户运营商分布数据', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + ."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + .'> - 如果您不指定StartTime和EndTime时，该接口返回过去24小时的数据；指定StartTime和EndTime时，返回起止时间的数据。'."\n" + .'> - 该接口只支持获取一个域名或当前账户下所有域名的数据。'."\n" + .'> - 单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainAverageResponseTime' => [ + 'summary' => '调DescribeDomainAverageResponseTime获取加速域名的平均响应时间，支持获取最近90天的数据', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111763', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'TimeMerge', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自适应计算Interval值，如果**timeMerge**=**1**，会根据startTime和endTime计算出合适的inteval值，和Interval参数任选。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DomainType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型。传dynamic时，查询全站加速动态资源的平均响应时间和静态资源的平均响应时间；默认不传，查询静态资源的平均响应时间。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'domaintype', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用英文逗号（,）分隔。'."\n" + ."\n" + .'默认查询所有加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。获取日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度，单位：秒。根据您指定**StartTime**和**EndTime**两者的时间跨度，该参数取值如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持**300**、**3600**、 **86400**，如果不传该参数，默认值为**300**。'."\n" + ."\n" + .'- 3-31天（不包含31天整）支持**3600**和**86400**，如果不传该参数，默认值为**3600**。'."\n" + ."\n" + .'- 31天及以上支持**86400**，如果不传该参数，默认值为**86400**。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '数据时间间隔。', + 'type' => 'string', + 'example' => '300', + ], + 'AvgRTPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间点平均响应时间列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '平均响应时间。', + 'type' => 'string', + 'example' => '3', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidIspParameter', + 'errorMessage' => 'The specified Isp is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2019-11-30T05:33:00Z\\",\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"AvgRTPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"3\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"EndTime\\": \\"2015-12-11T21:00:00Z\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"AvgRTPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"Value\\": \\"3\\"\\n },\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:05:00Z\\",\\n \\"Value\\": \\"3\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"<DescribeDomainAverageResponseTimeResponse>\\r\\n\\t<DomainName>example.com</DomainName>\\r\\n\\t<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>\\r\\n\\t<StartTime>2019-11-30T05:33:00Z</StartTime>\\r\\n\\t<EndTime>2019-11-30T05:40:00Z</EndTime>\\r\\n\\t<DataInterval>300</DataInterval>\\r\\n\\t<AvgRTPerInterval>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2019-11-30T05:33:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>3</Value>\\r\\n\\t\\t</DataModule>\\r\\n\\t\\t<DataModule>\\r\\n\\t\\t\\t<TimeStamp>2019-11-30T05:38:00Z</TimeStamp>\\r\\n\\t\\t\\t<Value>3</Value>\\r\\n\\t\\t</DataModule>\\r\\n\\t</AvgRTPerInterval>\\r\\n</DescribeDomainAverageResponseTimeResponse>\\r\\n\\t\\r\\n","errorExample":""}]', + 'title' => '获取平均响应时间数据', + 'description' => '<props="china">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)或者[投递实时日志到SLS](~~440145~~)来实现。</props>'."\n" + .'<props="intl">阿里云CDN产品的统计分析功能已经下线，与统计分析功能相关的OpenAPI接口已不再继续维护。鉴于当前该接口可能存在数据缺失、不准确等问题，建议您不要使用该接口。如果您有数据统计分析相关的需求，可以通过[运营报表](~~279577~~)来实现。</props>'."\n" + .'> - 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime时，返回起止时间的数据。'."\n" + .'> - 单用户调用频率：100次/秒。'."\n" + .'> - 支持批量查询域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainRealTimeDetailData' => [ + 'summary' => '调用DescribeDomainRealTimeDetailData批量获取域名实时监控详细数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111790', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的加速域名，一次最多同时查询20个域名，域名之间用英文逗号分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2019-11-30T05:33:00Z。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2019-11-30T05:40:00Z。'."\n" + ."\n" + .'> 结束时间需大于开始时间，并且结束时间和开始时间相差不超过10分钟。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'description' => '获取的类别信息，多个用英文逗号（,）分隔。取值：'."\n" + ."\n" + .'- **qps**：每秒访问次数。'."\n" + .'- **bps**：带宽数据。'."\n" + .'- **http_code**：HTTP返回码。', + 'type' => 'string', + 'required' => true, + 'example' => 'qps', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名，默认查询所有地域。您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取地域英文名。', + 'type' => 'string', + 'required' => false, + 'example' => 'Guangdong', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，默认查询所有运营商。您可以调用[DescribeCdnRegionAndIsp](~~91077~~)接口获取运营商英文名。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'Merge', + 'in' => 'query', + 'schema' => [ + 'description' => '是否输出汇总值。取值：'."\n" + ."\n" + .'- **true**：输出。'."\n" + .'- **false**：不输出。'."\n" + ."\n" + .'默认值为**false**。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MergeLocIsp', + 'in' => 'query', + 'schema' => [ + 'description' => '是否输出汇总值。取值：'."\n" + ."\n" + .'- **true**：输出只会按照Domain进行分组，聚合地域和运营商。'."\n" + .'- **false**：输出只会按照Domain进行分组。'."\n" + ."\n" + .'默认值为**false**。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '地区运营商详细数据。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "time_stp": "2018-06-05T20:00:00Z",'."\n" + .' "domain_name": "example.com",'."\n" + .' "location": "Guangdong",'."\n" + .' "isp": "telecom",'."\n" + .' "qps": 10'."\n" + .' },'."\n" + .' {'."\n" + .' "time_stp": "2018-06-05T20:00:00Z",'."\n" + .' "domain_name": "example.com",'."\n" + .' "location": "Jiangsu",'."\n" + .' "isp": "unicom",'."\n" + .' "qps": 11.1'."\n" + .' }'."\n" + .']', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B49E6DDA-F413-422B-B58E-2FA23F286726', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[\\\\n {\\\\n \\\\\\"time_stp\\\\\\": \\\\\\"2018-06-05T20:00:00Z\\\\\\",\\\\n \\\\\\"domain_name\\\\\\": \\\\\\"example.com\\\\\\",\\\\n \\\\\\"location\\\\\\": \\\\\\"Guangdong\\\\\\",\\\\n \\\\\\"isp\\\\\\": \\\\\\"telecom\\\\\\",\\\\n \\\\\\"qps\\\\\\": 10\\\\n },\\\\n {\\\\n \\\\\\"time_stp\\\\\\": \\\\\\"2018-06-05T20:00:00Z\\\\\\",\\\\n \\\\\\"domain_name\\\\\\": \\\\\\"example.com\\\\\\",\\\\n \\\\\\"location\\\\\\": \\\\\\"Jiangsu\\\\\\",\\\\n \\\\\\"isp\\\\\\": \\\\\\"unicom\\\\\\",\\\\n \\\\\\"qps\\\\\\": 11.1\\\\n }\\\\n]\\",\\n \\"RequestId\\": \\"B49E6DDA-F413-422B-B58E-2FA23F286726\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainRealTimeDetailDataResponse>\\n<Data>\\n <2018-06-05T20:00:00Z>\\n <example.com>\\n <Guangdong>\\n <telecom>\\n <qps>10</qps>\\n <http_code>\\n <200>1</200>\\n <304>2</304>\\n </http_code>\\n </telecom>\\n </Guangdong>\\n <Jiangsu>\\n <unicom>\\n <qps>11.1</qps>\\n <http_code>\\n <200>1</200>\\n <304>2</304>\\n <403>3</403>\\n </http_code>\\n </unicom>\\n </Jiangsu>\\n </example.com>\\n </2018-06-05T20:00:00Z>\\n</Data>\\n<RequestId>B49E6DDA-F413-422B-B58E-2FA23F286726</RequestId>\\n</DescribeDomainRealTimeDetailDataResponse>","errorExample":""}]', + 'title' => '批量获取域名实时监控详细数据', + 'description' => '- 支持查询7天内的数据，查询粒度为1分钟。'."\n" + .'- 单个用户的调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '>Data字段受API限制，按JSON字符串返回，具体结构及字段描述如下：'."\n" + ."\n" + .'### Data字段描述 （如对应字段没有数据则不返回该字段）'."\n" + .'| 名称 | 类型 | 描述 |示例值|'."\n" + .'|-------------|----------|----------------------------------------------|---|'."\n" + .'| domain_name | String | 查询域名。 | example.com |'."\n" + .'| isp | String | 运营商名称。 |unicom|'."\n" + .'| location | String | 地区名称。 | qingdao |'."\n" + .'| qps | Long |每秒访问次数。 | 40 |'."\n" + .'| bps | Long | 带宽数据，单位：bit/s。 | 100 |'."\n" + .'| http_code | Map| http_code明细。键为状态码名称，值为状态码数量。 |{"200": 1, "304": 2, "403": 3}|'."\n" + .'| time_stp | String | 数据起始时间，键为查询数据的起始时间，日期格式按照ISO8601表示法，并使用UTC时间,<br>例如：2016-10-20T04:00:00Z.。|2022-10-20T04:00:00Z|', + 'extraInfo' => ' ', + ], + 'DescribeDomainMultiUsageData' => [ + 'summary' => '调用DescribeDomainMultiUsageData批量查询加速域名的流量和请求数类五分钟粒度的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111781', + 'abilityTreeNodes' => [ + 'FEATUREcdnNZNXYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔。'."\n" + ."\n" + .'> - 单次查询最多可添加30个域名。'."\n" + .'> - 若参数为空，默认返回所有加速域名分组数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO 8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO 8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T21:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '查询用量的结束时间。', + 'type' => 'string', + 'example' => '2017-12-10T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '查询用量的开始时间。', + 'type' => 'string', + 'example' => '2017-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', + ], + 'RequestPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestDataModule' => [ + 'description' => '每五分钟各请求计量数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '类型。'."\n" + ."\n" + .'> CDN产品只有Simple。', + 'type' => 'string', + 'example' => 'Simple', + ], + 'TimeStamp' => [ + 'description' => '返回数据中，请求数所在时间片段起始时刻。', + 'type' => 'string', + 'example' => '2017-12-10T20:00:00Z', + ], + 'Domain' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Request' => [ + 'description' => '请求数，单位：个。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11288111', + ], + ], + ], + ], + ], + ], + 'TrafficPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TrafficDataModule' => [ + 'description' => '每五分钟各流量计量数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '请求数类型。取值：'."\n" + ."\n" + .'- **StaticHttps**：静态HTTPS请求数。'."\n" + .'- **DynamicHttps**：动态HTTPS请求数。'."\n" + .'- **DynamicHttp**：动态HTTP请求数。'."\n" + .'- **StaticQuic**：静态QUIC请求数。'."\n" + .'- **DynamicQuic**：动态QUIC请求数。', + 'type' => 'string', + 'example' => 'DynamicHttp', + ], + 'Domain' => [ + 'description' => '域名名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TimeStamp' => [ + 'description' => '返回数据中，用量数据所在时间片段起始时刻。', + 'type' => 'string', + 'example' => '2017-12-10T20:00:00Z', + ], + 'Area' => [ + 'description' => '大区名称。', + 'type' => 'string', + 'example' => 'CN', + ], + 'Bps' => [ + 'description' => '比特率，单位：bit/second。', + 'type' => 'number', + 'format' => 'float', + 'example' => '11288111.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName', + 'errorMessage' => 'The specified DomainNames is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2017-12-10T21:00:00Z\\",\\n \\"StartTime\\": \\"2017-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"RequestPerInterval\\": {\\n \\"RequestDataModule\\": [\\n {\\n \\"Type\\": \\"Simple\\",\\n \\"TimeStamp\\": \\"2017-12-10T20:00:00Z\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"Request\\": 11288111\\n }\\n ]\\n },\\n \\"TrafficPerInterval\\": {\\n \\"TrafficDataModule\\": [\\n {\\n \\"Type\\": \\"DynamicHttp\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"TimeStamp\\": \\"2017-12-10T20:00:00Z\\",\\n \\"Area\\": \\"CN\\",\\n \\"Bps\\": 11288111.1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainMultiUsageDataResesponse>\\n<TrafficPerInterval>\\n <TrafficDataModule>\\n <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>\\n <Domain>example.com</Domain>\\n <Bps>11288111.1</Bps>\\n <Type>Simple</Type>\\n <Area>CN</Area>\\n </TrafficDataModule>\\n</TrafficPerInterval>\\n<RequestPerInterval>\\n <RequestDataModule>\\n <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>\\n <Domain>example.com</Domain>\\n <Request>11288111</Request>\\n <Type>DynamicHttp</Type>\\n </RequestDataModule>\\n <RequestDataModule>\\n <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>\\n <Domain>example.com</Domain>\\n <Request>11288111</Request>\\n <Type>StaticHttps</Type>\\n </RequestDataModule>\\n</RequestPerInterval>\\n<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>\\n<StartTime>2017-12-10T20:00:00Z</StartTime>\\n<EndTime>2017-12-10T21:00:00Z</EndTime>\\n</DescribeDomainMultiUsageDataResesponse>","errorExample":""}]', + 'title' => '批量查询加速域名的流量和请求数', + 'description' => '- 如果您未指定StartTime和EndTime，该接口默认返回过去10分钟的数据。'."\n" + .'- StartTime和EndTime间隔最长为1小时。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + .'- 支持查询已删除的加速域名的流量和请求数。'."\n" + .'- 单用户调用频率：50次/秒', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserConfigs' => [ + 'summary' => '调用DescribeUserConfigs查询安全功能相关的配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '111841', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的配置，支持持单个查询。当前支持oss、green_manager、waf、cc_rule、ddos_dispatch、edge_safe、blocked_regions、http_acl_policy、bot_manager和ip_reputation配置。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9BCC7BAA-ACBE-45E5-83F0-98BF7E693E84', + ], + 'Configs' => [ + 'description' => '对应的配置数据。', + 'type' => 'object', + 'properties' => [ + 'OssLogConfig' => [ + 'description' => 'OSS日志存储配置。', + 'type' => 'object', + 'properties' => [ + 'Prefix' => [ + 'description' => '前缀。', + 'type' => 'string', + 'example' => 'test', + ], + 'Enable' => [ + 'description' => '是否开启存储空间。', + 'type' => 'string', + 'example' => 'off', + ], + 'Bucket' => [ + 'description' => '存储空间名称。', + 'type' => 'string', + 'example' => 'Buckettest', + ], + ], + ], + 'WafConfig' => [ + 'description' => 'WAF功能配置。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => '是否开启WAF功能。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingConfig', + 'errorMessage' => 'The input parameter Config that is mandatory for processing this request is not supplied.', + ], + [ + 'errorCode' => 'InvalidConfig.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter Config is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9BCC7BAA-ACBE-45E5-83F0-98BF7E693E84\\",\\n \\"Configs\\": {\\n \\"OssLogConfig\\": {\\n \\"Prefix\\": \\"test\\",\\n \\"Enable\\": \\"off\\",\\n \\"Bucket\\": \\"Buckettest\\"\\n },\\n \\"WafConfig\\": {\\n \\"Enable\\": \\"on\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserConfigsResponse>\\n<RequestId>9BCC7BAA-ACBE-45E5-83F0-98BF7E693E84</RequestId>\\n<Configs>\\n <OssLogConfig>\\n <Enable>off</Enable>\\n <Bucket>Bucket2</Bucket>\\n <Prefix>test</Prefix>\\n </OssLogConfig>\\n <GreenManagerConfig>\\n <Quota>500</Quota>\\n <Ratio>20%</Ratio>\\n </GreenManagerConfig>\\n <WafConfig>\\n <Enable>on</Enable>\\n </WafConfig>\\n</Configs>\\n</DescribeUserConfigsResponse>","errorExample":""}]', + 'title' => '查询安全功能相关的配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetReqHeaderConfig' => [ + 'summary' => '调用SetReqHeaderConfig设置回源自定义头。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111909', + 'abilityTreeNodes' => [ + 'FEATUREcdnJA88R2', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个用逗号（,）隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '回源自定义头参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'testkey', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '回源自定义头取值。', + 'type' => 'string', + 'required' => true, + 'example' => 'testvalue', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified value of parameter DomainName can not be empty.', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified value of parameter Key is not malformed.', + ], + [ + 'errorCode' => 'InvalidValue.Malformed', + 'errorMessage' => 'The specified value of parameter Value is not malformed.', + ], + [ + 'errorCode' => 'InvalidHeaderKey.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter HeaderKey is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<SetReqHeaderConfigResponse>\\r\\n\\t <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</SetReqHeaderConfigResponse>","errorExample":""}]', + 'title' => '设置回源自定义头', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCdnService' => [ + 'summary' => '变更CDN服务的计费类型。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111871', + 'abilityTreeNodes' => [ + 'FEATUREcdnBXNWCW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '开通服务的计费类型', + 'type' => 'string', + 'required' => true, + 'example' => 'PayByTraffic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0979B99B-4F00-5037-8E15-5F7D4ABF8AA1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified value of parameter "InternetChargeType" is not valid.', + ], + [ + 'errorCode' => 'InsufficientBalance', + 'errorMessage' => 'Your account does not have enough balance.', + ], + [ + 'errorCode' => 'FUWU_BIZ_COMMODITY_VERIFY_FAIL_INVALID_PAY_METHOD', + 'errorMessage' => 'INVALID_PAY_METHOD', + ], + [ + 'errorCode' => 'FUWU_BIZ_COMMODITY_VERIFY_FAIL_HASORDER', + 'errorMessage' => 'You have an order not yet effective', + ], + [ + 'errorCode' => 'CSS_CHECK_UPDOWNGRADE_ERROR', + 'errorMessage' => 'You have an order not yet effective', + ], + [ + 'errorCode' => 'COMMODITY.INVALID_COMPONENT', + 'errorMessage' => 'The specified value of parameter "InternetChargeType" is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0979B99B-4F00-5037-8E15-5F7D4ABF8AA1\\"\\n}","type":"json"}]', + 'title' => '修改CDN服务的计费类型', + ], + 'DescribeUserCdnStatus' => [ + 'summary' => '调用DescribeUserCdnStatus获取用户状态信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111839', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InDebt' => [ + 'description' => '是否欠费。'."\n" + ."\n" + .'- true：欠费。'."\n" + .'- false：未欠费。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OnService' => [ + 'description' => '服务是否可用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '39B1DC7F-9D25-5D54-8F02-6EE26A7F48CA', + ], + 'InDebtOverdue' => [ + 'description' => '是否欠费超期。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Enabled' => [ + 'description' => '是否开通了Cdn服务。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InDebt\\": false,\\n \\"OnService\\": true,\\n \\"RequestId\\": \\"39B1DC7F-9D25-5D54-8F02-6EE26A7F48CA\\",\\n \\"InDebtOverdue\\": false,\\n \\"Enabled\\": true\\n}","type":"json"}]', + 'title' => '获取用户状态信息', + ], + 'DescribeCdnTypes' => [ + 'summary' => '调用DescribeCdnTypes获取域名类型列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '111744', + 'abilityTreeNodes' => [ + 'FEATUREcdn9UE6OO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BDA62CE4-3477-439A-B52E-D2D7C829D7C1'."\n", + ], + 'CdnTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CdnType' => [ + 'description' => '域名业务类型。', + 'type' => 'array', + 'items' => [ + 'description' => '域名业务类型。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '域名业务类型。', + 'type' => 'string', + 'example' => 'download', + ], + 'Desc' => [ + 'description' => '域名业务类型描述。', + 'type' => 'string', + 'example' => 'Download Acceleration', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDA62CE4-3477-439A-B52E-D2D7C829D7C1\\\\n\\",\\n \\"CdnTypes\\": {\\n \\"CdnType\\": [\\n {\\n \\"Type\\": \\"download\\",\\n \\"Desc\\": \\"Download Acceleration\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取 CDN 类型列表', + ], + 'ModifyCdnDomainOwner' => [ + 'summary' => '调用ModifyCdnDomainOwner将其他阿里云账号下的域名迁移至本账号。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '162664', + 'abilityTreeNodes' => [ + 'FEATUREcdnRO9687', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C98E518B-024E-538E-8276-66310CB8667D', + ], + 'Content' => [ + 'description' => '域名迁移说明。', + 'type' => 'object', + 'example' => '{'."\n" + .' "域名归属权校验": false'."\n" + .'}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomain.NotExist', + 'errorMessage' => 'The domain you provided is not exist.', + ], + [ + 'errorCode' => 'DomainTransferFail', + 'errorMessage' => 'The domain does not allow to transfer to a different account.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C98E518B-024E-538E-8276-66310CB8667D\\",\\n \\"Content\\": {\\n \\"域名归属权校验\\": false\\n }\\n}","type":"json"}]', + 'title' => '迁移域名', + 'description' => '主要用于以下场景：'."\n" + .'- 您有多个阿里云账号，希望将账号A中的加速域名迁移至账号B。'."\n" + .'- 您在添加加速域名时，有提示该加速域名已经被添加过，您不清楚该加速域名归属于哪个账号，希望将该加速域名迁移至您正在操作的账号中。', + ], + 'DescribeCdnConditionIPBInfo' => [ + 'summary' => '调用DescribeCdnConditionIPBInfo查看高级条件所需要的运营商、地区和国家信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '165633', + 'abilityTreeNodes' => [ + 'FEATUREcdnORORBI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。取值如下：'."\n" + .'- condition_region_config_cn：提供地区中文名称及其对应代码的映射列表。'."\n" + .'- condition_region_config_en：提供地区英文名称及其对应代码的映射列表。'."\n" + .'- condition_isp_config_cn：提供运营商中文名称及其对应代码的映射列表。'."\n" + .'- condition_isp_config_en：提供运营商英文名称及其对应代码的映射列表。'."\n" + .'- condition_country_config_cn：提供国家中文名称及其对应代码的映射列表。'."\n" + .'- condition_country_config_en：提供国家英文名称及其对应代码的映射列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'condition_region_config_cn', + 'enum' => [ + 'condition_region_config_cn', + 'condition_region_config_en', + 'condition_isp_config_cn', + 'condition_isp_config_en', + 'condition_country_config_cn', + 'condition_country_config_en', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2C4AA72D-8C00-1113-BD68-8BC4E3CF4FF6', + ], + 'Datas' => [ + 'description' => '数据详情。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '配置值。', + 'type' => 'string', + 'example' => '"[{\\"text\\":\\"阿鲁巴\\",\\"value\\":\\"AW\\"}]"', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C4AA72D-8C00-1113-BD68-8BC4E3CF4FF6\\",\\n \\"Datas\\": [\\n {\\n \\"Value\\": \\"\\\\\\"[{\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿鲁巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AW\\\\\\\\\\\\\\"}]\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看高级条件所需要的信息', + ], + 'DescribeCdnSecFuncInfo' => [ + 'summary' => '调用DescribeCdnSecFuncInfo查询CDN应用安全具体功能信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '167969', + 'abilityTreeNodes' => [ + 'FEATUREcdnORORBI', + ], + ], + 'parameters' => [ + [ + 'name' => 'SecFuncType', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '应用安全功能类型。'."\n" + ."\n" + .'- CipherSuiteGroupCustomize: 自定义加密算法套件'."\n" + .'- CipherSuiteGroupStrict: 默认加密算法套件', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'CipherSuiteGroupCustomize' => '自定义加密算法套件', + 'CipherSuiteGroupStrict' => '默认加密算法套件', + ], + 'example' => 'CipherSuiteGroupCustomize', + 'enum' => [ + 'CipherSuiteGroupStrict', + 'CipherSuiteGroupCustomize', + ], + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '语言类型。'."\n" + ."\n" + .'- en: 英文'."\n" + .'- zh: 中文', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'zh', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回应用安全功能信息数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BCD7D917-76F1-442F-BB75-C810DE34C761', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => 'HTTP请求响应返回码。'."\n" + ."\n" + .'- 0：OK。'."\n" + .'- 非0：返回错误。', + 'type' => 'string', + 'example' => '0', + ], + 'HttpStatus' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Content' => [ + 'description' => '查询到的数据。', + 'type' => 'array', + 'items' => [ + 'description' => '应用安全功能信息。', + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', + ], + 'Value' => [ + 'description' => '值。', + 'type' => 'string', + 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCD7D917-76F1-442F-BB75-C810DE34C761\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": \\"0\\",\\n \\"HttpStatus\\": \\"200\\",\\n \\"Content\\": [\\n {\\n \\"Label\\": \\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\",\\n \\"Value\\": \\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询CDN应用安全具体功能信息', + ], + 'CheckCdnDomainExist' => [ + 'summary' => '调用CheckCdnDomainExist检测域名是否存在。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '172982', + 'abilityTreeNodes' => [ + 'FEATUREcdnORORBI', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64D28B53-5902-409B-94F6-FD46680144FE', + ], + 'Status' => [ + 'description' => '域名状态，取值：'."\n" + .'- **DomainNotExist**：域名未被添加'."\n" + .'- **DomainExistOtherUser**：域名已被其他账号添加'."\n" + .'- **DomainExistCdnProduct**：域名已被添加至Cdn'."\n" + .'- **DomainExistDcdnProduct**：域名已被添加至Dcdn'."\n" + .'- **DomainExistScdnProduct**：域名已被添加至Scdn'."\n" + .'- **DomainExistVodProduct**：域名已被添加至Vod'."\n" + .'- **DomainExistLiveProduct**：域名已被添加至Live'."\n" + .'- **DomainExistDcdnipaProduct**：域名已被添加至Dcdnipa', + 'type' => 'string', + 'example' => 'DomainNotExist', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DomainExist.OtherUser', + 'errorMessage' => 'This domain is already added by another user.', + ], + [ + 'errorCode' => 'DomainExist.OtherProduct', + 'errorMessage' => 'This domain is already existed in %s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64D28B53-5902-409B-94F6-FD46680144FE\\",\\n \\"Status\\": \\"DomainNotExist\\"\\n}","type":"json"}]', + 'title' => '检测域名是否存在', + ], + 'CheckCdnDomainICP' => [ + 'summary' => '调用CheckCdnDomainICP查询域名是否备案。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '174446', + 'abilityTreeNodes' => [ + 'FEATUREcdnRLQ471', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Status' => [ + 'description' => '资源包状态。取值：'."\n" + ."\n" + .'- **DomainIsRegistration**：已备案。'."\n" + ."\n" + .'- **DomainNotRegistration**：未备案。', + 'type' => 'string', + 'enumValueTitles' => [ + 'DomainNotRegistration' => '未备案', + 'DomainIsRegistration' => '已备案', + ], + 'example' => 'DomainIsRegistration', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-124', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + [ + 'errorCode' => 'CheckDomainICPFail', + 'errorMessage' => 'The domain query icp info error,check domain icp failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Status\\": \\"DomainIsRegistration\\"\\n}","type":"json"}]', + 'title' => '查询域名是否备案', + ], + 'BatchDescribeCdnIpInfo' => [ + 'summary' => '调用BatchDescribeCdnIpInfo批量查询IP是否为阿里云CDN服务IP。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '156304', + 'abilityTreeNodes' => [ + 'FEATUREcdnNSUDKT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IpAddrList', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的IP地址列表参数，IP地址之间用半角逗号（,）分隔，一次性最多查询20个IP地址。'."\n" + ."\n" + .'>- IPv4举例：192.0.2.1。'."\n" + .'>- IPv6举例：2001:db8:ffff:ffff:ffff:****:ffff。', + 'type' => 'string', + 'required' => true, + 'example' => '111.XXX.XXX.230,47.XXX.XXX.243', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果语言控制。取值：'."\n" + .'- **zh**（默认值）：简体中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '55ADD936-763F-5E1A-BF54-2EA3F6E94A52', + ], + 'IpInfoList' => [ + 'description' => 'IP地址返回结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IpAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '111.XXX.XXX.230', + ], + 'IspName' => [ + 'description' => '所属运营商名称。', + 'type' => 'string', + 'example' => '移动', + ], + 'Country' => [ + 'description' => '所属国家。', + 'type' => 'string', + 'example' => '中国', + ], + 'Province' => [ + 'description' => '所属省。', + 'type' => 'string', + 'example' => '北京市', + ], + 'City' => [ + 'description' => '所属市。', + 'type' => 'string', + 'example' => '北京市', + ], + 'CdnIp' => [ + 'description' => '是否属于阿里云CDN节点。'."\n" + .'- **true**：属于。'."\n" + .'- **false**：不属于。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvaildBatchIp.LengthTooLong', + 'errorMessage' => 'The batchIp parameter is too long', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvaildParameter', + 'errorMessage' => 'The parameter you provided is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"55ADD936-763F-5E1A-BF54-2EA3F6E94A52\\",\\n \\"IpInfoList\\": [\\n {\\n \\"IpAddress\\": \\"111.XXX.XXX.230\\",\\n \\"IspName\\": \\"移动\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"北京市\\",\\n \\"City\\": \\"北京市\\",\\n \\"CdnIp\\": \\"true\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<BatchDescribeCdnIpInfoResponse>\\n <RequestId>55ADD936-763F-5E1A-BF54-2EA3F6E94A52</RequestId>\\n <IpInfoList>\\n <IspName>移动</IspName>\\n <Country>中国</Country>\\n <IpAddress>111.XXX.XXX.230</IpAddress>\\n <City>北京市</City>\\n <CdnIp>true</CdnIp>\\n <Province>北京市</Province>\\n </IpInfoList>\\n <IpInfoList>\\n <IspName>NTT</IspName>\\n <Country>中国</Country>\\n <IpAddress>47.XXX.XXX.243</IpAddress>\\n <City>香港</City>\\n <CdnIp>true</CdnIp>\\n <Province>香港特别行政区</Province>\\n </IpInfoList>\\n</BatchDescribeCdnIpInfoResponse>","errorExample":""}]', + 'title' => '批量查询IP是否为CDN节点', + 'description' => '> 单用户调用频率：20次/秒。', + ], + 'DescribeCdnFullDomainsBlockIPHistory' => [ + 'summary' => '调用DescribeCdnFullDomainsBlockIPHistory获取封禁历史记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '228025', + 'abilityTreeNodes' => [ + 'FEATUREcdnHPRG9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IPList', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询IP/IP段。', + 'type' => 'string', + 'required' => true, + 'example' => '1.XXX.XXX.1,2.XXX.XXX.2', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询获取数据起始时间点，时间格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-24T17:00:00Z'."\n", + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询获取数据结束时间点，时间格式为：YYYY-MM-DDThh:mm:ssZ；结束时间需大于起始时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-24T19:00:00Z'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BCD7D917-76F1-442F-BB75-C810DE34C761', + ], + 'IPBlockInfo' => [ + 'description' => '操作结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BlockIP' => [ + 'description' => '下发的IP/IP段。', + 'type' => 'string', + 'example' => '1.XXX.XXX.0~1.XXX.XXX.255'."\n", + ], + 'DeliverTime' => [ + 'description' => '下发时间。', + 'type' => 'string', + 'example' => '2023-04-24 18:49:37'."\n", + ], + 'Status' => [ + 'description' => '下发状态。'."\n" + ."\n" + .'+ Success：下发成功。'."\n" + .'+ Failed：下发失败，或未有下发记录。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + 'Code' => [ + 'description' => '结果信息码。'."\n" + ."\n" + .'Code不为0可能有以下三种情况：'."\n" + ."\n" + .'+ IP格式不正确。'."\n" + .'+ 时间格式不正确。'."\n" + .'+ 其他。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Description' => [ + 'description' => '接口返回状态描述。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded', + 'errorMessage' => 'The quota is exceeded.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCD7D917-76F1-442F-BB75-C810DE34C761\\",\\n \\"IPBlockInfo\\": [\\n {\\n \\"BlockIP\\": \\"1.XXX.XXX.0~1.XXX.XXX.255\\\\n\\",\\n \\"DeliverTime\\": \\"2023-04-24 18:49:37\\\\n\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Description\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '查询封禁历史', + 'description' => '> '."\n" + .'>- 该接口需要<props="china"><ph>[提交工单](https://selfservice.console.aliyun.com/ticket/createIndex)</ph></props><props="intl"><ph>[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.2020520001.aliyun_topbar.18.dbd44bd3e4f845#/ticket/createIndex)</ph></props>申请后使用。'."\n" + .'> - 对用户指定的IP和时间段，返回用户在该时间段对该IP的下发时间和对应结果。'."\n" + .'> - 当指定的IP/IP段在指定时间段存在多条下发记录时，会按下发时间降序排列。'."\n" + .'> - 查询时间段支持的最大范围为90天。'."\n" + .'> - 给定IP和时间段不存在下发记录或下发失败时，下发时间为空。', + ], + 'SetCdnFullDomainsBlockIP' => [ + 'summary' => '设置封禁的IP或解禁IP，该操作对您账号下所有的CDN域名同时生效。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '227991', + 'abilityTreeNodes' => [ + 'FEATUREcdnHPRG9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IPList', + 'in' => 'formData', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '封禁或解禁IP列表，有多个IP时请用半角逗号（,）分隔，最大支持1000个IP。', + 'type' => 'string', + 'required' => true, + 'example' => '1.XXX.XXX.1,2.XXX.XXX.2', + ], + ], + [ + 'name' => 'OperationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作类型。'."\n" + ."\n" + .'- block：封禁。'."\n" + .'- unblock：解禁。', + 'type' => 'string', + 'required' => true, + 'example' => 'block', + ], + ], + [ + 'name' => 'BlockInterval', + 'in' => 'formData', + 'schema' => [ + 'description' => '封禁时长，单位为秒。设置为**0**时表示永久封禁。仅当**OperationType**为**block**时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3000', + ], + ], + [ + 'name' => 'UpdateType', + 'in' => 'formData', + 'schema' => [ + 'description' => '封禁时间类别。仅当**OperationType**为**block**时有效。取值：'."\n" + ."\n" + .'- **cover**：当前请求是采取配置覆盖方式。'."\n" + .'- **uncover**：采取时间计算比对最长方式。'."\n" + .'- 该参数为空时默认采取配置覆盖方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'cover', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。0为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '附加信息。取值说明如下：请求正常，返回OK。请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '23ACE7E2-2302-42E3-98F8-E5E697FD86C3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded', + 'errorMessage' => 'The quota is exceeded.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'You do not have access to this operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"23ACE7E2-2302-42E3-98F8-E5E697FD86C3\\"\\n}","type":"json"}]', + 'title' => '设置海量封禁IP', + 'description' => '> '."\n" + .'>- 该接口需要<props="china"><ph>[购买海量IP封禁服务](https://common-buy.aliyun.com/?commodityCode=dcdn_servicepackage_public_cn)</ph></props><props="intl"><ph>[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.2020520001.aliyun_topbar.18.dbd44bd3e4f845#/ticket/createIndex)</ph></props>后使用。'."\n" + .'> - 适用于封禁大批量IP，接口支持单次最大1000个IP/IP段。', + ], + 'DescribeCdnFullDomainsBlockIPConfig' => [ + 'summary' => '调用DescribeCdnFullDomainsBlockIPConfig查询全量封禁的相关配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '228031', + 'abilityTreeNodes' => [ + 'FEATUREcdnHPRG9U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IPList', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询IP/IP段列表，多个IP请用半角逗号（,）分隔，最大支持50个。', + 'type' => 'string', + 'required' => false, + 'example' => '1.XXX.XXX.1,2.XXX.XXX.2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '95994621-8382-464B-8762-C708E73568D1', + ], + 'Message' => [ + 'description' => '结果信息，返回正常是为OSS链接，异常是为错误信息。', + 'type' => 'string', + 'example' => 'http://xxxx-api.oss-cn-hangzhou.aliyuncs.com/blocklist%2Fxxxxxxxxxxxx.txt?Expires=1682663947&OSSAccessKeyId=xxxxxxxxxx&Signature=xxxxxx', + ], + 'Code' => [ + 'description' => '结果信息码。'."\n" + ."\n" + .'Code不为0可能有以下三种情况：'."\n" + ."\n" + .'+ IP格式不正确。'."\n" + .'+ IP个数超出限制。'."\n" + .'+ 其他。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded', + 'errorMessage' => 'The quota is exceeded.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalServerError', + 'errorMessage' => 'internal server error', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95994621-8382-464B-8762-C708E73568D1\\",\\n \\"Message\\": \\"http://xxxx-api.oss-cn-hangzhou.aliyuncs.com/blocklist%2Fxxxxxxxxxxxx.txt?Expires=1682663947&OSSAccessKeyId=xxxxxxxxxx&Signature=xxxxxx\\",\\n \\"Code\\": 0\\n}","type":"json"}]', + 'title' => '查询全量封禁配置', + 'description' => '>'."\n" + .'>- 该接口需要<props="china"><ph>[提交工单](https://selfservice.console.aliyun.com/ticket/createIndex)</ph></props><props="intl"><ph>[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.2020520001.aliyun_topbar.18.dbd44bd3e4f845#/ticket/createIndex)</ph></props>申请后使用。'."\n" + .'> - 对用户给定的IP/IP段，给出该用户当前时间生效的IP和对应过期时间；用户不指定IP时，返回当前全量生效的IP和对应过期时间。'."\n" + .'> - 结果写入OSS，以OSS链接返回 ，OSS文件中内容格式为ip-对应过期时间,时间格式为YYYY-MM-DD hh:mm:ss 。'."\n" + .'> - OSS文件分享链接有效期为3天。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'cdn.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'cdn.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'cdn.aliyuncs.com', + ], + ], +]; |