通过OOS自定义模板配置ROA风格API

更新时间:2025-03-14 06:46:29

在使用OSS过程中,创建和设置Bucket属性等功能往往会被频繁使用,同时,如果存在远距离数据传输加速的需求,也需要对Bucket的传输加速进行设置。基于该场景,本示例教程为您展示如何通过OOS自定义模板快速且简便地调用ROA风格API,以实现OSS Bucket及其传输加速功能的配置。

背景信息

阿里云部分云服务调用ROA风格API时,往往需要配置复杂的Body、Headers、Method以及URI等参数。而系统运维管理OOS支持在控制台以轻松简洁的方式调用ROA风格API,您无需考虑复杂的参数值,系统会自动填充,您只需根据控制台的提示即可轻松配置ROA风格API的各种调用参数。

本教程以通过OOS自定义模板调用ROA风格API实现OSS Bucket及其传输加速功能的配置为例,其他云服务的相关配置,请参考本文操作。

OOS支持配置ROA风格API的云服务类型如下:

说明

关于OOS执行云服务API具体支持的云产品信息,请参见支持的云产品列表。如果您想调用的云产品不在我们的支持列表上,请添加钉钉群(群号:23330931)联系我们。

操作步骤

说明

如果您使用RAM用户,请确保阿里云账号(主账号)已为该RAM用户授权AliyunOOSFullAccessAliyunOSSFullAccess策略。

  1. 进入系统运维编排OOS>自定义任务模板页面,单击创建模板

  2. 使用示例模板创建方式下,运维模板选择基础示例模板,单击下一步

    基础示例模版

  3. 通过OOS调用ROA风格API方式配置OSS Bucket及其传输加速功能。

    本示例以通过流程配置编辑器方式创建自定义模板为例,快速调用ROA风格API来实现OSS Bucket及其传输加速功能的配置。如果您已先编写好YAML命令,也可直接采用YAML方式配置OSS Bucket及其传输加速功能。

    展开查看:YAML命令模板示例

    FormatVersion: OOS-2019-06-01
    Description: 执行单个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. 流程配置页签下,单击右侧的添加模板参数

    2. 在弹出的参数面板中,设置参数名称(例如Bucket-example),选择参数类型字符串,单击screenshot_2025-03-06_13-50-28退出该面板。

    3. 流程配置页签下的ExecuteApi(执行API)阶段,配置任务相关参数。

      1. 任务输入区域,选择服务名称和API名称。

        服务名称

      2. 设置ROA风格API对应参数。

        • 必填参数:在bucket参数处,选择引用参数/任务输出,然后选择已设置好的模板参数(Bucket-example)。

          API参数风格-0

        • 其他参数:例如Headers参数或Body参数,您可以根据需要进行选择,若无特殊需求则无需设置。

          说明

          如果需要详细了解某些参数含义,您可以在参数旁边的screenshot_2025-03-06_15-59-08上,查看该参数的相关提示。

    4. 在页面底部,单击添加新任务,在弹出的快速选择页面,继续选择执行云服务API

      新任务-zh

    5. ExecuteApi1阶段,配置任务相关参数。

      1. 任务输入区域,选择服务名称和API名称。

        服务名称

      2. 设置ROA风格API对应参数。

        API参数风格

        • 必填参数:在bucket参数处,选择引用参数/任务输出,然后选择已设置好的模板参数(Bucket-example)。

        • Body参数:选择true即表示目标Bucket开启传输加速功能。

          说明

          如果需要详细了解参数含义,您可以在参数旁边的screenshot_2025-03-06_15-59-08上,查看该参数的相关提示。

  4. 单击创建模板,在弹出的对话框中输入模板名称,然后单击完成创建

  5. 找到已创建的自定义任务模板,单击对应操作列的创建执行,然后单击下一步:设置参数

  6. Bucket-example参数后输入自定义Bucket名称(例如test-by-oos),单击下一步:确定,然后单击创建

验证结果

  1. 进入对象存储OSS>Bucket列表页面,找到并单击已创建的Bucket名称(例如test-by-oos)。

  2. 在左侧导航栏,选择Bucket配置 > 传输加速,查看设置的传输加速功能已默认开启。

    传输加速

    可以看出通过OOS自定义模板调用ROA风格API后,可以快速且简便地创建Bucket并配置传输加速功能。

  • 本页导读 (1)
  • 背景信息
  • 操作步骤
  • 验证结果
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等