獲取復制規則
更新時間 2023-10-23 10:07:11
最近更新時間: 2023-10-23 10:07:11
分享文章
接口介紹
可通過此接口查詢存儲桶復制規則。
接口約束
無。
請求URI
POST /v1/crossRegionReplication/list
路徑參數
無
Query參數
無
請求參數
請求header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| content-type | 是 | String | 獲取復制規則請求header參數，默認為applicatin/json。 | applicatin/json |
請求body參數
| 字段 | 類型 | 必填 | 含義 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionCode | String | 是 | 區域編碼。 | 0001 | |
| bucket | String | 是 | 桶名。 | test |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 本次請求的結果碼。 | 0 | |
| error | 是 | String | 錯誤碼，獲取成功時，不返回該字段。 | ||
| message | 是 | String | 錯誤文本信息，獲取成功時，為空字符串。 | ||
| returnObj | 是 | String of Object | 返回結果。 | returnObj |
表 returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | String | 業務返回碼。 | 0 | |
| data | 是 | String | 業務返回數據。 | data | |
| message | 是 | String | 業務消息。 |
表 data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| userName | 是 | String | 用戶名。 | test | |
| ruleName | 是 | String | 規則名稱。 | rule1 | |
| templateId | 是 | Integer | 規則在后端的id。 | 123 | |
| bucket | 是 | String | 桶名稱。 | bucket2 | |
| regionCode | 是 | String | 區域編碼。 | 00002 | |
| dstBucket | 是 | String | 目標桶名稱。 | bucket1 | |
| dstRegionCode | 是 | String | 目標存儲區域。 | 00001 | |
| syncRule | 是 | String | 同步策略，CU: 增/改同步，CUD: 增/改/刪同步。 | CUD | |
| status | 是 | String | 規則狀態, F0A:開啟; F0X:關閉。 | F0A | |
| isSynchronized | 是 | String | 是否同步歷史數據, F0A:同步; F0X:不同步。 | F0A | |
| dstRegionName | 是 | String | 目標存儲區域名稱。 | 廣東資源池1區 | |
| storageClass | 是 | String | 存儲類型。 | STANDARD | |
| createTime | 是 | Long | 創建時間。 | 1681896531000 | |
| updateTime | 是 | Long | 更新時間。 | 1681896531000 | |
| id | 是 | Long | 規則在中臺的id。 | 1 | |
| isSystem | 是 | Integer | 是否是系統模板，0否，1是。 | 0 |
請求示例
POST /v1/crossRegionReplication/list?regionCode=0001&bucket=test
請求header示例
content-type:applicatin/json
請求體body
{
"bucket":"bucket2",
"regionCode":"0001"
}
響應示例
{
"statusCode": "0",
"message": "",
"returnObj": {
"code": "0",
"data": [
{
"userName": "test",
"ruleName": "rul2q",
"templateId": "123",
"bucket": "bucket2",
"regionCode": "00002",
"dstBucket": "bucket1",
"dstRegionCode": "00001",
"syncRule": "CUD",
"status": "F0A",
"isSynchronized": "F0A",
"dstRegionName": "廣東資源池1區",
"storageClass": "STANDARD",
"isSystem": 0,
"id": 44,
"createTime": 1681896531000,
"updateTime": 1681896531000
}
],
"message": ""
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 0 | 表示業務成功。 |
| 400 | 請求參數有誤。 |
| 403 | 用戶鑒權失敗，用戶無操作權限。 |
| 404 | 請求的資源不存在，輸入錯誤的URL。 |
| 500 | 業務執行異常。 |
