本接口根据边缘实例 ID 获取实例详细信息。

请求说明 #

• 请求方式：GET
• 请求地址：https://veenedge.volcengineapi.com/?Action=GetInstance&Version=2021-04-30

请求参数 #

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数，请参见公共参数。

Query #

返回参数 #

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

请求示例 #

GET https://veenedge.volcengineapi.com/?Action=GetInstance&Version=2021-04-30
&instance_identity=veen2111270501017515****
&<其他公共参数>

返回示例 #

{
    "ResponseMetadata": {
        "RequestId": "202511171104271C8C27EFBDD7391E****",
        "Action": "GetInstance",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "instance": {
            "instance_identity": "veen410114901022110****",
            "instance_uuid": "3101eb79-bd2c-56f4-87e0-3d28b5b6****",
            "instance_name": "",
            "load_type": "virtual_machine",
            "cloud_server_identity": "cloudserver-9gznn7twn2*****",
            "cloud_server_name": "debian10-l**",
            "vpc_identity": "vpc-lp9z2t****",
            "namespace": "ns-210006****",
            "subnet_cidr": "",
            "cluster": {
                "cluster_name": "**ct04",
                "country": "CN",
                "region": "CentralChina",
                "province": "HA",
                "city": "410300",
                "isp": "CTCC",
                "level": "3",
                "alias": "**电信04"
            },
            "node_name": "**ct04",
            "spec": "veEN.sG1.large",
            "spec_display": "通用型-SRIOV | 2C8G",
            "cpu": "2",
            "mem": "8",
            "status": "running",
            "creator": "veEN_**",
            "image": {
                "image_identity": "imageca7r5x****",
                "image_name": "debian-**",
                "system_arch": "Linux",
                "system_type": "Debian",
                "system_bit": "64位",
                "system_version": "10 SRIOV",
                "property": "PublicBaseImage",
                "disable_vga": false,
                "image_boot_mode": "BIOS",
                "gpu_version_info": {
                    "driver_version": "",
                    "cuda_version": "",
                    "cudnn_version": ""
                },
            },
            "storage": {
                "system_disk": {
                    "storage_type": "CloudBlockSSD",
                    "capacity": "40"
                },
                "data_disk": {
                    "storage_type": "CloudBlockSSD",
                    "capacity": "20"
                },
                "data_disk_list": [
                    {
                        "storage_type": "CloudBlockSSD",
                        "capacity": "20"
                    }
                ]
            },
            "network": {
                "internal_interface": {
                    "ip_addr": "10.**.**.152",
                    "mask": "24",
                    "ip6_addr": "",
                    "mask6": "",
                    "ips": [
                        {
                            "ip_type": "internal",
                            "addr": "10.**.**.152",
                            "mask": "24",
                            "isp": "",
                            "ip_version": "ipv4",
                            "primary": true                        }
                    ],
                    "mac_addr": "",
                    "bandwidth_peak": "5",
                    "bond": false                },
                "external_interface": {
                    "ip_addr": "106.**.**.180",
                    "mask": "25",
                    "ip6_addr": "",
                    "mask6": "",
                    "ips": [
                        {
                            "ip_type": "external",
                            "addr": "106.**.**.180",
                            "mask": "25",
                            "isp": "CTCC",
                            "ip_version": "ipv4"
                        }
                    ],
                    "mac_addr": "",
                    "bandwidth_peak": "5",
                    "bond": false                },
                "external_interfaces": [
                    {
                        "ip_addr": "106.**.**.180",
                        "mask": "25",
                        "ip6_addr": "",
                        "mask6": "",
                        "ips": [
                            {
                                "ip_type": "external",
                                "addr": "106.**.**.180",
                                "mask": "25",
                                "isp": "CTCC",
                                "ip_version": "ipv4"
                            }
                        ],
                        "mac_addr": "",
                        "bandwidth_peak": "5",
                        "bond": false                    }
                ],
                "bond_interface": false,
                "interfaces": [
                    {
                        "ip_addr": "10.**.**.152",
                        "mask": "24",
                        "ip6_addr": "",
                        "mask6": "",
                        "ips": [
                            {
                                "ip_type": "internal",
                                "addr": "10.**.**.152",
                                "mask": "24",
                                "isp": "",
                                "ip_version": "ipv4",
                                "primary": true                            }
                        ],
                        "mac_addr": "",
                        "bandwidth_peak": "5",
                        "bond": false                    },
                    {
                        "ip_addr": "106.**.**.180",
                        "mask": "25",
                        "ip6_addr": "",
                        "mask6": "",
                        "ips": [
                            {
                                "ip_type": "external",
                                "addr": "106.**.**.180",
                                "mask": "25",
                                "isp": "CTCC",
                                "ip_version": "ipv4"
                            }
                        ],
                        "mac_addr": "",
                        "bandwidth_peak": "5",
                        "bond": false                    }
                ],
                "vf_passthrough": true,
                "default_isp": "",
                "dns_type": "default",
                "dns_list": [
                    "114.114.114.114",
                    "180.184.1.1",
                    "223.6.6.6"
                ],
                "bandwidth_peak_update_status": "ready",
                "limit_mode": "shared",
                "udp_timeout": 60,
                "tcp_timeout": 900
            },
            "gpu": {
                "gpus": []
            },
            "secret": {
                "secret_type": 2
            },
            "billing": {
                "computing_billing_method": "DailyPeak",
                "bandwidth_billing_method": "HourUsed"
            },
            "account": {
                "account_identity": 210006****
            },
            "instance_desc": "",
            "host_name": "",
            "arch": "x86",
            "monitor_agent": {
                "agent_status": "running"
            },
            "project": "default",
            "spec_feature": 1,
            "subnet_identity": "",
            "advanced_configuration": {
                "delete_protection": false            },
            "start_time": 1757592644,
            "end_time": 0,
            "create_time": 1757592625,
            "update_time": 1757592644,
            "create_timestamp": "2025-09-11T12:10:25Z"
        }
    }
}

错误码 #

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。