vpc · 2017-03-12

DescribeNetworkInterfaces

POST

Query the ENI list.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/DescribeNetworkInterfaces path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://vpc.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/vpc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: vpc.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeNetworkInterfaces' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Offset":0,"Limit":20}'

Request parameters

Field	Type	Required	Description
NetworkInterfaceIds	string[]	—	Queries the ID of the ENI instance, such as `eni-pxir56ns`. Each request can have a maximum of 100 instances. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
Filters	Filter[]	—	Filter. `NetworkInterfaceIds` and `Filters` cannot be specified at the same time.
Offset	integer	—	Offset. Default value: 0.
Limit	integer	—	Number of returned results. Default value: 20. Maximum value: 100.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
NetworkInterfaceSet	NetworkInterface[]	List of instance details.
TotalCount	integer	Number of eligible instances.
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "NetworkInterfaceSet": …,
    "TotalCount": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/vpc.

SecretIdSecretKey

Request bodyvalid JSONPOST vpc.api3.convergecloud.com · DescribeNetworkInterfaces

{
  "Offset": 0,
  "Limit": 20
}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-17

{
  "Response": {
    "NetworkInterfaceSet": [],
    "TotalCount": 0,
    "RegionStatistics": [
      {
        "TotalCount": 0,
        "Region": "luzon"
      }
    ],
    "RequestId": "78bc5ee5-350c-a47f-5dc4-d44b3ad3ee28"
  }
}

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "ResourceNotFound",
      "Message": "指定资源 `eni-5uqtk0sn` 未找到。"
    },
    "RequestId": "d692c01e-6d7c-4751-ee7d-523ac60305c5"
  }
}