huawei-cloud-ecs-eip-query

Huawei Cloud ECS EIP Query Skill

Overview

This skill queries the EIP (Elastic IP, 弹性公网IP) bound to a single Huawei Cloud ECS instance. Given an ECS ID or ECS name (and an optional region), it returns the associated public IP address, EIP ID, status, bandwidth, and binding metadata. It is a read-only lookup skill: it never creates, modifies or deletes EIPs or ECS instances.

Architecture:

Agent → hcloud CLI (EIP, primary) → Huawei Cloud EIP API
       ↘ huaweicloudsdkeip Python SDK (fallback)  ↗

Applicable Scenarios:

• Check which public IP a specific ECS is using (troubleshooting connectivity)
• Per-instance network cost review (EIP bandwidth and billing mode)
• Resource discovery and inventory (mapping ECS → EIP bindings)
• Compliance reporting (per-instance public exposure)

Prerequisites

1. hcloud CLI (KooCLI) installed and authenticated — See references/cli-installation-guide.md
2. IAM permissions — vpc:publicIps:list (list) and vpc:publicIps:get (show detail), plus ecs:servers:list / ecs:servers:get when resolving an ECS by name — See references/eip-policies.md
3. Python 3.6+ with huaweicloudsdkeip package (SDK fallback) — pip install huaweicloudsdkeip

Credentials. KooCLI reads credentials from hcloud configure (AK/SK) or environment variables. The EIP API is region-scoped: the same account credentials used for other Huawei Cloud services work here, and --cli-region selects the region whose EIPs are queried. Never ask the user to paste AK/SK into the conversation.

Workflow

1. Determine the ECS — accept the ECS ID directly, or resolve an ECS name to its ID first: hcloud ECS ListServersDetails --cli-region= --name=
2. Run the query — hcloud EIP ListPublicips/v3 --cli-region= --vnic.device_id.1= (CLI primary)
3. Handle results — Parse the EIP public IP, EIP ID, status, bandwidth and binding details; report whether the ECS has a bound EIP
4. Fallback — If the CLI is unavailable, use the Python SDK example below

Core Commands

Query EIP by ECS ID (primary)

hcloud EIP ListPublicips/v3 --cli-region=cn-north-4 --vnic.device_id.1=

vnic.device_id is the bound ECS instance ID — this returns only the EIPs bound to that ECS.

Query EIP by ECS ID (JSON Output)

hcloud EIP ListPublicips/v3 --cli-region=cn-north-4 --vnic.device_id.1= --cli-output=json

Note: ListPublicips is a multi-version API — the version hint line (ListPublicips is a multi-version API, where the version (v3) is default...) is printed to stdout only when the /v3 version suffix is omitted. All commands in this skill use the explicit /v3 suffix, so their output is pure JSON — parse it directly with jq/python3 -c json.load (do not use tail -n +2, which would cut off the first { and break JSON parsing). If you ever run a command without the version suffix and see the hint line, drop it with tail -n +2 before parsing, or prefer the SDK fallback path below.

Resolve ECS Name to ID

hcloud ECS ListServersDetails --cli-region=cn-north-4 --name= --cli-output=json

The ECS ID is in the servers[].id field. ECS names are fuzzy matched; pass the exact name for a precise lookup.

Show ECS Detail (addresses include the public IP)

hcloud ECS ShowServer --cli-region=cn-north-4 --server_id=

The addresses field lists both fixed (private) and floating (public/EIP) addresses with OS-EXT-IPS:type of fixed or floating.

Show EIP Detail

hcloud EIP ShowPublicip/v3 --cli-region=cn-north-4 --publicip_id=

SDK Fallback Example

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v3 import EipClient
from huaweicloudsdkeip.v3.model import ListPublicipsRequest
from huaweicloudsdkeip.v3.region.eip_region import EipRegion

credentials = BasicCredentials(
    os.environ["HUAWEI_CLOUD_ACCESS_KEY"],
    os.environ["HUAWEI_CLOUD_SECRET_KEY"],
)
client = EipClient.new_builder() \
    .with_credentials(credentials) \
    .with_region(EipRegion.value_of("cn-north-4")) \
    .build()

request = ListPublicipsRequest()
request.vnic_device_id = [""]
response = client.list_publicips(request)
eips = response.publicips or []
for eip in eips:
    print(eip.id, eip.public_ip_address, eip.status, eip.associate_instance_type)
print("EIP number:", len(eips))

Parameter Confirmation

* Used by the corresponding sub-command; the primary EIP query only needs the ECS ID and region.

Reference Documents

• CLI Installation Guide
• EIP and ECS Policies
• Verification Method
• Data Flow Diagram
• Acceptance Criteria

KooCLI Command Format Standard

The hcloud EIP and hcloud ECS modules map directly to the Huawei Cloud EIP/ECS API operations.