Help Center> Cloud Container Instance (CCI)> API Reference> Proprietary APIs> Network> Reading the Status of a Network
View PDF

Reading the Status of a Network

Function

This API is used to read the status of a specified network.

URI

GET /apis/networking.cci.io/v1beta1/namespaces/{namespace}/networks/{name}/status

Table 1 Path parameters

Parameter

Mandatory

Description

namespace

Yes

Namespace to which the network you are querying belongs.

name

Yes

Name of the network you want to query.
Table 2 Query parameter

Parameter

Mandatory

Description

pretty

No

If 'true', then the output is pretty printed.

Request

N/A

Response

Response parameters

For the description about response parameters, see Table 3.

Example response

{
    "kind": "Network",
    "apiVersion": "networking.cci.io/v1beta1",
    "metadata": {
        "name": "test-network",
        "namespace": "test-ns",
        "selfLink": "/apis/networking.cci.io/v1beta1/namespaces/test-ns/networks/test-network",
        "uid": "f03452ac-a4ea-11e8-8500-c81fbe371a17",
        "resourceVersion": "2025736",
        "creationTimestamp": "2018-08-21T02:35:59Z",
        "annotations": {
            "network.alpha.kubernetes.io/default-security-group": "security-group-id",
            "network.alpha.kubernetes.io/domain-id": "domain-id",
            "network.alpha.kubernetes.io/project-id": "project-id",
            "network.alpha.kubernetes.io/type": "underlay_neutron"
        },
        "enable": true
    },
    "spec": {
        "availableZone": "cn-north-1a",
        "cidr": "192.168.0.0/24",
        "attachedVPC": "vpc-id",
        "networkID": "network-id",
        "networkType": "underlay_neutron",
        "subnetID": "subnet-id"
    },
    "status": {
        "state": "Active"
    }
}

Status Code

Table 3 Status code

Status Code

Description

200

This operation succeeds, and a Network resource object is returned.

For more status codes, see Status Codes.

Parent topic: Network