You can call Operation Orchestration Service (OOS) API operations by sending HTTP or HTTPS GET requests based on URLs. Each URL must include request parameters. This topic explains the syntax of HTTP or HTTPS GET requests and provides the endpoint of the OOS API.

Sample request

The following section provides an unencoded URL request to call the CreateTemplate operation: 
https://oos.cn-hangzhou.aliyuncs.com/?Action=CreateTemplate
&TemplateName=YourTemplateName
&<Common request parameters>
  • http specifies the protocol for transmitting the request.
  • oos.cn-hangzhou.aliyuncs.com specifies the endpoint of the OOS API.
  • Action=CreateTemplate specifies the operation that you want to perform. TemplateName=YourTemplateName is a request parameter for calling the CreateTemplate operation.
  • <Common request parameters> are common parameters defined in the system.

Protocols

You can send requests over HTTP or HTTPS. We recommend that you send requests over HTTPS to enhance security.

We recommend that you use the HTTPS protocol if the request contains sensitive data, such as the username, password, and Secure Shell (SSH) key pairs. For example, the request parameters of the StartExecutionoperation contain sensitive data.

Endpoints

The following table lists the endpoints of the OOS API. To minimize network latency, we recommend that you specify the endpoint based on the region where you make API requests.

China (Hangzhou) oos.cn-hangzhou.aliyuncs.com
China (Beijing) oos.cn-beijing.aliyuncs.com
China (Hohhot) oos.cn-huhehaote.aliyuncs.com
China (Zhangjiakou) oos.cn-zhangjiakou.aliyuncs.com
China (Hong Kong) oos.cn-hongkong.aliyuncs.com
China (Shanghai) oos.cn-shanghai.aliyuncs.com
China (Shenzhen) oos.cn-shenzhen.aliyuncs.com
India (Mumbai) oos.ap-south-1.aliyuncs.com
US (Virginia) oos.us-east-1.aliyuncs.com
Germany (Frankfurt) oos.eu-central-1.aliyuncs.com
UK (London) oos.eu-west-1.aliyuncs.com

Request parameters

You need to specify the Action parameter to decide which operation to perform. For example, to create a template, set Action to CreateTemplate. You need to specify both common request parameters and parameters that are specific to the operation.

Encoding

Requests and responses are encoded using UTF-8.