Alibaba Cloud Ims (20190815) SDK

3.3.6 · active · verified Fri Apr 17

The `alibabacloud-ims20190815` library is the Alibaba Cloud SDK for Identity Management Service (IMS), specifically for the API version dated 2019-08-15. It provides Python bindings to interact with IMS resources like users, groups, and access keys, simplifying API calls and response handling. It is currently at version 3.3.6 and receives regular maintenance updates as part of the broader Alibaba Cloud Python SDK ecosystem.

Common errors

```
TypeError: __init__() missing 1 required positional argument: 'config'
```
cause The client class (e.g., `ImsClient`) requires a `Config` object during initialization.

fix Pass a valid `Config` instance when creating the client: `client = ImsClient(config)`.
```
NoCredentialProviderError: The AK/SK credentials must be set correctly.
```
cause The SDK could not find valid Alibaba Cloud Access Key ID and Secret. This usually means environment variables are not set or the `Config` object was not correctly initialized with credentials.

fix Set `ALIBABA_CLOUD_ACCESS_KEY_ID` and `ALIBABA_CLOUD_ACCESS_KEY_SECRET` environment variables, or pass `access_key_id` and `access_key_secret` directly to the `Config` constructor.
```
SDK.ServerError: {"Code":"InvalidAccessKeyId.NotFound","Message":"The Access Key ID provided does not exist in our records.",...}
```
cause The provided Access Key ID is incorrect, revoked, or does not belong to your Alibaba Cloud account.

fix Verify that `ALIBABA_CLOUD_ACCESS_KEY_ID` is correct. Check the Alibaba Cloud console for the status of the Access Key and ensure it matches what is being used.
```
SDK.ServerError: {"Code":"SignatureDoesNotMatch","Message":"The request signature does not conform to Alibaba Cloud standards.",...}
```
cause The Access Key Secret used to sign the request is incorrect.

fix Verify that `ALIBABA_CLOUD_ACCESS_KEY_SECRET` is correct. Ensure there are no leading/trailing spaces or incorrect characters.

Warnings

gotcha Authentication requires setting `ALIBABA_CLOUD_ACCESS_KEY_ID` and `ALIBABA_CLOUD_ACCESS_KEY_SECRET` environment variables or passing them directly in the `Config` object. Incorrect or missing credentials will result in `NoCredentialProviderError` or authentication failures like `InvalidAccessKeyId`.
Fix: Ensure `os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID')` and `os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET')` return valid credentials. Verify permissions of the Access Key used.
gotcha Alibaba Cloud services are region-specific. While `cn-hangzhou` is a common default, ensure the `region_id` in your `Config` matches where your IMS resources are located or where the service is available. Using an unsupported region can lead to `EndpointNotFound` or service unavailability errors.
Fix: Set `config.region_id` to an appropriate region (e.g., 'ap-southeast-1', 'us-east-1'). Refer to Alibaba Cloud documentation for service availability by region.
gotcha The `alibabacloud-ims20190815` SDK often relies on core 'tea' dependencies like `alibabacloud-tea-openapi` and `alibabacloud-tea-util`. Although `pip` usually handles transitive dependencies, explicitly installing them (e.g., `pip install alibabacloud-tea-openapi alibabacloud-tea-util`) can prevent unexpected import errors or runtime issues, especially in isolated environments.
Fix: Explicitly install `alibabacloud-tea-openapi` and `alibabacloud-tea-util` alongside the service-specific SDK.

Install

pip install alibabacloud-ims20190815 Install Ims SDK
pip install alibabacloud-tea-openapi alibabacloud-tea-util Install core dependencies (often implicit)

Imports

Client

from alibabacloud_ims20190815.client import Client

models
wrong:
```
from alibabacloud_ims20190815.models import ListAccessKeysRequest
```
correct:
```
from alibabacloud_ims20190815 import models
```
While importing specific models directly is correct, importing `models` module and accessing attributes from it is more common and avoids long import lines for multiple request/response types.
Config
```
from alibabacloud_tea_openapi.models import Config
```
The `Config` class for client configuration is provided by the shared `alibabacloud-tea-openapi` dependency, not directly by the service SDK.

Quickstart

This quickstart demonstrates how to initialize the IMS client using environment variables for authentication and make a basic API call to list access keys. It highlights the use of `Config` from `alibabacloud_tea_openapi` and the `Client` and `models` from the specific IMS SDK.

import os
from alibabacloud_ims20190815.client import Client as ImsClient
from alibabacloud_ims20190815 import models as ImsModels
from alibabacloud_tea_openapi.models import Config

# Ensure environment variables are set for authentication
# export ALIBABA_CLOUD_ACCESS_KEY_ID='your_access_key_id'
# export ALIBABA_CLOUD_ACCESS_KEY_SECRET='your_access_key_secret'

# Configure client with Access Key, Secret, and Region
# Default region 'cn-hangzhou' might work, but specify if needed.
config = Config(
    access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', ''),
    access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', ''),
    region_id='cn-hangzhou' # Or your desired region, e.g., 'ap-southeast-1'
)

# If a specific endpoint is required (e.g., private link, specific region), uncomment and set it.
# config.endpoint = 'ims.cn-hangzhou.aliyuncs.com'

try:
    # Initialize the client
    client = ImsClient(config)

    # Create a request object (e.g., for listing access keys)
    list_access_keys_request = ImsModels.ListAccessKeysRequest()

    # Call the API
    response = client.list_access_keys(list_access_keys_request)

    # Print the response body
    print(response.body)

except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →