首页 运维编排服务 操作指南 动作 原子动作 API类动作 ACS::ExecuteAPI

ACS::ExecuteAPI

更新时间: 2020-01-10 17:45:56

用途

此Action可以用来调用某个云产品（如ECS）的OpenAPI。如果OpenAPI是一个异步调用，则您可以使用ACS::WaitFor来等待其资源达到预期的状态。请参考ACS::WaitFor动作。

语法

RPC风格API

说明：Tasks.Properties.API 就是云产品API的Action，所以无需在 Tasks.Properties.Parameters 中填写 Action

  • YAML格式
  2. Tasks:
  3.   - Name: executeAPITaskExample
  4.     Action: ACS::ExecuteAPI
  5.     Properties:
  6.       Service: ECS # 必填，云产品code name，即RAM ARN里面的云产品code name。大小写不敏感。如ECS, RDS, FC...
  7.       API: DescribeInstances # 必填，云产品的API名称。大小写不敏感。如ECS API "DescribeInstances"
  8.       AutoPaging: false # 可选，对于支持分页的OpenAPI，是否自动翻页以获取所有的结果，默认:true
  9.       Parameters:  # 调用OpenAPI所需要的参数，具体参考具体的API帮助
  10.         Parameter1: Value1
  11.         Parameter2: Value2
  12.     Outputs: 
  13.       OutputParameter1: 
  14.         ValueSelector: 'jq selector' # jq的选择器语法，以OpenAPI的返回作为JSON输入，jq的语法请参考 https://stedolan.github.io/jq/
  15.         Type: String/Boolean/List(Array)/Number/Object
  • JSON格式（请参考YAML注释说明）
  2. {
  3.   "Tasks": [
  4.     {
  5.       "Name": "executeAPITaskExample",
  6.       "Action": "ACS::ExecuteAPI",
  7.       "Properties": {
  8.         "Service": "ECS",
  9.         "API": "DescribeInstances",
  10.         "AutoPaging": false,
  11.         "Parameters": {
  12.           "Parameter1": "Value1",
  13.           "Parameter2": "Value2"
  14.         }
  15.       },
  16.       "Outputs": {
  17.         "OutputParameter1": {
  18.           "ValueSelector": "jq selector",
  19.           "Type": "String/Boolean/List(Array)/Number/Object"
  20.         }
  21.       }
  22.     }
  23.   ]
  24. }

ROA风格API

  • YAML格式
  2. Tasks:
  3.   - Name: executeAPITaskExample2
  4.     Action: ACS::ExecuteAPI
  5.     Properties:
  6.       Service: OOS # 必填，云产品code name，即RAM ARN里面的云产品code name。大小写不敏感。如OOS、ECS, RDS, FC...
  7.       API: PutBucket # 必填，云产品的API名称。大小写不敏感。如OOS API "PutBucket"。
  8.       Method: PUT  # 必填，该API HTTP请求方法。
  9.       URI: ''  # 该AP对应的I统一资源标识符。
  10.       Headers: # 选填，源API中请求头，定义在Headers部分，如下形式进行传递。
  11.         requestHeader1: 'requestHeader1Value'
  12.       Parameters: # 选填，源API中的公共参数，定义在Parameters部分，
  13.         commonParameter1: 'commonParameter1Value'
  14.         commonParameter2: 'commonParameter2Value'
  15.     # 选填，源API中的请求元素，定义在Body部分，通过xml方式进行传递。
  16.       Body: |
  17.         <?xml version="1.0" encoding="UTF-8"?> <supKey1> <parameter1> Value1
  18.         </parameter1> <parameter2> Value2 </parameter2> </supKey1>
  • JSON格式（请参考YAML注释说明）
  2. {
  3.   "Tasks": [
  4.     {
  5.       "Name": "executeAPITaskExample2",
  6.       "Action": "ACS::ExecuteAPI",
  7.       "Properties": {
  8.         "Service": "OOS",
  9.         "API": "PutBucket",
  10.         "Method": "PUT",
  11.         "URI": "",
  12.         "Headers": {
  13.           "requestHeader1": "requestHeader1Value"
  14.         },
  15.         "Parameters": {
  16.           "commonParameter1": "commonParameter1Value",
  17.           "commonParameter2": "commonParameter2Value"
  18.         },
  19.         "Body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <supKey1> <parameter1> Value1\n</parameter1> <parameter2> Value2 </parameter2> </supKey1>\n"
  20.       }
  21.     }
  22.   ]
  23. }

示例

RPC示例模版

