Alibaba Cloud ADB (AnalyticDB) SDK 20211201

Warnings

• breaking Alibaba Cloud SDKs are versioned by API dates (e.g., `adb20211201`). An update to this package (`pip install --upgrade alibabacloud-adb20211201`) will only update the client for the *20211201* API version. If new API features are released under a *newer API version* (e.g., `adb20240101`), you will need to install a *new, separate package* (e.g., `alibabacloud-adb20240101`), not just upgrade this one. This can lead to unexpected missing features if you expect all ADB features to be in a single continually updated package.
  Fix: Always check Alibaba Cloud's official documentation for the latest API versions and corresponding SDK packages. If newer features are desired, install the relevant new API-versioned SDK package.
• gotcha The `config.endpoint` is a critical configuration parameter. Incorrectly setting or omitting the endpoint can lead to connection errors, requests being routed to the wrong region, or authentication failures. Each service and region typically has a specific endpoint.
  Fix: Always explicitly set `config.endpoint` to the correct value for your service and region. Refer to Alibaba Cloud's official documentation for the exact endpoint URLs. For example, `adb.cn-hangzhou.aliyuncs.com` for AnalyticDB in Hangzhou.
• gotcha Alibaba Cloud Python SDKs, especially those based on the Tea framework, require request parameters to be encapsulated within specific request model objects (e.g., `DescribeDBClusterAttributeRequest`), rather than being passed as simple dictionaries. Passing a dictionary where a model object is expected will result in type errors.
  Fix: Always instantiate the appropriate request model class (found in `alibabacloud_adb20211201.models`) and pass parameters as attributes to that object. For example, `request = DescribeDBClusterAttributeRequest(db_cluster_id='...')`.
• gotcha While a generic `try...except Exception as error` can catch errors, for robust applications, it's advisable to implement more specific error handling. Alibaba Cloud API errors often come with specific `code` and `message` attributes within the exception object (e.g., `error.code`, `error.message`), which can be parsed for detailed problem identification.
  Fix: Inspect the `error` object for `code` and `message` attributes to implement more granular error handling logic. Consult the ADB API documentation for a list of common error codes.

Install

• pip install alibabacloud-adb20211201 Install via pip

Imports

• Client

  from alibabacloud_adb20211201.client import Client

• DescribeDBClusterAttributeRequest

  from alibabacloud_adb20211201.models import DescribeDBClusterAttributeRequest

  Ensure you import from the specific `adb20211201` package, not a generic `adb` or an older version package.
• Config

  from alibabacloud_tea_openapi.models import Config

  The core `Config` object comes from `alibabacloud-tea-openapi`, not the service-specific SDK package.
• RuntimeOptions

  from alibabacloud_tea_util.models import RuntimeOptions

  The `RuntimeOptions` class comes from `alibabacloud-tea-util`, not the service-specific SDK package.

Quickstart

This quickstart demonstrates how to initialize the `adb20211201` client, configure it with credentials and an endpoint, and then make a basic API call (describing a DB Cluster's attributes). Ensure your `ALIBABA_CLOUD_ACCESS_KEY_ID` and `ALIBABA_CLOUD_ACCESS_KEY_SECRET` environment variables are set, and replace the placeholder `db_cluster_id` and `cn-hangzhou` with your actual values.

import os
from alibabacloud_adb20211201.client import Client
from alibabacloud_adb20211201.models import DescribeDBClusterAttributeRequest
from alibabacloud_tea_openapi.models import Config
from alibabacloud_tea_util.models import RuntimeOptions

# Configure AccessKey ID and Secret from environment variables
config = Config(
    access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', ''),
    access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
)

# IMPORTANT: Configure the correct endpoint for your region and service.
# Replace 'cn-hangzhou' with your actual region.
config.endpoint = 'adb.cn-hangzhou.aliyuncs.com'

# Initialize the ADB client
client = Client(config)

# Example: Describe a DB Cluster Attribute
# Replace 'am-xxxxxxxxx' with an actual ADB cluster ID
request = DescribeDBClusterAttributeRequest(
    db_cluster_id='am-testclusterid'
)

runtime = RuntimeOptions()
try:
    # Make the API call
    response = client.describe_dbcluster_attribute_with_options(request, runtime)
    print("Successfully described DB Cluster attribute:")
    print(response.body.to_map())
except Exception as error:
    print(f"An error occurred: {error}")
    # In a production environment, parse 'error.code' and 'error.message'
    # for more specific error handling.