{
  "name": "asw",
  "display_name": "应用与服务编排工作流",
  "description": "介绍如何使用API对应用与服务编排工作流进行操作，包括创建工作流、启动工作流、获得工作流执行情况等。",
  "domain": "other",
  "api_version": "2020-07-22",
  "endpoint": "asw.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateFlowService",
      "description": "该接口用于生成状态机服务",
      "status": "online",
      "parameters": [
        {
          "name": "Definition",
          "type": "string",
          "required": true,
          "description": "定义文本（JSON格式）",
          "example": "qrn:qcs:asw:ap-xxxx:123456:execution:cfq5fjii:cgr51dcii"
        },
        {
          "name": "FlowServiceName",
          "type": "string",
          "required": true,
          "description": "状态机所属服务名",
          "example": "Hello-World"
        },
        {
          "name": "IsNewRole",
          "type": "boolean",
          "required": true,
          "description": "是不是新的角色",
          "example": "false"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "状态机类型（EXPRESS，STANDARD）",
          "example": "EXPRESS"
        },
        {
          "name": "FlowServiceChineseName",
          "type": "string",
          "required": false,
          "description": "状态机所属服务中文名",
          "example": "你好ASW"
        },
        {
          "name": "RoleResource",
          "type": "string",
          "required": false,
          "description": "角色资源名, 比如: qcs::cam::uin/20103392:roleName/SomeRoleForYourStateMachine",
          "example": "qcs::cam::uin/12345:roleName/NameOfARole"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "备注",
          "example": "这是一个ASW工作流示例"
        },
        {
          "name": "EnableCLS",
          "type": "boolean",
          "required": false,
          "description": "是否开启CLS日志投递功能",
          "example": "true"
        },
        {
          "name": "Input",
          "type": "string",
          "required": false,
          "description": "该状态机的默认输入",
          "example": "{}"
        }
      ],
      "required": [
        "Definition",
        "FlowServiceName",
        "IsNewRole",
        "Type"
      ]
    },
    {
      "name": "DescribeExecution",
      "description": "查询执行详细信息",
      "status": "online",
      "parameters": [
        {
          "name": "ExecutionResourceName",
          "type": "string",
          "required": true,
          "description": "执行资源名"
        }
      ],
      "required": [
        "ExecutionResourceName"
      ]
    },
    {
      "name": "DescribeExecutionHistory",
      "description": "一次执行会有很多步骤，经过很多节点，这个接口描述某一次执行的事件的历史",
      "status": "online",
      "parameters": [
        {
          "name": "ExecutionResourceName",
          "type": "string",
          "required": true,
          "description": "执行资源名",
          "example": "qrn:qcs:asw:ap-guangzhou:12345:http:json:flowmachine:bfhzs4j8"
        }
      ],
      "required": [
        "ExecutionResourceName"
      ]
    },
    {
      "name": "DescribeExecutions",
      "description": "对状态机的执行历史进行描述.",
      "status": "online",
      "parameters": [
        {
          "name": "StateMachineResourceName",
          "type": "string",
          "required": true,
          "description": "状态机资源名"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "页大小，最大100"
        },
        {
          "name": "PageIndex",
          "type": "integer",
          "required": true,
          "description": "页序号，从1开始"
        },
        {
          "name": "FilterExecutionStatus",
          "type": "string",
          "required": false,
          "description": "按状态过滤条件，INIT，RUNNING，SUCCEED，FAILED，TERMINATED"
        },
        {
          "name": "FilterExecutionResourceName",
          "type": "string",
          "required": false,
          "description": "按执行名过滤条件"
        }
      ],
      "required": [
        "StateMachineResourceName",
        "PageSize",
        "PageIndex"
      ]
    },
    {
      "name": "DescribeFlowServiceDetail",
      "description": "查询该用户指定状态机下的详情数据。",
      "status": "online",
      "parameters": [
        {
          "name": "FlowServiceResource",
          "type": "string",
          "required": true,
          "description": "状态机所属服务资源名",
          "example": "qrn:qcs:asw:sh:1300074211:http:json:flowmachine:flowservicete"
        }
      ],
      "required": [
        "FlowServiceResource"
      ]
    },
    {
      "name": "DescribeFlowServices",
      "description": "查询指定用户下所有状态机，以列表形式返回",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0。"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100。"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件，详见下表：实例过滤条件表。每次请求的Filter.Values的上限为5。参数名字仅支持FlowServiceName， Status, Type三种情况",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "过滤器名字"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "过滤器值的数组",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "ModifyFlowService",
      "description": "该接口用于修改状态机",
      "status": "online",
      "parameters": [
        {
          "name": "FlowServiceResource",
          "type": "string",
          "required": true,
          "description": "状态机资源名",
          "example": "无"
        },
        {
          "name": "Definition",
          "type": "string",
          "required": true,
          "description": "定义JSON",
          "example": "无"
        },
        {
          "name": "FlowServiceName",
          "type": "string",
          "required": true,
          "description": "状态机所属服务名",
          "example": "无"
        },
        {
          "name": "FlowServiceChineseName",
          "type": "string",
          "required": true,
          "description": "状态机所属服务中文名",
          "example": "无"
        },
        {
          "name": "IsNewRole",
          "type": "boolean",
          "required": true,
          "description": "是否是新角色",
          "example": "false"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "状态机类型",
          "example": "无"
        },
        {
          "name": "RoleResource",
          "type": "string",
          "required": true,
          "description": "角色资源名",
          "example": "无"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "状态机备注",
          "example": "无"
        },
        {
          "name": "EnableCLS",
          "type": "boolean",
          "required": false,
          "description": "是否允许日志投递",
          "example": "true"
        }
      ],
      "required": [
        "FlowServiceResource",
        "Definition",
        "FlowServiceName",
        "FlowServiceChineseName",
        "IsNewRole",
        "Type",
        "RoleResource"
      ]
    },
    {
      "name": "StartExecution",
      "description": "为指定的状态机启动一次执行",
      "status": "online",
      "parameters": [
        {
          "name": "StateMachineResourceName",
          "type": "string",
          "required": true,
          "description": "状态机资源名",
          "example": "qrn:qcs:asw:ap-xxxx:123456:execution:cfq5fjii:cgr51dcii"
        },
        {
          "name": "Input",
          "type": "string",
          "required": false,
          "description": "输入参数，内容为JsonObject，长度不大于524288字符。",
          "example": "{}"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "本次执行名。如果不填，系统会自动生成。如果填，应保证状态机下唯一",
          "example": "name of execution"
        }
      ],
      "required": [
        "StateMachineResourceName"
      ]
    },
    {
      "name": "StopExecution",
      "description": "终止某个状态机",
      "status": "online",
      "parameters": [
        {
          "name": "ExecutionQrn",
          "type": "string",
          "required": true,
          "description": "执行名称",
          "example": "qrn:qcs:asw:ap-xxxx:123456:execution:cfq5fjii:cgr51dcii"
        }
      ],
      "required": [
        "ExecutionQrn"
      ]
    }
  ]
}