You need to enable JavaScript to run this app.
导航
服务质量概览
最近更新时间:2024.08.09 10:27:33首次发布时间:2021.02.23 10:42:25

本接口支持通过指定服务地区,从而获取当前账号下的服务数据。

说明

该接口属于历史版本 API,建议您使用新版 DescribeImageXServiceQuality 接口。

请求说明

  • 接口名称:DescribeImageXServiceQuality
  • 请求方式:GET
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=DescribeImageXServiceQuality&Version=2018-08-01
  • 请求频率:
    • API 整体的请求频率限制为 100 次/秒
    • 单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟为 15 min

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01

Region

String

获取指定地区的数据。默认为空,表示获取国内数据。

  • cn:国内。
  • sg:新加坡。

返回参数

参数类型描述
FailureRateFloat用户感知失败率,为当日 0 点至查询时间的整体数据。
UploadDataObject of UploadData上传概览数据,为当日 0 点查询时间的整体数据。
CdnDataObject of CdnData下行概览数据,为当日 0 点至今整体数据。
ClientDataObject of ClientData客户端概览数据,为当日 0 点查询时间的整体数据。

UploadData

参数类型描述

SuccessRate

Float

上传成功率。

说明

上传成功率 = 上传成功次数 / 上传总有效次数

UploadCountInteger上传有效次数。
AvgSizeFloat上传文件平均大小,单位字节。
AvgDurationFloat上传平均耗时,单位为 ms。
TotalCountInteger上传总上报数据量。

CdnData

参数类型描述

SuccessRate

Float

网络成功率

说明

网络成功率 = 1 - 下载失败次数 / 下载总数

AvgDurationFloat网络平均耗时,单位为 ms。
TotalCountInteger下行总上报数据量。

ClientData

参数类型描述

SuccessRate

Float

解码成功率

说明

解码成功率 = 1 - 解码失败次数 / 解码总次数

AvgDecodeDurationFloat平均解码耗时,单位为 ms。
AvgQueueDurationFloat平均排队耗时,单位为 ms。
AvgLoadDurationFloat平均加载耗时,单位为 ms。
TotalCountInteger客户端总上报数据量。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXServiceQuality&Version=2018-08-01

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019062716011401022507408218620",
        "Action": "DescribeImageXServiceQuality",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailureRate": 0.006693045490108962,
        "UploadData": {
            "SuccessRate": 0.9975451872358082,
            "UploadCount": 7189143,
            "AvgSize": 377649,
            "AvgDuration": 2428,
            "TotalCount": 3919,
        },
        "CdnData": {
            "SuccessRate": 0.9927386619504328,
            "AvgDuration": 356,
            "TotalCount": 90281,
        },
        "ClientData": {
            "SuccessRate": 0.9996384232001669,
            "AvgDecodeDuration": 11,
            "AvgQueueDuration": 370,
            "AvgLoadDuration": 752,
            "TotalCount": 92781,
        }
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
				"Action": "DescribeImageXServiceQuality",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "",
            "Message": ""
        }
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。