查询快照链列表 - ListSnapshotChains
功能介绍
查询快照链的列表。标准快照当前只在部分区域支持,具体的区域列表请通过控制台查询。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
evs:snapshotChains:list
List
-
-
-
-
URI
GET /v5/{project_id}/snapshot-chains
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释 项目ID。获取方法请参见获取项目ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| marker | 否 | String | 参数解释 分页查询的起始资源ID,取值为上一页最后一条查询记录的资源ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
| limit | 否 | Integer | 参数解释 返回结果个数限制。 约束限制 不涉及。 取值范围 最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。 默认取值 不涉及。 |
| id | 否 | String | 参数解释 快照链ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
| volume_id | 否 | String | 参数解释 快照链所属的云硬盘ID。 可通过查询所有云硬盘详情获取云硬盘ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
| category | 否 | String | 参数解释 快照链的类型。 约束限制 不涉及。 取值范围 当前快照链支持"standard"、"backup"和"server_backup"三种类型。 默认取值 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| snapshot_chains | Array of snapshot_chains objects | 参数解释 快照链列表。 取值范围 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释 快照链ID。 取值范围 不涉及。 |
| availability_zone | String | 参数解释 快照链所属云硬盘的可用区。 取值范围 不涉及。 |
| snapshot_count | Integer | 参数解释 快照链上的快照个数。 取值范围 大于等于0。 |
| capacity | Integer | 参数解释 快照链的大小。 取值范围 大于等于0。 |
| project_id | String | 参数解释 项目ID。 取值范围 不涉及。 |
| volume_id | String | 参数解释 快照链所属的云硬盘ID。 取值范围 不涉及。 |
| category | String | 参数解释 快照链的类型。 取值范围 当前快照链支持"standard"、"standard_copy"两种类型。 |
| created_at | String | 参数解释 创建时间。 取值范围 不涉及。 |
| updated_at | String | 参数解释 更新时间。 取值范围 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | Error object | 参数解释 出现错误时,返回的错误信息。 取值范围 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释 出现错误时,返回的错误码。 取值范围 错误码和其对应的含义请参考错误码说明。 |
| message | String | 参数解释 出现错误时,返回的错误消息。 取值范围 不涉及。 |
请求示例
GET https://{endpoint}/v5/{project_id}/snapshot-chains 响应示例
状态码:200
{
"snapshot_chains" : [ {
"id" : "e97f57fe-767b-46c6-ac1b-10b77e491406",
"capacity" : 0,
"project_id" : "fb640396c4344e4f96057fab643fe5b5",
"volume_id" : "7c40f5ae-2b26-4922-b586-3d41af4822f1",
"category" : "standard",
"availability_zone" : "cn-southwest-242a",
"snapshot_count" : 1,
"created_at" : "2023-10-25T08:56:26.087002",
"updated_at" : "2023-10-25T08:56:26.758003"
}, {
"id" : "5b798ddd-872b-4823-ab45-a02733ed62cb",
"capacity" : 1,
"project_id" : "fb640396c4344e4f96057fab643fe5b5",
"volume_id" : "92fea069-6073-4784-a7e8-7a1a4caf9c70",
"category" : "standard",
"availability_zone" : null,
"snapshot_count" : 1,
"created_at" : "2023-08-15T13:17:59.061000",
"updated_at" : "2023-08-15T13:17:59.065000"
} ]
} 状态码:400
{
"error" : {
"message" : "XXXX",
"code" : "EVS.XXX"
}
} 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 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.evs.v2.region.EvsRegion; import com.huaweicloud.sdk.evs.v2.*; import com.huaweicloud.sdk.evs.v2.model.*; public class ListSnapshotChainsSolution { 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); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("<YOUR REGION>")) .build(); ListSnapshotChainsRequest request = new ListSnapshotChainsRequest(); try { ListSnapshotChainsResponse response = client.listSnapshotChains(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 31 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkevs.v2.region.evs_region import EvsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkevs.v2 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 = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSnapshotChainsRequest() response = client.list_snapshot_chains(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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := evs.EvsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := evs.NewEvsClient(hcClient) request := &model.ListSnapshotChainsRequest{} response, err := client.ListSnapshotChains(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
错误码
请参见错误码。