以下为含ECS云产品DescribeInstances API的模版。

  • YAML格式
  1. FormatVersion: OOS-2019-06-01
  2. Description: Views the ECS instances by specifying instance status.
  3. Parameters:
  4.   status:
  5.     Description: The ECS instances status for query instances.
  6.     Type: String
  7. Tasks:
  8. - Name: describeInstances
  9.   Action: ACS::ExecuteAPI
  10.   Description: Views the ECS instances by specifying instance status.
  11.   Properties:
  12.     Service: ECS
  13.     API: DescribeInstances
  14.     Parameters:
  15.       Status: '{{ status }}'
  16.   Outputs:
  17.     instanceIds:
  18.       Type: List
  19.       ValueSelector: Instances.Instance[].InstanceId
  20. Outputs:
  21.   instanceIds:
  22.     Type: List
  23.     Value: '{{ describeInstances.instanceIds }}'
  • JSON格式
  1. {
  2.   "FormatVersion": "OOS-2019-06-01",
  3.   "Description": "Views the ECS instances by specifying instance status.",
  4.   "Parameters": {
  5.     "status": {
  6.       "Description": "The ECS instances status for query instances.",
  7.       "Type": "String"
  8.     }
  9.   },
  10.   "Tasks": [
  11.     {
  12.       "Name": "describeInstances",
  13.       "Action": "ACS::ExecuteAPI",
  14.       "Description": "Views the ECS instances by specifying instance status.",
  15.       "Properties": {
  16.         "Service": "ECS",
  17.         "API": "DescribeInstances",
  18.         "Parameters": {
  19.           "Status": "{{ status }}"
  20.         }
  21.       },
  22.       "Outputs": {
  23.         "instanceIds": {
  24.           "Type": "List",
  25.           "ValueSelector": "Instances.Instance[].InstanceId"
  26.         }
  27.       }
  28.     }
  29.   ],
  30.   "Outputs": {
  31.     "instanceIds": {
  32.       "Type": "List",
  33.       "Value": "{{ describeInstances.instanceIds }}"
  34.     }
  35.   }
  36. }

ROA示例模版

