You can call the DescribeEdgeMachines operation to query cloud-native boxes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request syntax

`GET /edge_machines?hostname=String&model=String&online_state=String&life_state=String&page_size=Long&page_number=Long  HTTP/1.1`

Request parameters

Table 1. Request query parameters
Parameter Type Required Example Description
hostname String No ack-v-b010-ssdfw****

The hostname of the cloud-native box.

model String No ACK-V-B010

The model of the cloud-native box.

online_state String No offline/online

The online status of the cloud-native box. Valid values:

  • offline: The cloud-native box is offline.
  • online: The cloud-native box is online.
life_state String No activated/waitOnline/deleting

The lifecycle status of the cloud-native box.

page_size Long No 50

The number of entries to return on each page.

page_number Long No 4

The number of the page to return.

Response syntax

HTTP/1.1 200
Content-Type:application/json
{
    "edge_machines": [
        {
            "edge_machine_id": "c61083909b13f4a95b8554bda9577****",
            "created": "2021-07-07T20:44:00+08:00",
            "updated": "2021-07-07T20:44:00+08:00",
            "name": "ack-v-b010-ssdfw****",
            "hostname": "ack-v-b010-ssdfw****",
            "sn": "ACK9GBL31SXX****",
            "model": "ACK-V-B010",
            "life_state": "waitOnline",
            "online_state": "offline",
            "active_time": "0001-01-01T00:00:00Z"
        }
    ],
    "page_info": {
        "page_number": 1,
        "page_size": 50,
        "total_count": 1
    }
}

Response parameters

Table 2. Response body parameters
Parameter Type Example Description
edge_machines Array of edge_machines

The list of details about cloud-native boxes.

edge_machine_id String c61083909b13f4a95b8554bda9577****

The ID of the cloud-native box.

created String 2021-07-07T20:44:00+08:00

The time when the cloud-native box was created.

updated String 2021-07-07T20:44:00+08:00

The time when the cloud-native box was last updated.

name String ack-v-b010-ssdfw****

The name of the cloud-native box.

hostname String ack-v-b010-ssdfw****

The hostname of the cloud-native box.

sn String ACK9GBL31SXX****

The serial number of the cloud-native box.

model String ACK-V-B010

The model of the cloud-native box.

life_state String activated

The lifecycle status of the cloud-native box.

online_state String online

The online status of the cloud-native box.

active_time String 2021-07-19T16:07:48+08:00

The time when the cloud-native box was activated.

page_info Object

The pagination details.

page_number Integer 1

The page number of the returned page.

page_size Integer 50

The number of entries returned per page.

total_count Integer 1

The total number of entries returned.

Sample requests

Submit the following sample request to query cloud-native boxes:

GET /edge_machines?hostname=ack-v-b010-ssdfw****&model=ACK-V-B010&online_state=offline/online&life_state=activated/waitOnline/deleting&page_size=50&page_number=4 HTTP/1.1
Host:cs.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeEdgeMachinesResponse>
    <edge_machines>
        <edge_machine_id>c61083909b13f4a95b8554bda9577****</edge_machine_id>
        <created>2021-07-07T20:44:00+08:00</created>
        <updated>2021-07-07T20:44:00+08:00</updated>
        <name>ack-v-b010-ssdfw****</name>
        <hostname>ack-v-b010-ssdfw****</hostname>
        <sn>ACK9GBL31SXX****</sn>
        <model>ACK-V-B010</model>
        <life_state>activated</life_state>
        <online_state>online</online_state>
        <active_time>2021-07-19T16:07:48+08:00</active_time>
    </edge_machines>
    <page_info>
        <page_number>1</page_number>
        <page_size>50</page_size>
        <total_count>1</total_count>
    </page_info>
</DescribeEdgeMachinesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "edge_machines" : [ {
    "edge_machine_id" : "c61083909b13f4a95b8554bda9577****",
    "created" : "2021-07-07T20:44:00+08:00",
    "updated" : "2021-07-07T20:44:00+08:00",
    "name" : "ack-v-b010-ssdfw****",
    "hostname" : "ack-v-b010-ssdfw****",
    "sn" : "ACK9GBL31SXX****",
    "model" : "ACK-V-B010",
    "life_state" : "activated",
    "online_state" : "online",
    "active_time" : "2021-07-19T16:07:48+08:00"
  } ],
  "page_info" : {
    "page_number" : 1,
    "page_size" : 50,
    "total_count" : 1
  }
}

Error codes

For a list of error codes, visit the API Error Center.