云數據庫MySQL

幫助中心 > 數據庫 > 云數據庫MySQL > API文檔 > 實例相關

實例相關

1.實例列表

接口地址

https://api.yisu.com/rds/instance/getInstanceList

HTTP METHOD

POST

HTTP BODY編碼格式

application/x-www-form-urlencoded

請求參數

以下請求參數列表僅列出了接口請求參數和部分公共參數，完整公共參數列表見公共請求參數。

名稱	類型	是否必填	說明
currentPage	string	否	頁碼
pageSize	string	否	每頁數量

返回數據

名稱	類型	是否必須	備注	其他信息
code	number	非必須	錯誤碼
message	string	非必須	錯誤信息
data	object	非必須	返回數據
├─ Instances	object []	非必須	實例列表	item 類型: object
├─ instanceId	string	必須	實例ID
├─ instanceName	string	必須	實例名稱
├─ instanceType	string	必須	實例類型:Primary常規實例,Readonly只讀實例
├─ instanceStatus	string	必須	實例狀態：Running(運行中),Creating(創建中),BackupPolicySetting(設置備份策略中),Recovering(恢復備份中),Reloading(重啟中),Overdue(已過期),Abnormal(異常),ConfigureChanging(變更配置中),Deleting(刪除中),NetworkCreating(創建網絡中),NetworkChanging(修改網絡中),NetworkReleasing(釋放網絡中)
├─ instanceSeries	string	必須	系列,high高可用,basic基礎版
├─ dbEngine	string	必須	數據庫類型 Mysql
├─ engineVersion	string	必須	數據庫版本5.6, 5.7,8.0
├─ createTime	string	必須	開通時間
├─ expireTime	string	必須	到期時間
├─ regionId	integer	必須	機房id
├─ instanceExpired	integer	必須	是否已過期，1是0否
├─ instanceConfigure	string	必須	配置
├─ instanceCpu	integer	必須	vcpu核數
├─ instanceMemory	integer	必須	內存大小
├─ maxIOPS	integer	必須	最大IOPS
├─ maxConnections	integer	必須	最大連接數
├─ field_1	string	必須
├─ pageSize	number	非必須	每頁數量
├─ totalResult	string	非必須	總數量
requestId	string	非必須	請求ID

請求示例

    curl -XPOST
    "https://api.yisu.com/rds/instance/getInstanceList" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D¤tPage=1=pageSize=2"

返回示例

{
    "code": 200,
    "message": "請求成功",
    "data": {
        "Instances": [
            {
                "instanceId": "yisurds-60dxxxxc5a30-03197834",
                "instanceName": "yisurds-60dcxxxxc5a30-03197834",
                "instanceType": "Primary",
                "instanceStatus": "Running",
                "instanceSeries": "high",
                "dbEngine": "Mysql",
                "engineVersion": "5.7",
                "createTime": "2021-06-30 15:18:43",
                "expireTime": "2021-07-30 15:18:43",
                "regionId": 2,
                "instanceExpired": 0,
                "instanceConfigure": "通用型1核2G",
                "instanceCpu" : 2,
                "instanceMemory" : 4,
                "maxIOPS" : 5000,
                "maxConnections" : 1200
            }
        ],
        "currentPage": 1,
        "pageSize": 2,
        "totalResult": "4"
    },
    "requestId": "032cfa2836b4c64abd4c329924f41acb"
}

2.實例詳情

接口地址

https://api.yisu.com/rds/instance/getInstanceInfo

HTTP METHOD

POST

HTTP BODY編碼格式

application/x-www-form-urlencoded

請求參數

以下請求參數列表僅列出了接口請求參數和部分公共參數，完整公共參數列表見公共請求參數。

名稱	類型	是否必填	說明
instanceId	string	是	實例Id

返回數據

