Updated on 2026-01-13 GMT+08:00

Obtaining Server NIC Information

Function

This API is used to obtain the NIC information of a specified ECS instance. The detailed information about the NIC of the ECS is returned.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/sdg/asset/ecs/{server_id}/os-interface

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used to identify a specific project.

server_id

Yes

String

Server ID, which is used to identify a specific ECS instance.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

interface_attachments

Array of OsInterface objects

Network interface attachment list, which contains details about all network interfaces.

Table 3 OsInterface

Parameter

Type

Description

fixed_ips

Array of FixedIps objects

Fixed IP address list of the network interface, which contains all the fixed IP addresses assigned to the network interface.

net_id

String

Unique identifier of a network that a network interface belongs to.

port_id

String

Unique identifier of a port that a network interface belongs to.

Table 4 FixedIps

Parameter

Type

Description

ip_address

String

Fixed IP address of the network interface, which is used for network communication.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The NIC information of the server is obtained.

401

Unauthorized access. The request is rejected.

403

Unauthorized operation. The request is rejected.

404

The specified server or project does not exist. Retrieval failed.

Error Codes

See Error Codes.