本文介绍如何安装及使用RDS SDK for Python。

在线调试和生成SDK示例

OpenAPI Explorer提供在线调用云产品API、动态生成SDK示例代码和快速检索接口等功能，能显著降低使用API的难度，推荐您使用。

前提条件

  • 已创建AccessKey。
    说明 为避免主账号泄露AccessKey带来安全风险，建议您创建RAM用户，授予RAM用户云数据库RDS相关的访问权限，再使用RAM用户的AccessKey调用SDK。详情请参见账号访问控制
  • 已安装Python环境。

注意事项

请确保您的账号拥有相关操作权限，详情请参见RAM资源授权。

安装Alibaba Cloud SDK for Python

安装RDS SDK for Python，详细说明请参见快速开始。

请求步骤

  1. 发起调用，导入相关产品的SDK。 
    from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.acs_exception.exceptions import ClientException
from aliyunsdkcore.acs_exception.exceptions import ServerException
from aliyunsdkrds.request.v20140815.DescribeSQLLogRecordsRequest import DescribeSQLLogRecordsRequest
  2. 新建AcsClient。 
    client = AcsClient(
"<access-key-id>", 
"<access-key-secret>",
"<region-id>")
    说明 region-id可以通过接口DescribeRegions查询。
  3. 设置域名。 
    client.addEndpoint(
"<region-id>", 
"<product>", 
"<endpoint>");
    说明 endpoint请参见如下表 1。
    表 1. RDS OpenAPI域名
    域名 支持的区域 公网IP 控制台链接
    rds.aliyuncs.com

    青岛：cn-qingdao；

    北京：cn-beijing；

    杭州：cn-hangzhou；

    上海：cn-shanghai；

    深圳：cn-shenzhen；

    中国（香港）：cn-hongkong；

    亚太东南 1 （新加坡）：ap-southeast-1；

    美国东部 1 （弗吉尼亚）：us-east-1；

    美国西部 1 （硅谷）：us-west-1。

    		 106.11.XX.XX

    cn-qingdao ；

    cn-beijing ；

    cn-hangzhou；

    cn-shanghai；

    cn-shenzhen；

    cn-hongkong；

    ap-southeast-1；

    us-east-1；

    us-west-1。

    rds.cn-zhangjiakou.aliyuncs.com 华北3（张家口）：cn-zhangjiakou 47.92.XX.XX cn-zhangjiakou
    rds.ap-northeast-1.aliyuncs.com 亚太东北 1 （东京）：ap-northeast-1 47.91.XX.XX ap-northeast-1
    rds.ap-southeast-3.aliyuncs.com 亚太东南3 （吉隆坡）：ap-southeast-3 47.254.XX.XX ap-southeast-3
    rds.ap-southeast-2.aliyuncs.com 亚太东南 2 （悉尼）：ap-southeast-2 47.254.XX.XX ap-southeast-3
    rds.me-east-1.aliyuncs.com 中东东部 1 （迪拜）：me-east-1 47.91.XX.XX me-east-1
    rds.cn-huhehaote.aliyuncs.com 华北 5：cn-huhehaote 39.104.XX.XX cn-huhehaote
    rds.ap-south-1.aliyuncs.com 亚太南部 1 （孟买）：ap-south-1 149.129.XX.XX ap-south-1-1
    rds.ap-southeast-5.aliyuncs.com 亚太东南 5 （雅加达）：ap-southeast-5 149.129.XX.XX ap-southeast-5
  4. 创建Request对象（查询实例详情），并设置请求参数。 
    request = DescribeDBInstanceAttributeRequest();
request.set_DBInstanceId("实例名称");
  5. 初始化客户端。 
    response = client.do_action_with_exception(request)
  6. 调用返回结果。 
    print response

实例生命周期参考示例

  1. 创建实例

    调用示例

    from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.acs_exception.exceptions import ClientException
from aliyunsdkcore.acs_exception.exceptions import ServerException
from aliyunsdkrds.request.v20140815.DescribeDBInstancePerformanceRequest import DescribeDBInstancePerformanceRequest
from aliyunsdkrds.request.v20140815.CreateDBInstanceRequest import CreateDBInstanceRequest

client = AcsClient(
        "<access-key-id>",
        "<access-key-secret>",
        "cn-hangzhou"
        );
request = CreateDBInstanceRequest();
request.set_Engine("PostgreSQL");
request.set_EngineVersion("10.0");
request.set_DBInstanceClass("pg.n1.micro.1");
request.set_DBInstanceStorage("20");
request.set_DBInstanceNetType("Intranet");
request.set_DBInstanceDescription("aaa");
request.set_SecurityIPList("127.0.0.1");
request.set_PayType("Postpaid");
request.set_ZoneId("cn-hangzhou-b");
request.set_InstanceNetworkType("Classic");
request.set_Period("Month");
request.set_UsedTime("2");
try:
        response = client.do_action_with_exception(request)
        print response
except ServerException as e:
        print e
except ClientException as e:
        print e

    返回结果

    {
  "OrderId":"20279634xxxxxxx",
  "DBInstanceId":"pgm-xxxxxxx",
  "RequestId":"BAF2A62B-804B-4C6C-BEE4-BAD2CA4C79E1"
}
  2. 实例变配

    调用示例

    from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.acs_exception.exceptions import ClientException
from aliyunsdkcore.acs_exception.exceptions import ServerException
from aliyunsdkrds.request.v20140815.DescribeDBInstancePerformanceRequest import DescribeDBInstancePerformanceRequest
from aliyunsdkrds.request.v20140815.ModifyDBInstanceSpecRequest import ModifyDBInstanceSpecRequest

client = AcsClient(
        "<access-key-id>",
        "<access-key-secret>",
        "cn-hangzhou"
        );
