diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/paiflow | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/paiflow')
| -rw-r--r-- | data/en_us/paiflow/2021-02-02/api-docs.php | 3246 |
1 files changed, 3246 insertions, 0 deletions
diff --git a/data/en_us/paiflow/2021-02-02/api-docs.php b/data/en_us/paiflow/2021-02-02/api-docs.php new file mode 100644 index 0000000..57f77e0 --- /dev/null +++ b/data/en_us/paiflow/2021-02-02/api-docs.php @@ -0,0 +1,3246 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'PAIFlow', + 'version' => '2021-02-02', + ], + 'directories' => [ + [ + 'id' => 168663, + 'title' => 'Workflow Tasks', + 'type' => 'directory', + 'children' => [ + 'CreatePipelineRun', + 'DeletePipelineRun', + 'StartPipelineRun', + 'UpdatePipelineRun', + 'GetPipelineRun', + 'ListPipelineRunNodeLogs', + 'GetPipelineRunNode', + 'ListPipelineRunNodeOutputs', + 'ListPipelineRunNodeStatus', + 'ListPipelineRunsStatus', + 'ListPipelineRuns', + 'TerminatePipelineRun', + 'RerunPipelineRun', + ], + ], + [ + 'id' => 164779, + 'title' => 'Workflow', + 'type' => 'directory', + 'children' => [ + 'CreatePipeline', + 'DeletePipeline', + 'UpdatePipeline', + 'GetPipeline', + 'ListPipelines', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreatePipelineRun' => [ + 'summary' => 'Creates a pipeline job.', + 'path' => '/api/v1/pipelineruns', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140030', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The pipeline job.'."\n", + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => 'Pipeline的id; PipelineId和PipelineManifest 二选一', + 'description' => 'The pipeline ID. You must configure PipelineId or PipelineManifest.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow-rer7y***', + ], + 'Name' => [ + 'title' => 'Run的名字,若为空,则自动生成名字', + 'description' => 'The name of the pipeline job. If you leave this parameter empty, the system automatically generates a name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + 'PipelineManifest' => [ + 'title' => 'Pipeline内容; PipelineId和PipelineManifest 二选一一', + 'description' => 'The pipeline definition. For more information, see the sample pipeline definition. You must configure PipelineId or PipelineManifest.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'apiVersion: "core/v1"*********'."\n", + ], + 'Arguments' => [ + 'title' => '参数', + 'description' => 'The parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'arguments: parameters: - name: "execution_maxcompute" value: endpoint: "http://service***" odpsProject: "pai***"', + ], + 'NoConfirmRequired' => [ + 'title' => 'true代表直接启动; false代表只创建run但先不启动', + 'description' => 'Specifies whether to start the pipeline job. Valid values:'."\n" + ."\n" + .'* true (default): starts the pipeline job.'."\n" + .'* false: creates the pipeline job and does not start it.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'WorkspaceId' => [ + 'title' => '项目空间id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '84***', + ], + 'SourceType' => [ + 'title' => '来源,支持如下值:SDK; PAI_STUDIO; M6; UNKNOWN;', + 'description' => 'The type of the pipeline job source. Valid values:'."\n" + ."\n" + .'* UNKNOWN (default)'."\n" + .'* SDK'."\n" + .'* DESIGNER'."\n" + .'* M6'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'UNKNOWN', + ], + 'SourceId' => [ + 'title' => '实验id', + 'description' => 'The source ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'experiment-ybpy***', + ], + 'Options' => [ + 'title' => '选项,json格式', + 'description' => 'The options used to create the pipeline job, which are in the JSON format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"mlflow":{"experimentId":"exp-1jdk***"}}', + ], + 'Accessibility' => [ + 'title' => 'PUBLIC 公开;PRIVATE 私有', + 'description' => 'The pipeline accessibility.'."\n" + ."\n" + .'* PUBLIC (default)'."\n" + .'* PRIVATE'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PUBLIC', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA', + ], + 'PipelineRunId' => [ + 'title' => 'run的id', + 'description' => 'The ID of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'flow-rbvg***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\",\\n \\"PipelineRunId\\": \\"flow-rbvg***\\"\\n}","type":"json"}]', + 'title' => 'CreatePipelineRun', + 'requestParamsDescription' => 'Sample pipeline definition: The pipeline consists of a read table node `data_source` and a data type conversion node `type_transform`.'."\n" + ."\n" + .' apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "1557702098******"'."\n" + .' version: "v1"'."\n" + .' identifier: "my_pipeline"'."\n" + .' name: "source-transform"'."\n" + .' spec:'."\n" + .' inputs:'."\n" + .' parameters:'."\n" + .' - name: "execution_maxcompute"'."\n" + .' type: "Map"'."\n" + .' pipelines:'."\n" + .' - apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "pai"'."\n" + .' version: "v1"'."\n" + .' identifier: "data_source"'."\n" + .' name: "data_source"'."\n" + .' displayName: "Read-Table-1"'."\n" + .' spec:'."\n" + .' arguments:'."\n" + .' parameters:'."\n" + .' - name: "inputTableName"'."\n" + .' value: "pai_online_project.wumai_data"'."\n" + .' - name: "partition"'."\n" + .' value: "20220101"'."\n" + .' - name: "execution"'."\n" + .' from: "{{inputs.parameters.execution_maxcompute}}"'."\n" + .' - apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "pai"'."\n" + .' version: "v1"'."\n" + .' identifier: "type_transform"'."\n" + .' name: "type_transform"'."\n" + .' displayName: "Data Type Conversion-1"'."\n" + .' spec:'."\n" + .' arguments:'."\n" + .' artifacts:'."\n" + .' - name: "inputTable"'."\n" + .' from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"'."\n" + .' parameters:'."\n" + .' - name: "cols_to_double"'."\n" + .' value: "time,hour,pm2,pm10,so2,co,no2"'."\n" + .' - name: "execution"'."\n" + .' from: "{{inputs.parameters.execution_maxcompute}}"'."\n" + .' dependencies:'."\n" + .' - "data_source"'."\n", + ], + 'DeletePipelineRun' => [ + 'summary' => 'Deletes a pipeline job.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140374', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => 'PipelineRunId', + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow-hynm2bv8wqhp5esfxq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'DeletePipelineRun', + 'description' => 'When you call this API operation, the pipeline job must be in the following states:'."\n" + ."\n" + .'* Initialized'."\n" + .'* Terminated'."\n" + .'* Succeeded'."\n" + .'* Failed'."\n", + ], + 'StartPipelineRun' => [ + 'summary' => 'Starts a pipeline job.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}/start', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140031', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow-rbvg5wzljzjhc9ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'StartPipelineRun', + ], + 'UpdatePipelineRun' => [ + 'summary' => 'Updates a pipeline job. You can update only the name of a pipeline job.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140032', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow-rbvg5wzljzjhc9ks92', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The pipeline job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the updated pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testName', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'UpdatePipelineRun', + ], + 'GetPipelineRun' => [ + 'summary' => 'Queries the information about a pipeline job.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140029', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => 'run的id', + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'run-rbvg**********ks92'."\n", + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'title' => '是否返回详细信息,目前详细信息包含: RuntimeManifest', + 'description' => 'Specifies whether to return detailed information. Valid values:'."\n" + ."\n" + .'* false: does not return detailed information.'."\n" + .'* true: returns detailed information that contains Manifest.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false'."\n", + ], + ], + [ + 'name' => 'ManifestType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The type of the manifest to be returned. Valid values:'."\n" + ."\n" + .'* Raw (default): the original manifest submitted by the user.'."\n" + .'* Frozen: generates a UUID for each pipeline and freeze the pipeline version. Even if you upgrade the pipeline when the three tuples defined on a node remain unchanged, the original UUID is still used. In this case, you can re-run the pipeline based on this manifest.'."\n" + .'* Rendered: injects related information to the pipeline and renders it, including completing runtime environment information and optimizing pipeline configurations.'."\n" + .'* Expanded: provides a complete definition for each pipeline.'."\n" + .'* Runtime: the pipeline to be run.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Runtime' => 'Runtime', + 'Raw' => 'Raw', + 'Frozen' => 'Frozen', + 'Rendered' => 'Rendered', + 'Expanded' => 'Expanded', + ], + 'example' => 'Raw', + 'default' => 'Raw', + 'enum' => [ + 'Raw', + 'Frozen', + 'Expanded', + 'Rendered', + 'Runtime', + ], + ], + ], + [ + 'name' => 'TokenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shared pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'."\n", + ], + 'PipelineRunId' => [ + 'description' => 'The ID of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'flow-j94y**********lf7a'."\n", + ], + 'Name' => [ + 'description' => 'The name of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'testName', + ], + 'Status' => [ + 'description' => 'The status of the pipeline job. Valid values:'."\n" + ."\n" + .'* Initialized'."\n" + .'* Running'."\n" + .'* Succeeded'."\n" + .'* Failed'."\n" + .'* Suspended'."\n" + .'* Terminated'."\n" + .'* Unknown'."\n" + .'* Skipped'."\n" + .'* Terminating'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Manifest' => [ + 'description' => 'The definition of the pipeline job.'."\n", + 'type' => 'string', + 'example' => '{"ApiVersion":"core/v1","Metadata":{"NodeId":"node-n06d**********fc53","Provider":"155**********904","Name":"flow-j94y**********lf7a","Version":"v1","Identifier":"9fe11111-****-****-****-****ec811861","Namespace":null,"DisplayName":"name","NodeType":"Dag"},"Spec":{}}', + ], + 'Arguments' => [ + 'description' => 'The parameters for the pipeline job.'."\n", + 'type' => 'string', + 'example' => '{"arguments":{"parameters":[{"name":"execution","value":{"endpoint":"http://service.******","odpsProject":"******","spec":{"endpoint":"http://service.******","odpsProject":"*****"},"resourceType":"MaxCompute"}}]}}', + ], + 'UserId' => [ + 'description' => 'The ID of the RAM user that is used to create the pipeline.'."\n", + 'type' => 'string', + 'example' => '155**********904'."\n", + ], + 'ParentUserId' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used to create the pipeline.'."\n", + 'type' => 'string', + 'example' => '155**********904'."\n", + ], + 'StartedAt' => [ + 'description' => 'The time when the pipeline job started, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-30T12:51:33.028Z'."\n", + ], + 'FinishedAt' => [ + 'description' => 'The time when the pipeline job ended, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-30T12:52:33.028Z'."\n", + ], + 'NodeId' => [ + 'description' => 'The pipeline ID.'."\n", + 'type' => 'string', + 'example' => 'node-n06d**********fc53'."\n", + ], + 'Duration' => [ + 'description' => 'The running duration of the pipeline job. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'WorkspaceId' => [ + 'description' => 'The ID of the workspace to which the pipeline job belongs.'."\n", + 'type' => 'string', + 'example' => '15945', + ], + 'Message' => [ + 'description' => 'The failure message of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'error message'."\n", + ], + 'SourceType' => [ + 'description' => 'The type of the pipeline job source. Valid values:'."\n" + ."\n" + .'* UNKNOWN: If you leave this parameter empty, UNKNOWN is used as the default value.'."\n" + .'* SDK: The pipeline job is created by using an SDK.'."\n" + .'* DESIGNER: The pipeline job is created in Machine Learning Designer.'."\n" + .'* M6: The pipeline job is created on other websites.'."\n", + 'type' => 'string', + 'example' => 'UNKNOWN', + ], + 'SourceId' => [ + 'description' => 'The ID of the pipeline job source.'."\n", + 'type' => 'string', + 'example' => 'abcd*********hxfu'."\n", + ], + 'Options' => [ + 'description' => 'The option for the pipeline job, which is in the JSON format.'."\n", + 'type' => 'string', + 'example' => '{"mlflow":{"experimentId":"exp-**********"}}'."\n", + ], + 'GmtCreateTime' => [ + 'description' => 'The time when the pipeline job was created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-30T12:51:33.028Z'."\n", + ], + 'GmtModifiedTime' => [ + 'description' => 'The time when the pipeline job was modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-30T12:51:33.028Z'."\n", + ], + 'PipelineId' => [ + 'description' => 'The pipeline ID.'."\n", + 'type' => 'string', + 'example' => 'pipeline-j94y**********lf7a'."\n", + ], + 'Accessibility' => [ + 'description' => 'The accessibility of the pipeline job. Valid values:'."\n" + ."\n" + .'* PUBLIC'."\n" + .'* PRIVATE'."\n", + 'type' => 'string', + 'example' => 'PUBLIC', + ], + 'PipelineRunUri' => [ + 'description' => 'The URL of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\\\n\\",\\n \\"PipelineRunId\\": \\"flow-j94y**********lf7a\\\\n\\",\\n \\"Name\\": \\"testName\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Manifest\\": \\"{\\\\\\"ApiVersion\\\\\\":\\\\\\"core/v1\\\\\\",\\\\\\"Metadata\\\\\\":{\\\\\\"NodeId\\\\\\":\\\\\\"node-n06d**********fc53\\\\\\",\\\\\\"Provider\\\\\\":\\\\\\"155**********904\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"flow-j94y**********lf7a\\\\\\",\\\\\\"Version\\\\\\":\\\\\\"v1\\\\\\",\\\\\\"Identifier\\\\\\":\\\\\\"9fe11111-****-****-****-****ec811861\\\\\\",\\\\\\"Namespace\\\\\\":null,\\\\\\"DisplayName\\\\\\":\\\\\\"name\\\\\\",\\\\\\"NodeType\\\\\\":\\\\\\"Dag\\\\\\"},\\\\\\"Spec\\\\\\":{}}\\",\\n \\"Arguments\\": \\"{\\\\\\"arguments\\\\\\":{\\\\\\"parameters\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"execution\\\\\\",\\\\\\"value\\\\\\":{\\\\\\"endpoint\\\\\\":\\\\\\"http://service.******\\\\\\",\\\\\\"odpsProject\\\\\\":\\\\\\"******\\\\\\",\\\\\\"spec\\\\\\":{\\\\\\"endpoint\\\\\\":\\\\\\"http://service.******\\\\\\",\\\\\\"odpsProject\\\\\\":\\\\\\"*****\\\\\\"},\\\\\\"resourceType\\\\\\":\\\\\\"MaxCompute\\\\\\"}}]}}\\",\\n \\"UserId\\": \\"155**********904\\\\n\\",\\n \\"ParentUserId\\": \\"155**********904\\\\n\\",\\n \\"StartedAt\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"FinishedAt\\": \\"2021-01-30T12:52:33.028Z\\\\n\\",\\n \\"NodeId\\": \\"node-n06d**********fc53\\\\n\\",\\n \\"Duration\\": 60,\\n \\"WorkspaceId\\": \\"15945\\",\\n \\"Message\\": \\"error message\\\\n\\",\\n \\"SourceType\\": \\"UNKNOWN\\",\\n \\"SourceId\\": \\"abcd*********hxfu\\\\n\\",\\n \\"Options\\": \\"{\\\\\\"mlflow\\\\\\":{\\\\\\"experimentId\\\\\\":\\\\\\"exp-**********\\\\\\"}}\\\\n\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"PipelineId\\": \\"pipeline-j94y**********lf7a\\\\n\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"PipelineRunUri\\": \\"https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****\\"\\n}","type":"json"}]', + 'title' => 'GetPipelineRun', + ], + 'ListPipelineRunNodeLogs' => [ + 'summary' => 'Obtains the node logs of a pipeline job.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/logs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140372', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => 'Run id', + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow-73186********nku43', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'path', + 'schema' => [ + 'title' => 'Node id', + 'description' => 'The ID of the node on which the pipeline job is executed. You can call [ListPipelineRuns](~~438042~~) to obtain the node ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'node-hh5yc********mz8ms', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'title' => '当前偏移量', + 'description' => 'The offset from which the data is returned. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的log数目', + 'description' => 'The number of logs returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'FromTimeInSeconds', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The beginning of the time range to query. This value is a timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1612180056', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索词', + 'description' => 'The search keyword. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'title' => '是否倒排', + 'description' => 'Specifies whether the logs are sorted in descending order. Valid values:'."\n" + ."\n" + .'* false: The logs are sorted in ascending order. This is the default value.'."\n" + .'* true: The logs are sorted in descending order.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ToTimeInSeconds', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range to query. This value is a timestamp. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1612180056', + ], + ], + [ + 'name' => 'TokenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shared pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回结构体', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E', + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的作业数量', + 'description' => 'The total number of types that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Logs' => [ + 'title' => '日志列表', + 'description' => 'The list of the returned logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried logs.'."\n", + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\",\\n \\"TotalCount\\": 10,\\n \\"Logs\\": [\\n \\"abc\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListPipelineRunNodeLogs', + ], + 'GetPipelineRunNode' => [ + 'summary' => 'Queries information about a node. A pipeline job contains a variety of nodes.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140269', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => 'run 的 id', + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow-ebppc********5lwea', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'path', + 'schema' => [ + 'title' => 'node 的 id', + 'description' => 'The ID of a node in the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the node ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'node-wcs9z********27ps3', + ], + ], + [ + 'name' => 'Depth', + 'in' => 'query', + 'schema' => [ + 'title' => '查询深度', + 'description' => 'The depth at which information about the node is queried. If you set Depth to 2, the information about the node and all its child nodes at the next layer is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'* Logical (default): the logical node. The nodes submitted by users are logical nodes.'."\n" + .'* Physical: the physical node on which a container is deployed for executing specific logic. A logical node is converted to a physical node when the logical node runs in the background.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Logical', + ], + ], + [ + 'name' => 'TokenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shared pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体结构', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0a981ea816**********42244e7ba2', + ], + 'ApiVersion' => [ + 'title' => 'api 版本', + 'description' => 'The version defined in the pipeline.'."\n", + 'type' => 'string', + 'example' => 'core/v1', + ], + 'Metadata' => [ + 'title' => 'node 的元信息', + 'description' => 'The node metadata.'."\n", + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '节点 id', + 'description' => 'The node ID.'."\n", + 'type' => 'string', + 'example' => 'node-wcs9z********27ps3', + ], + 'Provider' => [ + 'title' => '提供方', + 'description' => 'The provider of the pipeline for the node. In most cases, this parameter indicates the uploader of the pipeline. If the pipeline is officially provided, the parameter value is PAI.'."\n", + 'type' => 'string', + 'example' => '15577********904', + ], + 'Name' => [ + 'title' => '名字', + 'description' => 'The node name.'."\n", + 'type' => 'string', + 'example' => 'flow-ebppc********5lwea', + ], + 'Version' => [ + 'title' => '版本', + 'description' => 'The version of the pipeline for the node.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Identifier' => [ + 'title' => '标识符', + 'description' => 'The identifier of the pipeline for the node.'."\n", + 'type' => 'string', + 'example' => 'composite-pipeline', + ], + 'NodeType' => [ + 'title' => '节点类型', + 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'* Pod: the specific node that runs.'."\n" + .'* Dag: the composite node, which is essentially a directed acyclic graph (DAG) consisting of child nodes.'."\n", + 'type' => 'string', + 'example' => 'Dag', + ], + 'RelatedNodeIds' => [ + 'title' => 'Alink逻辑节点所对应的物理节点ID / Alink物理节点所对应的逻辑节点ID', + 'description' => 'The ID of the physical node corresponding to the Alink logical node or the ID of the logical node corresponding to the Alink physical node.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The node ID.'."\n", + 'type' => 'string', + 'example' => 'node-wcs9z********27ps3', + ], + ], + 'DisplayName' => [ + 'title' => '展示名称', + 'description' => 'The display name of the node, which can be modified.'."\n", + 'type' => 'string', + 'example' => 'flow-ebppc********5lwea', + ], + ], + ], + 'Spec' => [ + 'title' => '算法体', + 'description' => 'The node specifications.'."\n", + 'type' => 'object', + 'properties' => [ + 'HasPipelines' => [ + 'title' => '是否有子 pipeline', + 'description' => 'Indicates whether the node contains child nodes. Valid values:'."\n" + ."\n" + .'* true: The node is a composite node. To query information about its child nodes, you must specify the Depth parameter.'."\n" + .'* false: The node is the one that actually runs.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Dependencies' => [ + 'title' => '依赖', + 'description' => 'The dependencies between the node and other nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the pipeline for other nodes that the node depends on.'."\n", + 'type' => 'string', + 'example' => '"single-node-sub1"', + ], + ], + 'Pipelines' => [ + 'title' => '子 pipeline 列表', + 'description' => 'The child nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The child node.'."\n", + 'type' => 'object', + 'example' => '', + ], + ], + 'Inputs' => [ + 'description' => 'The input information about of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Artifacts' => [ + 'description' => 'The node inputs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The node input.'."\n", + 'type' => 'object', + 'example' => '{"Name":"input","Value":"******"}', + ], + ], + 'Parameters' => [ + 'description' => 'The input parameters of the node.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The input parameter of the node.'."\n", + 'type' => 'object', + 'example' => '{"Name":"inputTable","Value":"******"}', + ], + ], + ], + ], + 'Outputs' => [ + 'description' => 'The output information about of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Artifacts' => [ + 'description' => 'The node outputs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The node output.'."\n", + 'type' => 'object', + 'example' => '{"Name":"output","Value":"******"}', + ], + ], + 'Parameters' => [ + 'description' => 'The output parameters of the node.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The output parameter of the node.'."\n", + 'type' => 'object', + 'example' => '{"Name":"outputTable","Value":"******"}', + ], + ], + ], + ], + 'When' => [ + 'description' => 'The condition on which the node runs.'."\n" + ."\n" + .'* If true is returned, the node is executed.'."\n" + .'* If false is returned, the node is skipped and the node status becomes Skipped.'."\n", + 'type' => 'string', + 'example' => '”{{inputs.parameters.skip}} == false“', + ], + 'WithItems' => [ + 'description' => 'Expands one pipeline node into multiple pipeline nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Expands an item in the dataset into a pipeline node.'."\n", + 'type' => 'string', + 'example' => 'abc', + ], + ], + 'WithParam' => [ + 'description' => 'Expands each item in an array that is the value type of a parameter into a pipeline node.'."\n", + 'type' => 'string', + 'example' => '"{{pipelines.generate.outputs.result}}"', + ], + 'WithSequence' => [ + 'description' => 'Expands each item of a numerical sequence into a pipeline node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => 'The start number of the numerical sequence.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'End' => [ + 'description' => 'The end number of the numerical sequence.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Format' => [ + 'description' => 'Formats the value of the numerical sequence.'."\n", + 'type' => 'string', + 'example' => '"2020-05-%d"', + ], + ], + ], + 'Parallelism' => [ + 'description' => 'The maximum parallelism of the nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'StatusInfo' => [ + 'title' => 'node 运行状态', + 'description' => 'The execution status of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'FinishedAt' => [ + 'title' => '结束时间', + 'description' => 'The time when the node finished execution.'."\n", + 'type' => 'string', + 'example' => '2021-10-15T10:40:54.000Z', + ], + 'StartedAt' => [ + 'title' => '开始时间', + 'description' => 'The time when the node started to execute.'."\n", + 'type' => 'string', + 'example' => '2021-10-15T10:39:58.000Z', + ], + 'Status' => [ + 'title' => '状态', + 'description' => 'The running status of the node. Valid values:'."\n" + ."\n" + .'* Succeeded'."\n" + .'* Running'."\n" + .'* Failed'."\n" + .'* Skipped: The node status becomes Skipped when its upstream node fails to be executed.'."\n" + .'* ReadyToSchedule: The node status becomes ReadyToSchedule if its upstream node is being executed.'."\n" + .'* Unknown'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'Conditions' => [ + 'description' => 'The running conditions of the node.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The running condition of the node.'."\n", + 'type' => 'object', + 'example' => '{"ArtifactArchived": "true"}', + ], + ], + 'Progress' => [ + 'description' => 'The running progress of the node.'."\n", + 'type' => 'string', + 'example' => '9/9', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0a981ea816**********42244e7ba2\\",\\n \\"ApiVersion\\": \\"core/v1\\",\\n \\"Metadata\\": {\\n \\"NodeId\\": \\"node-wcs9z********27ps3\\",\\n \\"Provider\\": \\"15577********904\\",\\n \\"Name\\": \\"flow-ebppc********5lwea\\",\\n \\"Version\\": \\"v1\\",\\n \\"Identifier\\": \\"composite-pipeline\\",\\n \\"NodeType\\": \\"Dag\\",\\n \\"RelatedNodeIds\\": [\\n \\"node-wcs9z********27ps3\\"\\n ],\\n \\"DisplayName\\": \\"flow-ebppc********5lwea\\"\\n },\\n \\"Spec\\": {\\n \\"HasPipelines\\": true,\\n \\"Dependencies\\": [\\n \\"\\\\\\"single-node-sub1\\\\\\"\\"\\n ],\\n \\"Pipelines\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"Inputs\\": {\\n \\"Artifacts\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"Value\\": \\"******\\"\\n }\\n ],\\n \\"Parameters\\": [\\n {\\n \\"Name\\": \\"inputTable\\",\\n \\"Value\\": \\"******\\"\\n }\\n ]\\n },\\n \\"Outputs\\": {\\n \\"Artifacts\\": [\\n {\\n \\"Name\\": \\"output\\",\\n \\"Value\\": \\"******\\"\\n }\\n ],\\n \\"Parameters\\": [\\n {\\n \\"Name\\": \\"outputTable\\",\\n \\"Value\\": \\"******\\"\\n }\\n ]\\n },\\n \\"When\\": \\"”{{inputs.parameters.skip}} == false“\\",\\n \\"WithItems\\": [\\n \\"abc\\"\\n ],\\n \\"WithParam\\": \\"\\\\\\"{{pipelines.generate.outputs.result}}\\\\\\"\\",\\n \\"WithSequence\\": {\\n \\"Start\\": 1,\\n \\"End\\": 10,\\n \\"Format\\": \\"\\\\\\"2020-05-%d\\\\\\"\\"\\n },\\n \\"Parallelism\\": 2\\n },\\n \\"StatusInfo\\": {\\n \\"FinishedAt\\": \\"2021-10-15T10:40:54.000Z\\",\\n \\"StartedAt\\": \\"2021-10-15T10:39:58.000Z\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Conditions\\": [\\n {\\n \\"ArtifactArchived\\": \\"true\\"\\n }\\n ],\\n \\"Progress\\": \\"9/9\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetPipelineRunNode', + 'description' => 'PAIFlow supports composite pipelines, which are reflected as composite nodes during running. To obtain information about such nodes, you can configure the Depth parameter (default value: 2). You can configure the Depth parameter to recursively obtain information about the queried node and its child nodes.'."\n" + ."\n" + .'A virtual root node exists each time a pipeline runs. You can call GetRun to obtain the root node. You can call GetNode to query the root node. The returned result also includes information about all nodes that run and their hierarchies.'."\n", + ], + 'ListPipelineRunNodeOutputs' => [ + 'summary' => 'Queries the outputs of a pipeline node.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/outputs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140373', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => 'Run id', + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow-n06dn********rfc53', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'path', + 'schema' => [ + 'title' => 'Node id', + 'description' => 'The ID of the pipeline node. You can call [ListPipelineRuns](~~438042~~) to obtain the node ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'node-n06dn********rfc53', + ], + ], + [ + 'name' => 'Depth', + 'in' => 'query', + 'schema' => [ + 'title' => '节点往下拿多少层子节点', + 'description' => 'The depth at which information about the node is queried. If you set Depth to 2, the information about the node and all its child nodes at the next layer is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '99999', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '节点名字', + 'description' => 'The name of the pipeline node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'myName', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页,页码从1开始', + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的输出数目', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => 'The field used to sort the returned results. The following fields are supported:'."\n" + ."\n" + .'* Name'."\n" + .'* Type'."\n" + .'* GmtCreateTime'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序, 顺序:ASC,倒序:DESC', + 'description' => 'The sorting order. This parameter must be used together with the SortBy parameter. Valid values:'."\n" + ."\n" + .'* DESC (default)'."\n" + .'* ASC'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => 'artifact 类型', + 'description' => 'The output type of the pipeline node.'."\n" + ."\n" + .'* Model'."\n" + .'* DataSet'."\n" + .'* Metrics'."\n" + .'* ModelEvaluation'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DataSet', + ], + ], + [ + 'name' => 'TokenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shared pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回结构', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E', + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的作业数量', + 'description' => 'The total number of outputs for the pipeline node.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Outputs' => [ + 'title' => '输出列表', + 'description' => 'The outputs of the pipeline node.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The output of the pipeline node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名字', + 'description' => 'The name of the output for the pipeline node.'."\n", + 'type' => 'string', + 'example' => 'model_******', + ], + 'Type' => [ + 'title' => '类型', + 'description' => 'The output type. Valid values:'."\n" + ."\n" + .'* Model'."\n" + .'* DataSet'."\n" + .'* Metrics'."\n" + .'* ModelEvaluation'."\n", + 'type' => 'string', + 'example' => 'Model', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the output was created.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:51:33.028Z', + ], + 'Id' => [ + 'title' => 'id', + 'description' => 'The output ID.'."\n", + 'type' => 'string', + 'example' => 'artifact-ty1xwv*******s8zf', + ], + 'NodeId' => [ + 'title' => '输出所属节点 id', + 'description' => 'The ID of the pipeline node to which the output belongs.'."\n", + 'type' => 'string', + 'example' => 'node-obpzu*******418grb7', + ], + 'ExpandedArtifactIndex' => [ + 'title' => '被扩展artifact的索引号,以0开始', + 'description' => 'The expanded index number of the output, starting from 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExpandableArtifactName' => [ + 'title' => '可扩展artifact的名字', + 'description' => 'The expandable name of the output.'."\n", + 'type' => 'string', + 'example' => 'inputArtifact', + ], + 'Info' => [ + 'title' => 'artifact内容', + 'description' => 'The output information.'."\n", + 'type' => 'object', + 'example' => '{ "metadata": { "type": { "Model": { "locationType": "MaxComputeOfflineModel", "modelType": "OfflineModel" } } }', + ], + 'Producer' => [ + 'title' => 'rtifact生产者', + 'description' => 'The output producer.'."\n", + 'type' => 'string', + 'example' => 'id-3d25-************-77856', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\",\\n \\"TotalCount\\": 2,\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"model_******\\",\\n \\"Type\\": \\"Model\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Id\\": \\"artifact-ty1xwv*******s8zf\\",\\n \\"NodeId\\": \\"node-obpzu*******418grb7\\",\\n \\"ExpandedArtifactIndex\\": 0,\\n \\"ExpandableArtifactName\\": \\"inputArtifact\\",\\n \\"Info\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Producer\\": \\"id-3d25-************-77856\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListPipelineRunNodeOutputs', + ], + 'ListPipelineRunNodeStatus' => [ + 'summary' => 'Queries the running status of a pipeline node.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/status', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140268', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作流任务ID', + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow-rbvg5wzljzjhc9****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点ID', + 'description' => 'The ID of the pipeline node. You can call [ListPipelineRuns](~~438042~~) to obtain the node ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'node-kdkfkfds****', + ], + ], + [ + 'name' => 'Depth', + 'in' => 'query', + 'schema' => [ + 'title' => '深度', + 'description' => 'The depth at which information about the node is queried. If you set Depth to N, the information about the node and all its child nodes at the N-1 layer is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '类型', + 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'* Logical (default): the logical node. The nodes submitted by users are logical nodes.'."\n" + .'* Physical: the physical node on which a container is deployed for executing specific logic. A logical node is converted to a physical node when the logical node runs in the background.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Logical', + ], + ], + [ + 'name' => 'TokenId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the shared pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E'."\n", + ], + 'Status' => [ + 'title' => '工作流任务的节点状态列表', + 'description' => 'The statuses of the pipeline node.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '工作流中节点ID', + 'description' => 'The ID of the pipeline node.'."\n", + 'type' => 'string', + 'example' => 'node-1jlzg7ncv0j6i3****', + ], + 'NodeName' => [ + 'title' => '工作流中节点名字', + 'description' => 'The name of the pipeline node.'."\n", + 'type' => 'string', + 'example' => 'sql', + ], + 'Status' => [ + 'title' => '节点运行状态', + 'description' => 'The running status of the node.'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'StartedAt' => [ + 'title' => '节点开始运行时间', + 'description' => 'The time when the node started to run, in UTC. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'FinishedAt' => [ + 'title' => '节点结束运行时间', + 'description' => 'The time when the node finished running, in UTC. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:40.232Z', + ], + 'RuntimeInfo' => [ + 'title' => '节点运行时信息', + 'description' => 'The runtime information of the node, in the escaped MAP format. You can customize the output of multiple KV pairs. If the same key value is used, the last output value is used. If the returned information is empty, {} is returned.'."\n", + 'type' => 'string', + 'example' => '{\\"DLC_INSTANCE_IDS\\": \\"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\\"}'."\n", + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\\\n\\",\\n \\"Status\\": [\\n {\\n \\"NodeId\\": \\"node-1jlzg7ncv0j6i3****\\",\\n \\"NodeName\\": \\"sql\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"StartedAt\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"FinishedAt\\": \\"2021-01-21T17:12:40.232Z\\",\\n \\"RuntimeInfo\\": \\"{\\\\\\\\\\\\\\"DLC_INSTANCE_IDS\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\\\\\\\\\\\\\\"}\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListPipelineRunNodeStatus', + ], + 'ListPipelineRunsStatus' => [ + 'summary' => 'Queries the statuses of multiple pipeline jobs or nodes at a time.', + 'path' => '/api/v1/pipelineruns', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140038', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'PipelineRuns' => [ + 'description' => 'The pipeline jobs that you want to query. You must configure PipelineRuns or Nodes. We recommend that you configure Nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow-hynm2bv8wqhp5esfxq', + ], + 'required' => false, + ], + 'Nodes' => [ + 'description' => 'The nodes that you want to query. You must configure PipelineRuns or Nodes. We recommend that you configure Nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The node that you want to query.'."\n", + 'type' => 'object', + 'properties' => [ + 'PipelineRunId' => [ + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow-hynm2bv8wqhp5esfxq', + ], + 'NodeId' => [ + 'description' => 'The ID of the pipeline node. You can call [ListPipelineRuns](~~438042~~) to obtain the node ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'node-hynm2bv8wqhp5esfx1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '948**'."\n", + ], + 'OutputType' => [ + 'description' => 'The output type of the pipeline node. Valid values:'."\n" + ."\n" + .'* Model'."\n" + .'* DataSet'."\n" + .'* Metrics'."\n" + .'* ModelEvaluation'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DataSet', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E', + ], + 'PipelineRuns' => [ + 'description' => 'The pipeline jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The pipeline job.'."\n", + 'type' => 'object', + 'properties' => [ + 'PipelineRunId' => [ + 'title' => 'run的id', + 'description' => 'The ID of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'flow-hynm2bv8wqhp5esfxq', + ], + 'Status' => [ + 'title' => 'run状态', + 'description' => 'The status of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'Name' => [ + 'title' => 'run名字', + 'description' => 'The name of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'myName', + ], + 'UserId' => [ + 'title' => '用户id', + 'description' => 'The ID of the user to which the pipeline belongs.'."\n", + 'type' => 'string', + 'example' => '1557702098194904', + ], + 'ParentUserId' => [ + 'title' => '父账户id', + 'description' => 'The ID of the Alibaba Cloud account to which the pipeline belongs.'."\n", + 'type' => 'string', + 'example' => '1557702098194904', + ], + 'NodeId' => [ + 'title' => '节点id', + 'description' => 'The node ID.'."\n", + 'type' => 'string', + 'example' => 'node-98odqfpcjzwdf3caq3', + ], + 'SourceId' => [ + 'title' => '实验id', + 'description' => 'The ID of the pipeline job source.'."\n", + 'type' => 'string', + 'example' => 'lmi7d24h3kr0xczjlu', + ], + 'IsDeleted' => [ + 'title' => '是否被删除', + 'description' => 'Indicates whether the pipeline job was deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'Nodes' => [ + 'description' => 'The pipeline nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The pipeline node.'."\n", + 'type' => 'object', + 'properties' => [ + 'PipelineRunId' => [ + 'title' => '运行Id', + 'description' => 'The ID of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'flow-hynm2bv8wqhp5esfxq', + ], + 'NodeId' => [ + 'title' => '节点Id', + 'description' => 'The ID of the pipeline node.'."\n", + 'type' => 'string', + 'example' => 'node-hynm2bv8wqhp5esfx1', + ], + 'Status' => [ + 'title' => '状态', + 'description' => 'The status of the pipeline node.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'InputArtifactArchived' => [ + 'title' => '输入artifact是否已保存', + 'description' => 'Indicates whether the input was saved.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'OutputArtifactArchived' => [ + 'title' => '输出artifact是否已保存', + 'description' => 'Indicates whether the output was saved.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'StartedAt' => [ + 'title' => '修改 UTC 时间,日期格式 iso8601', + 'description' => 'The time when the pipeline node started to run, in UTC. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'FinishedAt' => [ + 'title' => '修改 UTC 时间,日期格式 iso8601', + 'description' => 'The time when the pipeline node finished running, in UTC. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'NodeName' => [ + 'title' => '节点名', + 'description' => 'The name of the pipeline node.'."\n", + 'type' => 'string', + 'example' => 'dataSource', + ], + ], + ], + ], + 'Outputs' => [ + 'description' => 'The outputs of the pipeline node.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The output of the pipeline node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the output for the pipeline node.'."\n", + 'type' => 'string', + 'example' => 'model_******', + ], + 'Type' => [ + 'description' => 'The output type. Valid values:'."\n" + ."\n" + .'* Model'."\n" + .'* DataSet'."\n" + .'* Metrics'."\n" + .'* ModelEvaluation'."\n", + 'type' => 'string', + 'example' => 'DataSet', + ], + 'Metadata' => [ + 'description' => 'The output metadata.'."\n", + 'type' => 'object', + ], + 'GmtCreateTime' => [ + 'description' => 'The time when the output was created.'."\n", + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-30T12:51:33.028Z', + ], + 'Id' => [ + 'description' => 'The output ID.'."\n", + 'type' => 'string', + 'example' => 'artifact-ty1xwv*******s8zf', + ], + 'Producer' => [ + 'description' => 'The output producer.'."\n", + 'type' => 'string', + 'example' => 'id-3d25-************-77856', + ], + 'NodeId' => [ + 'description' => 'The ID of the pipeline node to which the output belongs.'."\n", + 'type' => 'string', + 'example' => 'node-obpzu*******418grb7'."\n", + ], + 'PipelineRunId' => [ + 'description' => 'The ID of the pipeline job to which the output belongs.'."\n", + 'type' => 'string', + 'example' => 'flow-dsjfk******jdskls', + ], + 'Value' => [ + 'description' => 'The output value.'."\n", + 'type' => 'string', + 'example' => '{\\"name\\": \\"model_flow_*********_node_**********_model\\", \\"location\\": {\\"name\\": \\"model_flow_**********_node_***********_model\\", \\"endpoint\\": \\"http://service.odps.aliyun.com/api\\", \\"project\\": \\"********\\"}}', + ], + 'ExpandedArtifactIndex' => [ + 'description' => 'The expanded index number of the output, starting from 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExpandableArtifactName' => [ + 'description' => 'The expandable name of the output.'."\n", + 'type' => 'string', + 'example' => 'inputArtifact', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\",\\n \\"PipelineRuns\\": [\\n {\\n \\"PipelineRunId\\": \\"flow-hynm2bv8wqhp5esfxq\\",\\n \\"Status\\": \\"Running\\",\\n \\"Name\\": \\"myName\\",\\n \\"UserId\\": \\"1557702098194904\\",\\n \\"ParentUserId\\": \\"1557702098194904\\",\\n \\"NodeId\\": \\"node-98odqfpcjzwdf3caq3\\",\\n \\"SourceId\\": \\"lmi7d24h3kr0xczjlu\\",\\n \\"IsDeleted\\": false\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"PipelineRunId\\": \\"flow-hynm2bv8wqhp5esfxq\\",\\n \\"NodeId\\": \\"node-hynm2bv8wqhp5esfx1\\",\\n \\"Status\\": \\"Running\\",\\n \\"InputArtifactArchived\\": true,\\n \\"OutputArtifactArchived\\": true,\\n \\"StartedAt\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"FinishedAt\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"NodeName\\": \\"dataSource\\"\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"model_******\\",\\n \\"Type\\": \\"DataSet\\",\\n \\"Metadata\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Id\\": \\"artifact-ty1xwv*******s8zf\\",\\n \\"Producer\\": \\"id-3d25-************-77856\\",\\n \\"NodeId\\": \\"node-obpzu*******418grb7\\\\n\\",\\n \\"PipelineRunId\\": \\"flow-dsjfk******jdskls\\",\\n \\"Value\\": \\"{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"model_flow_*********_node_**********_model\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"location\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"model_flow_**********_node_***********_model\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"endpoint\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"http://service.odps.aliyun.com/api\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"project\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"********\\\\\\\\\\\\\\"}}\\",\\n \\"ExpandedArtifactIndex\\": 0,\\n \\"ExpandableArtifactName\\": \\"inputArtifact\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListPipelineRunsStatus', + ], + 'ListPipelineRuns' => [ + 'summary' => 'Queries a list of pipeline jobs. Filtering, sorting, and pagination are supported for this API operation.', + 'path' => '/api/v1/pipelineruns', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140028', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the pipeline job source. You can view the ID of the pipeline job source on the pipeline details page. For more information, see [Manage pipelines](~~480625~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ybpy**********fb2z'."\n", + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting order. You must specify this parameter together with the SortBy parameter. Valid values:'."\n" + ."\n" + .'* ASC: ascending order.'."\n" + .'* DESC: descending order. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the pipeline job source. Valid values:'."\n" + ."\n" + .'* UNKNOWN: If you do not specify this parameter, UNKNOWN is used as the default value.'."\n" + .'* SDK: The pipeline job is created by using an SDK.'."\n" + .'* DESIGNER: The pipeline job is created by using Machine Learning Designer.'."\n" + .'* M6: The pipeline job is created on other websites.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'UNKNOWN', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the pipeline jobs to be filtered. Valid values:'."\n" + ."\n" + .'* Initialized'."\n" + .'* Running'."\n" + .'* Succeeded'."\n" + .'* Failed'."\n" + .'* Terminated'."\n" + .'* Unknown'."\n" + .'* Skipped'."\n" + .'* Terminating'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '104623', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户id', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '155**********904'."\n", + ], + ], + [ + 'name' => 'PipelineIds', + 'in' => 'query', + 'schema' => [ + 'title' => 'Pipeline的id集合,只有Source为M6可以使用该参数', + 'description' => 'The IDs of the pipelines. Multiple pipeline IDs are separated by commas (,). You can call [ListPipelines](~~438051~~) to obtain the ID of the pipeline.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow-rer7**********0otv, flow-hynm**********sfef', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field for sorting. Valid values:'."\n" + ."\n" + .'* PipelineId'."\n" + .'* UserId'."\n" + .'* ParentUserId'."\n" + .'* StartedAt'."\n" + .'* FinishedAt'."\n" + .'* WorkflowServiceId'."\n" + .'* Duration'."\n" + .'* GmtCreateTime'."\n" + .'* GmtModifiedTime'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PipelineId', + ], + ], + [ + 'name' => 'PipelineRunId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pipeline job ID. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => "\n" + .'flow-14vioac3k1s07k****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E', + ], + 'TotalCount' => [ + 'description' => 'The total amount of returned pipeline jobs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'PipelineRuns' => [ + 'description' => 'The queried pipeline jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the pipeline job.'."\n", + 'type' => 'object', + 'properties' => [ + 'PipelineRunId' => [ + 'description' => 'The ID of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'flow-j94y**********lf7a'."\n", + ], + 'Name' => [ + 'description' => 'The name of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'testName'."\n", + ], + 'Status' => [ + 'description' => 'The status of the pipeline job. Valid values:'."\n" + ."\n" + .'* Initialized'."\n" + .'* Running'."\n" + .'* Succeeded'."\n" + .'* Failed'."\n" + .'* Suspended'."\n" + .'* Terminated'."\n" + .'* Unknown'."\n" + .'* Skipped'."\n" + .'* Terminating'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'UserId' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '155**********904', + ], + 'ParentUserId' => [ + 'description' => 'The ID of the primary account of the user.'."\n", + 'type' => 'string', + 'example' => '155**********904', + ], + 'StartedAt' => [ + 'description' => 'The time when the pipeline job starts, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:51:33.028Z'."\n", + ], + 'FinishedAt' => [ + 'description' => 'The time of the pipeline job ends, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:52:33.028Z'."\n", + ], + 'NodeId' => [ + 'description' => 'The ID of the node on which the pipeline job is executed.'."\n", + 'type' => 'string', + 'example' => 'node-n06d**********fc53'."\n", + ], + 'Duration' => [ + 'description' => 'The running duration of the pipeline job. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '15945', + ], + 'Message' => [ + 'description' => 'The failure message of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'error message'."\n", + ], + 'SourceType' => [ + 'description' => 'The type of the pipeline job source. Valid values:'."\n" + ."\n" + .'* UNKNOWN'."\n" + .'* SDK'."\n" + .'* DESIGNER'."\n" + .'* M6'."\n", + 'type' => 'string', + 'example' => 'UNKNOWN', + ], + 'SourceId' => [ + 'description' => 'The ID of the source for the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'abcd*********hxfu'."\n", + ], + 'GmtCreateTime' => [ + 'description' => 'The time when the pipeline job is created, in UTC. The time must follow the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:51:33.028Z'."\n", + ], + 'GmtModifiedTime' => [ + 'description' => 'The time when the pipeline job is last modified, in UTC. The time must follow the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:51:33.028Z'."\n", + ], + 'PipelineId' => [ + 'description' => 'The pipeline ID.'."\n", + 'type' => 'string', + 'example' => 'pipeline-j94y**********lf7a'."\n", + ], + 'Accessibility' => [ + 'description' => 'The accessibility of the pipeline job. Valid values:'."\n" + ."\n" + .'* PUBLIC'."\n" + .'* PRIVATE'."\n", + 'type' => 'string', + 'example' => 'PUBLIC', + ], + 'PipelineRunUri' => [ + 'description' => 'The URL of the pipeline job.'."\n", + 'type' => 'string', + 'example' => 'https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****', + ], + ], + ], + 'required' => true, + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\",\\n \\"TotalCount\\": 15,\\n \\"PipelineRuns\\": [\\n {\\n \\"PipelineRunId\\": \\"flow-j94y**********lf7a\\\\n\\",\\n \\"Name\\": \\"testName\\\\n\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"UserId\\": \\"155**********904\\",\\n \\"ParentUserId\\": \\"155**********904\\",\\n \\"StartedAt\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"FinishedAt\\": \\"2021-01-30T12:52:33.028Z\\\\n\\",\\n \\"NodeId\\": \\"node-n06d**********fc53\\\\n\\",\\n \\"Duration\\": 60,\\n \\"WorkspaceId\\": \\"15945\\",\\n \\"Message\\": \\"error message\\\\n\\",\\n \\"SourceType\\": \\"UNKNOWN\\",\\n \\"SourceId\\": \\"abcd*********hxfu\\\\n\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"PipelineId\\": \\"pipeline-j94y**********lf7a\\\\n\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"PipelineRunUri\\": \\"https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListPipelineRuns', + ], + 'TerminatePipelineRun' => [ + 'summary' => 'Terminates a pipeline job.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}/termination', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140033', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'title' => 'Run id', + 'description' => 'The ID of the pipeline job. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow-rbvg5wzljzjhc9ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-****-****-****-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'TerminatePipelineRun', + ], + 'RerunPipelineRun' => [ + 'summary' => 'Re-runs a pipeline job.', + 'path' => '/api/v1/pipelineruns/{PipelineRunId}/rerun', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146517', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineRunId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The pipeline job ID. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'run-rbvg5wzljzjhc9ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\"\\n}","type":"json"}]', + 'title' => 'RerunPipelineRun', + ], + 'CreatePipeline' => [ + 'summary' => 'Creates a pipeline. A pipeline consists of a series of nodes that form a directed acyclic graph (DAG), which defines the machine learning process.', + 'path' => '/api/v1/pipelines', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13800', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '72***', + ], + 'Manifest' => [ + 'description' => 'The pipeline definition. For more information, see the sample pipeline definition.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apiVersion: "core/v1"*********', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681******', + ], + 'PipelineId' => [ + 'description' => 'The pipeline ID.'."\n", + 'type' => 'string', + 'example' => 'pipeline-hynm2bv8**********', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681******\\",\\n \\"PipelineId\\": \\"pipeline-hynm2bv8**********\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePipelineResponse>\\n <RequestId>DA869D1B-035A-43B2-ACC1-C56681BD9FAA</RequestId>\\n <PipelineId>pipeline-hynm2bv8**********</PipelineId>\\n</CreatePipelineResponse>","errorExample":""}]', + 'title' => 'CreatePipeline', + 'requestParamsDescription' => 'Sample pipeline definition: The pipeline consists of a read table node `data_source` and a data type conversion node `type_transform`.'."\n" + ."\n" + .' apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "166233998075****"'."\n" + .' version: "v1"'."\n" + .' identifier: "my_pipeline"'."\n" + .' name: "source-transform"'."\n" + .' spec:'."\n" + .' inputs:'."\n" + .' parameters:'."\n" + .' - name: "execution_maxcompute"'."\n" + .' value:'."\n" + .' spec:'."\n" + .' endpoint: "http://service.cn.maxcompute.aliyun-inc.com/api"'."\n" + .' odpsProject: "test_i****"'."\n" + .' type: "Map"'."\n" + .' pipelines:'."\n" + .' - apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "pai"'."\n" + .' version: "v1"'."\n" + .' identifier: "data_source"'."\n" + .' name: "data-source"'."\n" + .' displayName: "Read Table-1"'."\n" + .' spec:'."\n" + .' arguments:'."\n" + .' parameters:'."\n" + .' - name: "inputTableName"'."\n" + .' value: "pai_online_project.wumai_data"'."\n" + .' - name: "execution"'."\n" + .' from: "{{inputs.parameters.execution_maxcompute}}"'."\n" + .' - apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "pai"'."\n" + .' version: "v1"'."\n" + .' identifier: "type_transform"'."\n" + .' name: "type-transform"'."\n" + .' displayName: "Data Type Conversion-1"'."\n" + .' spec:'."\n" + .' arguments:'."\n" + .' artifacts:'."\n" + .' - name: "inputTable"'."\n" + .' from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"'."\n" + .' parameters:'."\n" + .' - name: "cols_to_double"'."\n" + .' value: "time,hour,pm2,pm10,so2,co,no2"'."\n" + .' - name: "execution"'."\n" + .' from: "{{inputs.parameters.execution_maxcompute}}"'."\n" + .' dependencies:'."\n" + .' - "data_source"'."\n" + ."\n" + .'Key parameter configurations in the sample pipeline definition:'."\n" + ."\n" + .'* **provider**: Replace the value of this parameter with your account ID.'."\n" + .'* **odpsProject**: Replace the value of this parameter with the name of the MaxCompute resource that is associated with the workspace. For more information about how to obtain the name of the MaxCompute resource, see [Manage workspaces](~~430481~~).'."\n", + ], + 'DeletePipeline' => [ + 'summary' => 'Deletes a pipeline.', + 'path' => '/api/v1/pipelines/{PipelineId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13813', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The pipeline ID. You can call [ListPipelines](~~438051~~) to obtain the ID of the pipeline.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pipeline-hynm2bv8wqhp5e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePipelineResponse>\\n <RequestId>DA869D1B-035A-43B2-ACC1-C56681BD9FAA</RequestId>\\n</DeletePipelineResponse>","errorExample":""}]', + 'title' => 'DeletePipeline', + 'description' => 'If the specified pipeline is subscribed by users as a shared pipeline or referenced by other pipelines as a sub-pipeline, the pipeline cannot be deleted.'."\n", + ], + 'UpdatePipeline' => [ + 'summary' => 'Updates the definition of a pipeline.', + 'path' => '/api/v1/pipelines/{PipelineId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13807', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The pipeline ID. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pipeline-hynm2bv8**********', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Manifest' => [ + 'description' => 'The pipeline definition. For more information, see the sample pipeline definition.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apiVersion: "core/v1"*********', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681******\\"\\n}","type":"json"}]', + 'title' => 'UpdatePipeline', + 'requestParamsDescription' => 'Sample pipeline definition: The pipeline consists of a read table node `data_source` and a data type conversion node `type_transform`.'."\n" + ."\n" + .' apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "166233998075****"'."\n" + .' version: "v1"'."\n" + .' identifier: "my_pipeline"'."\n" + .' name: "source-transform"'."\n" + .' spec:'."\n" + .' inputs:'."\n" + .' parameters:'."\n" + .' - name: "execution_maxcompute"'."\n" + .' value:'."\n" + .' spec:'."\n" + .' endpoint: "http://service.cn.maxcompute.aliyun-inc.com/api"'."\n" + .' odpsProject: "test_i****"'."\n" + .' type: "Map"'."\n" + .' pipelines:'."\n" + .' - apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "pai"'."\n" + .' version: "v1"'."\n" + .' identifier: "data_source"'."\n" + .' name: "data-source"'."\n" + .' displayName: "Read Table-1"'."\n" + .' spec:'."\n" + .' arguments:'."\n" + .' parameters:'."\n" + .' - name: "inputTableName"'."\n" + .' value: "pai_online_project.wumai_data"'."\n" + .' - name: "execution"'."\n" + .' from: "{{inputs.parameters.execution_maxcompute}}"'."\n" + .' - apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' provider: "pai"'."\n" + .' version: "v1"'."\n" + .' identifier: "type_transform"'."\n" + .' name: "type-transform"'."\n" + .' displayName: "Data Type Conversion-1"'."\n" + .' spec:'."\n" + .' arguments:'."\n" + .' artifacts:'."\n" + .' - name: "inputTable"'."\n" + .' from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"'."\n" + .' parameters:'."\n" + .' - name: "cols_to_double"'."\n" + .' value: "time,hour,pm2,pm10,so2,co,no2"'."\n" + .' - name: "execution"'."\n" + .' from: "{{inputs.parameters.execution_maxcompute}}"'."\n" + .' dependencies:'."\n" + .' - "data_source"'."\n" + ."\n" + .'Key parameter configurations in the sample pipeline definition:'."\n" + ."\n" + .'* **provider**: Replace the value of this parameter with your account ID.'."\n" + .'* **odpsProject**: Replace the value of this parameter with the name of the MaxCompute resource that is associated with the workspace. For more information about how to query the name of a MaxCompute resource, see [Manage workspaces](~~430481~~).'."\n", + ], + 'GetPipeline' => [ + 'summary' => 'Queries the information about a pipeline.', + 'path' => '/api/v1/pipelines/{PipelineId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13812', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The pipeline ID. You can call [ListPipelineRuns](~~438042~~) to obtain the ID of the pipeline job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pipeline-hynm2bv8wqhp5e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '63EDFF2F-4D51-46F0-9D65-2F8F393B****', + ], + 'PipelineId' => [ + 'description' => 'The pipeline ID.'."\n", + 'type' => 'string', + 'example' => 'pipeline-hynm2bv8wqhp5e****', + ], + 'Provider' => [ + 'description' => 'The value is the user ID for custom pipelines. The value is PAI for pipelines provided by Platform for AI (PAI).'."\n", + 'type' => 'string', + 'example' => '132668941337****', + ], + 'Identifier' => [ + 'description' => 'The pipeline identifier.'."\n", + 'type' => 'string', + 'example' => 'SqlWrite', + ], + 'Version' => [ + 'description' => 'The pipeline version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Manifest' => [ + 'description' => 'The pipeline definition.'."\n", + 'type' => 'string', + 'example' => 'apiVersion: ****', + ], + 'GmtCreateTime' => [ + 'description' => 'The time when the pipeline was created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'GmtModifiedTime' => [ + 'description' => 'The time when the pipeline was modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'Uuid' => [ + 'description' => 'The UUID of the pipeline. A UUID is generated each time the user modifies the pipeline.'."\n", + 'type' => 'string', + 'example' => 'q8dp9hklueznhg****', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '726**', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63EDFF2F-4D51-46F0-9D65-2F8F393B****\\",\\n \\"PipelineId\\": \\"pipeline-hynm2bv8wqhp5e****\\",\\n \\"Provider\\": \\"132668941337****\\",\\n \\"Identifier\\": \\"SqlWrite\\",\\n \\"Version\\": \\"v1\\",\\n \\"Manifest\\": \\"apiVersion: ****\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Uuid\\": \\"q8dp9hklueznhg****\\",\\n \\"WorkspaceId\\": \\"726**\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'GetPipeline', + 'responseParamsDescription' => 'Additional description of the Manifest parameter'."\n" + ."\n" + .' apiVersion: "core/v1"'."\n" + .' metadata:'."\n" + .' version: "v1"'."\n" + .' # The provider of the pipeline.'."\n" + .' provider: "132668**********"'."\n" + .' identifier: "my***"'."\n" + .' spec:'."\n" + .' inputs:'."\n" + .' parameters:'."\n" + .' - name: "inputTableName"'."\n" + .' value: "myDefault"'."\n" + .' # The data type. The value can be string, double, bool, integer, map, and list.'."\n" + .' type: "String"'."\n" + .' desc: "Table Name"'."\n" + .' # Specifies whether the parameter is required. Default value: false.'."\n" + .' required: false'."\n" + .' outputs:'."\n" + .' artifacts:'."\n" + .' - name: "outputTable"'."\n" + .' metadata:'."\n" + .' # The metadata type. The value can be DataSet, Model, ModelEvaluation, Any, DataStream, and Raw. In this example, DataSet is used.'."\n" + .' type:'."\n" + .' DataSet:'."\n" + .' locationType: "MaxComputeTable"'."\n" + .' desc: "Source MaxCompute Table Output Port"'."\n" + .' container:'."\n" + .' image: "registry.***.com/***/***:v*"'."\n" + .' command:'."\n" + .' - "bash"'."\n" + .' - "***.sh"'."\n" + .' volumeMounts:'."\n" + .' - name: "download-volume"'."\n" + .' path: "/***"'."\n" + .' initContainers:'."\n" + .' - image: "registry.***.com/***/***:v*"'."\n" + .' command:'."\n" + .' - "***.sh"'."\n" + .' args:'."\n" + .' - "--***"'."\n" + .' name: "initdownload"'."\n" + .' volumeMounts:'."\n" + .' - name: "download-volume"'."\n" + .' path: "/downloadPath"'."\n" + .' volumes:'."\n" + .' - name: "download-volume"'."\n" + .' emptyDir: {}'."\n", + ], + 'ListPipelines' => [ + 'summary' => 'Queries a list of pipelines.', + 'path' => '/api/v1/pipelines', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13816', + 'abilityTreeNodes' => [ + 'FEATURElearnWUYTTV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PipelineIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pipeline identifier. You can call **ListPipelines** to obtain the **identifier**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SqlWriteTable_2', + ], + ], + [ + 'name' => 'PipelineProvider', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pipeline provider.'."\n" + ."\n" + .'* The value is pai if the pipeline is provided by PAI.'."\n" + .'* The value is the ID of the Alibaba Cloud account if the pipeline is created by using the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pai', + ], + ], + [ + 'name' => 'PipelineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pipeline version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '726**', + ], + ], + [ + 'name' => 'FuzzyMatching', + 'in' => 'query', + 'schema' => [ + 'title' => '模糊匹配', + 'description' => 'Specifies whether to support fuzzy match. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681B****', + ], + 'Pipelines' => [ + 'description' => 'The pipelines.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The pipeline.'."\n", + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'description' => 'The pipeline ID.'."\n", + 'type' => 'string', + 'example' => 'pipeline-c0h44g3wlwkj8o*****', + ], + 'GmtCreateTime' => [ + 'description' => 'The time when the pipeline was created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-06T14:32:50Z', + ], + 'GmtModifiedTime' => [ + 'description' => 'The time when the pipeline was modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-06T22:26:24Z', + ], + 'Provider' => [ + 'description' => 'The pipeline provider.'."\n" + ."\n" + .'* The value is pai if the pipeline is provided by PAI.'."\n" + .'* The value is the ID of the Alibaba Cloud account if the pipeline is created by using the account.'."\n", + 'type' => 'string', + 'example' => 'pai', + ], + 'Identifier' => [ + 'description' => 'The pipeline identifier.'."\n", + 'type' => 'string', + 'example' => 'SqlWriteTable_2', + ], + 'Version' => [ + 'description' => 'The pipeline version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Uuid' => [ + 'description' => 'The UUID of the pipeline. A UUID is generated each time the user modifies the pipeline.'."\n", + 'type' => 'string', + 'example' => 'q8dp9hklueznh*****', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '726**', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681B****\\",\\n \\"Pipelines\\": [\\n {\\n \\"PipelineId\\": \\"pipeline-c0h44g3wlwkj8o*****\\",\\n \\"GmtCreateTime\\": \\"2021-01-06T14:32:50Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-06T22:26:24Z\\",\\n \\"Provider\\": \\"pai\\",\\n \\"Identifier\\": \\"SqlWriteTable_2\\",\\n \\"Version\\": \\"v1\\",\\n \\"Uuid\\": \\"q8dp9hklueznh*****\\",\\n \\"WorkspaceId\\": \\"726**\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListPipelines', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'paiflow.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'paiflow.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'paiflow.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'paiflow.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'paiflow.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'paiflow.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'paiflow.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'paiflow.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'paiflow.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'paiflow.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'paiflow.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'paiflow.ap-southeast-5.aliyuncs.com', + ], + ], +]; |
