MySQL实例管理相关接口

创建实例

描述

此接口支持通过openApi直接创建实例

URI

POST /rds-mysql/v1/instance

请求参数

返回参数

Instance:

示例

请求示例

{
    "dbInstanceIdentifier": "MySQL-1111",
    "storageType": "LOCAL_SSD",
    "allocatedStorage": 5,
    "chargeType": "hourlySettlement",
    "purchaseTime": "1",
    "count": 1,
    "dbInstanceClass": "std_1G",
    "dbInstanceType": "HARDS",
    "vpcId": "538f5658-a9ec-48e3-8e97-799ae38a6ed0",
    "subnetId": "aacc063a-fefa-4e29-81f0-d9cd5c81dc52",
    "engine": "MySQL",
    "engineVersion": "5.6",
    "masterUsername": "root",
    "masterUserPassword": "123456Aa"
}

响应示例

{
    "orderId": "313722851282067456",
    "instance":{
        "id": null,
        "createdAt": null,
        "updatedAt": null,
        "deletedAt": null,
        "isDeleted": false,
        "dbInstanceIdentifier": "yc-test",
        "availabilityZone": "cn-north-3a",
        "region": "cn-north-3",
        "account": null,
        "creator": "3b519d51-5696-453d-9390-853a9d87849d",
        "storageType": "LOCAL_SSD",
        "allocatedStorage": 5,
        "status": "CREATING",
        "chargeType": "hourlySettlement",
        "purchaseTime": "1",
        "expireTime": null,
        "count": 1,
        "characterSetName": "UTF8",
        "dbInstanceClass": "std_1G",
        "dbInstanceType": "HARDS-v2",
        "dbParameterGroupName": null,
        "vpcId": "3df78db2-ed42-4f94-b1d2-f52dfa3f968e",
        "subnetId": "4982097a-1789-492f-b89f-f41d40f9e8db",
        "engine": "MySQL",
        "engineVersion": "5.6",
        "masterUsername": "root",
        "masterUserPassword": "123456aB",
        "dbInstancePort": 3306,
        "timezone": "+08:00",
        "dbInstanceAddress": null,
        "originalBackupId": null,
        "isAutoRenew": null,
        "mainInstanceId": null,
        "readOnlyInstanceIds": null,
        "clusterState": null,
        "masterManagementIP": null,
        "slaveManagementIP": null,
        "duration": 0
    }
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例删除

描述

• 计费模式为包年包月的实例不支持删除，按需实例才支持删除操作。

URI

DELETE /rds-mysql/v1/instances/{id}

请求参数

返回参数

示例

请求示例

假设需要删除一个ID为“94d0e619-5417-4bd8-8595-d9c45f6b0afd”的按需实例，请求URL为“http://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/instances/94d0e619-5417-4bd8-8595-d9c45f6b0afd”。

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例重启

描述

• 实例重启操作成功后实例状态变为“重启中（RESTARTING）”，重启完成之后，实例状态变为“运行中”。

URI

POST /rds-mysql/v1/instances/{id}/action/restart

请求参数

返回参数

示例

请求示例

假设需要重启一个ID为“60873ce7-eee3-4832-b1c2-20b7e22a83b3”的按需实例，请求URL为“http://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/instances/60873ce7-eee3-4832-b1c2-20b7e22a83b3/actions/restart”。

响应示例

{
 "id": "d4b89d34-da9b-4fb6-b323-9aa6bd21367c",
 "createdAt": "2019-09-18 11:26:24",
 "updatedAt": "2019-09-19 11:33:04",
 "deletedAt": null,
 "isDeleted": false,
 "dbInstanceIdentifier": "sunbin-test-one",
 "availabilityZone": "cn-north-3a",
 "region": "cn-south-1",
 "account": "liying",
 "creator": "3b519d51-5696-453d-9390-853a9d87849d",
 "storageType": "LOCAL_SSD",
 "allocatedStorage": 5,
 "status": "RUNNING",
 "chargeType": "hourlySettlement",
 "purchaseTime": "1",
 "expireTime": null,
 "count": null,
 "characterSetName": "utf8",
 "dbInstanceClass": "std_1G",
 "dbInstanceType": "HARDS-v2",
 "dbParameterGroupName": null,
 "vpcId": "e6a2a747-087a-4740-8c61-d8a4fa358a85",
 "subnetId": "870c6b96-81cc-4e4a-9e5d-d1865ef3fdd6",
 "engine": "MySQL",
 "engineVersion": "5.7",
 "masterUsername": "root",
 "masterUserPassword": null,
 "dbInstancePort": 3306,
 "timezone": "+08:00",
 "dbInstanceAddress": "172.31.0.42",
 "originalBackupId": null,
 "isAutoRenew": "fasle",
 "mainInstanceId": null,
 "readOnlyInstanceIds": null
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例重命名

描述

• 实例重命名。

URI

PATCH /rds-mysql/v1/instances/{id}

请求参数

返回参数

示例

请求示例

{
    "name": "test"
}

响应示例

{
 "id": "d4b89d34-da9b-4fb6-b323-9aa6bd21367c",
 "createdAt": "2019-09-18 11:26:24",
 "updatedAt": "2019-09-19 11:33:04",
 "deletedAt": null,
 "isDeleted": false,
 "dbInstanceIdentifier": "sunbin-test-one",
 "availabilityZone": "cn-north-3a",
 "region": "cn-south-1",
 "account": "liying",
 "creator": "3b519d51-5696-453d-9390-853a9d87849d",
 "storageType": "LOCAL_SSD",
 "allocatedStorage": 5,
 "status": "RUNNING",
 "chargeType": "hourlySettlement",
 "purchaseTime": "1",
 "expireTime": null,
 "count": null,
 "characterSetName": "utf8",
 "dbInstanceClass": "std_1G",
 "dbInstanceType": "HARDS-v2",
 "dbParameterGroupName": null,
 "vpcId": "e6a2a747-087a-4740-8c61-d8a4fa358a85",
 "subnetId": "870c6b96-81cc-4e4a-9e5d-d1865ef3fdd6",
 "engine": "MySQL",
 "engineVersion": "5.7",
 "masterUsername": "root",
 "masterUserPassword": null,
 "dbInstancePort": 3306,
 "timezone": "+08:00",
 "dbInstanceAddress": "172.31.0.42",
 "originalBackupId": null,
 "isAutoRenew": "fasle",
 "mainInstanceId": null,
 "readOnlyInstanceIds": null
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例详情

描述

• 查看实例详情

URI

GET /rds-mysql/v1/instances/{id}

请求参数

返回参数

示例

请求示例

略

响应示例

{
 "id": "d4b89d34-da9b-4fb6-b323-9aa6bd21367c",
 "createdAt": "2019-09-18 11:26:24",
 "updatedAt": "2019-09-19 11:33:04",
 "deletedAt": null,
 "isDeleted": false,
 "dbInstanceIdentifier": "sunbin-test-one",
 "availabilityZone": "cn-north-3a",
 "region": "cn-south-1",
 "account": "liying",
 "creator": "3b519d51-5696-453d-9390-853a9d87849d",
 "storageType": "LOCAL_SSD",
 "allocatedStorage": 5,
 "status": "RUNNING",
 "chargeType": "hourlySettlement",
 "purchaseTime": "1",
 "expireTime": null,
 "count": null,
 "characterSetName": "utf8",
 "dbInstanceClass": "std_1G",
 "dbInstanceType": "HARDS-v2",
 "dbParameterGroupName": null,
 "vpcId": "e6a2a747-087a-4740-8c61-d8a4fa358a85",
 "subnetId": "870c6b96-81cc-4e4a-9e5d-d1865ef3fdd6",
 "engine": "MySQL",
 "engineVersion": "5.7",
 "masterUsername": "root",
 "masterUserPassword": null,
 "dbInstancePort": 3306,
 "timezone": "+08:00",
 "dbInstanceAddress": "172.31.0.42",
 "originalBackupId": null,
 "isAutoRenew": "fasle",
 "mainInstanceId": null,
 "readOnlyInstanceIds": null
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例列表

描述

• 获取所有实例列表

URI

GET /rds-mysql/v1/instances

请求参数

返回参数

示例

请求示例

响应示例

[
 {
  "id": "d4b89d34-da9b-4fb6-b323-9aa6bd21367c",
  "createdAt": "2019-09-18 11:26:24",
  "updatedAt": "2019-09-19 11:33:04",
  "deletedAt": null,
  "isDeleted": false,
  "dbInstanceIdentifier": "sunbin-test-one",
  "availabilityZone": "cn-north-3a",
  "region": "cn-south-1",
  "account": "liying",
  "creator": "3b519d51-5696-453d-9390-853a9d87849d",
  "storageType": "LOCAL_SSD",
  "allocatedStorage": 5,
  "status": "RUNNING",
  "chargeType": "hourlySettlement",
  "purchaseTime": "1",
  "expireTime": null,
  "count": null,
  "characterSetName": "utf8",
  "dbInstanceClass": "std_1G",
  "dbInstanceType": "HARDS-v2",
  "dbParameterGroupName": null,
  "vpcId": "e6a2a747-087a-4740-8c61-d8a4fa358a85",
  "subnetId": "870c6b96-81cc-4e4a-9e5d-d1865ef3fdd6",
  "engine": "MySQL",
  "engineVersion": "5.7",
  "masterUsername": "root",
  "masterUserPassword": null,
  "dbInstancePort": 3306,
  "timezone": "+08:00",
  "dbInstanceAddress": "172.31.0.42",
  "originalBackupId": null,
  "isAutoRenew": "fasle",
  "mainInstanceId": null,
  "readOnlyInstanceIds": null
 },
 {
  "id": "a0b762ae-d6ec-4c2a-8a16-f23170cbf8d7",
  "createdAt": "2019-09-17 12:25:30",
  "updatedAt": "2019-09-19 07:32:13",
  "deletedAt": null,
  "isDeleted": false,
  "dbInstanceIdentifier": "yctest",
  "availabilityZone": "cn-north-3a",
  "region": "cn-north-3",
  "account": "liying",
  "creator": "3b519d51-5696-453d-9390-853a9d87849d",
  "storageType": "LOCAL_SSD",
  "allocatedStorage": 5,
  "status": "RUNNING",
  "chargeType": "monthly",
  "purchaseTime": "1",
  "expireTime": "2019-10-18 00:00:00",
  "count": null,
  "characterSetName": "utf8",
  "dbInstanceClass": "std_1G",
  "dbInstanceType": "HARDS-v2",
  "dbParameterGroupName": null,
  "vpcId": "e6a2a747-087a-4740-8c61-d8a4fa358a85",
  "subnetId": "870c6b96-81cc-4e4a-9e5d-d1865ef3fdd6",
  "engine": "MySQL",
  "engineVersion": "5.7",
  "masterUsername": "root",
  "masterUserPassword": null,
  "dbInstancePort": 3306,
  "timezone": "+08:00",
  "dbInstanceAddress": "172.31.0.14",
  "originalBackupId": null,
  "isAutoRenew": "false",
  "mainInstanceId": null,
  "readOnlyInstanceIds": [
   "d2834321-a878-493b-baa2-2a5b71b1c654",
   "943eae8c-fccc-4c55-a96e-a631b2835ed8"
  ]
 }
]

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例分页列表

描述

• 获取所有实例的分页列表

• 根据过滤字段，筛选出“名称/ID/内网IP”符合条件的实例列表。

URI

GET /rds-mysql/v1/instances/{pageNo}/{pageSize}

请求参数

返回参数

示例

请求示例

假设需要查看当前用户所有实例列表，请求URL为“https://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/instances/1/10?filter=”。

响应示例

{
 "pageNo": 1,
 "pageSize": 10,
 "totalCount": 2,
 "data": [
  {
   "id": "d4b89d34-da9b-4fb6-b323-9aa6bd21367c",
   "createdAt": "2019-09-18 11:26:24",
   "updatedAt": "2019-09-19 11:33:04",
   "deletedAt": null,
   "isDeleted": false,
   "dbInstanceIdentifier": "sunbin-test-one",
   "availabilityZone": "cn-north-3a",
   "region": "cn-south-1",
   "account": "liying",
   "creator": "3b519d51-5696-453d-9390-853a9d87849d",
   "storageType": "LOCAL_SSD",
   "allocatedStorage": 5,
   "status": "RUNNING",
   "chargeType": "hourlySettlement",
   "purchaseTime": "1",
   "expireTime": null,
   "count": null,
   "characterSetName": "utf8",
   "dbInstanceClass": "std_1G",
   "dbInstanceType": "HARDS-v2",
   "dbParameterGroupName": null,
   "vpcId": "e6a2a747-087a-4740-8c61-d8a4fa358a85",
   "subnetId": "870c6b96-81cc-4e4a-9e5d-d1865ef3fdd6",
   "engine": "MySQL",
   "engineVersion": "5.7",
   "masterUsername": "root",
   "masterUserPassword": null,
   "dbInstancePort": 3306,
   "timezone": "+08:00",
   "dbInstanceAddress": "172.31.0.42",
   "originalBackupId": null,
   "isAutoRenew": "fasle",
   "mainInstanceId": null,
   "readOnlyInstanceIds": null
  },
  {
   "id": "a0b762ae-d6ec-4c2a-8a16-f23170cbf8d7",
   "createdAt": "2019-09-17 12:25:30",
   "updatedAt": "2019-09-19 07:32:13",
   "deletedAt": null,
   "isDeleted": false,
   "dbInstanceIdentifier": "yctest",
   "availabilityZone": "cn-north-3a",
   "region": "cn-north-3",
   "account": "liying",
   "creator": "3b519d51-5696-453d-9390-853a9d87849d",
   "storageType": "LOCAL_SSD",
   "allocatedStorage": 5,
   "status": "RUNNING",
   "chargeType": "monthly",
   "purchaseTime": "1",
   "expireTime": "2019-10-18 00:00:00",
   "count": null,
   "characterSetName": "utf8",
   "dbInstanceClass": "std_1G",
   "dbInstanceType": "HARDS-v2",
   "dbParameterGroupName": null,
   "vpcId": "e6a2a747-087a-4740-8c61-d8a4fa358a85",
   "subnetId": "870c6b96-81cc-4e4a-9e5d-d1865ef3fdd6",
   "engine": "MySQL",
   "engineVersion": "5.7",
   "masterUsername": "root",
   "masterUserPassword": null,
   "dbInstancePort": 3306,
   "timezone": "+08:00",
   "dbInstanceAddress": "172.31.0.14",
   "originalBackupId": null,
   "isAutoRenew": "false",
   "mainInstanceId": null,
   "readOnlyInstanceIds": [
    "d2834321-a878-493b-baa2-2a5b71b1c654",
    "943eae8c-fccc-4c55-a96e-a631b2835ed8"
   ]
  }
 ]
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例统计

描述

• 统计实例近期创建、即将过期、已过期、运行中的数量。

URI

GET /rds-mysql/v1/instances/statistics

请求参数

返回参数

示例

请求示例

http://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/instances/statistics

响应示例

{
    "running": 4,
    "total": 4,
    "dated": 0,
    "dating": 0,
    "creation": 1
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例数量

描述

• 查看已经购买的产品的总数量。

URI

GET /rds-mysql/v1/instance-num

请求参数

返回参数

示例

请求示例

响应示例

{
    "code": 200,
    "message": "get instance_num success",
    "data": 4
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例配额

描述

• 查看购买产品是否超过配额，没有超过配额，就可以购买，返回true，否则返回false。

URI

GET /rds-mysql/v1/instance-quota

请求参数

返回参数

示例

请求示例

响应示例

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例存储扩容

描述

此接口支持通过openApi直接对实例进行存储扩容

URI

POST /rds-mysql/v1/instances/{id}/action/modify-storage

请求参数

返回参数

示例

请求示例

{
    "storageSize": 10
}

响应示例

{
 "id": "d4b89d34-da9b-4fb6-b323-9aa6bd21367c",
 "createdAt": "2019-09-18 11:26:24",
 "updatedAt": "2019-09-19 11:33:04",
 "deletedAt": null,
 "isDeleted": false,
 "dbInstanceIdentifier": "sunbin-test-one",
 "availabilityZone": "cn-north-3a",
 "region": "cn-south-1",
 "account": "liying",
 "creator": "3b519d51-5696-453d-9390-853a9d87849d",
 "storageType": "LOCAL_SSD",
 "allocatedStorage": 5,
 "status": "EXTENDING",
 "chargeType": "hourlySettlement",
 "purchaseTime": "1",
 "expireTime": null,
 "count": null,
 "characterSetName": "utf8",
 "dbInstanceClass": "std_1G",
 "dbInstanceType": "HARDS-v2",
 "dbParameterGroupName": null,
 "vpcId": "e6a2a747-087a-4740-8c61-d8a4fa358a85",
 "subnetId": "870c6b96-81cc-4e4a-9e5d-d1865ef3fdd6",
 "engine": "MySQL",
 "engineVersion": "5.7",
 "masterUsername": "root",
 "masterUserPassword": null,
 "dbInstancePort": 3306,
 "timezone": "+08:00",
 "dbInstanceAddress": "172.31.0.42",
 "originalBackupId": null,
 "isAutoRenew": "fasle",
 "mainInstanceId": null,
 "readOnlyInstanceIds": null
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例扩容信息

描述

• 查询实例扩容信息，包括：实例扩容总次数，已经扩容次数，剩余扩容次数。

URI

GET /rds-mysql/v1/instances/{id}/extend-storage-count

请求参数

返回参数

示例

请求示例

响应示例

{
    "total": 23,
    "left": 0,
    "used": 23
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例算费

描述

• ‘控制台’在云服务器的选配页面将用户选择的云服务器商品通过后台参数传递的方式传递到‘订单中心’，在该功能中完成算费，支持新建，更配等算费。

URI

POST /rds-mysql/v1/instance-price

请求参数

返回参数

Activity:

示例

  https://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/instance-price?orderType=new

请求示例

{
    "allocatedStorage": 80,
    "chargeType": "monthly",
    "dbInstanceClass": "std_1G",
    "dbInstanceType": "HARDS",
    "region": "cn-north-3"
}

响应示例

{
    "totalMoney": "159.6000",
    "actualMoney": "159.6000",
    "couponId": null,
    "vouchersDeductMoney": null,
    "activityList": [
        {
            "discount": "1",
            "activityId": "",
            "activityDeductMoney": "0.0000",
            "activityName": "",
            "canUseCoupon": "Y"
        }
    ]
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

自动续费

描述

• 包年包月实例开启或者关闭自动续费

URI

GET /rds-mysql/v1/instances/{id}/action/auto-renew

请求参数

返回参数

示例

请求示例

开启自动续费：/rds-mysql/v1/instances/{id}/action/auto-renew?isAutoRenew=true

关闭自动续费：/rds-mysql/v1/instances/{id}/action/auto-renew?isAutoRenew=false

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例规格信息相关接口

规格列表

描述

• 获取所有规格列表。

URI

GET /rds-mysql/v1/instance-classes

请求参数

返回参数

InstanceClass：

示例

请求示例

响应示例

[
 {
  "id": "10",
  "createdAt": "2018-11-30 11:43:56",
  "updatedAt": null,
  "deletedAt": null,
  "isDeleted": false,
  "code": "std_128G",
  "name": "std_128G",
  "cpu": 64,
  "ram": 128,
  "maxConn": 300,
  "iops": 1000,
  "flavor": "rds-mysql_64C128G40G_general",
  "description": "标准128G规格"
 },
 {
  "id": "2",
  "createdAt": "2018-11-10 14:00:28",
  "updatedAt": null,
  "deletedAt": null,
  "isDeleted": false,
  "code": "std_1G",
  "name": "std_1G",
  "cpu": 1,
  "ram": 1,
  "maxConn": 300,
  "iops": 1000,
  "flavor": "rds-mysql_1C1G40G_general",
  "description": "标准1G规格"
 }
    ...
]

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

规格详情

描述

• 根据规格编码查看规格详情。

URI

GET /rds-mysql/v1/instance-classes/{code}

请求参数

返回参数

示例

请求示例

假设需要查看规格编码为“std_1G”的规格信息，请求URL为“http://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/instance-classes/std_1G”。

响应示例

{
 "id": "2",
 "createdAt": "2018-11-10 14:00:28",
 "updatedAt": null,
 "deletedAt": null,
 "isDeleted": false,
 "code": "std_1G",
 "name": "std_1G",
 "cpu": 1,
 "ram": 1,
 "maxConn": 300,
 "iops": 1000,
 "flavor": "rds-mysql_1C1G40G_general",
 "description": "标准1G规格"
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

数据库管理相关接口

创建数据库

描述

• 创建一个数据库。

URI

POST /rds-mysql/v1/instances/{id}/dbs

请求参数

Privilege

返回参数

Privilege

示例

请求示例

{
 "dbName": "test",
 "charset": "utf8",
 "privileges": []
}

响应示例

{
 "dbName": "test",
 "charset": "utf8",
 "privileges": []
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

数据库列表

描述

• 查看数据库列表。

URI

GET /rds-mysql/v1/instances/{id}/dbs

请求参数

返回参数

Database

Privilege

示例

请求示例

响应示例

[
 {
  "dbName": "inspur",
  "charset": "utf8mb4",
  "privileges": [
   {
    "dbName": "inspur",
    "dbCharacterSetName": "NULL",
    "userName": "inspur",
    "host": "%",
    "dbPrivileges": "Select,Insert,Update,Delete,Create,Drop,References,Index,Alter,Create_tmp_table,Lock_tables,Create_view,Show_view,Create_routine,Alter_routine,Execute,Event,Trigger",
    "dbPrivilegeType": "READWRITE"
   }
  ]
 }
]

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

删除数据库

描述

• 删除一个已经存在的数据库。

URI

DELETE /rds-mysql/v1/instances/{id}/dbs/{dbName}

请求参数

返回参数

示例

请求示例

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

账号相关接口

创建数据库账号

描述

• 创建MySQL账号，并可以给账号授权。

URI

POST /rds-mysql/v1/instances/{id}/users

请求参数

Privilege

返回参数

Privilege

示例

请求示例

{
    "name": "yc2",
    "password": "123456aB"
}

响应示例

{
    "name": "yc2",
    "status": null,
    "password": "123456aB",
    "privileges": []
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

数据库账号列表

描述

• 查看数据库账号列表。

URI

GET /rds-mysql/v1/instances/{id}/users

请求参数

返回参数

DbUSer

Privilege

示例

请求示例

响应示例

[
 {
  "name": "inspur",
  "status": "ACTIVE",
  "password": null,
  "privileges": [
   {
    "dbName": "inspur",
    "dbCharacterSetName": "NULL",
    "userName": "inspur",
    "host": "%",
    "dbPrivileges": "Select,Insert,Update,Delete,Create,Drop,References,Index,Alter,Create_tmp_table,Lock_tables,Create_view,Show_view,Create_routine,Alter_routine,Execute,Event,Trigger",
    "dbPrivilegeType": "READWRITE"
   }
  ]
 }
]

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

数据库账号删除

描述

• 删除一个已经存在的数据库账号。

URI

DELETE /rds-mysql/v1/instances/{id}/users/{userName}

请求参数

返回参数

示例

请求示例

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

授权与解除授权

描述

• 给已经存在的账号和数据库进行授权或者解除授权。

URI

PUT /rds-mysql/v1/instances/{id}/privileges

请求参数

Privilege

返回参数

示例

请求示例

{
 "grantPrivileges": [
  {
   "userName": "yc2",
   "dbName": "testa",
   "dbPrivilegeType": "READONLY"
  }
 ],
 "revokePrivileges": [
  {
   "userName": "yc1",
   "dbName": "testa",
   "dbPrivilegeType": "READONLY"
  }
 ]
}

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

重置用户密码

描述

• 重置数据库用户密码，目前仅支持root用户。

URI

PUT /rds-mysql/v1/instances/{id}/users/{accountName}/action/resetPassword

请求参数

返回参数

示例

请求示例

假设需要重置实例ID为“60873ce7-eee3-4832-b1c2-20b7e22a83b3”的ROOT用户密码，请求URL为“http://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/instances/60873ce7-eee3-4832-b1c2-20b7e22a83b3/users/root/password?accountPassword=123456aB”。

响应示例

{
    "RequestId": "9f850fc7-f2fa-41ff-8c86-fa550ebb71c0"
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

备份相关接口

实例备份

描述

• 实例备份功能目前只支持手动备份、物理全量备份功能。

URI

POST /rds-mysql/v1/instances/{id}/backups

请求参数

返回参数

示例

请求示例

{
    "name": "Backup-20190306182227",
    "backupType": "PHYSICAL",
    "backupMode": "FULL",
    "retentionDays": 7
}

响应示例

{
    "id": "ac05af37-b9b0-454a-b5dc-49dc3facf682",
    "createdAt": "2019-03-06 10:28:50",
    "updatedAt": null,
    "deletedAt": null,
    "isDeleted": false,
    "instanceId": "c11871cf-8ef2-45d9-9f83-f6df8e80c32e",
    "operationId": "016dd628-8890-4197-bee7-432dbd7c2628",
    "name": "Backup-20190306182228",
    "backupType": "PHYSICAL",
    "backupMode": "FULL",
    "backupMethod": "MANUAL",
    "status": "PROCESSING",
    "size": null,
    "container": "liying",
    "file": "mysql/c11871cf-8ef2-45d9-9f83-f6df8e80c32e-20190306102893.tar.gzip",
    "lastRecoveryTime": null,
    "retentionDays": 7,
    "isRestoring": false
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例备份列表

描述

• 查看实例备份列表。

URI

GET /rds-mysql/v1/instances/{id}/backups/{pageNo}/{pageSize}

请求参数

返回参数

示例

请求示例

响应示例

{

    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 2,
    "data": [
        {
            "id": "4fe8d8d7-0987-460d-977d-4943cb6d5b4d",
            "createdAt": "2019-03-06 10:45:49",
            "updatedAt": null,
            "deletedAt": null,
            "isDeleted": false,
            "instanceId": "60873ce7-eee3-4832-b1c2-20b7e22a83b3",
            "operationId": "30122419-fd64-45cd-ba1a-b47ef2588f72",
            "name": "Backup-20190306184450",
            "backupType": "PHYSICAL",
            "backupMode": "FULL",
            "backupMethod": "MANUAL",
            "status": "COMPLETED",
            "size": 282186,
            "container": "liying",
            "file": "mysql/60873ce7-eee3-4832-b1c2-20b7e22a83b3-201903061045202.tar.gzip",
            "lastRecoveryTime": null,
            "retentionDays": 7,
            "isRestoring": false
        },
        {
            "id": "c027ed75-4e4b-4c54-9067-2cccfef8c773",
            "createdAt": "2019-03-06 10:42:49",
            "updatedAt": null,
            "deletedAt": null,
            "isDeleted": false,
            "instanceId": "60873ce7-eee3-4832-b1c2-20b7e22a83b3",
            "operationId": "543004fa-7aee-4c53-b2b6-269ca111edfa",
            "name": "Backup-20190306184150",
            "backupType": "PHYSICAL",
            "backupMode": "FULL",
            "backupMethod": "MANUAL",
            "status": "COMPLETED",
            "size": 282187,
            "container": "liying",
            "file": "mysql/60873ce7-eee3-4832-b1c2-20b7e22a83b3-20190306104292.tar.gzip",
            "lastRecoveryTime": null,
            "retentionDays": 7,
            "isRestoring": false
        }
    ]
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例备份删除

描述

• 删除实例的某个备份。

URI

DELETE /rds-mysql/v1/instances/{id}/backups/{backupId}

请求参数

返回参数

示例

请求示例

假设需要删除实例ID为“60873ce7-eee3-4832-b1c2-20b7e22a83b3”的备份“4fe8d8d7-0987-460d-977d-4943cb6d5b4d”，请求URL为“http://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/instances/60873ce7-eee3-4832-b1c2-20b7e22a83b3/backups/4fe8d8d7-0987-460d-977d-4943cb6d5b4d”。

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例备份额外信息

描述

• 查询实例备份额外信息，包括此备份所在实例当时磁盘大小等。

URI

GET /rds-mysql/v1/instances/{id}/backups/{backupId}/statistics

请求参数

返回参数

BackupExtraMeta:

示例

请求示例

响应示例

[
 {
  "id": "c0c8749f-4980-41a3-9cb6-05ed23d9402b",
  "createdAt": null,
  "updatedAt": null,
  "deletedAt": null,
  "isDeleted": false,
  "backupId": "f1969919-0b38-4bc3-a4f5-727bb6363f9f",
  "name": "allocatedStorage",
  "value": "5"
 }
]

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例备份策略修改

描述

• 编辑并修改实例的自动备份策略。

URI

PUT /rds-mysql/v1/instances/{id}/backup-policy/action/modify-backup-policy

请求参数

返回参数

示例

请求示例

{
 "id": "4fb6d696-4fa3-466f-9344-468abd4d9180",
 "instanceId": "61803a72-597c-47d2-83ed-42dffe26c216",
 "cronJobId": null,
 "retentionDays": "7",
 "startTime": "01:00-02:00",
 "backupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday",
 "backupType": "PHYSICAL",
 "backupMode": "FULL",
 "status": true
}

响应示例

{
 "id": "1111",
 "createdAt": "2019-06-18 10:34:18",
 "updatedAt": "2019-06-18 17:40:23",
 "deletedAt": null,
 "isDeleted": false,
 "instanceId": "3e447437-58f8-4c96-8eb1-c43f698edfef",
 "cronJobId": "f91f53bb-c2e5-4fe4-a983-2e76526ac14b",
 "retentionDays": "729",
 "startTime": "03:00-04:00",
 "backupPeriod": "Monday,Tuesday",
 "backupType": "PHYSICAL",
 "backupMode": "FULL",
 "status": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

实例备份策略详情

描述

• 查看实例的自动备份策略详情。

URI

GET /rds-mysql/v1/instances/{id}/backup-policy

请求参数

返回参数

示例

请求示例

响应示例

{
 "id": "1111",
 "createdAt": "2019-06-18 10:34:18",
 "updatedAt": "2019-06-18 17:40:23",
 "deletedAt": null,
 "isDeleted": false,
 "instanceId": "3e447437-58f8-4c96-8eb1-c43f698edfef",
 "cronJobId": "f91f53bb-c2e5-4fe4-a983-2e76526ac14b",
 "retentionDays": "729",
 "startTime": "03:00-04:00",
 "backupPeriod": "Monday,Tuesday",
 "backupType": "PHYSICAL",
 "backupMode": "FULL",
 "status": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

开启实例自动备份

描述

• 开启实例自动备份任务。

URI

POST /rds-mysql/v1/instances/{id}/action/start-auto-backup

请求参数

返回参数

示例

请求示例

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

关闭实例自动备份

描述

• 关闭实例自动备份任务。

URI

POST /rds-mysql/v1/instances/{id}/action/stop-auto-backup

请求参数

返回参数

示例

请求示例

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

恢复相关接口

实例备份恢复

描述

• 指定实例分备份恢复该实例，恢复后该实例数据为当前备份的数据。

URI

POST /rds-mysql/v1/instances/action/restore

请求参数

返回参数

示例

请求示例

{
    "instanceId": "60873ce7-eee3-4832-b1c2-20b7e22a83b3",
    "backupId": "c027ed75-4e4b-4c54-9067-2cccfef8c773"
}

响应示例

{
    "id": "60873ce7-eee3-4832-b1c2-20b7e22a83b3",
    "createdAt": "2019-03-05 03:05:02",
    "updatedAt": "2019-03-06 10:52:10",
    "deletedAt": null,
    "isDeleted": false,
    "dbInstanceIdentifier": "test",
    "availabilityZone": "cn-north-3a",
    "storageType": "LOCAL_SSD",
    "allocatedStorage": 5,
    "status": "RESTORING",
    "chargeType": "hourlySettlement",
    "purchaseTime": "1",
    "expireTime": "2019-03-06 09:38:52",
    "count": null,
    "characterSetName": "utf8",
    "dbInstanceClass": "std_1G",
    "dbInstanceType": "HARDS",
    "dbParameterGroupName": null,
    "vpcId": "8d0e4bb2-94b9-4670-91ab-14b3d239858a",
    "subnetId": "a617cb0c-9d01-467e-894d-7f2b1c15d0a6",
    "engine": "MySQL",
    "engineVersion": "5.6",
    "masterUsername": "root",
    "masterUserPassword": null,
    "dbInstancePort": 3306,
    "timezone": "+08:00",
    "dbInstanceAddress": "172.31.0.44",
 "originalBackupId": null,
 "isAutoRenew": "fasle",
 "mainInstanceId": null,
 "readOnlyInstanceIds": null
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

日志管理相关接口

开启慢日志

描述

• 开启实例慢日志功能并设置阈值（long_query_time）

URI

POST /rds-mysql/v1/instances/{id}/logs/action/start-slow-log

请求参数

返回参数

示例

请求示例

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

关闭慢日志

描述

• 关闭实例慢日志功能

URI

POST /rds-mysql/v1/instances/{id}/logs/action/stop-slow-log

请求参数

返回参数

示例

请求示例

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

查询慢日志元信息

描述

• 查询慢日志元信息（状态和阈值）

URI

GET /rds-mysql/v1/instances/{id}/logs/slow-log-info

请求参数

返回参数

示例

请求示例

响应示例

{
 "status": "ON",
 "longQueryTime": "3"
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

设置慢日志阈值

描述

• 设置慢日志阈值参数大小

URI

PUT /rds-mysql/v1/instances/{id}/logs/action/modify-long-query-time

请求参数

返回参数

示例

请求示例

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

MySQL参数管理相关接口

查询实例参数

描述

• 查看实例可修改的参数列表

URI

GET /rds-mysql/v1/instances/{id}/parameters

请求参数

返回参数

InstanceParamsInfo：

示例

请求示例

响应示例

{
    "engine": "MySQL",
    "engineVersion": "5.6",
    "instanceType": "HARDS-v2",
    "items": [
        {
            "name": "log_queries_not_using_indexes",
            "paramType": "ENUM",
            "defaultValue": "OFF",
            "runningValue": "OFF",
            "needRestart": false,
            "min": null,
            "max": null,
            "enumValue": "ON,OFF",
            "rule": null,
            "description": "是否将不适用索引的查询记录到慢查询日志中。"
        },
        {
            "name": "query_cache_type",
            "paramType": "ENUM",
            "defaultValue": "0",
            "runningValue": "0",
            "needRestart": true,
            "min": null,
            "max": null,
            "enumValue": "0,1,2",
            "rule": null,
            "description": "查询缓存区的工作模式：0：禁用查询缓存区。1：启用查询缓存区。2：按需分配模式，只响应SELECT SQL_CACHE命令。"
        }
    ]
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

修改实例参数

描述

• 修改实例参数运行值

URI

PUT /rds-mysql/v1/instances/{id}/parameters

请求参数

返回参数

示例

请求示例

{
    "description": "5.7",
    "values": {
     "key_cache_age_threshold": "510"
    }
}

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

查询实例参数修改历史

描述

• 查询实例参数修改历史详情

URI

GET /rds-mysql/v1/instances/{id}/parameters/history/{pageNo}/{pageSize}

请求参数

返回参数

ConfigChangeHistory：

ConfigChangeParams：

示例

请求示例

响应示例

{
 "pageNo": 1,
 "pageSize": 10,
 "totalCount": 1,
 "data": [
  {
   "id": "8d306609-94e7-4b4c-83e9-31c7c9db65cc",
   "createdAt": "2019-10-25 10:22:12",
   "updatedAt": "2019-10-25 10:22:20",
   "deletedAt": null,
   "isDeleted": false,
   "description": "",
   "status": "SUCCESS",
   "instanceId": "e7cf844a-0008-4573-a4b7-56c95b1966b4",
   "operationId": "e8189ab4-0003-4f6f-8c47-3448aa718126",
   "values": [
    {
     "id": "0e14253f-117e-428b-81de-8c61c5b612bf",
     "createdAt": "2019-10-25 10:22:12",
     "updatedAt": null,
     "deletedAt": null,
     "isDeleted": false,
     "configChangeId": "8d306609-94e7-4b4c-83e9-31c7c9db65cc",
     "paramName": "auto_increment_increment",
     "sourceValue": "65533",
     "targetValue": "1"
    }
   ]
  }
 ]
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

参数模板分页列表

描述

• 根据过滤，分页获取参数模板列表

URI

GET /rds-mysql/v1/parameter-templates/{pageNo}/{pageSize}

请求参数

返回参数

ParameterTemplate：

示例

请求示例

假设需要查看当前用户所有参数模板，请求URL为“https://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/parameter-templates/1/10?filter=”。

响应示例

{
 "pageNo": 1,
 "pageSize": 10,
 "totalCount": 6,
 "data": [
  {
   "id": "8371d426-85a1-4651-95f9-1cb9d10ab2da",
   "createdAt": "2020-03-26 07:38:03",
   "updatedAt": "2020-03-26 07:38:31",
   "deletedAt": null,
   "isDeleted": false,
   "name": "test",
   "engine": "MySQL",
   "engineVersion": "5.7",
   "templateType": "CUSTOM"
  },
  {
   "id": "1",
   "createdAt": "2019-10-16 18:15:38",
   "updatedAt": null,
   "deletedAt": null,
   "isDeleted": false,
   "name": "rds/mysql-ha-5.6",
   "engine": "MySQL",
   "engineVersion": "5.6",
   "templateType": "DEFAULT"
  }
 ]
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

修改参数模板

描述

• 修改参数模板的名称、描述、参数值

URI

PUT /rds-mysql/v1/parameter-templates/{id}

请求参数

返回参数

示例

请求示例

{
 "name": "修改名称",
 "description": "修改描述",
 "values": {
  "max_connections": "10",
  "autocommit": "OFF"
 }
}

响应示例

{
 "code": 200,
 "type": null,
 "message": null,
 "success": true
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

参数模板详情

描述

• 查看参数模板详情

URI

GET /rds-mysql/v1/parameter-templates/{id}

请求参数

返回参数

ParamsInfo：

示例

请求示例

假设需要查询参数模板ID为“60873ce7-eee3-4832-b1c2-20b7e22a83b3”的详情，请求URL为“https://mysql.cn-north-3.inspurcloudapi.com/rds-mysql/v1/parameter-templates/60873ce7-eee3-4832-b1c2-20b7e22a83b3”。

响应示例

{
 "id": "061d32c9-6c46-4c3f-ba8e-9a7daca09ce6",
 "createdAt": "2020-04-09 02:48:17",
 "updatedAt": null,
 "deletedAt": null,
 "isDeleted": false,
 "name": "testtest",
 "engine": "MySQL",
 "engineVersion": "5.6",
 "templateType": "CUSTOM",
 "description": "测试",
 "items": [
  {
   "name": "auto_increment_increment",
   "paramType": "INTEGER",
   "defaultValue": "1",
   "runningValue": "1",
   "needRestart": false,
   "min": "1",
   "max": "65535",
   "enumValue": null,
   "rule": null,
   "description": "auto_increment_increment和auto_increment_offset 用于master-to-master的复制，并可以用来控制AUTO_INCREMENT列的操作。"
  }
 ]
}

返回值

请参考通用请求返回值

错误码

以下为本接口特有的错误码。

数据库连接与安全相关接口

实例绑定弹性公网ip

描述

• 实例绑定弹性公网ip

URI

POST /rds-mysql/v1/instances/{id}/action/binding-eip

请求参数