获取禁用 URL 列表详情--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取禁用 URL 列表详情

最近更新时间：2024.08.13 17:42:09首次发布时间：2024.08.13 17:39:19

本接口支持获取近 30 天内的已被禁用的 URL 列表详情，若 URL 解禁成功，则无法被查询。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：约 15 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=GetImageContentBlockList&Version=2023-05-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageContentBlockList`	接口名称。当前 API 的名称为 `GetImageContentBlockList`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
PageSize	Integer	否	`10`	每页条数，取值范围是[10,1000]。默认值为 100。
PageNum	Integer	否	`1`	页码，仅返回该页码上的任务。默认值为 1。
StartTime	Long	是	`1678204800`	开始查询时间，unix 时间戳，单位为秒。
EndTime	Long	是	`1678252535`	结束查询时间，unix 时间戳，单位为秒。
Domain	String	否	`test.example.com`	域名，指定后将返回包含该域名的 URL 禁用任务。
State	String	否	`succeed`	资源更新状态，取值如下所示： `submitting`：提交中 `running`：执行中 `succeed`：成功 `failed`：失败
Url	String	否	`http://t.test.com/778141***b133f7b`	指定要查询的 URL，缺省情况下查询当前服务所有禁用任务列表。
Order	String	否	`desc`	按时间排序，取值如下所示： `asc`：正序 `desc`：逆序

返回参数

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

参数	类型	示例值	描述
PageNum	Integer	`1`	当前页码
PageSize	Integer	`10`	每页最大记录数
Total	Integer	`1`	符合查询条件的总记录数
Data	Array of Data	`-`	具体数据

Data

参数	类型	示例值	描述
Url	String	`http://t.test.com/778141***b133f7b`	指定的 URL
State	String	`running`	URL 状态
Process	String	`0%`	任务进度
CreateTime	Long	`1678252511`	任务的创建时间
UpdateTime	Long	`1678252526`	任务的更新时间
Msg	String	`-`	完成结果提示信息
TaskType	String	`block_url`	任务类型，取值如下所示： `block_url`：禁用任务。 `unblock_url`：解禁任务，表示此时解禁未完成。

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageContentBlockList&Version=2023-05-01
{
  "PageNum": 1,
  "PageSize": 10,
  "Order": "desc",
  "StartTime": 1678204800,
  "EndTime": 1678252535,
  "Url": "http://t.test.com/778141***b133f7b"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageContentBlockList",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNum": 1,
        "PageSize": 10,
        "Total": 1,
        "Data": [
            {
            "Url":"http://t.test.com/778141***b133f7b",
            "TaskType":"block_url",
            "CreateTime":1678252511,
            "UpdateTime":1678252526,
            "State":"running",
            "Process":"0%",
            "Msg":""
         }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

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

历史版本

2018-08-01 版本 GetImageContentBlockList 接口文档现已停止维护，建议您参考本文档使用最新版本。