Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying a Port (Discarded)

Updated on 2022-08-11 GMT+08:00

Function

This API is used to query a single port.

URI

GET /v1/ports/{port_id}

Table 1 describes the parameters.
Table 1 Parameter description

Name

Mandatory

Description

port_id

Yes

Specifies the port ID, which uniquely identifies the port.

Request Message

  • Request parameter

    None

  • Example request
    GET https://{Endpoint}/v1/ports/d00f9c13-412f-4855-8af3-de5d8c24cd60

Response Message

  • Response parameter
    Table 2 Response parameter

    Name

    Type

    Description

    port

    port object

    Specifies the port objects. For details, see Table 3.

    Table 3 Description of the port field

    Name

    Type

    Description

    id

    String

    Specifies the port ID, which uniquely identifies the port.

    name

    String

    • Specifies the port name.
    • The value can contain no more than 255 characters. This parameter is left blank by default.

    network_id

    String

    • Specifies the ID of the network to which the port belongs.
    • The network ID must be a real one in the network environment.

    admin_state_up

    Boolean

    • Specifies the administrative state of the port.
    • The value can only be true, and the default value is true.

    mac_address

    String

    • Specifies the port MAC address.
    • The system automatically sets this parameter, and you are not allowed to configure the parameter value.

    fixed_ips

    Array of fixed_ip objects

    • Specifies the port IP address. For example, the value is "fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]. For details, see Table 4.
    • A port supports only one fixed IP address that cannot be changed.

    device_id

    String

    • Specifies the ID of the device to which the port belongs.
    • The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.

    device_owner

    String

    • Specifies the belonged device, which can be the DHCP server, router, load balancer, or Nova.
    • The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.

    tenant_id

    String

    Specifies the project ID.

    status

    String

    • Specifies the port status. The status of a HANA SR-IOV VM port is always DOWN.
    • The value can be ACTIVE, BUILD, or DOWN.

    security_groups

    Array of strings

    Specifies the security group UUID (extended attribute).

    allowed_address_pairs

    Array of allow_address_pair objects

    • Specifies a set of zero or more allowed address pairs. An address pair consists of an IP address and MAC address. This attribute is extended. For details, see parameter allow_address_pair in Table 5.
    • The IP address cannot be 0.0.0.0.
    • Configure a dedicated security group for the port if the parameter allowed_address_pairs has a large CIDR block (subnet mask less than 24).
    • If the value of allowed_address_pairs is 1.1.1.1/0, the source/destination check is disabled.

    extra_dhcp_opts

    Array of extra_dhcp_opt objects

    Specifies the extended option (extended attribute) of DHCP. For details, see Table 6.

    binding:vif_details

    Object

    Specifies the VIF details. Parameter ovs_hybrid_plug specifies whether the OVS/bridge hybrid mode is used.

    binding:profile

    Object

    Specifies the user-defined settings. This is an extended attribute.

    Instructions:

    • The internal_elb field is in boolean type and is available to common tenants. Set the value of this parameter to true only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system.

      Example:

      {"internal_elb": true}

    • The disable_security_groups field is in boolean type and is available to common tenants. The default value is false. In high-performance communication scenarios, you can set the parameter value to true, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to true.

      Example:

      {"disable_security_groups": true },

      Currently, the value can only be set to true. When the value is set to true, the FWaaS function does not take effect.

    binding:vnic_type

    String

    • Specifies the type of the bound vNIC.
    • The value can be normal or direct. Parameter normal indicates software switching. Parameter direct indicates SR-IOV PCIe passthrough, which is not supported.

    port_security_enabled

    Boolean

    Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. The default value is true.

    Table 4 fixed_ip object

    Name

    Type

    Description

    subnet_id

    String

    • Specifies the subnet ID.
    • You cannot change the parameter value.

    ip_address

    String

    Specifies the port IP address.

    Table 5 allow_address_pair object

    Name

    Type

    Description

    ip_address

    String

    • Specifies the IP address.
    • You cannot set it to 0.0.0.0.
    • Configure a dedicated security group for the port if the parameter allowed_address_pairs has a large CIDR block (subnet mask less than 24).

    mac_address

    String

    Specifies the MAC address.

    Table 6 extra_dhcp_opt object

    Name

    Type

    Description

    opt_name

    String

    Specifies the option name.

    opt_value

    String

    Specifies the option value.

  • Example response
    {
        "port": {
            "id": "d00f9c13-412f-4855-8af3-de5d8c24cd60",
            "name": "test",
            "status": "DOWN",
            "admin_state_up": "true",
            "fixed_ips": [
                {
                    "subnet_id": "70f2e74b-e660-410a-b754-0ca46744348a",
                    "ip_address": "10.128.1.10"
                }
            ],
            "mac_address": "fa:16:3e:d7:f2:6c",
            "network_id": "5b808927-13c9-4e60-a4f4-ed6ffe225167",
            "tenant_id": "43f2d1cca56a40729dcb17212482f34d",
            "device_id": "",
            "device_owner": "",
            "security_groups": [
                "02b4e8ee-74fa-4a31-802e-5490df11245e"
            ],
            "extra_dhcp_opts": [],
            "allowed_address_pairs": [],
            "binding:vnic_type": "normal",
            "binding:vif_details": {},
            "binding:profile": {},
            "port_security_enabled":true
        }
    }

Status Code

See Status Codes.

Error Code

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback