Qiniu Cloud SDK for Python

Install the SDK using pip to include it in your Python environment.

$ pip install qiniu

If you encounter the error ImportError: No module named requests.auth, you need to install the requests library manually:

$ pip install requests

To upload data, follow these steps:

1. Initialize qiniu.Auth with your access_key and secret_key.
2. Generate an upload token using q.upload_token(bucket_name).
3. Use qiniu.put_data(token, key, data) to perform the upload.

The put_data method returns a tuple (ret, info). If ret is not None, the upload was successful. If ret is None, info contains the error message.

import qiniu

# Initialize authentication
q = qiniu.Auth(access_key, secret_key)
key = 'hello'
data = 'hello qiniu!'

# Generate upload token
token = q.upload_token(bucket_name)

# Upload data
ret, info = qiniu.put_data(token, key, data)

if ret is not None:
    print('All is OK')
else:
    print(info) # error message in info

You can use the list_apps.py example script to list your Qiniu applications by providing your Access Key (AK) and Secret Key (SK) as command-line arguments.

$ python list_apps.py <YOUR_AK> <YOUR_SK>

Ensure your Python version matches the requirements for the SDK version you are using:

To manage resources within a specific application, you can obtain a QcosClient using the AccountClient.

• get_qcos_client(app_uri): Returns a cached QcosClient for the given app_uri. Warning: The internal cache is not thread-safe.
• create_qcos_client(app_uri): Manually creates a new QcosClient. This method automatically resolves the application's valid authentication and regional product information.

# Assuming 'client' is an initialized AccountClient
app_uri = 'your_app_uri'
qcos_client = client.get_qcos_client(app_uri)

Injection rules allow you to define how data or configurations are injected into sandboxes. These operations typically require Qiniu AK/SK authentication.

• list_injection_rules(): Lists all available injection rules.
• create_injection_rule(**opts): Creates a new rule. Pass the rule configuration via the injection key.
• get_injection_rule(rule_id): Retrieves a specific rule.
• update_injection_rule(rule_id, **opts): Updates an existing rule.
• delete_injection_rule(rule_id): Deletes a rule.

# Create an injection rule
client.create_injection_rule(injection={'type': 'id', 'id': 'some_id'})

# List rules
rules = client.list_injection_rules()

Retrieve operational data from running sandboxes:

• get_metrics(sandbox_id, **opts): Gets metrics for a single sandbox.
• get_sandboxes_metrics(sandbox_ids): Gets metrics for multiple sandboxes. sandbox_ids can be a list of strings, a list of dicts containing sandboxId, or a dict with a sandbox_ids key.
• get_logs(sandbox_id, **opts): Retrieves logs for a specific sandbox.

# Get logs
logs = client.get_logs('sandbox_id_123')

# Get metrics for multiple sandboxes
metrics = client.get_sandboxes_metrics(['id1', 'id2'])

The AccountClient provides methods to inspect your account status and regional availability:

• get_account_info(): Returns a tuple (result, ResponseInfo) containing the information of the account associated with the provided auth.
• get_region_products(region): Returns product information for a specific region (e.g., region='nq').
• get_app_region_products(app_uri): Returns the product information for the region where the specified application is located.