You need to enable JavaScript to run this app.
导航
更新资源封禁/解封状态
最近更新时间:2024.03.22 11:52:10首次发布时间:2024.03.15 16:43:19

本接口支持修改指定服务下资源的封禁状态。

说明

若您在封禁服务ServiceId开启了重名覆盖上传,当封禁的资源被上传的重名文件覆盖后,该资源的封禁状态会重置为正常。

注意事项

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

请求说明

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

请求参数

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

Query

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

ServiceId

String

serviceid

指定配置资源封禁的服务 ID。

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

Body

参数类型是否必选示例值描述
ObjectNameStringdemo1.png待修改封禁状态的资源存储 Key(不携带 Bucket 信息),可在控制台资源管理页面查看。

Status

String

disable/enable

资源的封禁状态,取值如下所示:

  • disable:禁用。禁用状态,您无法访问该资源。
  • enable:启用。启用状态,您可正常访问该资源。

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageResourceStatus&Version=2023-05-01&ServiceId=serviceid
{
    "Status": "enable",
    "ObjectName": "demo1.png"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateImageResourceStatus",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

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

服务端 SDK

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