edit-icon download-icon

ARMS Open API overview

Last Updated: Aug 10, 2018

An open API provides services over the HTTP interface at the underlying layer. When you call the open API SDK, an HTTP request is sent to the application gateway POP which then forwards the request to the backend server of ARMS for execution.

You can encapsulate parameters in each request. Each request corresponds to a method. The execution result is put into a response.

NOTE: Because the POP gateway provides services through the public network, the access to public network services is required to use API. Otherwise, a message indicating a service connection failure is displayed.

POP parameter description

Parameter Description
region Region of the API gateway. Currently supported regions include China North 2 (Beijing) (cn-beijing) and China East 1 (Hangzhou) (cn-hangzhou). For regions other than Beijing, you can set “region” to “cn-hangzhou”.
accessKeyId/accessKeySecret It is the AccessKey/SecretKey you obtained from the Alibaba Cloud official website.
endpoint The endpoint name must be consistent with the region, for example “cn-hangzhou”.
productName API product name. Set this parameter to “ARMS”.
domain Currently, this parameter is set to arms.[region].aliyuncs.com, for example arms.cn-hangzhou.aliyuncs.com.

Region description

Region RegionId
China East 1 (Hangzhou) cn-hangzhou
China East 2 (Shanghai) cn-shanghai
China North 1 (Qingdao) cn-qingdao
China North 2 (Beijing) cn-beijing
China South 1 (Shenzhen) cn-shenzhen

NOTE: A single IP address can call API up to 100 times per second.

Thank you! We've received your feedback.