You can call the DescribeEdgeMachineTunnelConfigDetail to query the tunnel configuration of a cloud-native box.

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

`POST /edge_machines/{edge_machineid}/tunnelconfig  HTTP/1.1`

Request parameters

Table 1. Request path parameters
Parameter Type Required Example Description
edge_machineid String Yes cc0725ddf688744979cd98445f67e****

The ID of the cloud-native box.

Response syntax

HTTP/1.1 200
Content-Type:application/json
{
    
  "model": "ACK-A-S001",
  "sn": "Q2CB5XZAFBFG****",
  "tunnel_endpoint": "wss://frontend-iotx-remote-debug.aliyun-inc.test",
  "token": "abcd****",
  "product_key": "a11rXul****",
  "device_name": "TEST0621N0FF****",
  "request_id": "bfd12953-31cb-42f1-8a36-7b80ec345094"
}

Response parameters

Table 2. Response body parameters
Parameter Type Example Description
model String ACK-A-S001

The model of the cloud-native box.

sn String Q2CB5XZAFBFG****

The serial number of the cloud-native box.

tunnel_endpoint String wss://frontend-iotx-r-debug.aliyun-inc.test

The backend endpoint of the tunnel.

token String abcd****

The token.

product_key String a11rXul****

The product key.

device_name String TEST0621N0FF****

The name of the cloud-native box.

request_id String bfd12953-31cb-42f1-8a36-7b80ec345094

The ID of the request.

Sample requests

Submit the following sample request to query the SSH token of a cloud-native box:

POST /edge_machines/[edge_machineid]/tunnelconfig 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

<DescribeEdgeMachineTunnelConfigDetailResponse>
    <model>ACK-A-S001</model>
    <sn>Q2CB5XZAFBFG****</sn>
    <tunnel_endpoint>wss://frontend-iotx-r-debug.aliyun-inc.test</tunnel_endpoint>
    <token>abcd****</token>
    <product_key>a11rXul****</product_key>
    <device_name>TEST0621N0FF****</device_name>
    <request_id>bfd12953-31cb-42f1-8a36-7b80ec345094</request_id>
</DescribeEdgeMachineTunnelConfigDetailResponse>

JSON format

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

{
  "model" : "ACK-A-S001",
  "sn" : "Q2CB5XZAFBFG****",
  "tunnel_endpoint" : "wss://frontend-iotx-r-debug.aliyun-inc.test",
  "token" : "abcd****",
  "product_key" : "a11rXul****",
  "device_name" : "TEST0621N0FF****",
  "request_id" : "bfd12953-31cb-42f1-8a36-7b80ec345094"
}

Error codes

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