名稱	類型	是否必須	備注	其他信息
code	number	非必須	錯誤碼
message	string	非必須	錯誤信息
data	object	非必須	返回數據
├─ instanceAttributes	object	非必須	實例信息
├─ instanceId	string	非必須	實例ID
├─ instanceName	string	非必須	實例名稱
├─ instanceType	string	非必須	實例類型:Primary常規實例,Readonly只讀實例
├─ instanceEngine	string	非必須	數據庫類型 Mysql
├─ engineVersion	string	非必須	數據庫版本5.6, 5.7,8.0
├─ instanceStatus	string	非必須	實例狀態：Running(運行中),Creating(創建中),BackupPolicySetting(設置備份策略中),Recovering(恢復備份中),Reloading(重啟中),Overdue(已過期),Abnormal(異常),ConfigureChanging(變更配置中),Deleting(刪除中),NetworkCreating(創建網絡中),NetworkChanging(修改網絡中),NetworkReleasing(釋放網絡中)
├─ createTime	string	非必須	開通時間
├─ expireTime	string	非必須	到期時間
├─ regionId	number	非必須	機房id
├─ instanceExpired	number	非必須	是否已過期，1是0否
├─ maintainTime	string	非必須	可維護時間
├─ instanceConfigure	string	非必須	配置
├─ configureClass	string	非必須	配置規格標識
├─ instanceCpu	number	非必須	cpu大小
├─ instanceMemory	number	非必須	內存大小
├─ maxIOPS	number	非必須	最大IOPS
├─ maxConnections	number	非必須	最大連接數
├─ instanceStorage	number	非必須	磁盤大小
├─ innerConnectAddress	string	非必須	內網連接地址
├─ innerConnectPort	number	非必須	內網連接端口
├─ payType	string	非必須	支付方式：prePay預支付
├─ connections	object []	非必須	連接信息	item 類型: object
├─ connectionId	string	非必須	連接id
├─ connectionType	string	非必須	連接類型 outer
├─ connectionHost	string	非必須	連接地址
├─ connectionValue	string	非必須	連接字符串
├─ maxBandwidth	string	非必須	最大帶寬
├─ maxConnections	string	非必須	最大連接數
├─ isMaxSpeed	string	非必須	是否已提速
├─ instanceTags	string []	非必須		item 類型: string
├─		非必須
├─ storage_type	string	非必須	磁盤類型：ssd
├─ instanceSeries	string	非必須	系列,high高可用,basic基礎版
requestId	string	非必須	請求ID

請求示例

    curl -XPOST
    "https://api.yisu.com/rds/instance/getInstanceInfo" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171"

返回示例

{
    "code": 200,
    "message": "請求成功",
    "data": {
        "instanceAttributes": {
            "instanceId": "yisurds-60e69eab6173d8-66643171",
            "instanceName": "yisurds-60e69eab6173d8-66643171",
            "instanceType": "Primary",
            "instanceEngine": "Mysql",
            "engineVersion": "8.0",
            "instanceStatus": "Running",
            "createTime": "2021-07-08 14:43:55",
            "expireTime": "2021-08-08 14:43:55",
            "regionId": 9,
            "instanceExpired": 0,
            "maintainTime": "02:00-06:00",
            "instanceConfigure": "通用型1核2G",
            "configureClass": "rds-8-1-3-9",
            "instanceCpu": 1,
            "instanceMemory": 2048,
            "maxIOPS": 1000,
            "maxConnections": 600,
            "instanceStorage": 20,
            "innerConnectAddress": "111.111.111.111",
            "innerConnectPort": 3306,
            "payType": "prePay",
            "connections": [
                {
                    "connectionId": "477",
                    "connectionType": "outer",
                    "connectionHost": "yisurds-60e69eab6173d8.rds.ysydb1.com",
                    "connectionValue": "yisurds-60e69eab6173d8",
                    "maxBandwidth": "5M",
                    "maxConnections": "20",
                    "isMaxSpeed": "0"
                }
            ],
            "instanceTags": [],
            "storage_type": "ssd",
            "instanceSeries": "high"
        }
    },
    "requestId": "0a1288402501ebafc4b091836db85b7a"
}

3.設置可維護時間

接口地址

https://api.yisu.com/rds/instance/setInstanceMaintainTime

HTTP METHOD

POST

HTTP BODY編碼格式

application/x-www-form-urlencoded

請求參數

以下請求參數列表僅列出了接口請求參數和部分公共參數，完整公共參數列表見公共請求參數。

名稱	類型	是否必填	說明
instanceId	string	是	實例Id
maintainTime	string	是	可維護時間,如：6-7

返回數據

名稱	類型	是否必須	備注
code	number	非必須	錯誤碼
message	string	非必須	錯誤信息
requestId	string	非必須	請求ID

