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 an IP Address Group

Updated on 2025-01-07 GMT+08:00

Function

This API is used to query the details of an IP address group.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

GET /v3/{project_id}/vpc/address-groups/{address_group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

address_group_id

Yes

String

IP address group ID that uniquely identifies the IP address group.

project_id

Yes

String

Project ID.

For details about how to obtain a project ID, see Obtaining a Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

address_group

AddressGroup object

Response body for querying an IP address group.

Table 3 AddressGroup

Parameter

Type

Description

id

String

  • IP address group ID that uniquely identifies the IP address group.

  • The value is a string in UUID format.

name

String

  • IP address group name.

  • The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

description

String

  • Description about the IP address group.

  • The value can contain no more than 255 characters.

  • The value cannot contain angle brackets (< or >).

max_capacity

Integer

  • Maximum number of entries in an IP address group. Each entry can be an IP address, IP address range, or CIDR block.

  • The value can be from 0 to 20.

  • The default value is 20.

ip_set

Array of strings

  • IP address sets in an IP address group.

  • The value can be a single IP address, IP address range, or CIDR block.

  • The default maximum number of IP address sets, including IP addresses, IP address ranges, and CIDR blocks, in an IP address group, is 20.

ip_version

Integer

  • Whether it is an IPv4 or IPv6 address group.

  • The value can be one of the following:

    • 4 (IPv4 address groups).

    • 6 (IPv6 address groups).

created_at

String

  • Time when the IP address group was created.

  • The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss, which is automatically generated by the system.

updated_at

String

  • Time when the IP address group was last updated.

  • The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss, which is automatically generated by the system.

tenant_id

String

  • ID of the project where the IP address group is used.

enterprise_project_id

String

  • Enterprise project ID.

  • The project ID can be 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.

Maximum: 36

tags

Array of ResourceTag objects

  • IP address group tags.

status

String

  • IP address group status.

  • The value can be one of the following:

    • NORMAL: The IP address group is normal.

    • UPDATING: The IP address group is being updated.

    • UPDATE_FAILED: Updating the IP address group failed.

  • The default value is NORMAL.

  • An IP address group in the UPDATING status cannot be updated again.

status_message

String

  • Details of the IP address group status.

ip_extra_set

Array of IpExtraSetRespOption objects

  • IP address sets and their remarks in an IP address group.

Table 4 ResourceTag

Parameter

Type

Description

key

String

  • Tag key

  • Tag keys must be unique for each resource.

Minimum: 1

Maximum: 128

value

String

  • Tag value.

Maximum: 255

Table 5 IpExtraSetRespOption

Parameter

Type

Description

ip

String

  • An IP address, IP address range, or CIDR block. Both IPv4 and IPv6 are supported.

remarks

String

  • Supplementary information about the IP address, IP address range, or CIDR block.

  • The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

Example Requests

This API is used to query the details of an IP address group.

GET https://{Endpoint}/v3/2bc7a67b35a64a79ad1d3bb8b5f61fc9/vpc/address-groups/dd18a501-fcd5-4adc-acfe-b0e2384baf08

Example Responses

Status code: 200

Normal response to the GET operation. For more status codes, see Status Codes.

  • {
      "address_group" : {
        "id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
        "name" : "AutoTester746010.580123789",
        "tenant_id" : "b2782e6708b8475c993e6064bc456bf8",
        "ip_version" : 4,
        "max_capacity" : 20,
        "ip_set" : [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ],
        "ip_extra_set" : [ {
          "ip" : "192.168.5.0/24",
          "remarks" : null
        }, {
          "ip" : "192.168.3.20-192.168.3.100",
          "remarks" : null
        }, {
          "ip" : "192.168.3.40",
          "remarks" : null
        }, {
          "ip" : "192.168.3.2",
          "remarks" : null
        } ],
        "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
        "created_at" : "2019-06-28T02:06:38.000+00:00",
        "updated_at" : "2019-06-28T02:06:38.000+00:00",
        "description" : "10.10.4.0/23",
        "status" : "NORMAL",
        "status_message" : ""
      },
      "request_id" : "ce6c359b-9002-41e5-a0b1-232759bd6637"
    }

Status Codes

Status Code

Description

200

Normal response to the GET operation. For more status codes, see Status Codes.

Error Codes

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