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

查询回收站实例信息

功能介绍

查询回收站实例信息

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/instances/recycle-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

查询记录数。默认为10,不能为负数,最小值为1,最大值为100。

offset

Integer

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

Content-Type

String

内容类型。

取值:application/json。

X-Language

String

语言。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_count

String

数据总数

instances

Array of RecycleInstanceV3 objects

回收站实例信息

表5 RecycleInstanceV3

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

ha_mode

String

实例类型。

engine_name

String

引擎名称。

engine_version

String

引擎版本。

pay_model

String

计费模式。

create_at

Integer

创建时间。

deleted_at

Integer

删除时间。

volume_type

String

磁盘类型。

volume_size

String

磁盘大小。

data_vip

String

数据面VIP。

data_vip_ipv6

String

数据面IPV6。

enterprise_project_id

String

企业项目ID。

enterprise_project_name

String

企业项目名称。

backup_level

String

备份级别。

recycle_backup_id

String

备份ID。

recycle_status

String

回收状态。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询回收站实例信息

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/recycle-info

响应示例

状态码: 200

Success.

{
  "total_count" : 2,
  "instances" : [ {
    "id" : "090e539b45e047ee9cc17750b321ef7ein07",
    "name" : "gauss-dd-single",
    "ha_mode" : "StandSingle",
    "engine_name" : "taurus",
    "engine_version" : "2.0.51.240300",
    "pay_model" : "0",
    "create_at" : 1712656933705,
    "deleted_at" : 1712659228276,
    "volume_type" : "",
    "volume_size" : "0",
    "data_vip" : "172.16.1.234",
    "data_vip_ipv6" : null,
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default",
    "backup_level" : "2",
    "recycle_backup_id" : "c62e218ccd6c49098baa925453c65e29br07",
    "recycle_status" : "Active"
  }, {
    "id" : "632423cc56c348bd967b3a03e7abdab9in07",
    "name" : "gauss-dd-single",
    "ha_mode" : "StandSingle",
    "engine_name" : "taurus",
    "engine_version" : "2.0.51.240300",
    "pay_model" : "0",
    "create_at" : 1712658210524,
    "deleted_at" : 1712659158927,
    "volume_type" : "",
    "volume_size" : "0",
    "data_vip" : "172.16.1.194",
    "data_vip_ipv6" : null,
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default",
    "backup_level" : "2",
    "recycle_backup_id" : "70d03dc459304f7298c0f5b49286f37cbr07",
    "recycle_status" : "Active"
  } ]
}

SDK代码示例

SDK代码示例如下。

Java

 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
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
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.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;


public class ListRecycleInstancesSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ListRecycleInstancesRequest request = new ListRecycleInstancesRequest();
        try {
            ListRecycleInstancesResponse response = client.listRecycleInstances(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());
        }
    }
}

Python

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ListRecycleInstancesRequest()
        response = client.list_recycle_instances(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

更多

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

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档