Querying a Specified API Version

Function

This API is used to query the version of a specified API.

URI

GET /{api_version}

Table 1 describes the parameters.

Table 1 Parameter description

Parameter	Type	Description
api_version	String	Specifies the version number, for example v2.0.

Request Parameters

None

Example Request

GET https://{Endpoint}/v2.0

Response Parameters

Table 2 Response parameter

Parameter	Type	Description
resources	Array of resource objects	Specifies the resource object list.

Table 3 resource object

Parameter	Type	Description
name	String	Specifies the resource name.
collection	String	Specifies the resource collection name.
links	Array of link objects	Specifies the link list. For details, see Table 4.

Table 4 link objects

Parameter	Type	Description
href	String	Specifies the API link.
rel	String	Specifies the relationship between the API link and the API version.

Example Response

{
    "resources": [
        {
            "links": [
                {
                    "href": "https://vpc.systems.com/v2.0/subnets",
                    "rel": "self"
                }
            ],
            "name": "subnet",
            "collection": "subnets"
        },
        {
            "links": [
                {
                    "href": "https://vpc.systems.com/v2.0/networks",
                    "rel": "self"
                }
            ],
            "name": "network",
            "collection": "networks"
        },
        {
            "links": [
                {
                    "href": "https://vpc.systems.com/v2.0/ports",
                    "rel": "self"
                }
            ],
            "name": "port",
            "collection": "ports"
        }
    ]
}

Status Code

See Status Codes.

Error Code

See Error Codes.

last updated: 2024-05-05 00:07