Querying the Network Information of a Container Cluster

Function

This API is used to query the network information of a container cluster.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/container-network/{cluster_id}/network-info

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
cluster_id	Yes	String	Cluster ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
mode	String	Network model
vpc	String	VPC Id
subnet	String	Network ID
security_group	String	Security group
ipv4_cidr	String	IPv4 Service CIDR Block
cidrs	String	Container network segment
kube_proxy_mode	String	Service forwarding mode. iptables ipvs
is_support_egress	Boolean	Whether egress rules can be configured. Its value can be true or false.

Example Requests

This API is used to query the network information of a container cluster.

GET https://{endpoint}/v5/{project_id}/container-network/{cluster_id}/network-info?enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "mode" : "overlay_l2",
  "vpc" : "08b0cbf3-058d-492d-a5fe-2a74110e6e66",
  "subnet" : "61f87ddd-553e-42c2-bb4d-a85c52335b06",
  "security_group" : "d98814a4-3fce-4338-9ca5-7c0dbf263d07",
  "cidrs" : "172.16.0.0/16",
  "kube_proxy_mode" : "iptables",
  "is_support_egress" : true,
  "ipv4_cidr" : "10.247.0.0/16"
}