Configure ROA-style API by using the OOS custom template - CloudOps Orchestration Service

Creating buckets and configuring their properties are common operations in Object Storage Service (OSS). For long‑distance data transfers, enabling and configuring transfer acceleration is also important. This tutorial shows how to use custom templates in CloudOps Orchestration Service (OOS) to call ROA‑style APIs and configure both the bucket and its transfer acceleration feature.

Background information

Calling ROA-style API for certain Alibaba Cloud services often requires configuring complex parameters like Body, Headers, Method, and URI. OOS simplifies this process in the console by automatically filling in many of these parameters. The console also provides prompts to help configure different invocation parameters for the ROA-style API.

This tutorial focuses on configuring OSS buckets and its transfer acceleration feature by calling ROA-style API with OOS custom templates. For other cloud services, refer to the table below.

OOS supports configuring ROA‑style APIs for the following types of cloud services:

Note

For details on cloud service supported by OOS for API calls, refer to the supported cloud product list. If the cloud service you need is not listed, join the DingTalk group (group number: 23330931).

Procedure

Note

If you are using a RAM user, make sure that the Alibaba Cloud account has granted the RAM user the AliyunOOSFullAccess and AliyunOSSFullAccess policies.

Navigate to the OOS console > Custom Task Template page, and click Create Template.
Select Create Template Based on Samples, select ACS-OOS-ExampleExecuteECSDescribeRegions for Select Template , and click Next Step.
Configure the OSS bucket and its transfer acceleration feature by invoking ROA-style API through OOS.
This example shows how to uses the flow configuration editor to complete the configuration. If you have a YAML command ready, you can also configure directly with YAML.
Expand to view: YAML command template example
```
FormatVersion: OOS-2019-06-01
Description: Execute a single API
Tasks:
  - Name: PutBucket
    Action: ACS::ExecuteApi
    Description: ''
    Properties:
      Service: oss
      API: PutBucket
      Parameters:
        bucket: '{{ bucket }}'
      Headers:
        x-oss-acl: private
      Body:
        CreateBucketConfiguration:
          StorageClass: Standard
          DataRedundancyType: LRS
  - Action: ACS::ExecuteApi
    Name: ExecuteApi1
    Description: ''
    Properties:
      Service: oss
      API: PutBucketTransferAcceleration
      Parameters:
        bucket: '{{ bucket }}'
      Headers: {}
      Body:
        TransferAccelerationConfiguration:
          Enabled: 'true'
Parameters:
  bucket:
    Type: String
```
1. On the Process Configuration tab, click Add Template Parameters on the right.
2. In the pop-up Parameter panel, set the Parameter Name (e.g. Bucket-example), set Parameter Type to String, and click to close the panel.
3. Configure task‑related parameters in the ExecuteApi stage under the Process Configuration tab.
  1. In the Task Input section, select service name and API name.
  2. Set the corresponding parameters for the ROA-style API.
    - Required Parameters: In the bucket field, select Reference Parameter/Task Output and then choose the pre-configured template parameter (Bucket-example).
    - Other Parameters: For Headers or Body field, configure as needed. If there are no special requirements, leave them unset.
      Note
      More information about specific parameter, you can hover over the to view the associated tips.
4. At the bottom of the page, you can click Add New Task, and on the pop-up Quick Selection page, select ACS::ExecuteApi.
5. In the ExecuteApi1 section, configure the relevant task parameters.
  1. In the Task Input section, select the service name and API name.
  2. Set the corresponding parameters for the ROA-style API.
    - Required Parameters: In the bucket field, select Reference Parameter/Task Output and then choose the pre-configured template parameter (Bucket-example).
    - Body: Selecting true indicates that the bucket enables the transfer acceleration feature.
      Note
      For more information about specific parameter, hover over the to view the associated tips.
Click Create Template, input the template name in the pop-up dialog box, and then click OK.
Locate the custom task template you created, click Create Execution in the corresponding Actions column, and then click Next Step: Parameter Settings .
Enter a custom bucket name after the Bucket-exampleparameter, e.g.test-by-oos, choose Next Step: Confirm, and then click Create.

Verification

Visit the OOS console > Buckets page, and click created bucket name (e.g. test-by-oos).
In the left-side navigation pane, select Bucket Configuration > Transfer Acceleration, and ensure the transfer acceleration feature is enabled.
By calling ROA‑style APIs through OOS custom templates, you can quickly and easily create a bucket and configure transfer acceleration feature.