GetVpcEndpoint--镜像仓库-火山引擎

文档中心

立即注册

导航

GetVpcEndpoint

最近更新时间：2024.11.28 11:20:01首次发布时间：2023.02.23 10:35:29

查询 VPC 访问入口信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=GetVpcEndpoint&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时，除了以下请求参数外，还需传入公共请求参数。公共请求参数说明，请参见火山引擎公共参数文档。

参数	类型	是否必选	示例值	描述
Action	String	是	GetVpcEndpoint	接口名称。当前 API 的名称为 `GetVpcEndpoint`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Registry	String	是	test-cr	镜像仓库实例名称。
Filter	Object of VpcEndpointFilter	否		查询 VPC 访问入口的过滤条件。

VpcEndpointFilter

参数	类型	是否必选	示例值	描述
Statuses	Array of String	否	["Enabling", "Enabled"]	VPC 访问入口状态数组，用于过滤出处于指定状态的 VPC 访问入口。 Enabling：开启中 Enabled：已开启 Disabling：关闭中 Failed：失败

参数

类型

是否必选

示例值

描述

Statuses

Array of String

否

["Enabling", "Enabled"]

VPC 访问入口状态数组，用于过滤出处于指定状态的 VPC 访问入口。

Enabling：开启中
Enabled：已开启
Disabling：关闭中
Failed：失败

请求示例

POST https://open.volcengineapi.com?Action=GetVpcEndpoint&Version=2022-05-12
{
    "Registry": "test-cr"
}

返回参数

参数	类型	示例值	描述
Registry	String	test-cr	标准版实例名称。
Vpcs	Array of VpcInfo	[{"VpcId":"vpc-2331","SubnetId": "subnet-09665","Status": "Enabling","Ip": "10.7.6.5"}]	查询 VPC 访问入口的过滤条件。

VpcInfo

参数	类型	示例值	描述
VpcId	String	vpc-luebclsohfwnljn****	VPC ID。
SubnetId	String	subnet-nlohebas****	子网 ID。
Region	String	cn-beijing	VPC 所在地域。
AccountId	Long	14000*****	VPC 归属的主账号 ID。
Ip	String	192.168.12.33	镜像仓库在 VPC 内的 IP 地址。
Status	String	Enabled	访问入口状态： Enabling：开启中 Enabled：已开启 Disabling：关闭中 Failed：失败
CreateTime	String	2022-05-20T13:00:55Z	创建时间。

返回示例

{
    "ResponseMetadata" : {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "GetVpcEndpoint",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing",
    },
    "Result": {
        "Registry": "test-cr",
        "Vpcs": [
            {
                "VpcId": "vpc-2331",  
                "SubnetId": "subnet-09665",
                "Status": "Enabling",
                "Ip": "10.7.6.5"
            },
            {
                "VpcId": "vpc-2334",
                "SubnetId": "subnet-8764",
                "Region": "cn-nantong",
                "Status": "Running",
                "Ip": "100.64.11.12"
            }
        ]
    }
}

错误码

本接口无特有错误码，公共错误码请参见公共错误码。