获取内网访问配置--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取内网访问配置

最近更新时间：2024.12.27 14:38:08首次发布时间：2024.12.27 14:38:08

本接口将为您展示指定服务的内网访问功能的配置详情。

注意事项

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

请求说明

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

请求参数

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

Query

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

Action String 是 DescribeVpcAccessConfig 接口名称。当前 API 的名称为 DescribeVpcAccessConfig。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVpcAccessConfig`	接口名称。当前 API 的名称为 `DescribeVpcAccessConfig`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`serviceid`	待查询配置的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

serviceid

待查询配置的服务 ID。

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

返回参数

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

参数	类型	示例值	描述
VpcAccessConfig	Object of VpcAccessConfig	`-`	内网访问配置项

VpcAccessConfig

参数	类型	示例值	描述
Status	String	`enable`	内网访问启用状态，取值如下所示： `enable`：开启 `disable`：关闭
VpcAccessDomain	String	`2100-da.veimagex--.*.org`	内网域名地址。
UrlAuthSwitch	Boolean	`true`	URL 鉴权开关，取值如下所示： `true`：开启 `false`：关闭
UrlAuthConfig	Object of UrlAuthConfig	`-`	URL 鉴权配置。

UrlAuthConfig

参数	类型	示例值	描述
AuthType	String	`cdn_typed`	指定的鉴权模式，取值如下所示： `cdn_typea`：鉴权模式 A `cdn_typeb`：鉴权模式 B `cdn_typec`：鉴权模式 C `cdn_typed`：鉴权模式 D 各种鉴权模式的说明，详见 URL 鉴权。
MasterKey	String	`12981301`	指定的主密钥。
BackupKey	String	`2389o31`	指定的备份密钥。
Duration	Long	`1800`	指定的鉴权生效时间。
SignName	String	`sign`	指定的签名参数名称。
TimeName	String	`t`	指定的时间戳参数名称。
TimeFormat	String	`decimal`	指定的时间戳格式，取值如下所示： `decimal`：十进制（unix 时间戳）。 `heximal`：十六进制（unix 时间戳）

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeVpcAccessConfig&Version=2023-05-01&ServiceId=serviceid

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeVpcAccessConfig",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "VpcAccessConfig": {
            "VpcAccessDomain": "",
            "UrlAuthConfig": {
                "AuthType": "cdn_typea",
                "MasterKey": "",
                "BackupKey": "",
                "Duration": null,
                "SignName": "",
                "TimeName": "",
                "TimeFormat": ""
            },
            "Status": "enable/disable",
            "UrlAuthSwitch": false
        }
    }
}

错误码

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

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