本接口将为您展示指定服务的内网访问功能的配置详情。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVpcAccessConfig | 接口名称。当前 API 的名称为 DescribeVpcAccessConfig 。 |
Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01 。 |
ServiceId | String | 是 |
| 待查询配置的服务 ID。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
VpcAccessConfig | Object of VpcAccessConfig | - | 内网访问配置项 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Status | String |
| 内网访问启用状态,取值如下所示:
|
VpcAccessDomain | String | 2100**-da**.veimagex-*-*.*.org | 内网域名地址。 |
UrlAuthSwitch | Boolean |
| URL 鉴权开关,取值如下所示:
|
UrlAuthConfig | Object of UrlAuthConfig | - | URL 鉴权配置。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AuthType | String |
| 指定的鉴权模式,取值如下所示:
|
MasterKey | String | 12981301 | 指定的主密钥。 |
BackupKey | String | 2389o31 | 指定的备份密钥。 |
Duration | Long | 1800 | 指定的鉴权生效时间。 |
SignName | String | sign | 指定的签名参数名称。 |
TimeName | String | t | 指定的时间戳参数名称。 |
TimeFormat | String |
| 指定的时间戳格式,取值如下所示:
|
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 是否正确。 |