請求示例

    curl -XPOST
    "https://api.yisu.com/rds/instance/setInstanceMaintainTime" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171=maintainTime=6-7"

返回示例

{
    "code": 200,
    "message": "請求成功",
    "requestId": "40dc920bb9615b3275a5e8ef038e30c3"
}

4.重啟實例

接口地址

https://api.yisu.com/rds/instance/reloadInstance

HTTP METHOD

POST

HTTP BODY編碼格式

application/x-www-form-urlencoded

請求參數

以下請求參數列表僅列出了接口請求參數和部分公共參數，完整公共參數列表見公共請求參數。

名稱	類型	是否必填	說明
instanceId	string	是	實例Id

返回數據

名稱	類型	是否必須	備注
code	number	非必須	錯誤碼
message	string	非必須	錯誤信息
requestId	string	非必須	請求ID

請求示例

    curl -XPOST
    "https://api.yisu.com/rds/instance/reloadInstance" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171"

返回示例

{
    "code": 200,
    "message": "請求成功",
    "requestId": "8a2885ff0cdf601e81cd970e51ed0f23"
}

5.創建實例

注意

請求創建實例接口時億速云賬號必須有足夠余額，否則無法支付成功，導致創建實例失敗

接口地址

https://api.yisu.com/rds/public/createInstance

HTTP METHOD

POST

HTTP BODY編碼格式

application/x-www-form-urlencoded

請求參數

以下請求參數列表僅列出了接口請求參數和部分公共參數，完整公共參數列表見公共請求參數。

名稱	類型	是否必填	說明
instanceMonth	string	是	購買月份
configureId	string	是	配置ID
regionId	string	是	機房ID
instanceStorage	string	是	磁盤大小
instanceSeries	string	是	系列
storageType	string	是	磁盤類型(ssd)
version	string	是	數據庫版本(5.6，5.7，8.0)
instanceNetwork	string	是	網絡類型(Classic)

返回數據

名稱	類型	是否必須	備注
code	integer	必須	錯誤碼
message	string	必須	錯誤信息
data	object	必須	返回數據
├─ orderId	string	必須	訂單ID
├─ instanceId	string	必須	實例ID
├─ expireTime	string	必須	到期時間
requestId	string	必須	請求ID

請求示例

    curl -XPOST
    "https://api.yisu.com/rds/public/createInstance" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceMonth=1=configureId=113=regionId=48=instanceStorage=20=instanceSeries=high=storageType=ssd=version=5.6=instanceNetwork=Classic"

返回示例

{
    "code": 200,
    "message": "請求成功",
    "data": {
        "orderId": "cor-60e9446fddc102-4",
        "instanceId": "yisurds-60e69eab6173d8-66643171",
        "innerConnectAddress": "111.111.111.111",
        "innerConnectPort" : 3306
    },
    "requestId": "9faec04290dce11b9721e1be925eec14"
}

6.續費實例

注意

請求續費實例接口時億速云賬號必須有足夠余額，否則無法支付成功，導致續費失敗

接口地址

https://api.yisu.com/rds/instance/renewInstance

HTTP METHOD

POST

HTTP BODY編碼格式

application/x-www-form-urlencoded

請求參數

以下請求參數列表僅列出了接口請求參數和部分公共參數，完整公共參數列表見公共請求參數。

名稱	類型	是否必填	說明
instanceId	string	是	實例Id
instanceMonth	string	是

返回結果

名稱	類型	說明
code	integer	錯誤碼
message	string	錯誤信息
data	object	返回數據
requestId	string	請求ID

返回數據

名稱	類型	是否必須	備注
code	number	非必須	錯誤碼
message	string	非必須	錯誤信息
data	object	非必須	返回數據
├─ orderId	string	非必須	訂單ID
├─ instanceId	string	非必須	實例ID
├─ expireTime	string	非必須	到期時間
requestId	string	非必須	請求ID

請求示例

    curl -XPOST
    "https://api.yisu.com/rds/instance/renewInstance" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171=instanceMonth=1"

返回示例

{
    "code": 200,
    "message": "請求成功",
    "data": {
        "orderId": "cor-60e9446fddc102-4",
        "instanceId": "yisurds-60e69eab6173d8-66643171",
        "expireTime": "2021-09-08 14:43:55"
    },
    "requestId": "9faec04290dce11b9721e1be925eec14"
}