To send a Resource Orchestration Service (ROS) API request, you must send an HTTPS GET or POST request to the ROS endpoint. You must add the request parameters that correspond to the API operation being called. After you call the API, the system returns a response. The request and response are encoded in UTF-8.
Request syntax
ROS API operations use the Remote Procedure Call (RPC) protocol. You can call ROS API operations by sending HTTPS GET or POST requests.
The following request syntax is used:
https://Endpoint/?Action=xx&Parameterswhere:
Endpoint
Public endpoint: the public endpoint of the ROS API is ros.aliyuncs.com. All regions are supported.
VPC endpoint: the virtual private cloud (VPC) endpoint of the ROS API is ros.vpc-proxy.aliyuncs.com. The following table lists the supported regions.
Region
Region ID
China (Hangzhou)
cn-hangzhou
China (Shanghai)
cn-shanghai
China (Nanjing - Local Region)
cn-nanjing
China (Qingdao)
cn-qingdao
China (Beijing)
cn-beijing
China (Zhangjiakou)
cn-zhangjiakou
China (Hohhot)
cn-huhehaote
China (Ulanqab)
cn-wulanchabu
China (Shenzhen)
cn-shenzhen
China (Heyuan)
cn-heyuan
China (Guangzhou)
cn-guangzhou
China (Chengdu)
cn-chengdu
China (Hong Kong)
cn-hongkong
US (Silicon Valley)
us-west-1
US (Virginia)
us-east-1
Singapore (Singapore)
ap-southeast-1
Australia (Sydney)
ap-southeast-2
Malaysia (Kuala Lumpur)
ap-southeast-3
Indonesia (Jakarta)
ap-southeast-5
Philippines (Manila)
ap-southeast-6
Thailand (Bangkok)
ap-southeast-7
India (Mumbai)
ap-southeast-1
Japan (Tokyo)
ap-northeast-1
South Korea (Seoul)
ap-northeast-2
Germany (Frankfurt)
eu-central-1
UK (London)
eu-west-1
UAE (Dubai)
me-east-1
China East 1 Finance
cn-hangzhou-finance
China East 2 Finance
cn-shanghai-finance-1
China South 1 Finance
cn-shenzhen-finance-1
China (Fuzhou - Local Region)
cn-fuzhou
China North 2 Ali Gov 1
cn-north-2-gov-1
Action
The name of the operation being called. For example, to query the list of stacks, you must set the Action parameter to ListStacks.
Parameters
The request parameters for the operation. Separate multiple parameters with ampersands (&).
Request parameters include both common parameters and operation-specific parameters. Common parameters include the API version number and authentication information. For more information, see Common parameters.
The following example demonstrates how to call the ListStacks operation to query the list of stacks:
https://ros.aliyuncs.com/?Action=ListStacks
&RegionId=cn-hangzhou
&Format=xml
&Version=2019-09-10
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1521552885****
&SignatureVersion=1.0
&AccessKeyId=LTAI4GENiH2u8MVj7Khh****
&Timestamp=2020-06-01T12:00:00Z