以下为含OSS云产品PutBucket API的模版。

  • YAML格式
  1. FormatVersion: OOS-2019-06-01
  2. Description:
  3.   en: Create multiple buckets in different region at the same time.
  4.   zh-cn: 同时创建多个不同区域的Bucket。
  5. Parameters:
  6.   Regions:
  7.     Description:
  8.       en: The region id..
  9.       zh-cn: 区域Id。
  10.     Type: List
  11.   BucketName:
  12.     Description:
  13.       en: The bucket name.
  14.       zh-cn: Bucket名称。
  15.     Type: String
  16.   DataRedundancyType:
  17.     Description:
  18.       en: Specifies the data disaster tolerance type of the bucket.
  19.       zh-cn: 指定Bucket的数据容灾类型。
  20.     Type: String
  21.     AllowedValues:
  22.       - LRS
  23.       - ZRS
  24.   StorageClass:
  25.     Description:
  26.       en: Specify the bucket storage type.
  27.       zh-cn: 指定Bucket存储类型。
  28.     Type: String
  29.     AllowedValues:
  30.       - Standard
  31.       - IA
  32.       - Archive
  33.   XOssAcl:
  34.     Description:
  35.       en: Specify bucket access rights.
  36.       zh-cn: 指定Bucket访问权限。
  37.     Type: String
  38.     AllowedValues:
  39.       - public-read-write
  40.       - public-read
  41.       - private
  42.   RateControl:
  43.     Description:
  44.       en: Concurrency ratio of task execution.
  45.       zh-cn: 任务执行的并发比率。
  46.     Type: Json
  47.     AssociationProperty: RateControl
  48.   OOSAssumeRole:
  49.     Description: The RAM role to be assumed by OOS.
  50.     Type: String
  51.     Default: OOSServiceRole
  52. RamRole: '{{ OOSAssumeRole }}'
  53. Tasks:
  54.   - Name: PutBucket
  55.     Action: 'ACS::ExecuteAPI'
  56.     Description:
  57.       en: Create buckets in different regions.
  58.       zh-cn: 创建不同区域的Bucket。
  59.     Properties:
  60.       Service: OSS
  61.       API: PutBucket
  62.       Method: PUT
  63.       URI: ''
  64.       Headers:
  65.         x-oss-acl: '{{ XOssAcl }}'
  66.       Parameters:
  67.         BucketName: '{{ BucketName }}-{{ACS::TaskLoopItem}}'
  68.         RegionId: '{{ACS::TaskLoopItem}}'
  69.       Body: |
  70.         <?xml version="1.0" encoding="UTF-8"?>
  71.         <CreateBucketConfiguration>
  72.           <StorageClass>{{ StorageClass }}</StorageClass>
  73.           <DataRedundancyType>{{ DataRedundancyType }}</DataRedundancyType>
  74.         </CreateBucketConfiguration>
  75.     Loop:
  76.       Items: '{{ Regions }}'
  77.       RateControl: '{{ RateControl }}'
  78.       Outputs:
  79.         imageIds:
  80.           AggregateType: 'Fn::ListJoin'
  81.           AggregateField: imageIds
  82.     Outputs:
  83.       imageIds:
  84.         Type: String
  85.         ValueSelector: .
  • JSON格式
  1. {
  2.   "FormatVersion": "OOS-2019-06-01",
  3.   "Description": {
  4.     "en": "Create multiple buckets in different region at the same time.",
  5.     "zh-cn": "同时创建多个不同区域的Bucket。"
  6.   },
  7.   "Parameters": {
  8.     "Regions": {
  9.       "Description": {
  10.         "en": "The region id..",
  11.         "zh-cn": "区域Id。"
  12.       },
  13.       "Type": "List"
  14.     },
  15.     "BucketName": {
  16.       "Description": {
  17.         "en": "The bucket name.",
  18.         "zh-cn": "Bucket名称。"
  19.       },
  20.       "Type": "String"
  21.     },
  22.     "DataRedundancyType": {
  23.       "Description": {
  24.         "en": "Specifies the data disaster tolerance type of the bucket.",
  25.         "zh-cn": "指定Bucket的数据容灾类型。"
  26.       },
  27.       "Type": "String",
  28.       "AllowedValues": [
  29.         "LRS",
  30.         "ZRS"
  31.       ]
  32.     },
  33.     "StorageClass": {
  34.       "Description": {
  35.         "en": "Specify the bucket storage type.",
  36.         "zh-cn": "指定Bucket存储类型。"
  37.       },
  38.       "Type": "String",
  39.       "AllowedValues": [
  40.         "Standard",
  41.         "IA",
  42.         "Archive"
  43.       ]
  44.     },
  45.     "XOssAcl": {
  46.       "Description": {
  47.         "en": "Specify bucket access rights.",
  48.         "zh-cn": "指定Bucket访问权限。"
  49.       },
  50.       "Type": "String",
  51.       "AllowedValues": [
  52.         "public-read-write",
  53.         "public-read",
  54.         "private"
  55.       ]
  56.     },
  57.     "RateControl": {
  58.       "Description": {
  59.         "en": "Concurrency ratio of task execution.",
  60.         "zh-cn": "任务执行的并发比率。"
  61.       },
  62.       "Type": "Json",
  63.       "AssociationProperty": "RateControl"
  64.     },
  65.     "OOSAssumeRole": {
  66.       "Description": "The RAM role to be assumed by OOS.",
  67.       "Type": "String",
  68.       "Default": "OOSServiceRole"
  69.     }
  70.   },
  71.   "RamRole": "{{ OOSAssumeRole }}",
  72.   "Tasks": [
  73.     {
  74.       "Name": "PutBucket",
  75.       "Action": "ACS::ExecuteAPI",
  76.       "Description": {
  77.         "en": "Create buckets in different regions.",
  78.         "zh-cn": "创建不同区域的Bucket。"
  79.       },
  80.       "Properties": {
  81.         "Service": "OSS",
  82.         "API": "PutBucket",
  83.         "Method": "PUT",
  84.         "URI": "",
  85.         "Headers": {
  86.           "x-oss-acl": "{{ XOssAcl }}"
  87.         },
  88.         "Parameters": {
  89.           "BucketName": "{{ BucketName }}-{{ACS::TaskLoopItem}}",
  90.           "RegionId": "{{ACS::TaskLoopItem}}"
  91.         },
  92.         "Body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CreateBucketConfiguration>\n  <StorageClass>{{ StorageClass }}</StorageClass>\n  <DataRedundancyType>{{ DataRedundancyType }}</DataRedundancyType>\n</CreateBucketConfiguration>\n"
  93.       },
  94.       "Loop": {
  95.         "Items": "{{ Regions }}",
  96.         "RateControl": "{{ RateControl }}",
  97.         "Outputs": {
  98.           "imageIds": {
  99.             "AggregateType": "Fn::ListJoin",
  100.             "AggregateField": "imageIds"
  101.           }
  102.         }
  103.       },
  104.       "Outputs": {
  105.         "imageIds": {
  106.           "Type": "String",
  107.           "ValueSelector": "."
  108.         }
  109.       }
  110.     }
  111.   ]
  112. }
阿里云首页 运维编排服务 相关技术圈