查詢一個或多個已創建的快照信息。
接口說明
InstanceId
、DiskId
、SnapshotIds
和ResourceGroupId
不是必需的請求參數,但是可以構建過濾器邏輯,參數之間為邏輯與(And)關系。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
swas-open:ListSnapshots | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 快照對應的輕量應用服務器所屬的地域 ID。 | cn-hangzhou |
InstanceId | string | 否 | 指定的輕量應用服務器的實例 ID。 | 2ad1ae67295445f598017499dc**** |
DiskId | string | 否 | 指定的磁盤 ID。 | d-bp14wq0149cpp2xy**** |
SnapshotIds | string | 否 | 快照 ID。取值可以由多個快照 ID 組成一個 JSON 數組,最多支持 100 個 ID,ID 之間用半角逗號(,)隔開。 | ["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"] |
PageSize | integer | 否 | 分頁查詢時設置的每頁行數。最大值:100。 默認值:10。 | 10 |
PageNumber | integer | 否 | 快照列表的頁碼。 默認值:1。 | 1 |
SourceDiskType | string | 否 | 快照源云盤的云盤類型。取值范圍:
| Data |
Tag | array<object> | 否 | 快照的標簽列表。 | |
object | 否 | 標簽。 | ||
Key | string | 否 | 快照的標簽鍵。標簽鍵長度的取值范圍:1~64。N 的取值范圍:1~20。 | TestKey |
Value | string | 否 | 快照的標簽值。標簽值長度的取值范圍:1~64。N 的取值范圍:1~20。 | TestValue |
ResourceGroupId | string | 否 | 指定的資源組 ID。 | rg-aek2bti7cf7**** |
返回參數
示例
正常返回示例
JSON
格式
{
"TotalCount": 1,
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
"PageSize": 10,
"PageNumber": 1,
"Snapshots": [
{
"Status": "Accomplished",
"CreationTime": "2021-03-09T07:12:49Z",
"SourceDiskId": "d-bp14wq0149cpp2xy****",
"SnapshotName": "test-SnapshotName",
"Progress": "100%",
"Remark": "test-Remark",
"SnapshotId": "s-bp16oazlsold4dks****",
"SourceDiskType": "System",
"RegionId": "cn-hangzhou",
"InstanceId": "2ad1ae67295445f598017499dc****",
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"RollbackTime": "2021-03-09T07:12:49Z",
"ResourceGroupId": "rg-aek2bti7cf7****"
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | RegionIdNotMatchHost | The parameter regionId does not match the endpoint host. | 傳入的regionId和請求的地址不匹配。 |
403 | InvalidParam | The specified parameter value is invalid. | 參數非法。 |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的實例不存在,請您檢查實例ID是否正確。 |
404 | InvalidDiskId.NotFound | The specified DiskId does not exist. | 指定的磁盤不存在,請您檢查磁盤ID是否正確。 |
500 | InternalError | An error occurred while processing your request. | 內部錯誤,請重試。如果多次嘗試失敗,請提交工單。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-05-29 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-02-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-09-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-09-18 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-05-25 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |