讓您全面了解并上手億速云產品
常見入門級使用教程
對外 API 開發文檔中心
您歷史提交的工單
您的每一條意見,我們都嚴謹處理
您的每一條建議,我們都認真對待
https://api.yisu.com/redis/instance/getInstanceList
POST
application/x-www-form-urlencoded
以下請求參數列表僅列出了接口請求參數和部分公共參數,完整公共參數列表見 公共請求參數。
名稱 | 類型 | 是否必填 | 說明 |
---|---|---|---|
currentPage | string | 否 | |
pageSize | string | 否 |
名稱 | 類型 | 是否必須 | 默認值 | 備注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必須 | 錯誤碼 | ||
message | string | 非必須 | 錯誤信息 | ||
data | object | 非必須 | 返回數據 | ||
├─ Instances | object [] | 非必須 | 實例列表 | item 類型: object | |
├─ instanceId | string | 非必須 | 實例ID | ||
├─ instanceName | string | 非必須 | 實例名稱 | ||
├─ innerAddress | string | 非必須 | 內網連接地址 | ||
├─ instanceVersion | string | 非必須 | 版本ID | ||
├─ instanceStatus | string | 非必須 | 狀態:Running(運行中),Creating(創建中),Recovering(備份恢復中),Reloading(重啟中),Overdue(已過期),Abnormal(異常),Forbidden(已禁用),Flushing(清除數據中),Backuping(備份中) | ||
├─ instanceExpired | number | 非必須 | 是否過期 | ||
├─ instanceConfigure | string | 非必須 | 配置 | ||
├─ instanceMemory | string | 非必須 | 內存(G) | ||
├─ versionClass | string | 非必須 | 版本號(2.8, 4.0, 5.0) | ||
├─ memoryUsage | string | 非必須 | 內存使用率 | ||
├─ maxInnerBandwidth | string | 非必須 | 最大內網帶寬 | ||
├─ maxConnections | string | 非必須 | 最大連接數 | ||
├─ createTime | string | 非必須 | 開通時間 | ||
├─ expireTime | string | 非必須 | 有效期 | ||
├─ regionId | number | 非必須 | 機房ID | ||
├─ currentPage | number | 非必須 | 頁碼 | ||
├─ pageSize | string | 非必須 | 每頁數量 | ||
├─ totalResult | string | 非必須 | 總記錄數 | ||
requestId | string | 非必須 | 請求ID |
curl -XPOST
"https://api.yisu.com/redis/instance/getInstanceList" \
-H "content-type: application/x-www-form-urlencoded" \
-d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D¤tPage=2=pageSize=2"
{
"code": 200,
"message": "請求成功",
"data": {
"Instances": [
{
"instanceId": "yisuredis-60exxxxx663-40223956",
"instanceName": "yisuredis-60exxxxxx663-40223956",
"innerAddress": "172.248.190.40",
"instanceVersion": "Redis 5.0",
"instanceStatus": "normal",
"instanceExpired": 0,
"instanceConfigure": "2G主從版",
"instanceMemory": "2",
"versionClass": "5.0",
"memoryUsage": "0.06%",
"maxInnerBandwidth": "16",
"maxConnections": "10000",
"createTime": "2021-07-13 10:35:09",
"expireTime": "2021-08-13 00:00:00",
"regionId": 2
}
],
"currentPage": 1,
"pageSize": "2",
"totalResult": "1"
},
"requestId": "916638ac440ee68523bc0a64696e3ed5"
}
https://api.yisu.com/redis/instance/getInstanceDetails
POST
application/x-www-form-urlencoded
以下請求參數列表僅列出了接口請求參數和部分公共參數,完整公共參數列表見 公共請求參數。
名稱 | 類型 | 是否必填 | 說明 |
---|---|---|---|
instanceId | string | 是 | 實例ID |
名稱 | 類型 | 是否必須 | 默認值 | 備注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必須 | 錯誤碼 | ||
message | string | 非必須 | 錯誤信息 | ||
data | object | 非必須 | 返回數據 | ||
├─ instanceAttribute | object | 非必須 | 實例信息 | ||
├─ instanceId | string | 非必須 | 實例ID | ||
├─ instanceName | string | 非必須 | 實例名 | ||
├─ innerAddress | string | 非必須 | 內網連接地址 | ||
├─ instanceVersion | string | 非必須 | 版本ID | ||
├─ instanceStatus | string | 非必須 | 狀態:Running(運行中),Creating(創建中),Recovering(備份恢復中),Reloading(重啟中),Overdue(已過期),Abnormal(異常),Forbidden(已禁用),Flushing(清除數據中),Backuping(備份中) | ||
├─ instanceExpired | number | 非必須 | 是否過期 | ||
├─ instanceConfigure | string | 非必須 | 配置 | ||
├─ instanceMemory | number | 非必須 | 內存 | ||
├─ versionClass | string | 非必須 | 版本號 | ||
├─ memoryUsage | string | 非必須 | 內存使用率 | ||
├─ maxInnerBandwidth | number | 非必須 | 最大內網帶寬 | ||
├─ maxConnections | number | 非必須 | 最大連接數 | ||
├─ createTime | string | 非必須 | 開通時間 | ||
├─ expireTime | string | 非必須 | 過期時間 | ||
├─ regionId | number | 非必須 | 機房ID | ||
requestId | string | 非必須 | 請求ID |
curl -XPOST
"https://api.yisu.com/redis/instance/getInstanceDetails" \
-H "content-type: application/x-www-form-urlencoded" \
-d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60exxxxxxx663-40223956"
{
"code": 200,
"message": "請求成功",
"data": {
"instanceAttribute": {
"instanceId": "yisuredis-60exxxxxx663-40223956",
"instanceName": "yisuredis-60exxxxxxx663-40223956",
"innerAddress": "172.248.190.40",
"instanceVersion": "Redis 5.0",
"instanceStatus": "normal",
"instanceExpired": 0,
"instanceConfigure": "2G主從版",
"instanceMemory": 2,
"versionClass": "5.0",
"memoryUsage": "0.06%",
"maxInnerBandwidth": 16,
"maxConnections": 10000,
"createTime": "2021-07-13 10:35:09",
"expireTime": "2021-08-13 00:00:00",
"regionId": 2
}
},
"requestId": "31efe98f2c7004f76508f0fa477b6b1b"
}
https://api.yisu.com/redis/instance/modifyInstanceInfo
POST
application/x-www-form-urlencoded
以下請求參數列表僅列出了接口請求參數和部分公共參數,完整公共參數列表見 公共請求參數。
名稱 | 類型 | 是否必填 | 說明 |
---|---|---|---|
instanceId | string | 是 | 實例ID |
instanceName | string | 是 | 實例名稱 |
名稱 | 類型 | 是否必須 | 默認值 | 備注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必須 | 錯誤碼 | ||
message | string | 非必須 | 錯誤信息 | ||
requestId | string | 非必須 | 請求ID |
curl -XPOST
"https://api.yisu.com/redis/instance/modifyInstanceInfo" \
-H "content-type: application/x-www-form-urlencoded" \
-d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60exxxxxxx663-40223956=instanceName=api%E6%B5%8B%E8%AF%95Redis"
{
"code": 200,
"message": "請求成功",
"requestId": "ada0f4dae3c74e11fcba7afc3de6fdc4"
}
https://api.yisu.com/redis/instance/reloadInstance
POST
application/x-www-form-urlencoded
以下請求參數列表僅列出了接口請求參數和部分公共參數,完整公共參數列表見 公共請求參數。
名稱 | 類型 | 是否必填 | 說明 |
---|---|---|---|
instanceId | string | 是 | 實例ID |
名稱 | 類型 | 是否必須 | 默認值 | 備注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必須 | 錯誤碼 | ||
message | string | 非必須 | 錯誤信息 | ||
requestId | string | 非必須 | 請求ID |
curl -XPOST
"https://api.yisu.com/redis/instance/reloadInstance" \
-H "content-type: application/x-www-form-urlencoded" \
-d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60exxxxxxx663-40223956"
{
"code": 200,
"message": "請求成功",
"requestId": "07917179235e9350c37f6e8a88c80716"
}
https://api.yisu.com/redis/instance/flushInstance
POST
application/x-www-form-urlencoded
以下請求參數列表僅列出了接口請求參數和部分公共參數,完整公共參數列表見 公共請求參數。
名稱 | 類型 | 是否必填 | 說明 |
---|---|---|---|
instanceId | string | 是 | 實例ID |
名稱 | 類型 | 是否必須 | 默認值 | 備注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必須 | 錯誤碼 | ||
message | string | 非必須 | 錯誤信息 | ||
requestId | string | 非必須 | 請求ID |
curl -XPOST
"https://api.yisu.com/redis/instance/flushInstance" \
-H "content-type: application/x-www-form-urlencoded" \
-d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60exxxxxxx663-40223956"
{
"code": 200,
"message": "請求成功",
"requestId": "a1c0bb820c24cd37d12e1e00039dfc6e"
}
https://api.yisu.com/redis/public/createInstance
POST
application/x-www-form-urlencoded
以下請求參數列表僅列出了接口請求參數和部分公共參數,完整公共參數列表見 公共請求參數。
名稱 | 類型 | 是否必填 | 說明 |
---|---|---|---|
instanceMonth | string | 是 | 購買月份 |
regionId | string | 是 | 機房ID |
versionClass | string | 是 | 版本號 |
configureId | string | 是 | 配置ID |
instanceNum | string | 是 | 購買數量 |
isAutoPwd | string | 是 | 是否自動生成密碼 |
password | string | 是 | 密碼 |
confirmPassword | string | 是 | 確認密碼 |
名稱 | 類型 | 是否必須 | 默認值 | 備注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必須 | 錯誤碼 | ||
message | string | 非必須 | 錯誤信息 | ||
data | object | 非必須 | 返回數據 | ||
├─ orderId | string | 必須 | 訂單ID | ||
├─ instanceId | string | 必須 | 實例ID | ||
├─ expireTime | string | 必須 | 到期時間 | ||
requestId | string | 非必須 | 請求ID |
curl -XPOST
"https://api.yisu.com/redis/public/createInstance" \
-H "content-type: application/x-www-form-urlencoded" \
-d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceMonth=1=regionId=2=versionClass=4.0=configureId=868=instanceNum=1=isAutoPwd=1=password==confirmPassword="
{
"code": 17031,
"message": "當前配置不存在",
"requestId": "b3a2d08b7388f3c4397d7a298fa8da5c"
}
https://api.yisu.com/redis/instance/renewInstance
POST
application/x-www-form-urlencoded
以下請求參數列表僅列出了接口請求參數和部分公共參數,完整公共參數列表見 公共請求參數。
名稱 | 類型 | 是否必填 | 說明 |
---|---|---|---|
instanceId | string | 是 | 實例ID |
instanceMonth | string | 是 | 續費月份 |
名稱 | 類型 | 是否必須 | 默認值 | 備注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必須 | 錯誤碼 | ||
message | string | 非必須 | 錯誤信息 | ||
data | object | 非必須 | 返回數據 | ||
├─ orderId | string | 非必須 | 訂單ID | ||
├─ instanceId | string | 非必須 | 實例ID | ||
├─ expireTime | string | 非必須 | 到期時間 | ||
requestId | string | 非必須 | 請求ID |