request = ModifyDBInstanceSpecRequest();
request.set_DBInstanceId("pgm-xxxxxxx");
request.set_PayType("Postpaid");
request.set_DBInstanceClass("pg.n2.small.1");
try:
        response = client.do_action_with_exception(request)
        print response
except ServerException as e:
        print e
except ClientException as e:
        print e

    返回结果

    {"RequestId":"B77F7694-B632-4C2A-BEA5-F8E44AD3A97E"}
  3. 创建只读实例

    调用示例

    from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.acs_exception.exceptions import ClientException
from aliyunsdkcore.acs_exception.exceptions import ServerException
from aliyunsdkrds.request.v20140815.DescribeDBInstancePerformanceRequest import DescribeDBInstancePerformanceRequest
from aliyunsdkrds.request.v20140815.CreateReadOnlyDBInstanceRequest import CreateReadOnlyDBInstanceRequest

client = AcsClient(
        "<access-key-id>",
        "<access-key-secret>",
        "cn-hangzhou"
        );
request = CreateReadOnlyDBInstanceRequest();
request.set_DBInstanceId("rm-xxxxxxx");
request.set_EngineVersion("5.6");
request.set_DBInstanceClass("rds.mysql.s1.small");
request.set_DBInstanceStorage("20");
request.set_DBInstanceDescription("testDesc");
request.set_PayType("Postpaid");
request.set_ZoneId("cn-hangzhou-b");
request.set_InstanceNetworkType("Classic");
try:
        response = client.do_action_with_exception(request)
        print response
except ServerException as e:
        print e
except ClientException as e:
        print e

    返回结果

    {
        "OrderId": "1214369xxxxxxx", 
        "ConnectionString": "rr-bpxxxxxxx.mysql.rds.aliyuncs.com", 
        "DBInstanceId": "rr-bpxxxxxxx", 
        "Port": "3306", 
        "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"

}
  4. 重启实例

    调用示例

    from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.acs_exception.exceptions import ClientException
from aliyunsdkcore.acs_exception.exceptions import ServerException
from aliyunsdkrds.request.v20140815.DescribeDBInstancePerformanceRequest import DescribeDBInstancePerformanceRequest
from aliyunsdkrds.request.v20140815.RestartDBInstanceRequest import RestartDBInstanceRequest

client = AcsClient(
        "<access-key-id>",
        "<access-key-secret>",
        "cn-hangzhou"
        );
request = RestartDBInstanceRequest();
request.set_DBInstanceId("rm-bpxxxxxxx");
try:
        response = client.do_action_with_exception(request)
        print response
except ServerException as e:
        print e
except ClientException as e:
        print e

    返回结果

    {"RequestId":"EED6E546-099A-4434-AB09-C85DD396E17B"}
  5. 实例列表

    调用示例

    from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.acs_exception.exceptions import ClientException
from aliyunsdkcore.acs_exception.exceptions import ServerException
from aliyunsdkrds.request.v20140815.DescribeDBInstancePerformanceRequest import DescribeDBInstancePerformanceRequest
from aliyunsdkrds.request.v20140815.DescribeDBInstancesRequest import DescribeDBInstancesRequest

client = AcsClient(
        "<access-key-id>",
        "<access-key-secret>",
        "cn-hangzhou"
        );
request = DescribeDBInstancesRequest();
print response
try:
        response = client.do_action_with_exception(request)
        print response
except ServerException as e:
        print e
except ClientException as e:
        print e

    返回结果

    {
    "Items": {
        "DBInstance": [
            {
                "LockMode": "Unlock",
                "DBInstanceNetType": "Intranet",
                "DBInstanceClass": "rds.mysql.s2.large",
                "ResourceGroupId": "rg-acfxxxxxxx",
                "DBInstanceId": "rm-bpxxxxxxx",
                "VpcCloudInstanceId": "",
                "ZoneId": "cn-hangzhou-f",
                "ReadOnlyDBInstanceIds": {
                    "ReadOnlyDBInstanceId": []
                },
                "InstanceNetworkType": "Classic",
                "ConnectionMode": "Standard",
                "Engine": "MySQL",
                "MutriORsignle": false,
                "InsId": 1,
                "ExpireTime": "",
                "CreateTime": "2018-11-07T15:52Z",
                "DBInstanceType": "Primary",
                "RegionId": "cn-hangzhou",
                "EngineVersion": "5.7",
                "LockReason": "",
                "DBInstanceStatus": "Running",
                "PayType": "Postpaid"
            },
            {
                "LockMode": "Unlock",
                "DBInstanceNetType": "Intranet",
                "DBInstanceClass": "rds.mysql.s2.large",
                "ResourceGroupId": "rg-acfxxxxxxx",
                "DBInstanceId": "rm-bpxxxxxxx",
                "VpcCloudInstanceId": "",
                "ZoneId": "cn-hangzhou-g",
                "ReadOnlyDBInstanceIds": {
                    "ReadOnlyDBInstanceId": []
                },
                "InstanceNetworkType": "Classic",
                "ConnectionMode": "Standard",
                "Engine": "MySQL",
                "MutriORsignle": false,
                "InsId": 1,
                "ExpireTime": "2019-11-07T16:00:00Z",
                "CreateTime": "2018-11-07T15:42Z",
                "DBInstanceType": "Primary",
                "RegionId": "cn-hangzhou",
                "EngineVersion": "5.7",
                "LockReason": "",
                "DBInstanceStatus": "Running",
                "PayType": "Prepaid"
            }
        ]
    },
    "TotalRecordCount": 209,
    "PageNumber": 1,
    "RequestId": "0C5793A6-80C3-4AC0-A5E1-CCA25F387AE6",
    "PageRecordCount": 30
}