Install & Compatibility
Where this runs
tested against v5.0.47 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.630s · 496.6MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 29.5s · import 0.536s · 497MB
529MB installed
● package 529MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ACEPApi
✓ from volcenginesdkacep import ACEPApi
✗ from volcengine.client import Client
ADVDEFENCEApi
✓ from volcenginesdkadvdefence import ADVDEFENCEApi
✗ from volcengine.client import Client
AIDAPApi
✓ from volcenginesdkaidap import AIDAPApi
✗ from volcengine.client import Client
This quickstart initializes an IAMService client using environment variables for credentials and then attempts to list the access keys associated with the account. This demonstrates basic client setup and a simple API call.
import os
from volcengine.iam.IAMService import IAMService
# Set your Volcengine Access Key (AK) and Secret Key (SK) as environment variables
# or replace with actual credentials. NEVER hardcode production credentials.
VOLCENGINE_AK = os.environ.get("VOLCENGINE_AK", "YOUR_AK")
VOLCENGINE_SK = os.environ.get("VOLCENGINE_SK", "YOUR_SK")
if VOLCENGINE_AK == "YOUR_AK" or VOLCENGINE_SK == "YOUR_SK":
print("Please set VOLCENGINE_AK and VOLCENGINE_SK environment variables or replace placeholders.")
exit(1)
try:
# Initialize the IAM service client
iam_service = IAMService()
iam_service.set_ak(VOLCENGINE_AK)
iam_service.set_sk(VOLCENGINE_SK)
# Default region is cn-beijing. You can set it explicitly if needed:
# iam_service.set_region("cn-beijing")
# Example: List up to 10 access keys for the current account
print("Attempting to list access keys...")
resp = iam_service.list_access_keys({"Limit": 10})
if resp.get("ResponseMetadata", {}).get("Error"):
error_message = resp["ResponseMetadata"]["Error"]["Message"]
print(f"Error listing access keys: {error_message}")
else:
access_keys = resp.get("Result", {}).get("AccessKeys", [])
print(f"Successfully listed {len(access_keys)} access keys.")
for key in access_keys:
print(f" Access Key Id: {key.get('AccessKeyId')}, Status: {key.get('Status')}")
except Exception as e:
print(f"An error occurred: {e}")
Upgrade
Version history
5.0.47latest on PyPI · released Aug 27, 2026
Audit
Dependencies
requestsrequiredRequired for making HTTP requests to Volcengine APIs.
cryptographyoptionalOptional dependency for KMS (Key Management Service) related operations.
pyyamloptionalOptional dependency for loading configurations from YAML files.