You need to enable JavaScript to run this app.
导航
获取边缘实例详情
最近更新时间:2023.07.03 16:32:35首次发布时间:2022.02.25 18:58:31

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

请求方法

GET

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

GetInstance

公共参数。该参数表示接口名称。取值:GetInstance。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

instance_identity

String

veen2202012110000220****

边缘实例 ID。您可以通过 ListInstances 接口获取边缘实例 ID。

返回数据

名称

类型

示例值

描述

instance

VEENInstance

请参见返回示例

边缘实例详细信息。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023052512070794DCBEE1950256AD****",
        "Action": "GetInstance",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "instance": {
            "instance_identity": "veen2111270501017515****",
            "instance_uuid": "5cd92a9f-d3bc-54a5-9a43-ad6a5ba6****",
            "instance_name": "",
            "load_type": "virtual_machine",
            "cloud_server_identity": "cloudserver-qpz257bcbfl****",
            "cloud_server_name": "cloud-server-test",
            "vpc_identity": "vpc-8p54gk****",
            "namespace": "ns-210006****",
            "subnet_cidr": "172.**.**.192/26",
            "cluster": {
                "cluster_name": "****-gzcm04",
                "country": "CN",
                "region": "SouthChina",
                "province": "GD",
                "city": "440100",
                "isp": "CMCC",
                "level": "1",
                "alias": "广州移动04"
            },
            "node_name": "admin07.****04",
            "spec": "veEN.G1.large",
            "spec_display": "通用型 | 2C8G",
            "cpu": "2",
            "mem": "8",
            "status": "running",
            "creator": "veEN_RD",
            "image": {
                "image_identity": "imagelgnzqa****",
                "image_name": "centos-7.2-amd64",
                "system_arch": "Linux",
                "system_type": "CentOS",
                "system_bit": "64位",
                "system_version": "7.2",
                "property": "PublicBaseImage",
                "disable_vga": false,
                "image_boot_mode": "BIOS"
            },
            "storage": {
                "system_disk": {
                    "storage_type": "CloudBlockHDD",
                    "capacity": "50"
                },
                "data_disk": {
                    "storage_type": "CloudBlockHDD",
                    "capacity": "20"
                },
                "data_disk_list": [
                    {
                        "storage_type": "CloudBlockHDD",
                        "capacity": "20"
                    }
                ]
            },
            "network": {
                "internal_interface": {
                    "ip_addr": "172.**.**.194",
                    "mask": "26",
                    "ip6_addr": "",
                    "mask6": "",
                    "ips": [
                        {
                            "addr": "172.**.**.194",
                            "mask": "26",
                            "isp": "",
                            "ip_version": "ipv4",
                            "primary": true
                        }
                    ],
                    "mac_addr": "0a:58:ac:**:**:c2",
                    "bandwidth_peak": "500"
                },
                "external_interface": {
                    "ip_addr": "183.**.**.4",
                    "mask": "24",
                    "ip6_addr": "",
                    "mask6": "",
                    "ips": [
                        {
                            "addr": "183.**.**.4",
                            "mask": "24",
                            "isp": "CMCC",
                            "ip_version": "ipv4"
                        }
                    ],
                    "mac_addr": "0a:58:b7:**:**:04",
                    "bandwidth_peak": "5"
                },
                "external_interfaces": [
                    {
                        "ip_addr": "183.**.***.4",
                        "mask": "24",
                        "ip6_addr": "",
                        "mask6": "",
                        "ips": [
                            {
                                "addr": "183.**.**.4",
                                "mask": "24",
                                "isp": "CMCC",
                                "ip_version": "ipv4"
                            }
                        ],
                        "mac_addr": "0a:58:b7:**:**:04",
                        "bandwidth_peak": "5"
                    }
                ],
                "default_isp": "",
                "dns_type": "default",
                "dns_list": [
                    "114.114.114.114",
                    "223.6.6.6"
                ]
            },
            "gpu": {
                "gpus": []
            },
            "secret": {
                "secret_type": 3,
                "secret_data": "sshkey-5jkvbn5kshg****"
            },
            "instance_desc": "",
            "host_name": "",
            "arch": "x86",
            "start_time": 1684488222,
            "end_time": 0,
            "create_time": 1684488192,
            "update_time": 1684488222
        }
    }
}

错误码

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