You need to enable JavaScript to run this app.
导航

获取服务下的更新文件

最近更新时间2024.03.15 15:47:54

首次发布时间2021.02.23 10:42:24

通过指定服务 ID 以及获取文件类型,从而得到符合条件的文件 URL 详情。

请求说明

  • 接口名称:GetImageUpdateFiles
  • 请求方式:GET
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=GetImageUpdateFiles&Version=2018-08-01
  • 请求频率限制:10 次/秒
  • 超时时间:20 秒

说明

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

请求参数

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

Query

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

ServiceId

String

服务 ID。

  • 您可以在veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息

Type

Integer

获取类型,取值如下所示:

  • 0:获取刷新 URL 列表;
  • 1:获取禁用 URL 列表。

UrlPattern

String

URL 格式,若指定 URL 格式则仅返回 URL 中包含该字符串的 URL 列表。
默认为空,缺省情况下返回所有 URL 列表。

Offset

Integer

分页偏移,默认 0。
当取值为 1 时,表示跳过一条 URL,从第二条 URL 开始取值。

LimitInteger获取 URL 个数,最大值为 100。

返回参数

参数类型描述
ServiceIdString服务 ID。
TotalInteger符合条件的 URL 总数
UpdateUrlsArray of UpdateUrls符合条件的 URL 列表。
StatusString当前存储状态,取值为:正常、未审核、禁用。

UpdateUrls

参数类型描述
ImageUrlString图片 URL。
UpdateAtStringURL 更新时间,即图像更新时的服务器当地时间。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageUpdateFiles&Version=2018-08-01&ServiceId=WMKp6UXe*&Type=1

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019052718371101022507411117783",
        "Action": "GetImageUpdateFiles",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceId": "WMKp6UXe*",
        "Total": 1,
        "UpdateUrls": [
            {
                "ImageUrl": "domain-xxx/img/bkt/key~tpl:param.format",
                "UpdateAt": "2019-05-27 18:26:09"
            }
        ],
        "Status": "正常"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019052718395201022507411128672",
        "Action": "GetImageUpdateFiles",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 600003,
            "Code": "",
            "Message": "parameter not valid"
        }
    }
}

错误码

访问公共错误码获取详细信息。

服务端 SDK

为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: