创建实例

Transcription

1 目录 目录 目录 CreateDBInstance 创建实例请求参数返回值请求示例示例返回 DeleteDBBackup 删除备份请求参数返回值 RequestId 请求示例返回示例 DescribeDBBackups 查看备份列表请求参数返回值 RequestId DBBackup Marker MaxRecords TotalCount 请求示例示例返回 CreateDBBackup 创建备份请求参数返回值 RequestId DBBackup 请求示例示例返回 DeleteDBSecurityGroup 删除安全组规则请求参数返回值 RequestId 请求示例示例返回 DescribeDBSecurityGroup 查看安全组规则列表请求参数返回值 RequestId DBSecurityGroupDescription DBSecurityGroupName Rule 请求示例示例返回 CreateDBSecurityGroupRule 添加安全组规则请求参数返回值 RequestId SecurityGroupRule 安全组规则 model 请求示例示例返回服务信息 Region 及可用区核心概念计费类型按日月结 (DAY) 包年包月 (YEAR_MONTH) 公共参数 CreateDBInstanceReadReplica 创建数据库只读实例请求参数返回值请求示例示例返回 RebootDBInstance 重启数据库实例 金山云 1/67

2 目录 请求参数返回值请求示例示例返回 ModifyDBInstance 修改数据库实例请求参数返回值请求示例示例返回 DescribeDBEngineVersions 查看数据库引擎版本请求参数返回值 RequestId DBEngineVersions 请求示例示例返回 DescribeDBInstances 查看数据库实例请求参数返回值请求示例示例返回 DescribeDBLogFiles 查看数据库日志文件请求参数返回值 RequestId Marker MaxRecords TotalCount DescribeDBLogFiles.N DescribeDBLogFiles.N.LogFileNam e DescribeDBLogFiles.N.Date DescribeDBLogFiles.N.Size DescribeDBLogFiles.N.Url 请求示例示例返回 DeleteDBInstance 删除数据库实例请求参数返回值请求示例示例返回 DBInstance 实例字段 DBInstanceClass DBSource 字段 DBInstanceIdentifier DBInstanceNam e DBBackupIdentifier DBBackupNam e PointInTim e DBInstanceIdentifier DBInstanceNam e DBInstanceType DBInstanceStatus GroupId AvailabilityZone MasterAvailabilityZone SlaveAvailabilityZone DBSecurityGroupId Vip Port Engine EngineVersion InstanceCreateTim e ServiceEndTim e PubliclyAccessible ReadReplicaDBInstanceIdentifiers VpcId SubnetId PMALink Region PreferredBackupTim e PreferredBackupWindow BackupRetentionPeriod Eip EipPort DBFlavor 实例规格字段 Iops Vcpus Disk Ram MaxConn DBParameterGroup 参数组字段 DBInstanceIdentifier DBSecurityGroupNam e DBSecurityGroupDescription DBSecurityGroupCreateTim e DBSecurityGroupRules 金山云 2/67

3 目录 DBSecurityGroupRule 安全组规则字段 Id Protocol Cidr From Port ToPort DBEngineVersions 字段 Engines EngineVersion 字段 Engine EngineVersion DBBackup 备份字段 DBSnapshotIdentifier DBInstanceIdentifier DBSnapshotNam e Engine EngineVersion BackupCreateTim e BackupUpdatedTim e BackupType BackupMode ParentId BackupSize BackupLocationRef CreateDBParameterGroup 创建一个数据库参数组请求参数 Action Version DBParam etergroupnam e Description Engine EngineVersion Param eters.nam e.n Param eters.value.n 返回值 DBParam etergroup 请求示例示例返回 DeleteDBParameterGroup 删除一个数据库参数组请求参数 Action Version DBParam etergroupid 返回值 RequestId 请求示例示例返回 DescribeDBInstanceParameters 查看当前实例数据库参数运行值列表请求参数 Action Version DBInstanceIdentifier Engine EngineVersion 返回值 RequestId Engine EngineVersion Param eters 请求示例示例返回 DescribeEngineDefaultParameters 查看数据库默认参数请求参数 Action Version Engine EngineVersion 返回值 RequestId Param eters 请求示例示例返回 DescribeDBParameterGroup 查看数据库参数组查看数据库参数组 Action Version Source Engine EngineVersion DBParameterGroupId Marker MaxRecords Keyword 请求示例示例返回 金山云 3/67

4 目录 ModifyDBParameterGroup 修改数据库参数组请求参数 Action Version DBParam etergroupid Param eters.nam e.n Param eters.value.n DBParam etergroupnam e Description 返回值 DBParam etergroup 请求示例示例返回 ResetDBParameterGroup 重置数据库参数组请求参数 Action Version DBParam etergroupid 返回值 RequestId DBParam etergroup 请求示例示例返回签名机制签名方法 Python Client Demo 错误码 OK INVALID_ACTION INVALID_PARAMETER_COMBINATION INVALID_PARAMETER_VALUE MISSING_PARAMETER NOT_FOUND MALFORMED_QUERY_STRING INTERNAL_FAILURE SERVICE_UNAVAILABLE BACKING_UP INSTANCE_TASK OPERATION_DENIED_CREATE_BACKUP INVALID_PACKAGES 金山云 4/67

5 Crea tedbin sta n ce 创建实例 创建 RDS 实例 ( 高可用实例或单实例 ) 目前仅支持在 VPC 机房创建实例, 所以用户在创建时需指定 vpc 网络信息, 如果需要在 basic 机房创建实例可联系售后处理 请求参数 英文名 称 中文名 称 类型 是否必 须 备注 Action Versio n 调用接口名称 API 版本号 String 是取固定值 :CreateDBInstance String 是取固定值 : DBInst ancecl ass 实例规 格 String 是 区分大小写, 取值示例 :"db.ram.1 db.disk.5" 表示内存 1GB, 磁盘 5GB 的 实例 客户只能购买特定规格的套餐, 否则将会报错 套餐规格具体可以 参见文档说明 DBInst ancena me Engine EngineV ersion 实例名称实例中数据库引擎的名称实例中数据库引擎的版本 String 是不超过 256 个字节, 仅支持中文 大小写字母 数字 减号和下划线 String 是区分大小写, 取值范围 :mysql percona String 是取值范围 : Master UserPa ssword 数据库 用户密 码 String 是 8-30 个字符, 必须包含大小写字母和数字, 支持的特殊字符为!@#$% ^&*() _+=- Master UserNa me DBInst ancety pe 数据库用户名数据库类型 String 是 root, rdsrepladmin, rdsadmin 不可用 String 是区分大小写, 取值范围 : 高可用实例 :HA 单实例 :SINGLE Public lyacce ssible 是否使 用 VPC Boolea n 是 现只能创建 VPC 实例, 请固定传入 true 作为参数 VpcId Subnet Id VPC dom ain_id VPC vne t_id String 是 VPC 网络 ID, 可在网络控制台获取 String 是终端子网 ID, 可在网络控制台获取 ( 注意类型必须为终端子网 ) 金山云 5/67

6 Prefer redbac kuptim e 自动备份发起时间范围 String 否格式 (hh:mm-hh:mm, 如 :01:00-02:00), 如不指定后台将随机分配 DBPara meterg roupid 参数组 i d String 否 指定实例的参数组, 如不指定, 系统将采用默认的参数组来创建实例 用 户需事先在控制台创建好参数组 Port 数据库 连接端 口 String 否默认 3306 BillTy pe 计费方 式 String 否 默认值 :YEAR_MONTH, 取值范围 :YEAR_MONTH( 包年包月 ),DAY( 按日计 费 ) 计费相关 Durati on Durati onunit 购买时长购买时长单位 String 否默认值 :1 String 否取值范围 :M( 月 ), 默认值 :M( 区分大小写 ) Availa bility Zone.N 可用区 字段 String 否 示例 (AvailabilityZone.1=cn-beijing-6a&AvailabilityZone.2=cn-beijin g-6b), 表示实例的主副本在 a 区, 备副本在 b 区 如果没有跨可用区的需求, 建议将实例创建在云主机的可用区内已减少网络延时 Projec tid 项目 Id Intege r 否 可从 IAM 获取 ProjectId 可按项目来进行细粒度权限控制, 将实例归类到某个项目下 返回值 英文名称 中文名称 类型 备注 RequestId 请求 ID String -- DBInstance RDS 实例信息 DBInstance -- 请求示例 db.disk.10& DBInstanceName=test&Engine=mysql&EngineVersion=5.6&MasterUserName=test&MasterUserPassword=Test123456&DBIns tancetype=ha&publiclyaccessible=true&vpcid=b33a a8-4c04-b28e-da253c8add32&subnetid=c2e0abd7-13df-461 a-bd8d-3b92faebf111&billtype=day 示例返回 金山云 6/67

7 "Data": "DBInstance": "DBInstanceClass": "Id": "RDSOpenAPI_0772c82ea87c666d", "Vcpus": 1, "Disk": 10, "Ram": 1, "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "DBInstanceName": "test", "DBInstanceStatus": "CREATING", "DBInstanceType": "HA", "DBParameterGroupId": "3b9aeb7b-552b b2-15f0278bb73e", "GroupId": "71e2bd82-423d-41ae-a9e6-2131a447d780", "DBSecurityGroupId": "55705", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T11:03: ", "MasterUserName": "test", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "0f71c616-6f5e-4f24-b809-59eb ", "PubliclyAccessible": false, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "DAY", "OrderType": "REGULAR", "OrderSource": "OPENAPI", "MultiAvailabilityZone": false, "ProductId": "ed8b94df-68e0-47dc-a86b-017d1426a8cd", "DiskUsed": 0, "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 ", "RequestId": "1345b363-c988-44f ff80b1e" DeleteDBBa cku p 删除备份 删除一个数据库备份 请求参数 英文名称 中文名称 类型 是否必须 备注 Action 调用接口名称 String 是取固定值 :DeleteDBBackup Version API 版本号 String 是取固定值 : DBBackupIdentifier 备份 Id String 是 返回值 Request Id 请求 ID 金山云 7/67

8 请求示例 951e-da51ea8753bb 返回示例 "RequestId": "ea8cdd80-be b25d-6b2fd9f3ce72" DescribeDBBa cku ps 查看备份列表 查看指定 RDS 实例的备份列表 请求参数 英文名称 中文名称 类型 是否必 须 备注 Action 调用接口名称 String 是取固定值 :DescribeDBBackups Version API 版本号 String 是取固定值 : DBInstanceIde ntifier 实例 Id String 是 BackupType 备份类型 String 否 取值范围 :AutoBackup( 自动产生的备份 ) Snap shot( 手动发起的备份 ) Keyword 备份搜索关键字 ( 根据备份名字 ) String 否 Marker 获取记录开始偏移量 Intege r 否 MaxRecords 每页结果中包含的最大条数 Intege r 否取值范围 [10,100], 默认为 10 返回值 Request Id 请求 ID DBBa ckup 备份 model 类型 :DBBackup Ma rker 获取记录开始偏移量 金山云 8/67

9 Ma xreco rds 每页结果中包含的最大条数 类型 :Integer To t a lc o unt 记录总数 类型 :Integer 请求示例 示例返回 金山云 9/67

10 "Data": "DBBackup": [ "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "DBBackupIdentifier": "d04d1bbf-0a46-459f-951e-da51ea8753bb", "Engine": "mysql", "EngineVersion": "5.6", "BackupCreateTime": " T11:42: ", "BackupUpdatedTime": " T11:42: ", "DBBackupName": "test-backup", "BackupMode": "FULL_AMOUNT_BACKUP", "BackupType": "Snapshot", "Status": "COMPLETED", "BackupSize": 1.72, "BackupLocationRef": "/ks3data/snapshot/71e2bd82-423d-41ae-a9e6-2131a447d780/d04d1bbf-0a46-459f-951e-da51ea8753bb", "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "DBBackupIdentifier": "ab12d007-5f30-41b3-9a3b-3ac0e61f9bdc", "Engine": "mysql", "EngineVersion": "5.6", "BackupCreateTime": " T11:21: ", "BackupUpdatedTime": " T11:21: ", "DBBackupName": "autobackup ", "BackupMode": "FULL_AMOUNT_BACKUP", "BackupType": "AutoBackup", "Status": "COMPLETED", "BackupSize": 1.71, "BackupLocationRef": "/ks3data/backup/71e2bd82-423d-41ae-a9e6-2131a447d780/ab12d007-5f30-4 1b3-9a3b-3ac0e61f9bdc", "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "DBBackupIdentifier": "8185c20e eca-93cf-c13b05d407c9", "Engine": "mysql", "EngineVersion": "5.6", "BackupCreateTime": " T11:10: ", "BackupUpdatedTime": " T11:10: ", "DBBackupName": "autobackup ", "BackupMode": "FULL_AMOUNT_BACKUP", "BackupType": "AutoBackup", "Status": "COMPLETED", "BackupSize": 1.71, "BackupLocationRef": "/ks3data/backup/71e2bd82-423d-41ae-a9e6-2131a447d780/8185c20e eca-93cf-c13b05d407c9" ], "TotalCount": 3, "MaxRecords": 10, "RequestId": "82cbb354-b82e-4627-b867-43a0a38c73ca" Crea tedbba cku p 创建备份 创建一个数据库备份 请求参数 金山云 10/67

11 英文名称 中文名称 类型 是否必须 备注 Action 调用接口名称 String 是 取固定值 :CreateDBBackup Version API 版本号 String 是 取固定值 : DBInstanceIdentifier 实例 Id String 是 实例 id DBBackupName 备份名称 String 是 备份名 返回值 Request Id 请求 ID DBBa ckup 备份 model 类型 :DBBackup 请求示例 e-b10d-754f23bc59e1&dbbackupname=test-backup 示例返回 "DBBackup": "DBInstanceIdentifier": "8ee3ac8a-116c-45e d1c62165dc7b", "DBBackupIdentifier": "d04d1bbf-0a46-459f-951e-da51ea8753bb", "Engine": "mysql", "EngineVersion": "5.6", "BackupCreateTime": " T11:42: ", "BackupUpdatedTime": " T11:42: ", "DBBackupName": "test-backup", "BackupType": "Snapshot", "Status": "NEW", "RequestId": "8a5cac b ca7491fae17c" DeleteDBSecu rityg rou p 删除安全组规则 删除指定实例的某一条或多条安全组规则 系统会根据指定的安全组规则 id 找到对应的 RDS 实例, 并从实例上把指定规则删 除 请求参数 英文名称 中文名称 类型 是否必须 备注 Action 调用接口名称 String 是取固定值 :DeleteDBSecurityGroup Version API 版本号 String 是取固定值 : 金山云 11/67

12 SecurityGroupRules.Id.N 安全组规则 IDs String 是注意是规则 id 返回值 Request Id 请求 ID 请求示例 示例返回 "RequestId": "0e4c2cb4-bd99-4a1a-954e-42b312ba1932" DescribeDBSecu rityg rou p 查看安全组规则列表 查看指定实例的安全组规则列表 请求参数 英文名称 中文名称 类型 是否必须 备注 Action 调用接口名称 String 是取固定值 :DescribeDBSecurityGroup Version API 版本号 String 是取固定值 : DBInstanceIdentifier 实例 Id String 是实例 id 返回值 Request Id 请求 ID DBS ecurit yg ro updescript io n 安全组描述 DBS ecurit yg ro upna me 安全组名称 Rule 安全组详情 金山云 12/67

13 类型 :List 请求示例 -af44-41ee-b10d-754f23bc59e1 示例返回 "Data": "SecurityGroups": "DBSecurityGroupId": "55705", "DBSecurityGroupDescription": "Security Group for 71e2bd82-423d-41ae-a9e6-2131a447d780", "DBSecurityGroupName": "SecGroup_71e2bd82-423d-41ae-a9e6-2131a447d780", "Rules": [ "ToPort": 3306, "Cidr": " /14", "FromPort": 3306, "Protocol": "tcp", "Id": "74860", "ToPort": 3306, "Cidr": " /15", "FromPort": 3306, "Protocol": "tcp", "Id": "74863" ], "RequestId": "2d57d5b2-db df-f03d80714fad" Crea tedbsecu rityg rou pru le 添加安全组规则 给指定实例安全组规则, 每次可添加多条规则 ( 最多 100) 请求参数 英文名称 中文名称 类型 是否必须 备注 Action 调用接口名称 String 是 取固定值 :CreateDBSecurityGroupRule Version API 版本号 String 是 取固定值 : DBInstanceIdentifier 实例 Id String 是 SecurityGroupRules.Cidr.N 安全组规则 String 是 IP 地址段, 格式为 : /32 返回值 Request Id 请求 ID 金山云 13/67

14 S ecurit yg ro uprule 安全组规则 mo del 安全组规则 model 类型 :List 请求示例 1a-af44-41ee-b10d-754f23bc59e1&SecurityGroupRules.Cidr.1= /14&SecurityGroupRules.Cidr.2= /15 示例返回 "Data": "SecurityGroupRules": [ "ToPort": 3306, "Cidr": " /14", "FromPort": 3306, "Protocol": "tcp", "Id": "74860", "DBSecurityGroupId": "55705", "ToPort": 3306, "Cidr": " /15", "FromPort": 3306, "Protocol": "tcp", "Id": "74863", "DBSecurityGroupId": "55705" ], "RequestId": "1ad92e74-a6ff-4563-b2c0-5f00e78a27a6" 服务信息 服务地址 krds.api.ksyun.com 通讯协议 支持 HTTP 或 HTTPS 协议 请求方法 详见具体 API 接口 请求参数 每个请求都需要包含公共的请求参数和操作所特有的请求参数, 详见具体 API 接口 编码方式 请求及结果返回都使用 UTF-8 字符集编码 返回结果 仅支持 json 返回结 Reg ion 及可用区 金山云 14/67

15 各个 region 都通过同一个 endpoint 来访问 API 服务 :krds.api.ksyun.com Regio n 名称 类型 Regio n 代码 可用区 北京 1 Basic 机房 cn-beijing-1 -- 北京 6 VPC 机房 cn-beijing-6 cn-beijing-6a,cn-being-6b 上海 1 Basic 机房 cn-shanghai-1 -- 上海 2 VPC 机房 cn-shanghai-2 cn-hanghai-2a,cn-hanghai-2b 广州 VPC 机房 cn-guangzhou-1 -- 香港 1 Basic 机房 cn-hongkong-1 -- 俄罗斯 VPC 机房 eu-east-1 -- 核心概念 计费类型 金山云支持按日月结和包年包月两种计费方式 在 API 接口中可以通过设置 BillType 参数来指定计费类型 按日月结 (DAY) 根据实例开通天数, 按月出账单进行线下结算 这是一种后付费模式, 需要客户线下跟金山云达成合同约定后才能进行此种结 算方式 目前大部分企业客户都采用此种方式 包年包月 (YEAR_MO NTH) 客户一次性购买指定数月或者数年的套餐 这是一种预付费模式, 创建实例时后台会自动对账户进行扣费, 若余额不足会导致 创建失败 此类型的实例一旦开通费用不可撤销, 客户若在实例到期前删除实例费用不再退还 客户用通过进一步指定 DurationUnit( 时间单位 ) 和 Duration( 时长 ) 参数来指定购买套餐的时长 例如 BillType=YEAR_MONTH&DurationUnit=M&Duration=5 表示购买 5 个月的计费类型为包年包月的实例 参数名称 中文名称 类型 备注 BillType 计费方式 String 默认值 :YEAR_MONTH, 取值范围 :YEAR_MONTH( 包年包月 ),DAY( 按日计费 ) Duration 购买时长 Intege r 默认值 :1, 在 BillType=YEAR_MONTH 时有效 DurationUni t 购买时长单 位 公共参数 String 取值范围 :M( 月 ), 默认值 :M( 区分大小写 ), 在 BillType=YEAR_MONTH 时有效 名称 描述 是否必须 Authorization 签名结果是 Host 请求服务域名 ( 用于签名计算 ) 是 X-Amz-Date ISO 8601 格式时间戳 ( 用于签名计算 ) 是 金山云 15/67

16 X-KSC-REQUEST-ID 请求流水号, 用于报障使用, 若不提供则默认自动生成一个否 Crea tedbin sta n cerea dreplica 创建数据库只读实例 基于主实例创建只读实例, 只读实例的套餐规格默认情况下与主实例一致 请求参数 英文名 称 中文名称 类型 是否必 须 备注 Action 调用接口名称 String 是取固定值 :CreateDBInstanceReadReplica Version API 版本号 String 是取固定值 : DBInstan ceclass 实例规格 String 否 区分大小写, 只读规格必须 主实例, 取值示例 :db.ra m.1 db.disk.10 同主实例一样, 只读实例也必须是标准 套餐 DBInstan ceidenti fier 主实例 Id String 是主实例 id 一个主实例最多只能有 3 个只读实例 DBInstan cename 实例名称 String 是 不超过 256 个字节, 仅支持中文 大小写字母 数字 减 号和下划线 Attache dvipid 共享同一主实例下的只 读实例 ip, 默认创建一 个新的 ip String 否 BillTyp e 计费方式 String 否 YEAR_MONTH( 包年包月 ),DAY( 按日计费 ), 默认值 :YE AR_MONTH Duration 购买时长 String 否默认值 :1 Duration Unit 购买时长单位 String 否取值范围 :M( 月 ), 默认值 :M( 区分大小写 ) Availab ilityzon e.1 可用区 String 否 示例 (AvailabilityZone.1=cn-beijing-6a), 默认情况下 只读实例可用区与主实例一致, 如果主实例是跨可用区实 例, 只读实例会随机分布 Project Id 项目 Id Intege r 否 可从 IAM 获取 ProjectId 返回值 英文名称 中文名称 类型 备注 RequestId 请求 ID String -- DBInstance RDS 实例信息 DBInstance -- 请求示例 db.disk.10&dbinstan cename=test-rr&billtype=day&dbinstanceidentifier=bb2d111a-af44-41ee-b10d-754f23bc59e1&version= 金山云 16/67

17 示例返回 "Data": "DBInstance": "DBInstanceClass": "Id": "RDSOpenAPI_0772c82ea87c666d", "Vcpus": 1, "Disk": 10, "Ram": 1, "DBInstanceIdentifier": "488fcb aaf8-050d79b3ea9e", "DBSource": "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "DBInstanceName": "test", "DBInstanceType": "HA", "DBInstanceName": "test-rr", "DBInstanceStatus": "CREATING", "DBInstanceType": "RR", "DBParameterGroupId": "1f6a616b c1b-a c9bb", "GroupId": "71e2bd82-423d-41ae-a9e6-2131a447d780", "DBSecurityGroupId": "55705", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T11:11: ", "MasterUserName": "test", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "0f71c616-6f5e-4f24-b809-59eb ", "PubliclyAccessible": false, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "DAY", "OrderType": "REGULAR", "OrderSource": "OPENAPI", "MultiAvailabilityZone": false, "ProductId": "5520c1b9-11e3-4fac-a838-e7b87a31c905", "DiskUsed": 0, "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 ", "RequestId": " f-3cb9-468b-8250-ac828ad54618" RebootDBIn sta n ce 重启数据库实例 重启指定的实例, 包括高可用实例 只读实例及临时实例 请求参数 英文名称 中文名称 类型 是否必须 备注 Action 调用接口名称 String 是取固定值 :RebootDBInstance Version API 版本号 String 是取固定值 : DBInstanceIdentifier 实例 Id String 是 金山云 17/67

18 返回值 英文名称 中文名称 类型 备注 RequestId 请求 ID String -- DBInstance RDS 实例信息 DBInstance -- 请求示例 1ee-b10d-754f23bc59e1 示例返回 金山云 18/67

19 "Data": "DBInstance": "DBInstanceClass": "Id": "RDSOpenAPI_0772c82ea87c666d", "Vcpus": 1, "Disk": 10, "Ram": 1, "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "PreferredBackupWindow": 1440, "BackupRetentionPeriod": 30, "PreferredBackupTime": "02:00-03:00", "DBInstanceName": "test-modify-name", "DBInstanceStatus": "REBOOTING", "DBInstanceType": "HA", "DBParameterGroupId": "3b9aeb7b-552b b2-15f0278bb73e", "GroupId": "71e2bd82-423d-41ae-a9e6-2131a447d780", "DBSecurityGroupId": "55705", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T11:03: ", "MasterUserName": "test", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "0f71c616-6f5e-4f24-b809-59eb ", "PubliclyAccessible": false, "ReadReplicaDBInstanceIdentifiers": [ "id": "8e e5f-4f9c-a642-c9da21744d27", "Vip": " ", "ReadReplicaDBInstanceIdentifier": "488fcb aaf8-050d79b3ea9e" ], "BillType": "DAY", "OrderType": "REGULAR", "OrderSource": "OPENAPI", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6b", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "ed8b94df-68e0-47dc-a86b-017d1426a8cd", "DiskUsed": 0, "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 ", "RequestId": "c43a763d-911a-4702-aede-fd3ee812795b" Modif ydbin sta n ce 修改数据库实例 修改实例的实例名, 或 mysql 管理员账户密码, 或自动备份时间, 或参数组 请求参数 英文名称 中文名称 类型 是否必 须 备注 金山云 19/67

20 Action 调用接口名称 String 是取固定值 :ModifyDBInstance Version API 版本号 String 是取固定值 : DBInstanceId entifier DBInstanceNa me MasterUserPa ssword 实例 Id String 是 实例新名称 String 否 数据库用户密码 String 否 不超过 256 个字节, 仅支持中文 大小写字母 数字 减号和下划线 8-30 个字符, 必须包含大小写字母和数字, ^&*()_+=- PreferredBac kuptime 自动备份发起时间范围 String 否格式 (hh:mm-hh:mm, 如 :01:00-02:00) DBParameterG roupid 租户的参数组 id 或者是官方 的默认参数组 id String 否租户的参数组 id 或者是官方的默认参数组 id 返回值 英文名称 中文名称 类型 备注 RequestId 请求 ID String -- DBInstance RDS 实例信息 DBInstance -- 请求示例 e1&dbinstancename=test-modify-name&version= 示例返回 金山云 20/67

21 "Data": "DBInstance": "DBInstanceClass": "Id": "RDSOpenAPI_0772c82ea87c666d", "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "PreferredBackupWindow": 1440, "BackupRetentionPeriod": 30, "PreferredBackupTime": "02:00-03:00", "DBInstanceName": "test-modify-name", "DBInstanceStatus": "active", "DBInstanceType": "HA", "DBParameterGroupId": "3b9aeb7b-552b b2-15f0278bb73e", "DBSecurityGroupId": "55705", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T11:03: ", "MasterUserName": "test", "VpcId": "0f71c616-6f5e-4f24-b809-59eb ", "PubliclyAccessible": true, "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6b", "SlaveAvailabilityZone": "cn-beijing-6a", "DiskUsed": 277, "RequestId": "390e be-9629-b10afbf440fc" DescribeDBE n gin eversion s 查看数据库引擎版本 列出 RDS 支持的所有数据库引擎及版本 请求参数 英文名称 中文名称 类型 是否必须 备注 Action 调用接口名称 String 是取固定值 :DescribeDBEngineVersions Version API 版本号 String 是取固定值 : 返回值 Request Id 请求 ID DBEng ineversio ns DBEngineVersions 类型 :List 请求示例 金山云 21/67

22 示例返回 "Data": "Engines": "MySQL": [ "Engine": "mysql", "EngineVersion": "5.5", "Engine": "mysql", "EngineVersion": "5.7", "Engine": "mysql", "EngineVersion": "5.6" ], "Percona": [ "Engine": "percona", "EngineVersion": "5.6" ], "RequestId": "ee1df d-86d7-511a0fabd11b" DescribeDBIn sta n ces 查看数据库实例 获取账户下的实例列表, 或者获取某一实例的详情 ( 指定 DBInstanceIdentifier 的情况下 ) 在获取实例列表时可通过 DBInstanceType DBInstanceStatus Keyword 条件进行过滤 若所有列表无法一次全返回, 可通过设置 Marker 来分页返回 请求参数 英文名称 中文名称 类型 是否必 须 备注 Action 调用接口名称 String 是取固定值 :DescribeDBInstances Version API 版本号 String 是取固定值 : DBInstance Identifier 调用接口名称 String 否 实例 ID( 传入实例 ID, 获取的是该实例的详情, 否则则获取 lis t) DBInstance Type 调用接口名称 String 否 HA( 高可用 ),RR( 只读实例 ),TEMP( 临时实例 ) DBInstance Status 按实例状态过 滤 String 否 ACTIVE( 运行中 )/INVALID( 请续费 ) Keyword 按名称 /VIP 模 糊过滤 String 否 金山云 22/67

23 Order 排序方式 String 否 区分大小写, 取值范围 :DEFAULT( 默认排序方式 ),GROUP( 按复制组排序, 会把只读实例排在所属主实例的后面 ) Marker 记录开始偏移量 Intege r 否 MaxRecords 每页结果中包含的最大条数 Intege r 否取值范围 :1-100 返回值 英文名称 中文名称 类型 备注 RequestId 请求 ID String -- DBInstance RDS 实例列表 List -- Marker 下次获取记录开始偏移量 Integer -- MaxRecords 每页结果中包含的最大条数 Integer -- TotalCount 记录总数 Integer -- 请求示例 示例返回 列表返回 "Data": "Instances": [ "DBInstanceClass": "Id": "RDSOpenAPI_0772c82ea87c666d", "Vcpus": 1, "Disk": 10, "Ram": 1, "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "DBInstanceName": "test", "DBInstanceStatus": "BUILDING_RR", "DBInstanceType": "HA", "DBParameterGroupId": "3b9aeb7b-552b b2-15f0278bb73e", "GroupId": "71e2bd82-423d-41ae-a9e6-2131a447d780", "DBSecurityGroupId": "55705", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T11:03: ", "MasterUserName": "test", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "0f71c616-6f5e-4f24-b809-59eb ", "PubliclyAccessible": false, "ReadReplicaDBInstanceIdentifiers": [ 金山云 23/67

24 ,, "ReadReplicaDBInstanceIdentifier": "488fcb aaf8-050d79b3ea9e" ], "BillType": "DAY", "OrderType": "REGULAR", "OrderSource": "OPENAPI", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6b", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "ed8b94df-68e0-47dc-a86b-017d1426a8cd", "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 " "DBInstanceClass": "Id": "RDSOpenAPI_bb0b4cbff280227c", "Vcpus": 1, "Disk": 15, "Ram": 1, "DBInstanceIdentifier": " e-cd ac10b053ea", "DBInstanceName": "dsj_test12221", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", "DBParameterGroupId": "b9ef ff-4e03-a29d-c58b57de7f5d", "GroupId": "b85cc696-14ab-4509-a8f1-5dca8f8ab3c9", "DBSecurityGroupId": "55581", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T12:30: ", "MasterUserName": "admin", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "40e0c2e f17-abb5-1a6efe3951c8", "SubnetId": "bc c94-4a6b-bec0-d97c75d83774", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "YEAR_MONTH", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "b24bd18b-280b-4528-aba6-d605079f16a4", "ServiceEndTime": " T23:59: ", "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 " "DBInstanceClass": "Id": "RDSOpenAPI_bb0b4cbff280227c", "Vcpus": 1, "Disk": 15, "Ram": 1, "DBInstanceIdentifier": " e-929b-479c-8ac5-cd753746d69e", "DBInstanceName": "ls-dts- 长期测试 ", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", 金山云 24/67

25 , "DBInstanceType": "HA", "DBParameterGroupId": "debf0e06-52d4-45c2-bdc3-95ead7b18936", "GroupId": "d365632c-362f-404d-a526-be645b41fb86", "DBSecurityGroupId": "55248", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T23:19: ", "MasterUserName": "admin", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "c1d332f1-164b a-149e75a51ad4", "SubnetId": "2f8b762b-b8c9-400d-a989-96ea2ea7a5f9", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "YEAR_MONTH", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "87161cf6-bded-4746-b2ec-1316ee742056", "ServiceEndTime": " T23:59: ", "OrderUse": "RENEW", "Eip": " ", "EipPort": "42592", "ProjectId": 0, "ProjectName": " 默认项目 " "DBInstanceClass": "Id": "RDSOpenAPI_bb0b4cbff280227c", "Vcpus": 1, "Disk": 15, "Ram": 1, "DBInstanceIdentifier": "ea345c3f-69ca-4035-a0ec-4f1b6313a7b2", "DBInstanceName": "krds_ ", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", "DBParameterGroupId": "d57a669e e5d-b7f9-1a5f067a2058", "GroupId": "c67d44c1-a8e7-490a-a61b-94a69706fb81", "DBSecurityGroupId": "55191", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T18:18: ", "MasterUserName": "admin", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "c1d332f1-164b a-149e75a51ad4", "SubnetId": "2f8b762b-b8c9-400d-a989-96ea2ea7a5f9", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "YEAR_MONTH", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "2dc211a6-156b-4eaa-b012-a17e f", "ServiceEndTime": " T23:59: ", 金山云 25/67

26 ,, "ServiceEndTime": " T23:59: ", "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 " "DBInstanceClass": "Id": "RDSOpenAPI_bb0b4cbff280227c", "Vcpus": 1, "Disk": 15, "Ram": 1, "DBInstanceIdentifier": "7ad090ce-fb a750cf5", "DBInstanceName": "krds_ ", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", "DBParameterGroupId": "6ec6cd33-4ead-4f4d-8b90-de231b26a452", "GroupId": "7e4f64ca adf-8583-be3046d0737e", "DBSecurityGroupId": "55180", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T11:54: ", "MasterUserName": "admin", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "c1d332f1-164b a-149e75a51ad4", "SubnetId": "2f8b762b-b8c9-400d-a989-96ea2ea7a5f9", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "YEAR_MONTH", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "1aaa30b e4d aa6aa2a46b", "ServiceEndTime": " T23:59: ", "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 " "DBInstanceClass": "Id": "RDSOpenAPI_bb0b4cbff280227c", "Vcpus": 1, "Disk": 15, "Ram": 1, "DBInstanceIdentifier": "c0844c1f f7-b4f fc854", "DBInstanceName": "krds_ ", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", "DBParameterGroupId": "ceb b-bff7-39ddafe8083e", "GroupId": "c012259b-15a0-41d c6d7627cb", "DBSecurityGroupId": "55141", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T09:59: ", "MasterUserName": "admin", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", 金山云 26/67

27 ,, "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "c5e37d c4263", "SubnetId": "7ef1376f-a040-4d8a-be4a-3de9a436f041", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "YEAR_MONTH", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "a89d8f0d-c6da-4f20-b6f6-071cde8e7cc2", "ServiceEndTime": " T23:59: ", "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 " "DBInstanceClass": "Id": "RDSOpenAPI_0772c82ea87c666d", "Vcpus": 1, "Disk": 10, "Ram": 1, "DBInstanceIdentifier": "ab6fc9f3-9d91-466d-a d72458", "DBInstanceName": "p56", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", "DBParameterGroupId": "f7b13f2d-a906-4dd1-b96c-93340b2c8da2", "GroupId": "fac85cf c0-a73a-85f4c6850f20", "DBSecurityGroupId": "54453", "Vip": " ", "Port": 3306, "Engine": "percona", "EngineVersion": "5.6", "InstanceCreateTime": " T10:39: ", "MasterUserName": "admin", "DatastoreVersionId": "fefcbba4-9ba7-47f9-9e30-69ca7c128255", "Region": "cn-beijing-6", "VpcId": "c1d332f1-164b a-149e75a51ad4", "SubnetId": "2f8b762b-b8c9-400d-a989-96ea2ea7a5f9", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "YEAR_MONTH", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "b403a0b6-a6e7-4f0b-b857-52eb741a4a49", "ServiceEndTime": " T23:59: ", "OrderUse": "RENEW", "ProjectId": 0, "ProjectName": " 默认项目 " "DBInstanceClass": "Id": "RDSOpenAPI_aeeb0ef ", "Vcpus": 2, "Disk": 60, "Ram": 4, "DBInstanceIdentifier": "9f965c6b bb-b9dc a0c", 金山云 27/67

28 , "DBInstanceIdentifier": "9f965c6b bb-b9dc a0c", "DBInstanceName": "qhy_dts_test2", "DBInstanceStatus": "INVALID", "DBInstanceType": "HA", "DBParameterGroupId": "332e627a-a96b-4417-aca5-c dcf", "GroupId": "fcdb3d5d-39ea-4b79-8adc-90f1b9ee2b32", "DBSecurityGroupId": "54224", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T11:16: ", "MasterUserName": "admin", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "c1d332f1-164b a-149e75a51ad4", "SubnetId": "2f8b762b-b8c9-400d-a989-96ea2ea7a5f9", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "YEAR_MONTH", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "00c7df86-879d-4477-a58c f7", "ServiceEndTime": " T23:59: ", "OrderUse": "RENEW", "ProjectId": 0, "ProjectName": " 默认项目 " "DBInstanceClass": "Id": "RDSOpenAPI_dfa4e4afc97087bc", "Vcpus": 1, "Disk": 30, "Ram": 2, "DBInstanceIdentifier": "d854023d-05e5-45c0-ba09-7bbf2ba6982c", "DBInstanceName": "dts_test2", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", "DBParameterGroupId": "b da0-49e9-b73c f3d5fd", "GroupId": "15ac46f9-e a309-5dab68cbb281", "DBSecurityGroupId": "54127", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T15:33: ", "MasterUserName": "admin", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "821575bf-13a fdc-b b24", "SubnetId": "acb6229c-70f3-4b87-af68-2c75ceb3d6b7", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "DAY", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "5ae902ec bcd-95db-cdab47bdeaab", 金山云 28/67

29 "ProductId": "5ae902ec bcd-95db-cdab47bdeaab", "OrderUse": "BUY", "Eip": " ", "EipPort": "63426", "ProjectId": 0, "ProjectName": " 默认项目 ", "DBInstanceClass": "Id": "RDSOpenAPI_dfa4e4afc97087bc", "Vcpus": 1, "Disk": 30, "Ram": 2, "DBInstanceIdentifier": " b4e-4d4b-be39-ee554b15aba3", "DBInstanceName": "dts_test", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", "DBParameterGroupId": "3cfa3e52-5b56-45da-9ac1-def732c5f5ca", "GroupId": "e a59-4e9c-9a39-08b7c90b3639", "DBSecurityGroupId": "54126", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T15:17: ", "MasterUserName": "admin", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "821575bf-13a fdc-b b24", "SubnetId": "acb6229c-70f3-4b87-af68-2c75ceb3d6b7", "PubliclyAccessible": true, "ReadReplicaDBInstanceIdentifiers": [], "BillType": "DAY", "OrderType": "REGULAR", "OrderSource": "CONSOLE", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6a", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "ae9c9a c9-bb87-1c97c82f028d", "OrderUse": "BUY", "Eip": " ", "EipPort": "33735", "ProjectId": 0, "ProjectName": " 默认项目 " ], "TotalCount": 13, "MaxRecords": 10, "Marker": 11, "RequestId": "a92d1fc7-178f-4f77-b1b b120" 详情返回 : 金山云 29/67

30 "Data": "Instances": [ "DBInstanceClass": "Id": "RDSOpenAPI_0772c82ea87c666d", "Vcpus": 1, "Disk": 10, "Ram": 1, "DBInstanceIdentifier": "bb2d111a-af44-41ee-b10d-754f23bc59e1", "PreferredBackupWindow": 1440, "BackupRetentionPeriod": 30, "PreferredBackupTime": "02:00-03:00", "DBInstanceName": "test", "DBInstanceStatus": "ACTIVE", "DBInstanceType": "HA", "DBParameterGroupId": "3b9aeb7b-552b b2-15f0278bb73e", "GroupId": "71e2bd82-423d-41ae-a9e6-2131a447d780", "DBSecurityGroupId": "55705", "Vip": " ", "Port": 3306, "Engine": "mysql", "EngineVersion": "5.6", "InstanceCreateTime": " T11:03: ", "MasterUserName": "test", "DatastoreVersionId": "96867ed6-6f6a-4006-bbc5-46c1f22d63a9", "Region": "cn-beijing-6", "VpcId": "0f71c616-6f5e-4f24-b809-59eb ", "PubliclyAccessible": false, "ReadReplicaDBInstanceIdentifiers": [ "id": "8e e5f-4f9c-a642-c9da21744d27", "Vip": " ", "ReadReplicaDBInstanceIdentifier": "488fcb aaf8-050d79b3ea9e" ], "BillType": "DAY", "OrderType": "REGULAR", "OrderSource": "OPENAPI", "MultiAvailabilityZone": false, "MasterAvailabilityZone": "cn-beijing-6b", "SlaveAvailabilityZone": "cn-beijing-6a", "ProductId": "ed8b94df-68e0-47dc-a86b-017d1426a8cd", "DiskUsed": , "OrderUse": "BUY", "ProjectId": 0, "ProjectName": " 默认项目 " ], "RequestId": "00c72a39-702d a-c58a837864d2" DescribeDBLogF iles 查看数据库日志文件 查看指定实例的 SlowLog,ErrorLog 及 Binlog 请求参数 金山云 30/67

31 英文名称 中文名称 类型 是否必 须 备注 Action 调用接口名称 String 是取固定值 :DescribeDBLogFiles Version API 版本号 String 是取固定值 : DBInstanceIdentif ier 实例 Id String 是 DBLogType 日志类型 String 是 大小写敏感, 取值范围 :SlowLog\/ErrorLog\ /Binlog Marker 偏移量 Intege r 否 MaxRecords 每页结果中包含的最大 条数 Intege r 否取值范围为 [10.200], 默认为 50 返回值 Request Id 请求 ID Ma rker 下次开始获取记录开始偏移量 Ma xreco rds 每页结果中包含的最大条数 * 类型 :Integer To t a lc o unt 日志文件详情列表 类型 :Integer DescribeDBLo g Files.N 记录总数 类型 :List DescribeDBLo g Files.N.Lo g FileNa me 日志文件下载 URL DescribeDBLo g Files.N.Da t e 日志日期 ( 天 ) 金山云 31/67

32 DescribeDBLo g Files.N.S ize 日志大小 类型 :Long DescribeDBLo g Files.N.Url 日志下载 url, 为 NULL 时, 表示 RDS 没有提供下载链接 URL 请求示例 示例返回 列表返回 金山云 32/67

33 "Data": "DescribeDBLogFiles": [ "LogFileName": " cffad0baac44985b790995f31de23c0/binlogs/v3/71e2bd82-423d-41ae-a9e6-2131a447d780/ _112405_8ee3ac 8a-116c-45e d1c62165dc7b/binlog ?AccessKeyId=bCPubcaLG5jstVnENKm%2F&Expires= &Sig nature=wbn38z9b6knrgmcn8b7xbkg526e%3d", "Size": 0.14, "RawSize": 0.14, "Date": " T11:21: ", "StartTime": " T11:21: ", "EndTime": " T11:21: ", "LogFileName": " cffad0baac44985b790995f31de23c0/binlogs/v3/71e2bd82-423d-41ae-a9e6-2131a447d780/ _112405_8ee3ac 8a-116c-45e d1c62165dc7b/binlog ?AccessKeyId=bCPubcaLG5jstVnENKm%2F&Expires= &Sig nature=3bpxzj%2b0d49em7lc6sevilozo3e%3d", "Size": 5.17, "RawSize": 5.17, "Date": " T11:21: ", "StartTime": " T11:21: ", "EndTime": " T11:21: ", "LogFileName": " cffad0baac44985b790995f31de23c0/binlogs/v3/71e2bd82-423d-41ae-a9e6-2131a447d780/ _112404_8ee3ac 8a-116c-45e d1c62165dc7b/binlog ?AccessKeyId=bCPubcaLG5jstVnENKm%2F&Expires= &Sig nature=kxeriiktewuvbzxbflsb7xkdkjg%3d", "Size": 0.14, "RawSize": 0.14, "Date": " T11:20: ", "StartTime": " T11:20: ", "EndTime": " T11:21: ", "LogFileName": " cffad0baac44985b790995f31de23c0/binlogs/v3/71e2bd82-423d-41ae-a9e6-2131a447d780/ _112404_8ee3ac 8a-116c-45e d1c62165dc7b/binlog ?AccessKeyId=bCPubcaLG5jstVnENKm%2F&Expires= &Sig nature=b340quxs2bnzywo2gqtx1%2bhd4zy%3d", "Size": , "RawSize": , "Date": " T11:06: ", "StartTime": " T11:06: ", "EndTime": " T11:20: " ], "TotalCount": 4, "MaxRecords": 200, "RequestId": "ed03a54a-8ce d60-2b538bd664e9" DeleteDBIn sta n ce 删除数据库实例 删除一个数据库实例 请求参数 金山云 33/67

34 英文名称 中文名称 类型 是否必须 备注 Action 调用接口名称 String 是取固定值 :DeleteDBInstance Version API 版本号 String 是取固定值 : DBInstanceIdentifier 实例 Id String 是 返回值 英文名称 中文名称 类型 备注 RequestId 请求 ID String -- DBInstance RDS 实例信息 DBInstance -- 请求示例 aaf8-050d79b3ea9e 示例返回 "Data":, "RequestId": "590bcf18-54eb-4405-a41d-2c15e16a0eaa" DBIn sta n ce 实例 字段 DBInst a ncec la ss 实例规格 类型 :DBFlavor DBS o urce 数据来源 类型 :DBSource 字段 DBInst a nceident ifier 来源实例 Id DBInst a ncena me 来源实例名称 金山云 34/67

35 DBBa ckupident ifier 来源备份 Id DBBa ckupna me 来源备份名称 Po int InTime 来源时间点 DBInst a nceident ifier 实例 ID DBInst a ncena me 实例名称 DBInst a ncetype 实例类型 取值范围 :HA( 高可用 ),RR( 只读实例 ),TEMP( 临时实例 ) DBInst a nces t a t us 实例状态 取值范围 :CREATING( 创建中 )/ ACTIVE( 运行中 )/ REBOOTING( 重启中 )/ BACKING_UP( 备份中 )/ RESTORING( 备 份恢复中 )/ DELETING( 删除中 )/ LOCKED( 锁定中 )/ FAILED( 失败 )/ UPGRADING( 升级中 )/ MODIFYING_SPEC( 更 配中 )/ MODIFYING_TYPE( 更改实例类型中 )/ RESTART_REQUIRED( 需要重启 )/ BUILDING_RR( 创建 RR 实例中 )/ UNACTIVE( 未激活 )/ RUNNING_TASK( 任务中 )/ INVALID( 请续费 ) G ro upid 实例组 ID 实例 ID Ava ila bilit yzo ne 可用区 金山云 35/67

36 Ma st erava ila bilit yzo ne 主可用区 S la veava ila bilit yzo ne 备可用区 DBS ecurit yg ro upid 安全组 ID Vip 实例虚 IP Po rt 实例端口 类型 :Integer Eng ine 数据库类型 Eng ineversio n 数据库版本号 Inst a ncec rea t etime 实例创建时间 S erviceendtime 实例到期时间 PubliclyAccessible 网络类型 类型 :Boolean 备注 : 默认值 false, 创建 Classic 实例 ; 为 true 时, 创建 VPC 实例 金山云 36/67

37 Rea dreplica DBInst a nceident ifiers HA 实例下关联的 RR 实例 Id 类型 :List VpcId 当网络类型为 VPC 时需要返回 VpcId S ubnet Id 当网络类型为 VPC 时需要返回 SubnetId PMALink 数据库的 PHPMyAdmin 链接地址 Reg io n 实例 Region 信息 PreferredBa ckuptime 自动备份时间 PreferredBa ckupwindo w 备份时间窗口 类型 :Integer Ba ckupret ent io nperio d 备份保留时间 类型 :Integer Eip EipPo rt 类型 : String DBF la vor 实例规格 字段 Io ps 金山云 37/67

38 实例 iops 大小 类型 :Integer Vcpus 实例 cpu 个数 类型 :Integer Disk 实例磁盘空间大小 类型 :Integer Ra m 实例内存空间大小 类型 :Integer Ma xc o nn 实例最大连接数 类型 :Integer DBPa ra m eterg rou p 参数组 字段 DBInst a nceident ifier 实例 ID DBS ecurit yg ro upna me 安全组名称 DBS ecurit yg ro updescript io n 安全组描述 DBS ecurit yg ro upc rea t etime 安全组创建时间 DBS ecurit yg ro uprules 安全组规则 类型 :List DBSecu rityg rou pru le 安全组规则 金山云 38/67

39 字段 Id 安全组的 ID Pro t o co l 协议 类型 :Integer 备注 :TCP C idr IP 段 Fro mpo rt 端口 类型 :Integer To Po rt 实例 ID 类型 :Integer DBE n gin eversion s 字段 Eng ines 数据库类型列表 类型 :Object Key: 数据库类型 Value:[EngineVersion,...] Eng ineversio n 数据库类型对应版本号列表 类型 :Object 字段 Eng ine 数据库类型 类型 : String Eng ineversio n 金山云 39/67

40 版本号 类型 : String DBBa cku p 备份 字段 DBS na psho t Ident ifier 备份 ID DBInst a nceident ifier 实例 ID DBS na psho t Na me 备份的名称 Eng ine 数据库类型 Eng ineversio n 数据库版本 Ba ckupc rea t etime 备份创建时间 取值范围 :COMPLETED( 完成 )/FAILED( 失败 )/ BUILDING( 备份中 )/DELETED( 删除 )/DELETED_FAILED( 删除失败 ) Ba ckupupda t edtime 备份更新时间 Ba ckuptype 备份类型 取值范围 :Snapshot( 手动全量备份 )/AutoBackup( 自动备份 ) Ba ckupmo de 备份方式 金山云 40/67

41 取值范围 :INCREMENTAL_BACKUP( 增量备份 )/FULL_AMOUNT_BACKUP( 全量备份 ) Pa rent Id 父备份 Id 备注 : 当备份为増备时, 用于标记依赖的前置备份 Ba ckups ize 备份大小 类型 :Long 单位 : 字节 (Byte) Ba ckuplo ca t io nref 备份文件地址 Crea tedbpa ra m eterg rou p 创建一个数据库参数组 请求参数 Act io n 调用接口名称 备注 : 取固定值 :CreateDBParameterGroup 是否必须 : 是 Versio n API 版本号 备注 : 取固定值 : 是否必须 : 是 DBPa ra met erg ro upna me 参数组名称 是否必须 : 是 Descript io n 参数组描述 是否必须 : 是 Eng ine 金山云 41/67

42 数据库引擎的名称 备注 : 不同的数据库引擎, 需要不同的数据库参数组是否必须 : 是 Eng ineversio n 数据库引擎的版本 是否必须 : 是 Pa ra met ers.na me.n 参数名 备注 : 无需全量参数 是否必须 : 是 Pa ra met ers.va lue.n 参数值 是否必须 : 是 返回值 DBPa ra met erg ro up 参数组 类型 :DBParameterGroup 请求示例 &Description=test &DBParameterGroupName=test &EngineVersion=mysql-5.5 &Action=CreateDBParameterGroup &Parameters.Name.1=binlog_format &Parameters.Value.1=MIXED 示例返回 金山云 42/67

43 "Data": "DBParameterGroup": "DBParameterGroupID":"72c371a0-4dad ba-9d5fc4517d04", "DBParameterGroupName":"test", "EngineVersion":"mysql-5.5", "Description":"test", "Parameters": "binlog_format":"mixed", "Engine":"mysql", "RequestId":" ", "Status":"OK", "Message":"OK" DeleteDBPa ra m eterg rou p 删除一个数据库参数组 请求参数 Act io n 调用接口名称 备注 : 取固定值 :DeleteDBParameterGroup 是否必须 : 是 Versio n API 版本号 备注 : 取固定值 : 是否必须 : 是 DBPa ra met erg ro upid 参数模板 ID 是否必须 : 是 返回值 Request Id 请求 ID 请求示例 &DBParameterGroupId =xxxxxxxx 金山云 43/67

44 示例返回 "RequestId": " " DescribeDBIn sta n cepa ra m eters 查看当前实例数据库参数运行值列表 请求参数 Act io n 调用接口名称 备注 : 取固定值 :DescribeDBInstanceParameters 是否必须 : 是 Versio n API 版本号 备注 : 取固定值 : 是否必须 : 是 DBInst a nceident ifier 按实例 Id 过滤 是否必须 : 否 备注 : 实例 ID( 传入实例 ID, 获取的是该实例的详情, 否则则获取 list) Eng ine 数据引擎名称 是否必须 : 否 Eng ineversio n 数据库引擎版本 是否必须 : 否 返回值 Request Id 请求 ID Eng ine 金山云 44/67

45 数据库引擎 Eng ineversio n 数据库引擎版本 Pa ra met ers 参数列表 * 类型 :Object 请求示例 &DBInstanceIdentifier=xxxxxxxx &< 公共请求参数 > 示例返回 "Data": "Engine": "MySQL", "EngineVersion": "5.5", "Parameters": "innodb_thread_concurrency": "0", "innodb_strict_mode": "OFF", "slow_launch_time": "2", "log_bin_trust_function_creators": "OFF", "innodb_log_buffer_size": " ", "character_set_server": "utf8", "connect_timeout": "15", "net_write_timeout": "300", "auto_increment_increment": "1", "bulk_insert_buffer_size": " ", "innodb_write_io_threads": "8", "innodb_open_files": "300", "innodb_stats_sample_pages": "8", "table_definition_cache": "400", "concurrent_insert": "AUTO", "default_week_format": "0", "low_priority_updates": "OFF", "wait_timeout": "28800", "query_cache_limit": " ", "myisam_sort_buffer_size": " ", "query_alloc_block_size": "8192", "init_connect": "", "ft_query_expansion_limit": "20", "net_retry_count": "10", "innodb_flush_log_at_trx_commit": "1", "innodb_stats_method": "nulls_equal", "query_cache_type": "OFF", "join_buffer_size": " ", "interactive_timeout": "28800", "lower_case_table_names": "0", "log_queries_not_using_indexes": "OFF", "delayed_queue_size": "1000", "long_query_time": " ", "rpl_semi_sync_master_enabled": "ON", 金山云 45/67

46 "rpl_semi_sync_master_enabled": "ON", "local_infile": "ON", "sync_binlog": "1", "auto_increment_offset": "1", "max_allowed_packet": " ", "ft_min_word_len": "4", "delayed_insert_timeout": "300", "rpl_semi_sync_slave_enabled": "ON", "innodb_old_blocks_pct": "37", "innodb_purge_batch_size": "20", "group_concat_max_len": "1024", "innodb_concurrency_tickets": "500", "delay_key_write": "ON", "innodb_rollback_on_timeout": "OFF", "key_cache_division_limit": "100", "innodb_additional_mem_pool_size": " ", "net_read_timeout": "30", "innodb_table_locks": "ON", "innodb_buffer_pool_size": " ", "innodb_read_io_threads": "8", "binlog_format": "MIXED", "delayed_insert_limit": "100", "innodb_old_blocks_time": "0", "div_precision_increment": "4", "max_connect_errors": "10", "innodb_stats_on_metadata": "OFF", "innodb_read_ahead_threshold": "56", "tmp_table_size": " ", "key_cache_age_threshold": "300", "innodb_max_dirty_pages_pct": "75", "tx_isolation": "REPEATABLE-READ", "query_cache_size": "0", "innodb_file_format": "Antelope", "back_log": "1024", "table_open_cache": "400", "rpl_semi_sync_master_timeout": "1000", "innodb_purge_threads": "1", "innodb_autoinc_lock_mode": "1", "sort_buffer_size": " ", "query_prealloc_size": "8192", "autocommit": "ON", "key_cache_block_size": "1024", "innodb_thread_sleep_delay": "10000", "innodb_lock_wait_timeout": "50", "RequestId": " " DescribeE n gin edef a u ltpa ra m eters 查看数据库默认参数 请求参数 Act io n 调用接口名称 备注 : 取固定值 :DescribeDBInstances 是否必须 : 是 Versio n 金山云 46/67

47 API 版本号 备注 : 取固定值 : 是否必须 : 是 Eng ine 数据引擎名称 是否必须 : 是 Eng ineversio n 数据库引擎版本 是否必须 : 是 返回值 Request Id 请求 ID Pa ra met ers 数据库参数列表 类型 :Object("": "Min":?,"Max":?,"Default":?,"RestartRequired":?,"Type":?) 请求示例 &Engine=mysql &EngineVersion=mysql-5.5 示例返回 "Data": "Engine":"mysql", "EngineVersion":"mysql-5.5", "Parameters": "innodb_thread_concurrency": "Min":0, "Default":0, "Max":1000,, "innodb_strict_mode": "Default":"OFF", 金山云 47/67

48 "Default":"OFF", "Type":"string", "slow_launch_time": "Min":0, "Default":2, "Max":10,, "log_bin_trust_function_creators": "Default":"OFF", "Type":"string", "innodb_log_buffer_size": "Min":262144, "Default": , "Max": , "RestartRequired":true,, "character_set_server": "Default":"utf8", "Type":"string", "connect_timeout": "Min":2, "Default":15, "Max": ,, "net_write_timeout": "Min":1, "Default":300, "Max":500,, "auto_increment_increment": "Min":1, "Default":1, "Max":65535,, "bulk_insert_buffer_size": "Min":0, "Default": , "Max": ,, "innodb_write_io_threads": "Min":1, "Default":8, "Max":64, "RestartRequired":true,, "innodb_open_files": 金山云 48/67

49 "innodb_open_files": "Min":10, "Default":300, "Max":10240, "RestartRequired":true,, "innodb_stats_sample_pages": "Min":1, "Default":8, "Max":2048,, "table_definition_cache": "Min":400, "Default":400, "Max":8096,, "concurrent_insert": "Default":"AUTO", "Type":"string", "default_week_format": "Min":0, "Default":0, "Max":7,, "low_priority_updates": "Default":"OFF", "Type":"string", "wait_timeout": "Min":1, "Default":28800, "Max": ,, "query_cache_limit": "Min":0, "Default": , "Max": ,, "myisam_sort_buffer_size": "Min":4096, "Default": , "Max": ,, "query_alloc_block_size": "Min":1024, "Default":8192, "Max":32768, 金山云 49/67

50 , "init_connect": "Default":"", "Type":"string", "ft_query_expansion_limit": "Min":0, "Default":20, "Max":1000, "RestartRequired":true,, "net_retry_count": "Min":1, "Default":10, "Max":1000,, "innodb_flush_log_at_trx_commit": "Min":0, "Default":1, "Max":2,, "innodb_stats_method": "Default":"nulls_equal", "Type":"string", "query_cache_type": "Default":"OFF", "RestartRequired":true, "Type":"string", "lower_case_table_names": "Min":0, "Default":0, "Max":1, "RestartRequired":true,, "interactive_timeout": "Min":1, "Default":28800, "Max": ,, "join_buffer_size": "Min":128, "Default": , "Max": ,, "log_queries_not_using_indexes": "Default":"OFF", "Type":"string" 金山云 50/67

51 "Type":"string", "delayed_queue_size": "Min":1, "Default":1000, "Max":2000,, "rpl_semi_sync_master_enabled": "Default":"ON", "Type":"string", "long_query_time": "Min":0, "Default":1.0, "Max":5000, "Type":"float", "local_infile": "Default":"ON", "Type":"string", "sync_binlog": "Min":0, "Default":1, "Max":100,, "auto_increment_offset": "Min":1, "Default":1, "Max":65535,, "max_allowed_packet": "Min":1024, "Default": , "Max": ,, "ft_min_word_len": "Min":1, "Default":4, "Max":10, "RestartRequired":true,, "rpl_semi_sync_slave_enabled": "Default":"ON", "Type":"string", "delayed_insert_timeout": "Min":1, "Default":300, "Max":500, 金山云 51/67

52 , "innodb_old_blocks_pct": "Min":5, "Default":37, "Max":95,, "innodb_purge_batch_size": "Min":1, "Default":20, "Max":5000,, "group_concat_max_len": "Min":4, "Default":1024, "Max": ,, "innodb_concurrency_tickets": "Min":1, "Default":500, "Max":1000,, "delay_key_write": "Default":"ON", "Type":"string", "innodb_rollback_on_timeout": "Default":"OFF", "RestartRequired":true, "Type":"string", "key_cache_division_limit": "Min":1, "Default":100, "Max":100,, "innodb_additional_mem_pool_size": "Min": , "Default": , "Max": , "RestartRequired":true,, "net_read_timeout": "Min":1, "Default":30, "Max":500,, "innodb_table_locks": "Default":"ON", 金山云 52/67

53 "Default":"ON", "Type":"string", "innodb_buffer_pool_size": "Min":"instance_memory * 20%", "Default":"instance_memory * 60%", "Max":"instance_memory * 80%", "RestartRequired":true, "Type":"expression", "innodb_read_io_threads": "Min":1, "Default":8, "Max":64, "RestartRequired":true,, "binlog_format": "Default":"MIXED", "Type":"string", "delayed_insert_limit": "Min":1, "Default":100, "Max":2000,, "innodb_old_blocks_time": "Min":0, "Default":0, "Max":1000,, "div_precision_increment": "Min":0, "Default":4, "Max":30,, "innodb_stats_on_metadata": "Default":"OFF", "Type":"string", "max_connect_errors": "Min":1, "Default":10, "Max":100,, "innodb_read_ahead_threshold": "Min":0, "Default":56, "Max":64,, "tmp_table_size": 金山云 53/67