You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /veImageX/API 参考/服务管理/更新内网访问配置
更新内网访问配置
最近更新时间：2024.12.27 14:38:08首次发布时间：2024.12.27 14:38:08
我的收藏

本接口支持更新指定服务的内网访问配置。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

ServiceId

String

是

serviceid

待更新配置的服务 ID

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

Status

String

是

enable

内网访问状态，取值如下所示：

  • enable：开启
  • disable：（默认）关闭

UrlAuthSwitch

Boolean

是

true

当 Status 为 enable 时，该参数为必填。
是否启用 URL 鉴权开关，取值如下所示：

  • true：开启
  • false：（默认）关闭

UrlAuthConfig

Object of UrlAuthConfig

否

-

当 UrlAuthSwitch 为 true 时，该参数为必填。
URL 鉴权配置。

UrlAuthConfig

参数类型是否必选示例值描述

AuthType

String

是

cdn_typed

指定一个鉴权，取值如下所示：

  • cdn_typea：鉴权模式 A
  • cdn_typeb：鉴权模式 B
  • cdn_typec：鉴权模式 C
  • cdn_typed：鉴权模式 D
    各种鉴权模式的说明，详见 URL 鉴权。
MasterKeyString是89*******jl指定主密钥，由 6-40 位大小写字母与数字组成。
BackupKeyString否0j*******hw指定备份密钥，由 6-40 位大小写字母与数字组成。

Duration

Long

是

1800

签名的有效时间，单位是秒。该参数与请求中包含时间戳搭配使用，用来计算签名的过期时间。取值范围为[1, 630720000]内的正整数。
签名的过期时间 = 时间戳 + Duration。在 veImageX-CDN 收到某个请求时，如果签名的过期时间小于当前时间，veImageX-CDN 判定签名已过期。

SignName

String

否

sign

当 AuthType 为 cdn_typea、cdn_typed时，该参数为必填。对于其他类型，该参数不生效。
表示签名参数的名称。输入规则如下所示：

  • 可以包括大小写英文字母、数字、下划线（_）。
  • 长度不能超过 100 个字符。
  • 至少包含一个字母或者数字。
  • 不能与 TimeName 相同。

TimeName

String

否

t

当 AuthType 为 cdn_typed 时，该参数为必填。对于其他类型，该参数不生效。
表示时间戳参数的名称。输入规则如下所示：

  • 可以包括大小写英文字母、数字、下划线（_）。
  • 长度为 1-100 个字符。
  • 至少包含一个字母或者数字。
  • 不能与 SignName 相同。

TimeFormat

String

否

heximal

当 AuthType 为 cdn_typed 时，该参数为必填。
时间戳的进制配置，取值如下所示：

  • decimal：（默认）十进制（unix 时间戳）。
  • heximal：十六进制（unix 时间戳）。

说明

  • 当 AuthType 为 cdn_typec 时，该参数的值会被强制设置为 heximal。
  • 当 AuthType 为 cdn_typea 和 cdn_typeb 时，该参数的值会被强制设置为 decimal。

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateVpcAccessConfig&Version=2023-05-01
{
    "Status": "enable",
    "UrlAuthSwitch": true,
    "UrlAuthConfig": {
        "AuthType": "cdn_typed",
        "MasterKey": "89*******jl",
        "BackupKey": "0j*******hw",
        "Duration": 1800,
        "SignName": "sign",
        "TimeName": "t",
        "TimeFormat": "heximal"
    },
    "ServiceId": "serviceid"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateVpcAccessConfig",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    }
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.ServiceIdInvalid service ID请检查您的服务 ID 是否正确。