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 request syntax is as follows:
  • Endpoint
    • Public endpoint: You can access this public endpoint in all regions.
    • VPC endpoint: The following table lists the supported regions.
      Region Region ID
      China (Hangzhou) cn-hangzhou
      China (Shanghai) cn-shanghai
      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-south-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
      China South 1 Finance cn-shenzhen-finance
      China North 2 Ali Gov 1 cn-north-2-gov-1
  • Action

    The operation that you want to perform. For example, you can call the ListStacks operation to query the list of stacks.

  • 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 shows how to query the list of stacks by calling the ListStacks operation.