开发者社区> 问答> 正文

运维编排服务模板API有哪些?

运维编排服务模板API有哪些?

展开
收起
小天使爱美 2020-03-24 11:42:03 771 0
1 条回答
写回答
取消 提交回答
  • 调用CreateTemplate创建一个模版。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Content String 是 {“FormatVersion”: “OOS-2019-06-01”, “Description”: “Describe instances of given status”, “Parameters”: {“Status”: {“Type”: “String”, “Description”: “(Required) The status of the Ecs instance.”}}, “Tasks”: [{“Properties”: {“Parameters”: {“Status”: “{{ Status }}”}, “API”: “DescribeInstances”, “Service”: “Ecs”}, “Name”: “foo”, “Action”: “ACS::ExecuteApi”}]} 模板内容。JSON或YAML格式,长度限制为 64 KB。

    TemplateName String 是 MyTemplate 模板名称。内容限制为字母、数字、中划线、下划线,长度200字符,且不能以ALIYUN、ACS、ALIBABA、ALICLOUD开头。

    RegionId String 否 cn-hangzhou 地域ID

    Tags Map 否 {“k1”:”v1”,”k2”:”v2”} 标签键和值映射, 标签键值对数量范围是1至20。

    返回数据 名称 类型 示例值 描述 RequestId String 20758A-585D-4A41-A9B2-28DA8F4F534F 请求ID

    Template 模板元信息

    CreatedBy String root(13090000) 模板创建者

    CreatedDate String 2019-05-16T10:26:14Z 模板创建时间

    Description String Describe instances of given status 模板说明

    HasTrigger Boolean true 是否成功触发

    Hash String 4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4 模板内容的SHA256

    ShareType String Private 模板共享类型。目前用户创建的模板的共享类型均为 Private。

    Tags Map { “k1”:”v1”, “k2”:”v2” } 该资源对应标签键值的映射

    TemplateFormat String JSON 模板格式。系统字段判断,为JSON或YAML。

    TemplateId String t-94753d38 模板ID

    TemplateName String MyTemplate 模板名称

    TemplateVersion String v1 模板版本。以“v”+数字的形式,数字从1开始。

    UpdatedBy String root(130900000) 模板更新者

    UpdatedDate String 2019-05-16T10:26:14Z 模板更新时间

    示例 请求示例

    http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=CreateTemplate&Content={“FormatVersion”: “OOS-2019-06-01”, “Description”: “Describe instances of given status”, “Parameters”: {“Status”: {“Type”: “String”, “Description”: “(Required) The status of the Ecs instance.”}}, “Tasks”: [{“Properties”: {“Parameters”: {“Status”: “{{ Status }}”}, “API”: “DescribeInstances”, “Service”: “Ecs”}, “Name”: “foo”, “Action”: “ACS::ExecuteApi”}]}&TemplateName=MyTemplate&<公共请求参数> 正常返回示例

    XML 格式

    20758A-585D-4A41-A9B2-28DA8F4F534F root(130900000) 2019-05-27T08:46:33Z root(1309000000) 2019-05-27T08:46:33Z Describe instances of given status 4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4 Private v1 v2 JSON MyTemplate t-94753eeaef8 v1 JSON 格式

    { “RequestId”: “20758A-585D-4A41-A9B2-28DA8F4F534F”, “Template”: { “CreatedBy”: “root(130900000)”, “CreatedDate”: “2019-05-27T08:46:33Z”, “UpdatedBy”: “root(1309000000)”, “UpdatedDate”: “2019-05-27T08:46:33Z”, “Description”: “Describe instances of given status”, “Hash”: “4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4”, “ShareType”: “Private”, “Tags”: { “k1”: “v1”, “k2”: “v2” }, “TemplateFormat”: “JSON”, “TemplateName”: “MyTemplate”, “TemplateId”: “t-94753eeaef8”, “TemplateVersion”: “v1” } } 错误码 访问错误中心查看更多错误码。

     </article>
    

    调用DeleteTemplate删除一个模版。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DeleteTemplate 系统规定参数。取值:DeleteTemplate。

    TemplateName String 是 MyTemplate 模板名称。内容限制为字母、数字、中划线、下划线,长度200字符,且不能以ALIYUN、ACS、ALIBABA、ALICLOUD开头。

    RegionId String 否 cn-hangzhou 地域ID

    返回数据 名称 类型 示例值 描述 RequestId String 2075899A-585D-4A41-A9B2-28DA8534F 请求ID

    示例 请求示例

    http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=DeleteTemplate &TemplateName=MyTemplate &<公共请求参数> 正常返回示例

    XML 格式

    2075899A-585D-4A41-A9B2-28DA8534F JSON 格式

    { "RequestId":"2075899A-585D-4A41-A9B2-28DA8534F" } 错误码

    访问错误中心查看更多错误码。

    调用GetTemplate获取一个模版,包括内容。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetTemplate 系统规定参数。取值:GetTemplate。

    TemplateName String 是 MyTemplate 模板名称。内容限制为字母、数字、中划线、下划线,长度200字符。

    RegionId String 否 cn-hangzhou 地域ID

    TemplateVersion String 否 v1 模板版本。格式:“v”+数字。取值范围:v1-v200。

    返回数据 名称 类型 示例值 描述 Content String “{\n \”FormatVersion\”: \”OOS-2019-06-01\”,\n \”Parameters\”: {\n \”Status\”: {\n \”Type\”: \”String\”,\n \”Description\”: \”(Required) The ID of the ECS instance.\”\n }\n },\n \”Tasks\”: [\n {\n \”Name\”: \”bar\”,\n \”Properties\”: {\n \”Parameters\”: {\n \”Status\”: \”{{ Status }}\”\n },\n \”API\”: \”DescribeInstances\”,\n \”Service\”: \”Ecs\”\n },\n \”Action\”: \”acs::ExecuteAPI\”,\n \”Outputs\”: {\n \”InstanceIds\”: {\n \”ValueSelector\”: \”.Instances.Instance[].InstanceId\”,\n \”Type\”: \”List\”\n }\n }\n }\n ],\n \”Outputs\”: {\n \”InstanceIds\”: {\n \”Value\”: \” {{ bar.InstanceIds }} \”,\n \”Type\”: \”List\”\n }\n }\n}\n” 模板内容

    RequestId String FAAFCA45-AB65-4049-BFE0-868E1C8025AF 请求ID

    Template 模板元信息

    CreatedBy String root(1300000) 模板创建者

    CreatedDate String 2019-05-16T10:26:14Z 模板创建时间

    Description String Describe instances of given status 模板说明

    HasTrigger Boolean true 是否成功触发

    Hash String 4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4 模板内容的SHA256

    ShareType String Private 模板共享类型。目前用户创建的模板的共享类型均为 Private。

    Tags Map {“k1”:”v1”,”k2”:”v2”} 标签键及值映射,键值对数量限制为1至20。

    TemplateFormat String JSON 模板格式。系统字段判断,为JSON或YAML。

    TemplateId String t-94753d38 模板ID

    TemplateName String MyTemplate 模板名称

    TemplateVersion String v1 模板版本。以“v”+数字的形式,数字从1开始。

    UpdatedBy String root(130000) 模板更新者

    UpdatedDate String 2019-05-16T10:26:14Z 模板更新时间

    示例 请求示例

    http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=GetTemplate&TemplateName=MyTemplate&<公共请求参数> 正常返回示例

    XML 格式

    { “FormatVersion”: “OOS-2019-06-01”, “Parameters”: { “Status”: { “Type”: “String”, “Description”: “(Required) The ID of the ECS instance.” } }, “Tasks”: [ { “Name”: “bar”, “Properties”: { “Parameters”: { “Status”: “{{ Status }}” }, “API”: “DescribeInstances”, “Service”: “Ecs” }, “Action”: “acs::ExecuteAPI”, “Outputs”: { “InstanceIds”: { “ValueSelector”: “.Instances.Instance[].InstanceId”, “Type”: “List<String>” } } } ], “Outputs”: { “InstanceIds”: { “Value”: “ {{ bar.InstanceIds }} “, “Type”: “List<String>” } } } FAAFCA45-AB65-4049-BFE0-868E1C8025AF root(130000) 2019-05-27T10:32:52Z root(130000) 2019-05-27T08:46:33Z 62eac5c64b9dae5c41e1e8b648baad95f812cab4f9221a5283edb882b5f8d712 Private JSON MyTemplate t-9475828d38 v1 v2 v1 JSON 格式

    { “Content”: “{ “FormatVersion”: “OOS-2019-06-01”, “Parameters”: { “Status”: { “Type”: “String”, “Description”: “(Required) The ID of the ECS instance.” } }, “Tasks”: [ { “Name”: “bar”, “Properties”: { “Parameters”: { “Status”: “{{ Status }}” }, “API”: “DescribeInstances”, “Service”: “Ecs” }, “Action”: “acs::ExecuteAPI”, “Outputs”: { “InstanceIds”: { “ValueSelector”: “.Instances.Instance[].InstanceId”, “Type”: “List” } } } ], “Outputs”: { “InstanceIds”: { “Value”: “ {{ bar.InstanceIds }} “, “Type”: “List” } } } “, “RequestId”: “FAAFCA45-AB65-4049-BFE0-868E1C8025AF”, “Template”: { “CreatedBy”: “root(130000)”, “CreatedDate”: “2019-05-27T10:32:52Z”, “UpdatedBy”: “root(130000)”, “UpdatedDate”: “2019-05-27T08:46:33Z”, “Hash”: “62eac5c64b9dae5c41e1e8b648baad95f812cab4f9221a5283edb882b5f8d712”, “ShareType”: “Private”, “TemplateFormat”: “JSON”, “TemplateName”: “MyTemplate”, “TemplateId”: “t-9475828d38”, “Tags”: { “k1”: “ v1 “, “k2”: “ v2 “ }, “TemplateVersion”: “v1” } } 错误码 访问错误中心查看更多错误码。

     </article>
    

    调用ListExecutionRiskyTasks获取模版中的高风险任务。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListExecutionRiskyTasks 系统规定参数。取值:ListExecutionRiskyTasks。

    TemplateName String 是 myTemplate 模板名称

    RegionId String 否 cn-hangzhou 地域ID

    返回数据 名称 类型 示例值 描述 RequestId String C04B668D-D2DD-4B40-B6E9-0E3C4F53D5B5 请求ID

    RiskyTasks 风险任务

    示例 请求示例

    http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=ListExecutionRiskyTasks &TemplateName=myTemplate &<公共请求参数> 正常返回示例

    XML 格式

    C04B668D-D2DD-4B40-B6E9-0E3C4F53D5B5 parenttask1 childtask2 root template name ECS DeleteInstance task3 root template name SLB RemoveBackendServers JSON 格式

    { "RiskyTasks":[ { "API":"DeleteInstance", "Service":"ECS", "Template":[ "root template name" ], "Task":[ "parenttask1", "childtask2" ] }, { "API":"RemoveBackendServers", "Service":"SLB", "Template":[ "root template name" ], "Task":[ "task3" ] } ], "RequestId":"C04B668D-D2DD-4B40-B6E9-0E3C4F53D5B5" } 错误码 访问错误中心查看更多错误码。

    调用ListTemplates查询模板,支持多种过滤方式。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListTemplates 系统规定参数。取值:ListTemplates。

    CreatedBy String 否 ACS 模板创建者。

    对于阿里云官方提供的模板,为ACS 对于用户个人创建的模板,可填写 UID 进行筛选,或填写 用户名称 进行筛选 CreatedDateAfter String 否 2019-05-16T10:26:14Z 创建时间大于等于指定时间的模板。

    格式为:YYYY-MM-DDThh:mm:ssZ

    CreatedDateBefore String 否 2019-05-16T10:26:14Z 创建时间小于等于指定时间的模板。

    格式为:YYYY-MM-DDThh:mm::ssZ

    HasTrigger Boolean 否 true 是否触发

    MaxResults Integer 否 50 分页大小。取值范围:20-100。默认为50。

    NextToken String 否 xxx 对查询结果进行翻页时需要传入的Token值,如有则获取自当前页的返回值。

    RegionId String 否 cn-hangzhou 地域ID

    ShareType String 否 Private 分享类型。取值范围:

    Public Private SortField String 否 Popularity 排序字段。取值范围:

    TotalExecutionCount(默认值):总执行次数 Popularity:受欢迎程度 TemplateName:模板名称 CreatedDate:创建时间 SortOrder String 否 Descending 排序方向。取值范围:

    Ascending:升序 Descending(默认值):降序 Tags Map 否 {“k1”:”v1”,”k2”:”v2”} 标签键及值的映射,键值对数量限制为1至20。

    TemplateFormat String 否 YAML 模板格式。取值范围:

    JSON YAML TemplateName String 否 MyTemplate 模板名称。列出含所填模板名称的所有模板。

    返回数据 名称 类型 示例值 描述 MaxResults Integer 50 分页大小。

    NextToken String xxx 对查询结果进行翻页时需要传入的Token值,如有则获取自当前页的返回值。

    RequestId String BEF54BA-17B6-449F-A219-49ACB157E3 请求ID

    Templates Array 模板元信息

    CreatedBy String root(1309200) 模板创建者

    CreatedDate String 2019-05-16T10:26:14Z 模板创建时间

    Description String Describe instances of given status 模板说明

    HasTrigger Boolean true 是否成功触发

    Hash String 4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4 模板内容的SHA256

    Popularity Integer 8 公共模板模板受欢迎程度。范围是1-10,数字越高表示越受欢迎。若ShareType为Private,该字段值为-1。

    说明 该字段在ShareType为Public时有意义。

                    </tr>
    
                    <tr class="row-level-4-7">
    
                       <td class="entry colsep-1 rowsep-1">ShareType</td>
    
                       <td class="entry colsep-1 rowsep-1">String</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-ShareType">Public</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-ShareType">
                          <p class="p">模板共享类型。目前用户创建的模板的共享类型均为 <strong class="ph b">Private</strong>。取值范围:
                          </p>
    
                          <ul class="ul">
    
                             <li class="li"><strong class="ph b">Public</strong></li>
    
                             <li class="li"><strong class="ph b">Private</strong></li>
    
                          </ul>
    
                       </td>
    
                    </tr>
    
                    <tr class="row-level-4-8">
    
                       <td class="entry colsep-1 rowsep-1">Tags</td>
    
                       <td class="entry colsep-1 rowsep-1">Map</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-Tags">{"k1":"k2","k2":"v2"}</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-Tags">
                          <p class="p">标签键及值,键值对数量限制为1至20。</p>
    
                       </td>
    
                    </tr>
    
                    <tr class="row-level-4-9">
    
                       <td class="entry colsep-1 rowsep-1">TemplateFormat</td>
    
                       <td class="entry colsep-1 rowsep-1">String</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-TemplateFormat">JSON</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-TemplateFormat">
                          <p class="p">模板格式。系统字段判断,为JSON或YAML。</p>
    
                       </td>
    
                    </tr>
    
                    <tr class="row-level-4-10">
    
                       <td class="entry colsep-1 rowsep-1">TemplateId</td>
    
                       <td class="entry colsep-1 rowsep-1">String</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-TemplateId">t-94753deed38</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-TemplateId">
                          <p class="p">模板ID</p>
    
                       </td>
    
                    </tr>
    
                    <tr class="row-level-4-11">
    
                       <td class="entry colsep-1 rowsep-1">TemplateName</td>
    
                       <td class="entry colsep-1 rowsep-1">String</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-TemplateName">MyTemplate</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-TemplateName">
                          <p class="p">模板名称</p>
    
                       </td>
    
                    </tr>
    
                    <tr class="row-level-4-12">
    
                       <td class="entry colsep-1 rowsep-1">TemplateVersion</td>
    
                       <td class="entry colsep-1 rowsep-1">String</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-TemplateVersion">v1</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-TemplateVersion">
                          <p class="p">模板版本。以“v”+数字的形式,数字从1开始。</p>
    
                       </td>
    
                    </tr>
    
                    <tr class="row-level-4-13">
    
                       <td class="entry colsep-1 rowsep-1">TotalExecutionCount</td>
    
                       <td class="entry colsep-1 rowsep-1">Integer</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-TotalExecutionCount">5</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-TotalExecutionCount">
                          <p class="p">私有模板总执行次数。若<strong class="ph b">ShareType</strong>为<strong class="ph b">Public</strong>,该字段值为<code class="ph codeph">-1</code>。
                          </p>
    
                          <div class="note note note-note">
                             <div class="note-icon-wrapper"><i class="icon-note note"></i></div>
                             <div class="note-content"><strong>说明</strong> 该字段在<strong class="ph b">ShareType</strong>为<strong class="ph b">Private</strong>时有意义。
                             </div>
                          </div>
    
                       </td>
    
                    </tr>
    
                    <tr class="row-level-4-14">
    
                       <td class="entry colsep-1 rowsep-1">UpdatedBy</td>
    
                       <td class="entry colsep-1 rowsep-1">String</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-UpdatedBy">root(13092000)</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-UpdatedBy">
                          <p class="p">模板更新者</p>
    
                       </td>
    
                    </tr>
    
                    <tr class="row-level-4-15">
    
                       <td class="entry colsep-1 rowsep-1">UpdatedDate</td>
    
                       <td class="entry colsep-1 rowsep-1">String</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-example-Templates-UpdatedDate">2019-05-16T10:26:14Z</td>
    
                       <td class="entry colsep-1 rowsep-1" id="result-description-Templates-UpdatedDate">
                          <p class="p">模板更新时间</p>
    
                       </td>
    
                    </tr>
    
                 </tbody>
              </table>
    
           </section>
    
           <section class="section" id="demo">
              <h2 class="title sectiontitle" id="h2-url-4">示例</h2>
    
    
              <p class="p">请求示例</p>
              <pre class="pre codeblock" id="request-demo"><code>
    

    http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=ListTemplates&<公共请求参数>

    正常返回示例

              <p class="p"><code class="ph codeph">XML</code> 格式
              </p>
              <pre class="pre codeblock" id="xml-return-success-demo"><code><ListTemplatesResponse>
    

    <MaxResults>50</MaxResults> <RequestId>BEF54BA-17B6-449F-A219-49ACB157E3</RequestId> <Templates> <CreatedBy>root(13090000)</CreatedBy> <CreatedDate>2019-05-14T09:16:37Z</CreatedDate> <UpdatedBy>root(130900000)</UpdatedBy> <UpdatedDate>2019-05-27T08:46:33Z</UpdatedDate> <Description></Description> <Hash>d02b84917e5a82c672630bf041a61dd5dc52fbc481ff98516c6a81876f3d9c01</Hash> <ShareType>Private</ShareType> <TemplateFormat>JSON</TemplateFormat> <TemplateName>MyTemplate</TemplateName> <TemplateId>t-94753dd828d38</TemplateId> <Tags> <k1> v1 </k1> <k2> v2 </k2> </Tags> <TemplateVersion>v1</TemplateVersion> <TotalExecutionCount>0</TotalExecutionCount> <Popularity>-1</Popularity> </Templates>

    JSON 格式

    { “RequestId”:”BEF54BA-17B6-449F-A219-49ACB157E3”, “MaxResults”:50, “Templates”:[ { “TemplateName”:”MyTemplate”, “TotalExecutionCount”:0, “Description”:””, “TemplateFormat”:”JSON”, “Popularity”:-1, “TemplateId”:”t-94753dd828d38”, “Tags”: {“k1”: “ v1 “, “k2”: “ v2 “}, “Hash”:”d02b84917e5a82c672630bf041a61dd5dc52fbc481ff98516c6a81876f3d9c01”, “TemplateVersion”:”v1”, “UpdatedDate”:”2019-05-27T08:46:33Z”, “CreatedBy”:”root(13090000)”, “CreatedDate”:”2019-05-14T09:16:37Z”, “UpdatedBy”:”root(130900000)”, “ShareType”:”Private” } ]}

    错误码

              <p class="p" cond-props="intl">访问<a href="https://error-center.alibabacloud.com/status/product/oos">错误中心</a>查看更多错误码。
              </p>
    
           </section>
    
        </div>
    
     </article>
    

    调用UpdateTemplate更新一个已经存在的模板。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 UpdateTemplate 系统规定参数。取值:UpdateTemplate。

    Content String 是 {“FormatVersion”: “OOS-2019-06-01”, “Description”: “Describe instances of given status”, “Parameters”: {“Status”: {“Type”: “String”, “Description”: “(Required) The status of the Ecs instance.”}}, “Tasks”: [{“Properties”: {“Parameters”: {“Status”: “{{ Status }}”}, “API”: “DescribeInstances”, “Service”: “Ecs”}, “Name”: “foo”, “Action”: “ACS::ExecuteApi”}] 模板内容。JSON或YAML格式,长度限制为 64 KB。

    TemplateName String 是 MyTemplate 模板名称。内容限制为字母、数字、中划线、下划线,长度200字符,且不能以ALIYUN、ACS、ALIBABA、ALICLOUD开头。

    RegionId String 否 cn-hangzhou 地域ID

    Tags Map 否 {“k1”:”v1”,”k2”:”v2”} 标签键及值映射,键值对数量限制为1至20。

    返回数据 名称 类型 示例值 描述 RequestId String 2075899A-585D-4A41-A9B2-28DF4F534F 请求ID

    Template 模板元信息

    CreatedBy String root(130920000) 模板创建者

    CreatedDate String 2019-05-16T10:26:14Z 模板创建时间

    Description String Describe instances of given status 模板说明

    HasTrigger Boolean true 是否成功触发

    Hash String 4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4 模板内容的SHA256

    ShareType String Private 模板共享类型。目前用户创建的模板的共享类型均为 Private。

    Tags Map {“k1”:”v1”,”k2”:”v2”} 标签键及值,键值对数量限制为1至20。

    TemplateFormat String JSON 模板格式。系统字段判断,为JSON或YAML。

    TemplateId String t-94753deed38 模板ID

    TemplateName String MyTemplate 模板名称

    TemplateVersion String v2 模板版本。以“v”+数字的形式,数字从1开始。

    UpdatedBy String root(1309000) 模板更新者

    UpdatedDate String 2019-05-16T10:26:14Z 模板更新时间

    示例 请求示例

    http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=UpdateTemplate&Content={“FormatVersion”: “OOS-2019-06-01”, “Description”: “Describe instances of given status”, “Parameters”: {“Status”: {“Type”: “String”, “Description”: “(Required) The status of the Ecs instance.”}}, “Tasks”: [{“Properties”: {“Parameters”: {“Status”: “{{ Status }}”}, “API”: “DescribeInstances”, “Service”: “Ecs”}, “Name”: “foo”, “Action”: “ACS::ExecuteApi”}]&TemplateName=MyTemplate&<公共请求参数> 正常返回示例

    XML 格式

    2075899A-585D-4A41-A9B2-28DF4F534F root(13090000) 2019-05-27T08:46:33Z root(13090000) 2019-05-27T08:46:33Z Describe instances of given status 4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4 Private JSON MyTemplate t-94753de38 v1 v2 v2 JSON 格式

    { “RequestId”: “2075899A-585D-4A41-A9B2-28DF4F534F”, “Template”: { “CreatedBy”: “root(13090000)”, “CreatedDate”: “2019-05-27T08:46:33Z”, “UpdatedBy”: “root(13090000)”, “UpdatedDate”: “2019-05-27T08:46:33Z”, “Description”: “Describe instances of given status”, “Hash”: “4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4”, “ShareType”: “Private”, “TemplateFormat”: “JSON”, “TemplateName”: “MyTemplate”, “TemplateId”: “t-94753de38”, “Tags”: { “k1”: “ v1 “, “k2”: “ v2 “ }, “TemplateVersion”: “v2” } } 错误码 访问错误中心查看更多错误码。

     </article>
    

    调用ValidateTemplateContent校验一个模版是否合法。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ValidateTemplateContent 系统规定参数。取值:ValidateTemplateContent。

    Content String 是 {"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]} 模板内容。JSON或YAML格式,长度限制为 64 KB。

    RegionId String 否 cn-hangzhou 地域ID

    返回数据 名称 类型 示例值 描述 Outputs String {} 模板输出

    Parameters String { "Status": { "Description": "(Required) The status of the Ecs instance.", "Type": "String" } } 模板参数

    RamRole String OOSServiceRole RAM角色

    RequestId String ADF2066B-4017-4EF0-861C-C0FF3A9F1ED4 请求ID

    Tasks 模板中定义的任务

    示例 请求示例

    http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=ValidateTemplateContent &Content={"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]} &<公共请求参数> 正常返回示例

    XML 格式

    ADF2066B-4017-4EF0-861C-C0FF3A9F1ED4 (Required) The status of the Ecs instance. String OOSServiceRole foo DescribeInstances {{ Status }} Ecs JSON 格式

    { "Outputs":{}, "Parameters":{ "Status":{ "Description":"(Required) The status of the Ecs instance.", "Type":"String" } }, "RequestId":"ADF2066B-4017-4EF0-861C-C0FF3A9F1ED4", "Tasks":[ { "Name":"foo", "Properties":{ "Parameters":{ "Status":"{{ Status }}" }, "API":"DescribeInstances", "Service":"Ecs" } } ], "RamRole":"OOSServiceRole" } 错误码 访问错误中心查看更多错误码。

    2020-03-24 11:45:43
    赞同 展开评论 打赏
问答排行榜
最热
最新

相关电子书

更多
Spring Boot2.0实战Redis分布式缓存 立即下载
CUDA MATH API 立即下载
API PLAYBOOK 立即下载