文档

DescribeSoarRecordInOutput - 获取组件运行时数据

更新时间:

当用户执行剧本任务后,通过该接口可获取组件动作的输入数据与输出数据。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeSoarRecordInOutputRead
  • acs:yundun-sas::{#accountId}:*

请求参数

名称类型必填描述示例值
ActionUuidstring

组件动作的 UUID。

说明 调用 DescribeSoarTaskAndActions 接口可以获取该参数。
0531ff66-dd05-4f24-84bf-xxxxxxxx
Langstring

请求和接收消息的语言类型。取值:

  • zh(默认):中文。
  • en:英文。
zh

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

372D8B41-AF8D-573A-9B3F-0924950F241F
InOutputInfostring

组件动作的执行结果。

{ "actionUuid": "3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx", "outputSummary": { "datalist": [ { "a": "a" } ], "total_data_successful": 1, "total_data": 1, "total_exe_successful": 1, "total_exe": 1, "total_data_with_dup": 1, "status": true }, "outputSchema": { "a": "String", "startTime": "DateTime" }, "inputParams": { "inputData": [ { "outputFields": { "a": "a" } } ], "totalSize": 1 }, "startTime": "2023-11-13 17:47:28.645", "taskName": "92af3c79-1754-4646-9366-9ddbxxxxx" }

InOutputInfo 为 JSONString 格式,其中包含字段如下:

  • actionUuid:组件动作执行记录的 UUID
  • startTime:组件动作的开始执行时间
  • taskName:组件动作对应的剧本任务名称
  • outputSchema:动作输出数据的元信息,为 JSON 格式,编排剧本时定义
  • outputSummary:动作的输出参数,为 JSON 格式,包含字段如下:
    • datalist:输出的数据详情
    • total_data_successful:执行成功的条目数
    • total_data:执行的总条目数
    • total_exe_successful:执行成功的次数
    • total_exe:总执行次数
    • total_data_with_dup:重复的数据次数
    • status:执行是否成功,true 表示成功,false 表示失败
  • inputParams:动作的输入数据,为 JSON 格式,包含字段如下:
    • inputData:动作的具体输入数据
    • totalSize:动作的输入数据条目数

示例

正常返回示例

JSON格式

{
  "RequestId": "372D8B41-AF8D-573A-9B3F-0924950F241F",
  "InOutputInfo": "{\n    \"actionUuid\": \"3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx\",\n    \"outputSummary\": {\n        \"datalist\": [\n            {\n                \"a\": \"a\"\n            }\n        ],\n        \"total_data_successful\": 1,\n        \"total_data\": 1,\n        \"total_exe_successful\": 1,\n        \"total_exe\": 1,\n        \"total_data_with_dup\": 1,\n        \"status\": true\n    },\n    \"outputSchema\": {\n        \"a\": \"String\",\n        \"startTime\": \"DateTime\"\n    },\n    \"inputParams\": {\n        \"inputData\": [\n            {\n                \"outputFields\": {\n                    \"a\": \"a\"\n                }\n            }\n        ],\n        \"totalSize\": 1\n    },\n    \"startTime\": \"2023-11-13 17:47:28.645\",\n    \"taskName\": \"92af3c79-1754-4646-9366-9ddbxxxxx\"\n}"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