Updated on 2024-11-11 GMT+08:00

Querying API Versions

Function

This API is used to query the versions of EPS APIs.

Calling Method

For details, see Calling APIs.

URI

GET /

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

versions

Array of VersionDetail objects

Version list.

Table 2 VersionDetail

Parameter

Type

Description

id

String

Version ID, for example, v1.0.

links

Array of Link objects

API URL.

version

String

If the APIs of this version support microversions, the supported minimum microversion is returned. If microversions are not supported, no information is returned.

status

String

Version status. Possible values are as follows:

CURRENT: primary version.

SUPPORTED: earlier version which is still supported.

DEPRECATED: deprecated version which may be deleted later.

updated

String

Version release time, which is a UTC time. For example, the release time of v1.0 is 2016-12-09T00:00:00Z.

min_version

String

If the APIs of this version support microversions, the supported minimum microversion is returned. If microversions are not supported, no information is returned.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 5 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 7 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 9 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 11 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 405

Table 12 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 13 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 406

Table 14 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 15 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 408

Table 16 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 17 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 409

Table 18 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 19 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 410

Table 20 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 21 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 412

Table 22 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 23 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 429

Table 24 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 25 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 26 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 27 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 501

Table 28 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 29 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 503

Table 30 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 31 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "versions" : [ {
    "id" : "v1.0",
    "links" : [ {
      "rel" : "self",
      "href" : "https://*API URL*/v1.0"
    } ],
    "version" : "",
    "status" : "CURRENT",
    "updated" : "2016-12-09T00:00:00Z",
    "min_version" : ""
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.eps.v1.region.EpsRegion;
import com.huaweicloud.sdk.eps.v1.*;
import com.huaweicloud.sdk.eps.v1.model.*;


public class ListApiVersionsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        EpsClient client = EpsClient.newBuilder()
                .withCredential(auth)
                .withRegion(EpsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListApiVersionsRequest request = new ListApiVersionsRequest();
        try {
            ListApiVersionsResponse response = client.listApiVersions(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkeps.v1.region.eps_region import EpsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeps.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = EpsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EpsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListApiVersionsRequest()
        response = client.list_api_versions(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    eps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := eps.NewEpsClient(
        eps.EpsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListApiVersionsRequest{}
	response, err := client.ListApiVersions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

410

Gone

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Error Codes

See Error Codes.