tencentcloud-sdk-nodejs/tencentcloud/services/asw/v20200722/asw_models.d.ts

腾讯云 API NODEJS SDK

/**
 * DescribeExecutionHistory返回参数结构体
 */
export interface DescribeExecutionHistoryResponse {
    /**
     * 执行的事件列表
     */
    Events: Array<ExecutionEvent>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeExecutions请求参数结构体
 */
export interface DescribeExecutionsRequest {
    /**
     * 状态机资源名
     */
    StateMachineResourceName: string;
    /**
     * 页大小，最大100
     */
    PageSize: number;
    /**
     * 页序号，从1开始
     */
    PageIndex: number;
    /**
     * 按状态过滤条件，INIT，RUNNING，SUCCEED，FAILED，TERMINATED
     */
    FilterExecutionStatus?: string;
    /**
     * 按执行名过滤条件
     */
    FilterExecutionResourceName?: string;
}
/**
 * DescribeFlowServices返回参数结构体
 */
export interface DescribeFlowServicesResponse {
    /**
     * 用户的状态机列表
     */
    FlowServiceSet?: Array<StateMachine>;
    /**
     * 用户的状态机总数
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 状态机
 */
export interface StateMachine {
    /**
     * 状态机资源
     */
    FlowServiceResource: string;
    /**
     * 状态机类型。EXPRESS，STANDARD
     */
    Type: string;
    /**
     * 状态机名称
     */
    FlowServiceName: string;
    /**
     * 状态机中文名
     */
    FlowServiceChineseName: string;
    /**
     * 创建时间。timestamp
     */
    CreateDate: string;
    /**
     * 修改时间。timestamp
     */
    ModifyDate: string;
    /**
     * 状态机状态
     */
    Status: string;
    /**
     * 创建者的subAccountUin
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Creator: string;
    /**
     * 修改者的subAccountUin
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Modifier: string;
    /**
     * 状态机id
     */
    FlowServiceId: string;
    /**
     * 模板id
     */
    TemplateId: string;
    /**
     * 备注
     */
    Description: string;
}
/**
 * DescribeFlowServiceDetail返回参数结构体
 */
export interface DescribeFlowServiceDetailResponse {
    /**
     * 状态机所属服务名
     */
    FlowServiceName: string;
    /**
     * 状态机状态
     */
    Status: string;
    /**
     * 定义文本（JSON格式）
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Definition: string;
    /**
     * 角色资源名
  注意：此字段可能返回 null，表示取不到有效值。
     */
    RoleResource: string;
    /**
     * 状态机的类型，可以为 （EXPRESS/STANDARD）
     */
    Type: string;
    /**
     * 生成时间
     */
    CreateDate: string;
    /**
     * 备注
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Description: string;
    /**
     * 状态机所属服务中文名
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FlowServiceChineseName: string;
    /**
     * 是否开启日志CLS服务
  注意：此字段可能返回 null，表示取不到有效值。
     */
    EnableCLS: boolean;
    /**
     * CLS日志查看地址
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CLSUrl: string;
    /**
     * 工作流提示输入
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FlowInput: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeExecution返回参数结构体
 */
export interface DescribeExecutionResponse {
    /**
     * 执行资源名
     */
    ExecutionResourceName?: string;
    /**
     * 资源名称
     */
    Name?: string;
    /**
     * 执行开始时间，毫秒
     */
    StartDate?: string;
    /**
     * 执行结束时间，毫秒
     */
    StopDate?: string;
    /**
     * 状态机资源名
     */
    StateMachineResourceName?: string;
    /**
     * 执行状态。INIT，RUNNING，SUCCEED，FAILED，TERMINATED
     */
    Status?: string;
    /**
     * 执行的输入
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Input?: string;
    /**
     * 执行的输出
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Output?: string;
    /**
     * 启动执行时，状态机的定义
     */
    ExecutionDefinition?: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeFlowServices请求参数结构体
 */
export interface DescribeFlowServicesRequest {
    /**
     * 偏移量，默认为0。
     */
    Offset?: number;
    /**
     * 返回数量，默认为20，最大值为100。
     */
    Limit?: number;
    /**
     * 过滤条件，详见下表：实例过滤条件表。每次请求的Filter.Values的上限为5。参数名字仅支持FlowServiceName， Status, Type三种情况
     */
    Filters?: Array<Filter>;
}
/**
 * DescribeExecution请求参数结构体
 */
export interface DescribeExecutionRequest {
    /**
     * 执行资源名
     */
    ExecutionResourceName: string;
}
/**
 * DescribeExecutionHistory请求参数结构体
 */
export interface DescribeExecutionHistoryRequest {
    /**
     * 执行资源名
     */
    ExecutionResourceName: string;
}
/**
 * CreateFlowService返回参数结构体
 */
export interface CreateFlowServiceResponse {
    /**
     * 状态机所属服务资源
     */
    FlowServiceResource: string;
    /**
     * 生成日期
     */
    CreateDate: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StartExecution请求参数结构体
 */
export interface StartExecutionRequest {
    /**
     * 状态机资源名
     */
    StateMachineResourceName: string;
    /**
     * 输入参数，内容为JsonObject，长度不大于524288字符。
     */
    Input?: string;
    /**
     * 本次执行名。如果不填，系统会自动生成。如果填，应保证状态机下唯一
     */
    Name?: string;
}
/**
 * 模版过滤类型
 */
export interface Filter {
    /**
     * 过滤器名字
     */
    Name?: string;
    /**
     * 过滤器值的数组
     */
    Values?: Array<string>;
}
/**
 * 执行的事件历史
 */
export interface ExecutionEvent {
    /**
     * 执行资源名
     */
    ExecutionResourceName: string;
    /**
     * 自增序号
     */
    EventId: number;
    /**
     * 事件类型
     */
    EventCategory: string;
    /**
     * 步骤节点名称
     */
    StepName: string;
    /**
     * 该步骤引用的资源名
     */
    ResourceName: string;
    /**
     * 该事件发生时间，毫秒
     */
    Timestamp: string;
    /**
     * 事件内容
     */
    Content: string;
    /**
     * 异常信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Exception: string;
}
/**
 * ModifyFlowService返回参数结构体
 */
export interface ModifyFlowServiceResponse {
    /**
     * 状态机资源名
     */
    FlowServiceResource: string;
    /**
     * 更新时间
     */
    UpdateDate: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StartExecution返回参数结构体
 */
export interface StartExecutionResponse {
    /**
     * 执行资源名
     */
    ExecutionResourceName: string;
    /**
     * 执行开始时间
     */
    StartDate: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlowService请求参数结构体
 */
export interface CreateFlowServiceRequest {
    /**
     * 定义文本（JSON格式）
     */
    Definition: string;
    /**
     * 状态机所属服务名
     */
    FlowServiceName: string;
    /**
     * 是不是新的角色
     */
    IsNewRole: boolean;
    /**
     * 状态机类型（EXPRESS，STANDARD）
     */
    Type: string;
    /**
     * 状态机所属服务中文名
     */
    FlowServiceChineseName?: string;
    /**
     * 角色资源名, 比如: qcs::cam::uin/20103392:roleName/SomeRoleForYourStateMachine
     */
    RoleResource?: string;
    /**
     * 备注
     */
    Description?: string;
    /**
     * 是否开启CLS日志投递功能
     */
    EnableCLS?: boolean;
    /**
     * 该状态机的默认输入
     */
    Input?: string;
}
/**
 * DescribeExecutions返回参数结构体
 */
export interface DescribeExecutionsResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyFlowService请求参数结构体
 */
export interface ModifyFlowServiceRequest {
    /**
     * 状态机资源名
     */
    FlowServiceResource: string;
    /**
     * 定义JSON
     */
    Definition: string;
    /**
     * 状态机所属服务名
     */
    FlowServiceName: string;
    /**
     * 状态机所属服务中文名
     */
    FlowServiceChineseName: string;
    /**
     * 是否是新角色
     */
    IsNewRole: boolean;
    /**
     * 状态机类型
     */
    Type: string;
    /**
     * 角色资源名
     */
    RoleResource: string;
    /**
     * 状态机备注
     */
    Description?: string;
    /**
     * 是否允许日志投递
     */
    EnableCLS?: boolean;
}
/**
 * DescribeFlowServiceDetail请求参数结构体
 */
export interface DescribeFlowServiceDetailRequest {
    /**
     * 状态机所属服务资源名
     */
    FlowServiceResource: string;
}
/**
 * StopExecution返回参数结构体
 */
export interface StopExecutionResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StopExecution请求参数结构体
 */
export interface StopExecutionRequest {
    /**
     * 执行名称
     */
    ExecutionQrn: string;
}