'1.0',
'info' => ['style' => 'RPC', 'product' => 'Pcdn', 'version' => '2017-04-11'],
'directories' => [
[
'children' => ['GetAllAppVersions', 'GetShareRateData', 'GetClientsRatio', 'GetConsumerStatus', 'GetTokenList'],
'type' => 'directory',
'title' => '应用',
'id' => 320546,
],
[
'children' => ['AddConsumer', 'GetAllIsp', 'GetAllPlatformTypes', 'GetAllRegions', 'GetAllMarkets'],
'type' => 'directory',
'title' => '服务',
'id' => 320552,
],
[
'children' => ['GetBalanceBandwidthData', 'GetBalanceTrafficData', 'GetFeeHistory', 'GetCurrentMode', 'GetExpenseSummary'],
'type' => 'directory',
'title' => '费用',
'id' => 320558,
],
[
'children' => ['GetTrafficByRegion', 'GetTrafficData', 'GetFluencyData'],
'type' => 'directory',
'title' => '流量',
'id' => 320564,
],
[
'children' => ['GetLogsList'],
'type' => 'directory',
'title' => '日志',
'id' => 320568,
],
[
'children' => ['AddPcdnControlRule', 'DeletePcdnControlRule', 'DisablePcdnControlRule', 'EnablePcdnControlRule', 'GetControlRules', 'EditPcdnControlRule'],
'type' => 'directory',
'title' => '启停设置',
'id' => 320570,
],
[
'children' => ['AddDomain', 'DeleteDomain', 'StartDomain', 'StopDomain', 'GetAccessData', 'GetBandwidthData', 'GetCoverRateData', 'GetDomainCount', 'GetDomains', 'GetFirstFrameDelayData'],
'type' => 'directory',
'title' => '域名',
'id' => 320577,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddConsumer' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型。'."\n"
.'- **download**:大文件下载。'."\n"
.'- **live**:直播流媒体。'."\n"
.'- **vod**:视音频点播。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'download'],
],
[
'name' => 'Company',
'in' => 'query',
'schema' => ['description' => '公司名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alibaba'],
],
[
'name' => 'Site',
'in' => 'query',
'schema' => ['description' => '网站网址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example.com'],
],
[
'name' => 'Requirement',
'in' => 'query',
'schema' => ['description' => '需求描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourRequirement'],
],
[
'name' => 'Mobile',
'in' => 'query',
'schema' => ['description' => '电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '151016****'],
],
[
'name' => 'Ca',
'in' => 'query',
'schema' => ['description' => '固定参数,默认为空。', 'type' => 'string', 'required' => false, 'example' => 'Ca'],
],
[
'name' => 'Operator',
'in' => 'query',
'schema' => ['description' => '操作者。', 'type' => 'string', 'required' => false, 'example' => 'pop'],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => ['description' => '电子邮箱。', 'type' => 'string', 'required' => false, 'example' => 'username@example.com'],
],
[
'name' => 'BandwidthRequirement',
'in' => 'query',
'schema' => ['description' => '带宽需求。单位:5Gbps。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3D28E5B7-AA32-4C21-83E8-515947135E0D'],
'ResourceId' => ['description' => '创建资源ID。', 'type' => 'string', 'example' => '76lw75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"3D28E5B7-AA32-4C21-83E8-515947135E0D\\",\\n \\"ResourceId\\": \\"76lw75\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 76lwxx\\r\\n 636F1CA7-E59F-4B4F-9C4E-59E75CC01A0F\\r\\n 0\\r\\n","errorExample":""}]',
'title' => '申请开通PCDN服务',
'summary' => '调用AddConsumer申请开通PCDN服务。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'AddDomain' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => [
'description' => '业务类型。取值:'."\n"
.'- **live**:直播流媒体。'."\n"
.'- **vod**:视音频点播。'."\n"
.'- **download**:大文件下载。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'live',
'enum' => ['vod', 'live', 'download'],
],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '域名信息,仅支持添加单个。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example.com'],
],
[
'name' => 'LiveFormat',
'in' => 'query',
'schema' => ['description' => '直播格式,多个使用竖线(|)分割。当业务类型为live的时候必填。取值:'."\n"
."\n"
.'- **hls**'."\n"
.'- **flv**', 'type' => 'string', 'required' => false, 'example' => 'hls'],
],
[
'name' => 'SliceDomain',
'in' => 'query',
'schema' => ['description' => '切片域名,当业务类型为live、直播格式包含flv且客户集成模式为“与第三方CDN集成”时必填。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => 'A域名所在地域,当业务类型为live,直播格式包含flv时必填。'."\n"
."\n"
.'目前合法值包括cn-beijing、cn-shanghai、ap-southeast-1。其中当区域为“ap-southeast-1”时,后端会返回错误。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'DemoUrls',
'in' => 'query',
'schema' => ['description' => '示例URL地址,多个用竖线(|)分隔。', 'type' => 'string', 'required' => false, 'example' => 'http://lesson-01.mp4'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B40C0B7C-C90E-43CD-963A-1B6AC6BCF6FF'],
'ResourceId' => ['description' => '规则资源ID。', 'type' => 'string', 'example' => 'tu9lfh'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"B40C0B7C-C90E-43CD-963A-1B6AC6BCF6FF\\",\\n \\"ResourceId\\": \\"tu9lfh\\"\\n}","errorExample":""},{"type":"xml","example":"B40C0B7C-C90E-43CD-963A-1B6AC6BCF6FF\\ntu9lfh\\n0","errorExample":""}]',
'title' => '添加域名',
'summary' => '调用AddDomain添加域名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'AddPcdnControlRule' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST+RULE'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地区列表代码,使用竖线(|)分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商英文名,多个使用竖线(|)分隔。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mobile'],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端类型代码,使用竖线(|)分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '01'],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型:**live**、**vod**、**download**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'live'],
],
[
'name' => 'Market',
'in' => 'query',
'schema' => ['description' => '市场。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'AppVersion',
'in' => 'query',
'schema' => ['description' => '应用版本。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务返回码,正常返回为0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20963AEE-E3A5-461F-8809-C494558373AB'],
'ResourceId' => ['description' => '规则资源ID。', 'type' => 'string', 'example' => '6p9uch'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter domainName that is mandatory for processing this request is not supplied.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"20963AEE-E3A5-461F-8809-C494558373AB\\",\\n \\"ResourceId\\": \\"6p9uch\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 6p9uch\\n 0\\n 20963AEE-E3A5-461F-8809-C494558373AB\\n","errorExample":""}]',
'title' => '添加启停设置',
'summary' => '调用AddPcdnControlRule添加启停设置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeleteDomain' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '要删除的域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5923BFA8-ACC2-4949-A0AB-46B66FF45BDD'],
'ResourceId' => ['description' => '域名资源ID。', 'type' => 'string', 'example' => '23j63d'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"5923BFA8-ACC2-4949-A0AB-46B66FF45BDD\\",\\n \\"ResourceId\\": \\"23j63d\\"\\n}","errorExample":""},{"type":"xml","example":"\\n0\\n23j63d\\n5923BFA8-ACC2-4949-A0AB-46B66FF45BDD\\n\\n","errorExample":""}]',
'title' => '删除域名',
'summary' => '调用DeleteDomain删除域名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeletePcdnControlRule' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => '启停规则资源ID。', 'type' => 'string', 'required' => true, 'example' => 'y6z7rp'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务返回码,正常返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6FFD92E4-AD03-423C-AD1D-41F1990E56BA'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'You have no permission to delete this pcdn control rule.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"6FFD92E4-AD03-423C-AD1D-41F1990E56BA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 555F7320-5D9F-4C43-9FD4-442447691127\\n 0\\n","errorExample":""}]',
'title' => '删除启停设置',
'summary' => '调用DeletePcdnControlRule删除启停设置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pcdn:DeletePcdnControlRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DisablePcdnControlRule' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => '启停规则资源ID。', 'type' => 'string', 'required' => true, 'example' => 'y6z7rp', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务返回码,正常返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A2A7EBC0-089D-4F6F-8FF3-6AFA67ED4313'],
'ResourceId' => ['description' => '规则资源ID。', 'type' => 'string', 'example' => 'y6z7rp'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"A2A7EBC0-089D-4F6F-8FF3-6AFA67ED4313\\",\\n \\"ResourceId\\": \\"y6z7rp\\"\\n}","errorExample":""},{"type":"xml","example":"\\n y6z7rp\\n C7075F7D-8998-47CD-AA59-5C207D012F7B\\n 0\\n","errorExample":""}]',
'title' => '停用启停设置',
'summary' => '调用DisablePcdnControlRule停用启停设置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'EditPcdnControlRule' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => true, 'example' => 'TEST+RULE+EDIT', 'docRequired' => true],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => '启停规则资源。', 'type' => 'string', 'required' => true, 'example' => 'y6z7rp', 'docRequired' => true],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地域列表代码,多个使用竖线(|)分隔。'."\n"
."\n"
.'代码详情请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => true, 'example' => '67', 'docRequired' => true],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商英文名,使用竖线(|)分隔。', 'type' => 'string', 'required' => true, 'example' => 'mobile', 'docRequired' => true],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端类型代码,多个使用竖线(|)分隔。'."\n"
."\n"
.'代码详情请参见[通用字段参考](~~151572~~)。'."\n", 'type' => 'string', 'required' => true, 'example' => '01', 'docRequired' => true],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型:live、vod、download。', 'type' => 'string', 'required' => true, 'example' => 'live', 'docRequired' => true],
],
[
'name' => 'Market',
'in' => 'query',
'schema' => ['description' => '市场,多个用竖线(|)分隔,全部填写all。', 'type' => 'string', 'required' => true, 'example' => 'APPStore', 'docRequired' => true],
],
[
'name' => 'AppVersion',
'in' => 'query',
'schema' => ['description' => '应用版本,多个用竖线(|)分隔,修改全部填写all。', 'type' => 'string', 'required' => true, 'example' => '9.27.3501', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6FFD92E4-AD03-423C-AD1D-41F1990E56BA'],
'ResourceId' => ['description' => '规则资源ID。', 'type' => 'string', 'example' => 'y6z7rp'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"6FFD92E4-AD03-423C-AD1D-41F1990E56BA\\",\\n \\"ResourceId\\": \\"y6z7rp\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n y6z7rp\\r\\n 555F7320-5D9F-4C43-9FD4-442447691127\\r\\n 0\\r\\n","errorExample":""}]',
'title' => '修改启停设置',
'summary' => '调用EditPcdnControlRule修改启停设置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'EnablePcdnControlRule' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => '启停规则资源ID。', 'type' => 'string', 'required' => true, 'example' => 'y6z7rp', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A2A7EBC0-089D-4F6F-8FF3-6AFA67ED4313'],
'ResourceId' => ['description' => '规则资源ID。', 'type' => 'string', 'example' => 'y6z7rp'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"A2A7EBC0-089D-4F6F-8FF3-6AFA67ED4313\\",\\n \\"ResourceId\\": \\"y6z7rp\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n y6z7rp\\r\\n C7075F7D-8998-47CD-AA59-5C207D012F7B\\r\\n 0\\r\\n","errorExample":""}]',
'title' => '启用启停设置',
'summary' => '调用EnablePcdnControlRule启用启停设置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetAccessData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '待查询的域名,多个用竖线(|)分割,不传查询全部。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地域,使用竖线(|)分隔,查询全部地域填all。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商名称,使用竖线(|)分隔,查询全部运营商填all。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端,使用竖线(|)分隔,查询全部终端填all。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型,多个用竖线(|)分隔,全部填all。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2017-05-01'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2017-05-10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '448328AF-82C4-420F-8D7F-4C9F2D523D7F'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '标签,描述数据类型。', 'type' => 'string', 'example' => '访客量'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-06 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '带宽数据,单位:bit/s。', 'type' => 'string', 'example' => '10879016'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"448328AF-82C4-420F-8D7F-4C9F2D523D7F\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"访客量\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-06 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"10879016\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n \\r\\n BF921B07-EEB0-44BD-8E21-BD796E3FFBF2\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取加速域名访客统计数据',
'summary' => '获取加速域名最小1天粒度的访客统计数据。',
'description' => '> - 不指定**StartTime**和**EndTime**时,默认读取过去24小时的数据;指定**StartTime**和**EndTime**时,按指定的起止时间查询。'."\n"
."\n"
.'- 支持批量域名查询,多个域名用竖线(|)分隔。'."\n"
."\n"
.'- 最多可获取最近90天的数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetAllAppVersions' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4785676A-6382-4D0B-AA23-5081742EE74E'],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '平台类型码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Value' => ['description' => '版本号。', 'type' => 'string', 'example' => '6.6.2'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"4785676A-6382-4D0B-AA23-5081742EE74E\\",\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Code\\": 1,\\n \\"Value\\": \\"6.6.2\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0484CF2A-3C0F-4183-9DF3-6239FA433001\\n \\n 0\\n","errorExample":""}]',
'title' => '获取所有应用版本列表',
'summary' => '调用GetAllAppVersions获取所有支持的地区列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllAppVersions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetAllIsp' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FB3AA371-2230-4FF8-8E94-952EBF2CF30C'],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NameCn' => ['description' => '中文名称。', 'type' => 'string', 'example' => '长宽'],
'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'tp4xpa'],
'NameEn' => ['description' => '英文名称。', 'type' => 'string', 'example' => 'greatwall'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => '请求中缺少必要的参数domainName'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"FB3AA371-2230-4FF8-8E94-952EBF2CF30C\\",\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"NameCn\\": \\"长宽\\",\\n \\"ResourceId\\": \\"tp4xpa\\",\\n \\"NameEn\\": \\"greatwall\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 7EA16831-74AC-4A2A-8355-19BEEF546663\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取所有支持的运营商列表',
'summary' => '调用GetAllIsp获取所有支持的运营商列表。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllIsp',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetAllMarkets' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BFCDB187-ED92-430A-8C8A-A96B63AD89F0'],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '平台类型码。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'MarketCode' => ['description' => '市场类型码。', 'type' => 'string', 'example' => 'b1f2523b184b66ab'],
'MarketName' => ['description' => '市场名称。', 'type' => 'string', 'example' => 'Player SDK for 阿里少儿'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"BFCDB187-ED92-430A-8C8A-A96B63AD89F0\\",\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Code\\": 2,\\n \\"MarketCode\\": \\"b1f2523b184b66ab\\",\\n \\"MarketName\\": \\"Player SDK for 阿里少儿\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 607AB575-A09C-43DC-8204-943C54991A58\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取所有市场列表',
'summary' => '调用GetAllMarkets获取当前用户的所有市场列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllMarkets',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetAllPlatformTypes' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E500E41E-C47B-4F0E-835B-71AFB0EB9773'],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '终端名称。', 'type' => 'string', 'example' => 'Flash'],
'Code' => ['description' => '终端类型码。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"E500E41E-C47B-4F0E-835B-71AFB0EB9773\\",\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Name\\": \\"Flash\\",\\n \\"Code\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6EDE89AE-1B70-448E-B38F-77CB59F14C0D\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取所有支持的终端类型列表',
'summary' => '调用GetAllPlatformTypes获取所有支持的终端类型列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllPlatformTypes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetAllRegions' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'FB3AA371-2230-4FF8-8E94-952EBF2CF30C'],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '中文名称。', 'type' => 'string', 'example' => '北京'],
'Code' => ['description' => '地区编号。', 'type' => 'string', 'example' => '11'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"FB3AA371-2230-4FF8-8E94-952EBF2CF30C\\",\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Name\\": \\"北京\\",\\n \\"Code\\": \\"11\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 7EA16831-74AC-4A2A-8355-19BEEF546663\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取所有支持的地区列表',
'summary' => '调用GetAllRegions获取所有支持的地区列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetBalanceBandwidthData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DataInterval',
'in' => 'query',
'schema' => ['description' => '查询数据的时间粒度,支持300、3600、14400、28800和86400秒。'."\n"
."\n"
.'不传和传的值不支持时,使用默认值300秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => '当前账单的资源ID。', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20963AEE-E3A5-461F-8809-C494558373AB'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '标签,描述数据类型。', 'type' => 'string', 'example' => '带宽'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-01 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '带宽数据,bit/second。', 'type' => 'string', 'example' => '185187502281'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"20963AEE-E3A5-461F-8809-C494558373AB\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"带宽\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-01 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"185187502281\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n \\r\\n 5923BFA8-ACC2-4949-A0AB-46B66FF45BDD\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取用户已出账单消费周期',
'summary' => '获取用户已出账单的消费周期、消费时间、计量峰值数值、业务类型等信息。',
'description' => '当用户有多于1个业务类型(live、vod、download)时,不同业务单独输出消费时间和计量数据。',
'changeSet' => [],
],
'GetBalanceTrafficData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DataInterval',
'in' => 'query',
'schema' => ['description' => '查询数据的时间粒度,支持**300**、**3600**、**14400**、**28800**和**86400**秒。'."\n"
."\n"
.'> 当不传该参数和所传的值不支持时,使用默认值**300**秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => '当前账单的资源ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcde123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20963AEE-E3A5-461F-8809-C494558373AB'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '标签,描述数据类型。', 'type' => 'string', 'example' => '流量'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-01 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '流量数据,单位:byte。', 'type' => 'string', 'example' => '177339955340'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"20963AEE-E3A5-461F-8809-C494558373AB\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"流量\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-01 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"177339955340\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n\\n20963AEE-E3A5-461F-8809-C494558373AB\\n\\n0\\n","errorExample":""}]',
'title' => '获取账单带宽详情',
'summary' => '调用GetBalanceTrafficData获取账单带宽详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetBandwidthData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '待查询的域名列表。支持批量域名查询,多个域名用竖线(|)分隔。'."\n"
."\n"
.'不传该参数将查询全部。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地域代码,多个用竖线(|)分隔,全部填all。'."\n"
."\n"
.'查询请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商代码,多个用竖线(|)分隔,全部填all。'."\n"
."\n"
.'查询请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端代码,多个用竖线(|)分隔,全部填all。'."\n"
."\n"
.'查询请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型,多个用竖线(|)分隔。取值:'."\n"
.'- **live**:直播流媒体。'."\n"
.'- **download**:大文件下载。'."\n"
.'- **vod**:视视频点播。'."\n"
.'- **all**:全部业务类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2017-05-01'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2017-05-10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5C2C4882-69C3-45BA-A10E-67E4DFFEA403'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '标签,用于描述数据类型。', 'type' => 'string', 'example' => '带宽'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-01 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '带宽数据,bit/second。', 'type' => 'string', 'example' => '95231540262'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"5C2C4882-69C3-45BA-A10E-67E4DFFEA403\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"带宽\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-01 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"95231540262\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 带宽\\r\\n C86F7C0C-D520-4F67-95DB-277E9A233E4E\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取加速域名的网络带宽监控数据',
'summary' => '调用GetBandwidthData获取加速域名的网络带宽监控数据,支持获取最近90天的数据。',
'description' => '> - 单位:bit/second。'."\n"
."\n"
.'- 不指定StartTime和EndTime时,默认读取过去24小时的数据;指定StartTime和EndTime时,按指定的起止时间查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetBandwidthData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetClientsRatio' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '42FA014D-045F-491F-8749-20745C516F89'],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Value' => ['description' => '流量值。', 'type' => 'string', 'example' => '28914025061'],
'Name' => ['description' => '平台类型。', 'type' => 'string', 'example' => 'iOS'],
'Rate' => ['description' => '比例。', 'type' => 'string', 'example' => '0.000001762543363929356'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"42FA014D-045F-491F-8749-20745C516F89\\",\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Value\\": \\"28914025061\\",\\n \\"Name\\": \\"iOS\\",\\n \\"Rate\\": \\"0.000001762543363929356\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 69501FC0-4CDD-4E1E-8995-C7EB8A16AA34\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取当前自然月所有终端分布比例',
'summary' => '调用GetClientsRatio获取当前自然月所有终端分布比例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetClientsRatio',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetConsumerStatus' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Comment' => ['description' => '审核意见。', 'type' => 'string', 'example' => '审核通过'],
'Inservice' => ['description' => '是否在服务状态。', 'type' => 'boolean', 'example' => 'true'],
'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2018-01-01 10:48:48'],
'BusinessType' => ['description' => '业务类型。取值:'."\n"
.'- **vod**:表示点播。'."\n"
.'- **live**:表示直播。'."\n"
.'- **download**:表示下载。', 'type' => 'string', 'example' => 'vod'],
'LiveMonitor' => ['description' => '是否支持直播监控。', 'type' => 'boolean', 'example' => 'false'],
'CdnUrlRedirectFlag' => ['description' => '是否支持CDN跳转。', 'type' => 'boolean', 'example' => 'false'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '23321CEB-637B-44B3-B39C-B47FD36850F5'],
'RealtimeMonitor' => ['description' => '是否支持实时监控。', 'type' => 'boolean', 'example' => 'false'],
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'UpdatedAt' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2018-01-01 10:48:48'],
'Audit' => ['description' => '审核状态。取值:'."\n"
.'- **1**:表示通过。'."\n"
.'- **0**:表示审核中。'."\n"
.'- **-1**:表示不通过。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'IntegreatedMode' => ['description' => '集成模式。取值:'."\n"
.'- **1**:表示合并计价。'."\n"
.'- **2**:表示拆分计价。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Comment\\": \\"审核通过\\",\\n \\"Inservice\\": true,\\n \\"CreatedAt\\": \\"2018-01-01 10:48:48\\",\\n \\"BusinessType\\": \\"vod\\",\\n \\"LiveMonitor\\": false,\\n \\"CdnUrlRedirectFlag\\": false,\\n \\"RequestId\\": \\"23321CEB-637B-44B3-B39C-B47FD36850F5\\",\\n \\"RealtimeMonitor\\": false,\\n \\"Code\\": 0,\\n \\"UpdatedAt\\": \\"2018-01-01 10:48:48\\",\\n \\"Audit\\": 1,\\n \\"IntegreatedMode\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\ttrue\\r\\n\\t23321CEB-637B-44B3-B39C-B47FD36850F5\\r\\n\\t0\\r\\n\\t1\\r\\n\\tfalse\\r\\n\\tfalse\\r\\n\\tfalse\\r\\n\\t1\\r\\n\\t审核通过\\r\\n vod\\r\\n\\t2018-01-01 10:48:48\\r\\n\\t2018-01-01 10:48:48\\r\\n ","errorExample":""}]',
'title' => '获取客户状态信息',
'summary' => '调用GetConsumerStatus获取客户状态信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetConsumerStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetControlRules' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '当前页码。', 'type' => 'string', 'required' => true, 'example' => '10', 'docRequired' => true],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的记录条数。', 'type' => 'string', 'required' => true, 'example' => '1', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '20963AEE-E3A5-461F-8809-C494558373AB'],
'Pager' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页的记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Total' => ['description' => '总记录的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '173'],
'Page' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'SettingList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Setting' => [
'description' => '返回的计费信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreatedAt' => ['description' => '插入时间。', 'type' => 'string', 'example' => '2017-06-02 13:16:37.0'],
'BusinessType' => ['description' => '业务类型。', 'type' => 'string', 'example' => 'live'],
'ClientId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '200000'],
'Usable' => ['description' => '规则是否启用,一般为true。', 'type' => 'boolean', 'example' => 'true'],
'PlatformType' => ['description' => '终端类型代码。', 'type' => 'string', 'example' => '01'],
'Region' => ['description' => '地区。', 'type' => 'string', 'example' => '11'],
'MarketType' => ['description' => '市场类型。', 'type' => 'string', 'example' => 'all'],
'UpdatedAt' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2017-06-01 21:19:12.0'],
'AppVersion' => ['description' => '应用版本号。', 'type' => 'string', 'example' => '6.6.2'],
'IspName' => ['description' => '运营商。', 'type' => 'string', 'example' => 'unicom'],
'Onoff' => ['description' => '启停状态。', 'type' => 'boolean', 'example' => 'false'],
'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'qqq'],
'ResourceId' => ['description' => '启停规则资源ID。', 'type' => 'string', 'example' => 'lrntfr'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"20963AEE-E3A5-461F-8809-C494558373AB\\",\\n \\"Pager\\": {\\n \\"PageSize\\": 2,\\n \\"Total\\": 173,\\n \\"Page\\": 1\\n },\\n \\"SettingList\\": {\\n \\"Setting\\": [\\n {\\n \\"CreatedAt\\": \\"2017-06-02 13:16:37.0\\",\\n \\"BusinessType\\": \\"live\\",\\n \\"ClientId\\": \\"200000\\",\\n \\"Usable\\": true,\\n \\"PlatformType\\": \\"01\\",\\n \\"Region\\": \\"11\\",\\n \\"MarketType\\": \\"all\\",\\n \\"UpdatedAt\\": \\"2017-06-01 21:19:12.0\\",\\n \\"AppVersion\\": \\"6.6.2\\",\\n \\"IspName\\": \\"unicom\\",\\n \\"Onoff\\": false,\\n \\"Name\\": \\"qqq\\",\\n \\"ResourceId\\": \\"lrntfr\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 2\\r\\n 1\\r\\n 173\\r\\n \\r\\n 0\\r\\n \\r\\n \\r\\n 2017-06-02 13:16:37.0\\r\\n false\\r\\n qqq\\r\\n 01\\r\\n 11\\r\\n unicom\\r\\n lrntfr\\r\\n all\\r\\n 6.6.2\\r\\n live\\r\\n 200000\\r\\n 2017-06-02 13:16:37.0\\r\\n \\r\\n \\r\\n 2017-06-01 21:19:12.0\\r\\n false\\r\\n 59\\r\\n 02\\r\\n 11\\r\\n all\\r\\n pm8fq9\\r\\n b1f2523b184b66ab|39667742fd585678\\r\\n 3.3.024_home|DVB_TV_Yingshi_R_5.1.1.25_1d433747\\r\\n live\\r\\n 200000\\r\\n 2017-06-01 21:19:12.0\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '获取启停设置列表',
'summary' => '调用GetControlRules获取启停设置列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetControlRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetCoverRateData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '待查询的域名列表,以竖线分割,不传查询全部。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地区,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商,竖线分隔,全部填all。'."\n", 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'example' => '2017-05-01', 'docRequired' => true],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'example' => '2017-05-10', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5C2C4882-69C3-45BA-A10E-67E4DFFEA403'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '标签,描述数据类型。', 'type' => 'string', 'example' => '带宽峰值'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-01 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '带宽数据,单位:bit/second。', 'type' => 'string', 'example' => '290426020145'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"5C2C4882-69C3-45BA-A10E-67E4DFFEA403\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"带宽峰值\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-01 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"290426020145\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n C86F7C0C-D520-4F67-95DB-277E9A233E4E\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '查询加速域名PCDN覆盖率数据',
'summary' => '查询加速域名的最小1天粒度的PCDN覆盖率数据,单位:%。',
'description' => '**调用该接口前,请您注意:**'."\n"
."\n"
.'不指定StartTime和EndTime时,默认读取过去24小时的数据;指定StartTime和EndTime时,按指定的起止时间查询。'."\n"
."\n"
.'支持批量域名查询,多个域名用竖线(|)分隔。'."\n"
."\n"
.'最多可获取最近90天的数据。',
'changeSet' => [],
],
'GetCurrentMode' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F84A4387-33B0-4F2D-87E4-BC3465BF568E'],
'EstimateBandwidth' => ['description' => '预估月95带宽(bps),仅在ModeCode=95时返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '6219331'],
'PaddingModeCode' => ['description' => '待生效计费方式。'."\n"
."\n"
.'- **0**:日峰值带宽。'."\n"
."\n"
.'- **1**:日流量。'."\n"
."\n"
.'- **95**:月95峰值带宽。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ModeCode' => ['description' => '当前计费方式。'."\n"
."\n"
.'- **0**:日峰值带宽。'."\n"
."\n"
.'- **1**:日流量。'."\n"
."\n"
.'- **95**:月95峰值带宽。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'EffectiveAt' => ['description' => '生效时间戳,当服务变配,且变配未生效时返回。', 'type' => 'integer', 'format' => 'int32', 'example' => '1540345299'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F84A4387-33B0-4F2D-87E4-BC3465BF568E\\",\\n \\"EstimateBandwidth\\": 6219331,\\n \\"PaddingModeCode\\": 0,\\n \\"Code\\": 0,\\n \\"ModeCode\\": 0,\\n \\"EffectiveAt\\": 1540345299\\n}","errorExample":""},{"type":"xml","example":"\\n F84A4387-33B0-4F2D-87E4-BC3465BF568E\\n 95\\n 6219331\\n 0\\n 0\\n 1540345299\\n\\n","errorExample":""}]',
'title' => '查询当前计费方式',
'summary' => '调用GetCurrentMode查询当前计费方式。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetDomainCount' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Data' => ['description' => '域名数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B40C0B7C-C90E-43CD-963A-1B6AC6BCF6FF'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"Data\\": 6,\\n \\"RequestId\\": \\"B40C0B7C-C90E-43CD-963A-1B6AC6BCF6FF\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6\\r\\n 9B9F0410-C648-4232-A424-7574905B7982\\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取用户域名总数目',
'summary' => '调用GetDomainCount获取用户域名总数目。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetDomains' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '当前页码。', 'type' => 'string', 'required' => true, 'example' => '1', 'docRequired' => true],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页记录条数。', 'type' => 'string', 'required' => true, 'example' => '10', 'docRequired' => true],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '域名。', 'type' => 'string', 'required' => false, 'example' => 'xxx.com.cn'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '425AEBD2-C4BA-44E4-9FC1-026844933422'],
'Pager' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页的记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Total' => ['description' => '总记录的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Page' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的域名信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '当前域名的状态,是否启用。', 'type' => 'boolean', 'example' => 'true'],
'Domain' => ['description' => '域名。', 'type' => 'string', 'example' => 'xxx.com.cn'],
'SliceFormat' => ['description' => '切片格式,仅在BusinessType=live时返回。', 'type' => 'string', 'example' => 'flv'],
'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2017-05-12 20:56:34'],
'UpdatedAt' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2017-05-12 20:56:34'],
'ResourceId' => ['description' => '域名资源ID。', 'type' => 'string', 'example' => 'i4e6g9'],
'BusinessType' => ['description' => '业务类型:download、live、vod。'."\n", 'type' => 'string', 'example' => 'vod'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"425AEBD2-C4BA-44E4-9FC1-026844933422\\",\\n \\"Pager\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"Page\\": 1\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Status\\": true,\\n \\"Domain\\": \\"xxx.com.cn\\",\\n \\"SliceFormat\\": \\"flv\\",\\n \\"CreatedAt\\": \\"2017-05-12 20:56:34\\",\\n \\"UpdatedAt\\": \\"2017-05-12 20:56:34\\",\\n \\"ResourceId\\": \\"i4e6g9\\",\\n \\"BusinessType\\": \\"vod\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 10\\n 1\\n 1\\n\\n425AEBD2-C4BA-44E4-9FC1-026844933422\\n\\n0\\n\\n","errorExample":""}]',
'title' => '查询域名与状态',
'summary' => '查询用户名下所有的域名与状态。域名状态包括:正常、停用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetExpenseSummary' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => false, 'example' => '2017-05-01'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2017-05-10'],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '搜索传入的内容,如果为空显示全部。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地域代码,多个用竖线(|)分隔,查询全部传all。'."\n"
."\n"
.'代码查询请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => false, 'example' => '00'],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商代码,多个用竖线(|)分隔,查询全部传all。'."\n"
."\n"
.'代码查询请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端代码,多个用竖线(|)分隔,查询全部传all。'."\n"
."\n"
.'代码查询请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型代码,多个用竖线(|)分隔,查询全部传all。'."\n"
."\n"
.'代码查询请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '450CFF96-32FE-4229-85CA-EC588DAB0888'],
'Data' => [
'description' => '数据信息。',
'type' => 'object',
'properties' => [
'ForecastFluency' => ['description' => '参考流畅率。', 'type' => 'number', 'format' => 'float', 'example' => '98'],
'TopBandwidth' => ['description' => '总峰值带宽。', 'type' => 'integer', 'format' => 'int64', 'example' => '414344'],
'TotalTraffic' => ['description' => '总流量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12419172'],
'CoverRate' => ['description' => '覆盖率。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ShareRate' => ['description' => '分享率。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalUV' => ['description' => '总访问人数。', 'type' => 'integer', 'format' => 'int32', 'example' => '21723058'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter domainName that is mandatory for processing this request is not supplied.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"450CFF96-32FE-4229-85CA-EC588DAB0888\\",\\n \\"Data\\": {\\n \\"ForecastFluency\\": 98,\\n \\"TopBandwidth\\": 414344,\\n \\"TotalTraffic\\": 12419172,\\n \\"CoverRate\\": 0,\\n \\"ShareRate\\": 0,\\n \\"TotalUV\\": 21723058\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 0.0\\r\\n 98.03\\r\\n 12419172\\r\\n 414344\\r\\n 21723058\\r\\n \\r\\n 807F6545-56E7-4CB0-B178-722E7851C0B5\\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取消费数据概况',
'summary' => '调用GetExpenseSummary获取消费数据概况。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetFeeHistory' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '当前页码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的记录条数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5CED561E-A4E3-4842-8BB6-700BE2AE7784'],
'Pager' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页的记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Total' => ['description' => '总记录的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'Page' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'FeeList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Fee' => [
'description' => '返回的计费信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndDate' => ['description' => '计费周期结束时间。', 'type' => 'string', 'example' => '2017-05-05 23:59:59'],
'TimeSpan' => ['description' => '计费周期。', 'type' => 'string', 'example' => '2017-05-05 00:00:00 至 2017-05-05 23:59:59'],
'Date' => ['description' => '出账时间。', 'type' => 'string', 'example' => '2017-05-05'],
'StartDate' => ['description' => '计费周期开始时间。', 'type' => 'string', 'example' => '2017-05-05 00:00:00'],
'LevelThreeTraffic' => ['description' => '流量。', 'type' => 'integer', 'format' => 'int32', 'example' => '12345678'],
'Mode' => ['description' => '当前计费方式描述。', 'type' => 'string', 'example' => '日峰值带宽'],
'TotalTraffic' => ['description' => '总流量。', 'type' => 'integer', 'format' => 'int32', 'example' => '12345678'],
'BusinessType' => ['description' => '业务类型。', 'type' => 'string', 'example' => 'live'],
'LevelTwoTraffic' => ['description' => '流量。', 'type' => 'integer', 'format' => 'int32', 'example' => '12345678'],
'LevelThreeBandwidth' => ['description' => '带宽。', 'type' => 'integer', 'format' => 'int32', 'example' => '999000'],
'FlowOut' => ['description' => '计费方式。取值:'."\n"
.'- **0**:日峰值带宽。'."\n"
.'- **95**:月95峰值带宽。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'LevelTwoBandwidth' => ['description' => '带宽。', 'type' => 'integer', 'format' => 'int32', 'example' => '999000'],
'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => '6aphce'],
'TotalBandwidth' => ['description' => '总带宽。', 'type' => 'integer', 'format' => 'int32', 'example' => '89999000'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"5CED561E-A4E3-4842-8BB6-700BE2AE7784\\",\\n \\"Pager\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 8,\\n \\"Page\\": 1\\n },\\n \\"FeeList\\": {\\n \\"Fee\\": [\\n {\\n \\"EndDate\\": \\"2017-05-05 23:59:59\\",\\n \\"TimeSpan\\": \\"2017-05-05 00:00:00 至 2017-05-05 23:59:59\\",\\n \\"Date\\": \\"2017-05-05\\",\\n \\"StartDate\\": \\"2017-05-05 00:00:00\\",\\n \\"LevelThreeTraffic\\": 12345678,\\n \\"Mode\\": \\"日峰值带宽\\",\\n \\"TotalTraffic\\": 12345678,\\n \\"BusinessType\\": \\"live\\",\\n \\"LevelTwoTraffic\\": 12345678,\\n \\"LevelThreeBandwidth\\": 999000,\\n \\"FlowOut\\": 0,\\n \\"LevelTwoBandwidth\\": 999000,\\n \\"ResourceId\\": \\"6aphce\\",\\n \\"TotalBandwidth\\": 89999000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n 2017-05-05 23:59:59\\r\\n 2017-05-05 00:00:00\\r\\n 123456789999000\\r\\n 2017-05-05\\r\\n 0\\r\\n vod\\r\\n 1\\r\\n 2017-05-05 00:00:00 至 2017-05-05 23:59:59\\r\\n 日峰值带宽\\r\\n \\r\\n \\r\\n 2017-05-04 23:59:59\\r\\n 2017-05-04 00:00:00\\r\\n 123456789999000\\r\\n 2017-05-04\\r\\n 0\\r\\n vod\\r\\n 1\\r\\n 2017-05-04 00:00:00 至 2017-05-04 23:59:59\\r\\n 日峰值带宽\\r\\n \\r\\n \\r\\n \\r\\n 10\\r\\n 1\\r\\n 8\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取计费数据历史记录',
'summary' => '调用GetFeeHistory获取计费数据历史记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetFirstFrameDelayData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '待查询的域名列表,以竖线分割,不传查询全部。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地区,竖线分隔,全部填all。'."\n", 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'example' => '2017-05-01', 'docRequired' => true],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'example' => '2017-05-10', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AADC33E0-F172-4BA8-9D48-09BC013CEB47'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '标签,描述数据类型。', 'type' => 'string', 'example' => '首帧延时'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-01 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '带宽数据,单位:bit/second。', 'type' => 'string', 'example' => '352'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"AADC33E0-F172-4BA8-9D48-09BC013CEB47\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"首帧延时\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-01 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"352\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n \\r\\n E2C71271-907F-4F65-A7D9-452005960109\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取加速域名首帧延时数据',
'summary' => '获取加速域名的首帧延时数据,单位:ms。',
'description' => '**调用该接口前,请您注意:**'."\n"
."\n"
.'- 不指定StartTime和EndTime时,默认读取过去24小时的数据;指定StartTime和EndTime时,按指定的起止时间查询。'."\n"
."\n"
.'- 支持批量域名查询,多个域名用竖线(|)分隔。'."\n"
."\n"
.'- 最多可获取最近90天的数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetFirstFrameDelayData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetFluencyData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '待查询的域名,多个用竖线(|)分割,不传查询全部。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地区,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端,竖线分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型,多个用竖线(|)分隔,全部填all。'."\n", 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'example' => '2017-05-01', 'docRequired' => true],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'example' => '2017-05-10', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05870F21-0700-4770-A19C-13CA610884B7'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '标签,描述数据类型。', 'type' => 'string', 'example' => '参考流畅率'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-06 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '带宽数据,单位:bit/second。'."\n", 'type' => 'string', 'example' => '98.47'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"05870F21-0700-4770-A19C-13CA610884B7\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"参考流畅率\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-06 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"98.47\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n \\r\\n B0C0A171-3CE8-4EBC-8956-3F227D86AB2B\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取参考流畅率数据',
'summary' => '获取加速域名的参考流畅率数据,单位:%。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetFluencyData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetLogsList' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '搜索传入的内容,如果为空显示全部。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
],
[
'name' => 'Date',
'in' => 'query',
'schema' => ['description' => '日志日期。', 'type' => 'string', 'required' => false, 'example' => '2016-10-20'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '获取日志的起始时间点。日期格式按照ISO8601表示法,并使用UTC时间。', 'type' => 'string', 'required' => false, 'example' => '2016-10-20T04:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '获取日志的结束时间点。日期格式按照ISO8601表示法,并使用UTC时间。'."\n"
."\n"
.'> 结束时间需大于起始时间。', 'type' => 'string', 'required' => false, 'example' => '2016-10-20T04:01:00Z'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B40C0B7C-C90E-43CD-963A-1B6AC6BCF6FF'],
'LogList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Log' => [
'description' => '返回日志的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Url' => ['description' => '链接路径。', 'type' => 'string', 'example' => 'http://pcdn-log.oss-cn-shanghai.aliyuncs.com/xxxx/2017-05-07/xxxx'],
'StartDate' => ['description' => '开始时间。', 'type' => 'string', 'example' => '2017-05-07 21:00:00'],
'EndDate' => ['description' => '结束时间。', 'type' => 'string', 'example' => '2017-05-07 21:59:59'],
'FileName' => ['description' => '文件名称。', 'type' => 'string', 'example' => 'ccd_cdn.xxxx.com.cn_2017-05-03_07.tar.gz'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"B40C0B7C-C90E-43CD-963A-1B6AC6BCF6FF\\",\\n \\"LogList\\": {\\n \\"Log\\": [\\n {\\n \\"Url\\": \\"http://pcdn-log.oss-cn-shanghai.aliyuncs.com/xxxx/2017-05-07/xxxx\\",\\n \\"StartDate\\": \\"2017-05-07 21:00:00\\",\\n \\"EndDate\\": \\"2017-05-07 21:59:59\\",\\n \\"FileName\\": \\"ccd_cdn.xxxx.com.cn_2017-05-03_07.tar.gz\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n 2017-05-07 00:59:59\\n 2017-05-07 00:00:00\\n http://pcdn-log.oss-cn-shanghai.aliyuncs.com/xxxx/2017-05-07/xxxx\\n ccd_cdn.xxxx.com.cn_2017-05-03_01.tar.gz\\n \\n \\n 2017-05-07 21:59:59\\n 2017-05-07 21:00:00\\n http://pcdn-log.oss-cn-shanghai.aliyuncs.com/xxxx/2017-05-07/xxxx\\n ccd_cdn.xxxx.com.cn_2017-05-03_07.tar.gz\\n \\n\\n0\\nB40C0B7C-C90E-43CD-963A-1B6AC6BCF6FF\\n\\n","errorExample":""}]',
'title' => '获取日志列表',
'summary' => '获取当前用户选定时间的日志列表,供用户查看与下载。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetShareRateData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '搜索传入的内容,如果为空显示全部。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地域代码,多个用竖线(|)分隔,查询全部传all。'."\n"
."\n"
.'代码详情请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商代码,多个用竖线(|)分隔,查询全部传all。'."\n"
."\n"
.'代码详情请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端代码,多个用竖线(|)分隔,查询全部传all。'."\n"
."\n"
.'代码详情请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型代码,多个用竖线(|)分隔,查询全部传all。'."\n"
."\n"
.'代码详情请参见[通用字段参考](~~151572~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2017-05-01'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2017-05-10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8ECFC607-8D62-4DE8-9D8D-CC7F63B07B7D'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '数据。', 'type' => 'string', 'example' => 'P2P分享率'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-01 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '分享率数据,**0**~**1**。', 'type' => 'string', 'example' => '1'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"8ECFC607-8D62-4DE8-9D8D-CC7F63B07B7D\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"P2P分享率\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-01 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"1\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n \\r\\n 8ECFC607-8D62-4DE8-9D8D-CC7F63B07B7D\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取PCDN分享率信息',
'summary' => '调用GetShareRateData获取PCDN分享率信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetShareRateData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetTokenList' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5CED561E-A4E3-4842-8BB6-700BE2AE7784'],
'TokenList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Token' => [
'description' => '返回Token信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PlatformName' => ['description' => '终端名称。', 'type' => 'string', 'example' => 'OTT'],
'Token' => ['description' => 'Token值。', 'type' => 'string', 'example' => '6000170200591aed94fc62fb5e0166b64d199b86d1e0128fd0'],
'PlatformType' => ['description' => '终端code。', 'type' => 'string', 'example' => '02'],
'CreatedAt' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2017-05-16 20:16:20'],
'UpdatedAt' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2017-05-16 20:16:20'],
'ResourceId' => ['description' => '终端资源ID。', 'type' => 'string', 'example' => '6y23ph'],
'ClientId' => ['description' => '用户ClientID。', 'type' => 'string', 'example' => '200000'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter domainName that is mandatory for processing this request is not supplied.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"5CED561E-A4E3-4842-8BB6-700BE2AE7784\\",\\n \\"TokenList\\": {\\n \\"Token\\": [\\n {\\n \\"PlatformName\\": \\"OTT\\",\\n \\"Token\\": \\"6000170200591aed94fc62fb5e0166b64d199b86d1e0128fd0\\",\\n \\"PlatformType\\": \\"02\\",\\n \\"CreatedAt\\": \\"2017-05-16 20:16:20\\",\\n \\"UpdatedAt\\": \\"2017-05-16 20:16:20\\",\\n \\"ResourceId\\": \\"6y23ph\\",\\n \\"ClientId\\": \\"200000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":" \\r\\n 5CED561E-A4E3-4842-8BB6-700BE2AE7784\\r\\n \\r\\n \\r\\n 2017-05-16 20:16:20\\r\\n 02\\r\\n 1a5wb7s\\r\\n 6000170200591aed94fc62fb5e0166b64d199b86d1e0128fd0\\r\\n OTT\\r\\n 200000\\r\\n 2017-05-16 20:16:20\\r\\n \\r\\n \\r\\n 2017-05-16 20:16:20\\r\\n 00\\r\\n 8zs9op\\r\\n 6000170000591aed949d0f54a343f1a4233c1e7d1c5ca816be\\r\\n PC\\r\\n 200000\\r\\n 2017-05-16 20:16:20\\r\\n \\r\\n \\r\\n 2017-05-16 20:16:20\\r\\n 01\\r\\n blocm6\\r\\n 6000170100591aed94b45ed32785cc74f5a861ddfcb8b7c841\\r\\n Android\\r\\n 200000\\r\\n 2017-05-16 20:16:20\\r\\n \\r\\n \\r\\n 2017-05-16 20:16:20\\r\\n 05\\r\\n 1i85ijq\\r\\n 6000170500591aed949b2e40bf306fdb5c7081349621e412ee\\r\\n iOS\\r\\n 200000\\r\\n 2017-05-16 20:16:20\\r\\n \\r\\n \\r\\n 0\\r\\n \\r\\n","errorExample":""}]',
'title' => '获取终端 Token 列表',
'summary' => '获取终端Token列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetTokenList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetTrafficByRegion' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26CF81F8-18F5-4F93-A1D6-33AAA592CF56'],
'TrafficDataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TrafficData' => [
'description' => '数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '地区名称。', 'type' => 'string', 'example' => '北京'],
'Traffic' => ['description' => '流量数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '448096774168859'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"26CF81F8-18F5-4F93-A1D6-33AAA592CF56\\",\\n \\"TrafficDataList\\": {\\n \\"TrafficData\\": [\\n {\\n \\"Name\\": \\"北京\\",\\n \\"Traffic\\": 448096774168859\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n 北京\\r\\n 448096774168859\\r\\n \\r\\n \\r\\n 天津\\r\\n 149046039126012\\r\\n \\r\\n \\r\\n 河北\\r\\n 311633084563883\\r\\n \\r\\n \\r\\n 山西\\r\\n 111913357608613\\r\\n \\r\\n \\r\\n 内蒙古\\r\\n 121310599233230\\r\\n \\r\\n \\r\\n 辽宁\\r\\n 356807056403655\\r\\n \\r\\n \\r\\n 吉林\\r\\n 151925345175750\\r\\n \\r\\n \\r\\n 黑龙江\\r\\n 141110412597382\\r\\n \\r\\n \\r\\n 上海\\r\\n 532977262961283\\r\\n \\r\\n \\r\\n 江苏\\r\\n 1253060710817965\\r\\n \\r\\n \\r\\n 浙江\\r\\n 1257256406683929\\r\\n \\r\\n \\r\\n 安徽\\r\\n 334797729767759\\r\\n \\r\\n \\r\\n 福建\\r\\n 566841917282337\\r\\n \\r\\n \\r\\n 江西\\r\\n 272442583002765\\r\\n \\r\\n \\r\\n 山东\\r\\n 821863346319563\\r\\n \\r\\n \\r\\n 河南\\r\\n 379985564854609\\r\\n \\r\\n \\r\\n 湖北\\r\\n 456205987172989\\r\\n \\r\\n \\r\\n 湖南\\r\\n 328102608958956\\r\\n \\r\\n \\r\\n 广东\\r\\n 2191515252948832\\r\\n \\r\\n \\r\\n 广西\\r\\n 445799095250735\\r\\n \\r\\n \\r\\n 海南\\r\\n 66774008061768\\r\\n \\r\\n \\r\\n 重庆\\r\\n 193123106090999\\r\\n \\r\\n \\r\\n 四川\\r\\n 498112097201725\\r\\n \\r\\n \\r\\n 贵州\\r\\n 100434438057521\\r\\n \\r\\n \\r\\n 云南\\r\\n 303816561733595\\r\\n \\r\\n \\r\\n 西藏\\r\\n 18238481216618\\r\\n \\r\\n \\r\\n 陕西\\r\\n 231890693493741\\r\\n \\r\\n \\r\\n 甘肃\\r\\n 110097638533238\\r\\n \\r\\n \\r\\n 5F949A3F-850B-4139-B666-638F563BE843\\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取用户当前自然月内每个地区的流量数据',
'summary' => '调用GetTrafficByRegion获取用户当前自然月内每个地区的流量数据。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetTrafficByRegion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetTrafficData' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '域名,多个用竖线(|)分割,不传该参数查询全部。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地区,多个用竖线(|)分隔,全部填all。'."\n", 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'IspName',
'in' => 'query',
'schema' => ['description' => '运营商,多个用竖线(|)分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'PlatformType',
'in' => 'query',
'schema' => ['description' => '终端,多个用竖线(|)分隔,全部填all。'."\n", 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => ['description' => '业务类型,多个用竖线(|)分隔,全部填all。', 'type' => 'string', 'required' => true, 'example' => 'all', 'docRequired' => true],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => true, 'example' => '2017-05-01', 'docRequired' => true],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => true, 'example' => '2017-05-10', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ECD5669E-DD42-4A1A-9D6D-09740F50CD92'],
'Labels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Label' => [
'type' => 'array',
'items' => ['description' => '标签,描述数据类型。', 'type' => 'string', 'example' => '流量'],
'description' => '',
],
],
'description' => '',
],
'DataList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UsageData' => [
'description' => '返回的信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => ['description' => '数据的时间片起始时刻。', 'type' => 'string', 'example' => '2017-05-01 00:00:00'],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Values' => [
'type' => 'array',
'items' => ['description' => '带宽数据,单位:bit/second。', 'type' => 'string', 'example' => '171416772471986'],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"ECD5669E-DD42-4A1A-9D6D-09740F50CD92\\",\\n \\"Labels\\": {\\n \\"Label\\": [\\n \\"流量\\"\\n ]\\n },\\n \\"DataList\\": {\\n \\"UsageData\\": [\\n {\\n \\"Date\\": \\"2017-05-01 00:00:00\\",\\n \\"Values\\": {\\n \\"Values\\": [\\n \\"171416772471986\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n \\r\\n 38F88DFE-499C-4A6F-A42F-251C0825C788\\r\\n \\r\\n 0\\r\\n","errorExample":""}]',
'title' => '获取网络流量监控数据',
'summary' => '获取加速域名的网络流量监控数据,单位:byte。',
'description' => '**调用该接口前,请您注意:**'."\n"
."\n"
.'- 不指定StartTime和EndTime时,默认读取过去24小时的数据;指定StartTime和EndTime时,按指定的起止时间查询。'."\n"
."\n"
.'- 支持批量域名查询,多个域名用竖线(|)分隔。'."\n"
."\n"
.'- 最多可获取最近90天的数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'StartDomain' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '域名信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B9F0410-C648-4232-A424-7574905B7982'],
'ResourceId' => ['description' => '域名资源ID。', 'type' => 'string', 'example' => 'jjh32t'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"9B9F0410-C648-4232-A424-7574905B7982\\",\\n \\"ResourceId\\": \\"jjh32t\\"\\n}","errorExample":""},{"type":"xml","example":"\\n0\\njjh32t\\n9B9F0410-C648-4232-A424-7574905B7982\\n","errorExample":""}]',
'title' => '启用域名',
'summary' => '调用StartDomain启用域名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pcdn:StartDomain',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'StopDomain' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => '域名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '业务码,成功返回0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B9F0410-C648-4232-A424-7574905B7982'],
'ResourceId' => ['description' => '域名资源ID。', 'type' => 'string', 'example' => 'tu9lfh'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify domainName.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"RequestId\\": \\"9B9F0410-C648-4232-A424-7574905B7982\\",\\n \\"ResourceId\\": \\"tu9lfh\\"\\n}","errorExample":""},{"type":"xml","example":"\\n0\\ntu9lfh\\n9B9F0410-C648-4232-A424-7574905B7982\\n\\n","errorExample":""}]',
'title' => '停用域名',
'summary' => '调用StopDomain停用域名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pcdn:StopDomain',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚(悉尼)已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-south-1', 'regionName' => '印度(孟买)已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云(邀测)', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pcdn.aliyuncs.com', 'endpoint' => 'pcdn.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'MissingDomainName', 'message' => 'The input parameter DomainName that is mandatory for processing this request is not supplied.', 'http_code' => null, 'description' => '参数DomainName为必填,请校验DomainName参数是否输入。'],
['code' => 'MissingParameter', 'message' => 'The parameter {0} is required for this request.', 'http_code' => null, 'description' => '缺少参数:{0},请检查{0}字段是否输入。'],
['code' => 'MissingParameter', 'message' => 'You must specify domainName.', 'http_code' => 400, 'description' => '请求中缺少必要的参数domainName'],
],
'changeSet' => [],
'ram' => [
'productCode' => 'PCDN',
'productName' => 'PCDN',
'ramCodes' => ['pcdn'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'GetTrafficData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetTrafficData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCoverRateData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetCoverRateData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDomains',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetDomains',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetLogsList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetLogsList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAllIsp',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllIsp',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddDomain',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'pcdn:AddDomain',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetFluencyData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetFluencyData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetFirstFrameDelayData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetFirstFrameDelayData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddConsumer',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'pcdn:AddConsumer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAccessData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAccessData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDomainCount',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetDomainCount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetShareRateData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetShareRateData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetBalanceBandwidthData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetBalanceBandwidthData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddPcdnControlRule',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'pcdn:AddPcdnControlRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnablePcdnControlRule',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pcdn:EnablePcdnControlRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartDomain',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pcdn:StartDomain',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopDomain',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pcdn:StopDomain',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCurrentMode',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetCurrentMode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeletePcdnControlRule',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pcdn:DeletePcdnControlRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetFeeHistory',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetFeeHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAllAppVersions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllAppVersions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTokenList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetTokenList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisablePcdnControlRule',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pcdn:DisablePcdnControlRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTrafficByRegion',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetTrafficByRegion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetExpenseSummary',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetExpenseSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAllRegions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetConsumerStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetConsumerStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetClientsRatio',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetClientsRatio',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAllMarkets',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllMarkets',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDomain',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pcdn:DeleteDomain',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetControlRules',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetControlRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'EditPcdnControlRule',
'description' => '',
'operationType' => '',
'ramAction' => [
'action' => 'pcdn:EditPcdnControlRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAllPlatformTypes',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetAllPlatformTypes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetBandwidthData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetBandwidthData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetBalanceTrafficData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pcdn:GetBalanceTrafficData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PCDN', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];