Name: acm-sdk-python
Owner: Alibaba
Description: Alibaba ACM SDK for Python
Created: 2018-02-01 14:36:59.0
Updated: 2018-05-17 08:17:30.0
Pushed: 2018-04-08 12:40:13.0
Homepage: null
Size: 94
Language: Python
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Python SDK for ACM.
For Python 2.7 and above:
install acm-sdk-python
For Python 2.6:
stall setuptools first:
https://pypi.io/packages/source/s/setuptools/setuptools-33.1.1.zip
p setuptools-33.1.1.zip
etuptools-33.1.1 && sudo python setup.py install
setuptools already exists:
easy_install acm-sdk-python
rt acm
OINT = "acm.aliyun.com:8080"
SPACE = "**********"
"**********"
"**********"
t config
nt = acm.ACMClient(ENDPOINT, NAMESPACE, AK, SK)
_id = "com.alibaba.cloud.acm:sample-app.properties"
p = "group"
t(client.get(data_id, group))
d watch
rt time
nt.add_watcher(data_id, group, lambda x:print("config change detected: " + x))
.sleep(5) # wait for config changes
nt = ACMClient(endpoint, namespace, ak, sk)
DEFAULT_TENANT
None
None
Extra option can be set by set_options
, as following:
nt.set_options({key}={value})
Configurable options are:
ACMClient.get(data_id, group, timeout, no_snapshot)
param
data_id Data id.
param
group Group, use DEFAULT_GROUP
if no group specified.
param
timeout Timeout for requesting server in seconds.
param
no_snapshot Whether to use local snapshot while server is unavailable.
return
W
Get value of one config item following priority:
Step 1 - Get from local failover dir(default: ${cwd}/acm/data
).
Failover dir can be manually copied from snapshot dir(default: ${cwd}/acm/snapshot
) in advance.
This helps to suppress the effect of known server failure.
Step 2 - Get from one server until value is got or all servers tried.
Content will be save to snapshot dir after got from server.
Step 3 - Get from snapshot dir.
ACMClient.add_watchers(data_id, group, cb_list)
param
data_id Data id.param
group Group, use DEFAULT_GROUP
if no group specified.param
cb_list List of callback functions to add.return
Add watchers to a specified config item.
threading.Thread
.
ACMClient.remove_watcher(data_id, group, cb, remove_all)
param
data_id Data id.param
group Group, use “DEFAULT_GROUP” if no group specified.param
cb Callback function to delete.param
remove_all Whether to remove all occurrence of the callback or just once.return
Remove watcher from specified key.
ACMClient.list_all(group, prefix)
param
group Only dataIds with group match shall be returned, default is None.param
group only dataIds startswith prefix shall be returned, default is None Case sensitive.return
List of data items.Get all config items of current namespace, with dataId and group information only.
ACMClient.publish(data_id, group, content, timeout)
param
data_id Data id.param
group Group, use “DEFAULT_GROUP” if no group specified.param
content Config value.param
timeout Timeout for requesting server in seconds.return
True if success or an exception will be raised.Publish one data item to ACM.
ACMClient.remove_watcher(data_id, group, cb, remove_all)
param
data_id Data id.param
group Group, use “DEFAULT_GROUP” if no group specified.param
timeout Timeout for requesting server in seconds.return
True if success or an exception will be raised.Remove one data item from ACM.
Debugging mode if useful for getting more detailed log on console.
Debugging mode can be set by:
lient.set_debugging()
ly effective within the current process
A CLI Tool is along with python SDK to make convenient access and management of config items in ACM server.
You can use acm {subcommand}
directly after installation, sub commands available are as following:
add add a namespace
use switch to a namespace
current show current endpoint and namespace
show show all endpoints and namespaces
list get list of dataIds
pull get one config content
push push one config
export export dataIds to local files
import import files to ACM server
Use acm -h
to see the detailed manual.
ACM allows you to encrypt data along with Key Management Service, service provided by Alibaba Cloud (also known as KMS).
To use this feature, you can follow these steps:
pip install aliyun-python-sdk-kms
.cipher-
prefix.ACMClient
, info needed are: region_id
, kms_ak
, kms_secret
, key_id
.Example:
acm.ACMClient(ENDPOINT, NAMESPACE, AK, SK)
t_options(kms_enabled=True, kms_ak=KMS_AK, kms_secret=KMS_SECRET, region_id=REGION_ID, key_id=KEY_ID)
blish an encrypted config item.
blish("cipher-dataId", None, "plainText")
t the content of an encrypted config item.
t("cipher-dataId", None)