You need to enable JavaScript to run this app.
导航
查询服务质量概览
最近更新时间:2024.04.12 15:11:27首次发布时间:2024.04.12 15:11:27

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

注意事项

  • 请求频率:
    • API 整体的请求频率限制为 100 次/秒
    • 单用户请求频率限制为 50 次/秒
  • 数据延迟:约为 15 分钟
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:GET
  • 请求地址:https://imagex.volcengineapi.com/?Action=DescribeImageXServiceQuality&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringDescribeImageXServiceQuality接口名称。当前 API 的名称为 DescribeImageXServiceQuality
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01

Region

String

cn

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

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

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

UploadData

参数类型示例值描述

SuccessRate

Float

0.9975451872358082

上传成功率。

说明

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

UploadCountInteger7189143上传有效次数。
AvgSizeFloat377649上传文件平均大小,单位为字节。
AvgDurationFloat2428上传平均耗时,单位为 ms。
TotalCountInteger3919上传总上报数据量。

CdnData

参数类型示例值描述

SuccessRate

Float

0.9927386619504328

网络成功率

说明

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

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

ClientData

参数类型示例值描述

SuccessRate

Float

0.9996384232001669

解码成功率

说明

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

AvgDecodeDurationFloat11平均解码耗时,单位为 ms。
AvgQueueDurationFloat370平均排队耗时,单位为 ms。
AvgLoadDurationFloat752平均加载耗时,单位为 ms。
TotalCountInteger92781客户端总上报数据量。

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXServiceQuality&Version=2023-05-01&Region=cn

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXServiceQuality",
        "Version": "2023-05-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
        }
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码

状态码错误码错误信息说明
400InvalidParameterMissing Parameter.请求参数错误,请检查您的请求参数是否正确。
401ParamAccountMismatchParam {} did not belong to your account.请求参数不属于账号,请检查您的请求参数是否正确。
500InternalErrorInternal Error.内部错误,请提交工单联系技术支持。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。