更新时间:2024-11-11 GMT+08:00

查询API版本列表

功能介绍

查询企业项目的API版本列表。

调用方法

请参见如何调用API

URI

GET /

请求参数

响应参数

状态码: 200

表1 响应Body参数

参数

参数类型

描述

versions

Array of VersionDetail objects

版本列表

表2 VersionDetail

参数

参数类型

描述

id

String

版本ID(版本号),如v1.0。

links

Array of Link objects

API的URL地址。

version

String

若该版本API支持微版本,则返回支持的最大微版本号,如果不支持微版本,则返回空。

status

String

版本状态,为如下3种:

CURRENT:表示该版本为主推版本。

SUPPORTED:表示为老版本,但是现在还继续支持。

DEPRECATED:表示为废弃版本,存在后续删除的可能。

updated

String

版本发布时间,采用UTC时间表示。如v1.0发布的时间2016-12-09T00:00:00Z。

min_version

String

若该版本API 支持微版本,则返回支持的最小微版本号, 如果不支持微版本,则返回空。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表5 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表7 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表9 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表11 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 405

表12 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表13 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 406

表14 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表15 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 408

表16 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表17 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 409

表18 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表19 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 410

表20 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表21 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 412

表22 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表23 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 429

表24 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表25 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表26 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表27 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 501

表28 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表29 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 503

表30 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表31 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

响应示例

状态码: 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代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

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

错误码

请参见错误码