summaryrefslogtreecommitdiff
path: root/data/zh_cn/paistudio/2021-02-02/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/paistudio/2021-02-02/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/paistudio/2021-02-02/api-docs.php')
-rw-r--r--data/zh_cn/paistudio/2021-02-02/api-docs.php6588
1 files changed, 3120 insertions, 3468 deletions
diff --git a/data/zh_cn/paistudio/2021-02-02/api-docs.php b/data/zh_cn/paistudio/2021-02-02/api-docs.php
index 9a31a5a..282c719 100644
--- a/data/zh_cn/paistudio/2021-02-02/api-docs.php
+++ b/data/zh_cn/paistudio/2021-02-02/api-docs.php
@@ -1,103 +1,52 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'PaiStudio',
- 'version' => '2021-02-02',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'PaiStudio', 'version' => '2021-02-02'],
'directories' => [
[
- 'id' => 197103,
- 'title' => '工作流草稿',
+ 'children' => ['CopyExperiment', 'UpdateExperimentMeta', 'UpdateExperimentContent', 'PublishExperiment', 'GetExperimentMeta', 'GetExperimentStatus'],
'type' => 'directory',
- 'children' => [
- 'CreateExperiment',
- 'CopyExperiment',
- 'UpdateExperimentMeta',
- 'UpdateExperimentContent',
- 'PublishExperiment',
- 'GetExperiment',
- 'GetExperimentMeta',
- 'GetExperimentStatus',
- 'DeleteExperiment',
- 'ListExperiments',
- ],
+ 'title' => '工作流草稿',
+ 'id' => 289486,
],
[
- 'id' => 197114,
- 'title' => '工作流草稿作业',
+ 'children' => ['GetJob', 'StopJob', 'StopExperiment'],
'type' => 'directory',
- 'children' => [
- 'CreateJob',
- 'GetJob',
- 'ListJobs',
- 'StopJob',
- 'StopExperiment',
- ],
+ 'title' => '工作流草稿作业',
+ 'id' => 289502,
],
[
- 'id' => 197111,
- 'title' => '工作流草稿目录',
+ 'children' => ['CreateExperimentFolder', 'UpdateExperimentFolder', 'GetExperimentFolderChildren', 'DeleteExperimentFolder'],
'type' => 'directory',
- 'children' => [
- 'CreateExperimentFolder',
- 'UpdateExperimentFolder',
- 'GetExperimentFolderChildren',
- 'DeleteExperimentFolder',
- ],
+ 'title' => '工作流草稿目录',
+ 'id' => 289497,
],
[
- 'id' => 197169,
- 'title' => '算法',
+ 'children' => ['GetAlgorithmTree', 'GetAlgorithmDef'],
'type' => 'directory',
- 'children' => [
- 'GetAlgorithmTree',
- 'GetAlgorithmDef',
- ],
+ 'title' => '算法',
+ 'id' => 289508,
],
[
- 'id' => 197189,
+ 'children' => ['ListRecentExperiments', 'GetExperimentsStatistics', 'GetExperimentsUsersStatistics', 'PreviewMCTable', 'GetMCTableSchema', 'SearchMCTables', 'GetNodeInputSchema', 'GetExperimentVisualizationMeta', 'QueryExperimentVisualizationData', 'GetAlgoTree', 'ListNodeOutputs', 'GetNodeOutput', 'ListAuthRoles', 'ListImageLabels', 'MigrateExperiments', 'CreateExperimentMigrateValidation', 'MigrateExperimentFolders', 'GetAlgorithmDefs'],
+ 'type' => 'directory',
'title' => '其它(未在目录中的文档)',
+ 'id' => 289511,
+ ],
+ [
+ 'children' => ['CreateExperiment', 'CreateJob', 'DeleteExperiment', 'GetExperiment', 'GetTemplate', 'ListExperiments', 'ListImages', 'ListJobs', 'ListTemplates'],
'type' => 'directory',
- 'children' => [
- 'ListRecentExperiments',
- 'ListTemplates',
- 'GetTemplate',
- 'GetExperimentsStatistics',
- 'GetExperimentsUsersStatistics',
- 'PreviewMCTable',
- 'GetMCTableSchema',
- 'SearchMCTables',
- 'GetNodeInputSchema',
- 'GetExperimentVisualizationMeta',
- 'QueryExperimentVisualizationData',
- 'GetAlgoTree',
- 'ListNodeOutputs',
- 'GetNodeOutput',
- 'ListAuthRoles',
- 'ListImages',
- 'ListImageLabels',
- 'MigrateExperiments',
- 'CreateExperimentMigrateValidation',
- 'MigrateExperimentFolders',
- 'GetAlgorithmDefs',
- ],
+ 'title' => '其他',
+ 'id' => 457209,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateExperiment' => [
- 'summary' => '创建PAI Designer工作流草稿。',
- 'path' => '/api/v1/experiments',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CopyExperiment' => [
+ 'path' => '/api/v1/experiments/{ExperimentId}/copy',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -107,10 +56,10 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '14187',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '16683',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
@@ -118,104 +67,78 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '工作流草稿。',
+ 'description' => '请求Body。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '工作流草稿名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'description' => '工作流草稿描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Pipeline draft description',
- ],
- 'Source' => [
- 'description' => '工作流草稿来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
- 'FolderId' => [
- 'description' => '工作流草稿所属文件夹ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-xfdafx093xxfd',
- ],
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '84972',
- ],
- 'TemplateId' => [
- 'description' => '模板ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'template-xze5df2scrxxz',
- ],
- 'Options' => [
- 'description' => '工作流草稿选项。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
+ 'Name' => ['title' => '实验名称，最大长度 128，可包含中英文', 'description' => '复制后的工作流草稿名称，最大长度 128，可包含中英文。', 'type' => 'string', 'required' => true, 'example' => 'Pipeline draft name'],
+ 'Description' => ['title' => '实验描述', 'description' => '工作流草稿描述。', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft description'],
+ 'Source' => ['title' => '实验来源，目前 PaiStudio，data-airec（推荐白盒）', 'description' => '工作流草稿创建来源。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
+ 'FolderId' => ['title' => '实验创建的目录 id', 'description' => '复制后工作流草稿所属的的文件夹ID。该参数在调用[CreateExperimentFolder](~~2854071~~)创建工作流草稿文件夹后返回。', 'type' => 'string', 'required' => true, 'example' => 'folder-erwx872xuryx'],
+ 'WorkspaceId' => ['title' => '实验创建的Workspace', 'description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '84972'],
'Accessibility' => [
'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '工作空间可见性，可能值为：'."\n"
- .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n"
- .'- PUBLIC：在此工作空间中，对所有人可见。',
+ 'description' => '工作流草稿的可见性，取值如下：'."\n"
+ .'- PUBLIC：在此工作空间中，对所有人可见。'."\n"
+ .'- PRIVATE：在此工作空间中，仅对您和管理员可见。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
'example' => 'PUBLIC',
],
],
'required' => false,
],
],
+ [
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['title' => '实验Id', 'description' => '源工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-s2gf8fj160mqxyf0qd'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回结果。',
+ 'description' => '响应内容。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '42F23B58-3684-5443-848A-8DA81FF99712',
- ],
- 'ExperimentId' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6D161C28-9CB1-584E-8DD5-64441E32A5B3'],
+ 'ExperimentId' => ['description' => '复制生成的工作流草稿ID。', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\"\\n}","type":"json"}]',
- 'title' => '创建工作流草稿',
- ],
- 'CopyExperiment' => [
+ 'title' => '复制工作流草稿',
'summary' => '复制PAI Designer工作流草稿。',
- 'path' => '/api/v1/experiments/{ExperimentId}/copy',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-04T09:15:21.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyExperiment'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CopyPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D161C28-9CB1-584E-8DD5-64441E32A5B3\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\"\\n}","type":"json"}]',
+ ],
+ 'CreateExperiment' => [
+ 'summary' => '创建PAI Designer工作流草稿。',
+ 'path' => '/api/v1/experiments',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -225,10 +148,10 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '16683',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14187',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
@@ -236,70 +159,103 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求Body。',
+ 'description' => '工作流草稿。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '实验名称，最大长度 128，可包含中英文',
- 'description' => '复制后的工作流草稿名称，最大长度 128，可包含中英文。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'title' => '实验描述',
- 'description' => '工作流草稿描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Pipeline draft description',
- ],
- 'Source' => [
- 'title' => '实验来源，目前 PaiStudio，data-airec（推荐白盒）',
- 'description' => '工作流草稿创建来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
- 'FolderId' => [
- 'title' => '实验创建的目录 id',
- 'description' => '复制后工作流草稿所属的的文件夹ID。该参数在调用[CreateExperimentFolder](~~2854071~~)创建工作流草稿文件夹后返回。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-erwx872xuryx',
- ],
- 'WorkspaceId' => [
- 'title' => '实验创建的Workspace',
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '84972',
- ],
+ 'Name' => ['description' => '工作流草稿名称。', 'type' => 'string', 'required' => true, 'example' => 'Pipeline draft name'],
+ 'Description' => ['description' => '工作流草稿描述。', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft description'],
+ 'Source' => ['description' => '工作流草稿来源。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
+ 'FolderId' => ['description' => '工作流草稿所属文件夹ID。', 'type' => 'string', 'required' => true, 'example' => 'folder-xfdafx093xxfd'],
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '84972'],
+ 'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'required' => false, 'example' => 'template-xze5df2scrxxz'],
+ 'Options' => ['description' => '工作流草稿选项。', 'type' => 'string', 'required' => false, 'example' => '{"mlflow":{"experimentId":"exp-1"}}'],
'Accessibility' => [
'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '工作流草稿的可见性，取值如下：'."\n"
- .'- PUBLIC：在此工作空间中，对所有人可见。'."\n"
- .'- PRIVATE：在此工作空间中，仅对您和管理员可见。',
+ 'description' => '工作空间可见性，可能值为：'."\n"
+ .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n"
+ .'- PUBLIC：在此工作空间中，对所有人可见。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
'example' => 'PUBLIC',
],
],
'required' => false,
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '42F23B58-3684-5443-848A-8DA81FF99712'],
+ 'ExperimentId' => ['description' => '工作流草稿ID。', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ ],
+ ],
+ ],
+ ],
+ 'title' => '创建工作流草稿',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExperiment'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreatePipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\"\\n}","type":"json"}]',
+ ],
+ 'CreateExperimentFolder' => [
+ 'summary' => '创建工作流草稿文件夹。',
+ 'path' => '/api/v1/experimentfolders',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13799',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '实验Id',
- 'description' => '源工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-s2gf8fj160mqxyf0qd',
+ 'description' => '请求Body。',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '45699'],
+ 'Name' => ['description' => '工作流草稿名称。', 'type' => 'string', 'required' => true, 'example' => 'Pipeline draft name'],
+ 'ParentFolderId' => ['description' => '父文件夹ID。', 'type' => 'string', 'required' => false, 'example' => 'folder-xxfdjhfxdfad'],
+ 'Source' => ['description' => '工作流草稿创建来源。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
+ 'Accessibility' => ['title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC', 'description' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'],
+ ],
+ 'required' => false,
],
],
],
@@ -307,111 +263,139 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应内容。',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6D161C28-9CB1-584E-8DD5-64441E32A5B3',
- ],
- 'ExperimentId' => [
- 'description' => '复制生成的工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
+ 'FolderId' => ['description' => '新建的文件夹的ID。', 'type' => 'string', 'example' => 'folder-xxfdjhfxduxd'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D161C28-9CB1-584E-8DD5-64441E32A5B3\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\"\\n}","type":"json"}]',
- 'title' => '复制工作流草稿',
- ],
- 'UpdateExperimentMeta' => [
- 'summary' => '更新PAI Designer工作流草稿的Meta信息。',
- 'path' => '/api/v1/experiments/{ExperimentId}/meta',
- 'methods' => [
- 'put',
+ 'title' => '创建工作流草稿文件夹',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExperimentFolder'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreatePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"FolderId\\": \\"folder-xxfdjhfxduxd\\"\\n}","type":"json"}]',
+ ],
+ 'CreateExperimentMigrateValidation' => [
+ 'path' => '/api/v1/migrate/experimentvalidation',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '14190',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '100051',
+ 'abilityTreeNodes' => ['FEATURElearn01UVDS'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
+ 'name' => 'SourceExpId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Studio1.0中的实验ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
+ 'title' => 'Schema of Response',
+ 'description' => '响应结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ ],
+ ],
+ ],
+ ],
+ 'title' => '创建工作流草稿迁移的校验',
+ 'summary' => '创建工作流草稿迁移的校',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-15T06:49:21.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExperimentMigrateValidation'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreateExperimentMigrateValidation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
+ ],
+ 'CreateJob' => [
+ 'path' => '/api/v1/jobs',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14185',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
+ ],
+ 'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求Body。',
+ 'description' => '请求',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '工作流草稿名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'description' => '工作流草稿描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Pipeline draft description',
- ],
- 'FolderId' => [
- 'description' => '工作流草稿更新后的所属的文件夹ID。'."\n"
- .'* 如果该值不为空，将工作流草稿移动到该文件夹。'."\n"
- .'* 如果为空，不移动。'."\n"
- .'* 如果为root，且Accessibility为PUBILC，移动到公共根目录'."\n"
- .'* 如果为root，且Accessibility为PRIVATE，移动到自己的根目录',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder-xfd782efd08wex',
- ],
- 'Options' => [
- 'description' => '工作流草稿选项。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
- 'Accessibility' => [
- 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '工作流草稿的可见性，取值如下：'."\n"
- .'- PUBLIC：在此工作空间中，对所有人可见。'."\n"
- .'- PRIVATE：在此工作空间中，仅对您和管理员可见。',
+ 'PipelineDraftId' => ['title' => '工作流草稿ID。', 'description' => '工作流草稿ID。', 'type' => 'string', 'required' => false, 'example' => 'draft-o1p0k444nlq3cd50zz'."\n"],
+ 'ExperimentId' => ['title' => '工作流草稿Id，已经废弃，建议使用PipelineDraftId。', 'description' => '工作流草稿ID，已经废弃，建议使用PipelineDraftId参数。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'draft-o1p0k444nlq3cd50zz'],
+ 'ExecuteType' => [
+ 'description' => '作业执行类型。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
- 'example' => 'PUBLIC',
+ 'enumValueTitles' => ['EXECUTE_ALL' => '运行工作流草稿中所有节点', 'EXECUTE_ONE' => '执行指定节点', 'EXECUTE_TO_HERE' => '从根节点执行到该节点', 'EXECUTE_FROM_HERE' => '从指定的节点开始运行', 'EXECUTE_CHILDREN' => '执行指定节点的下游节点'],
+ 'example' => 'EXECUTE_ALL',
],
+ 'NodeId' => ['description' => '工作流节点ID。', 'type' => 'string', 'required' => false, 'example' => 'id-2d88-1608982098027-91558'],
+ 'Options' => ['description' => '运行选项，json格式。', 'type' => 'string', 'required' => false, 'example' => '{"mlflow":{"experimentId":"exp-1"}}'],
],
'required' => false,
],
@@ -421,32 +405,49 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应结果。',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '85082123-2A3F-52E7-B27A-F04700B82FFB'],
+ 'JobId' => ['description' => '工作流草稿作业ID。', 'type' => 'string', 'example' => 'job-jcs4mmyangk7r2zdqz'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\"\\n}","type":"json"}]',
- 'title' => '更新工作流草稿Meta',
- ],
- 'UpdateExperimentContent' => [
- 'summary' => '更新工作流草稿的内容。',
- 'path' => '/api/v1/experiments/{ExperimentId}/content',
- 'methods' => [
- 'put',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '创建工作流草稿作业',
+ 'summary' => '创建工作流草稿的作业。',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-13T07:01:16.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreateJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85082123-2A3F-52E7-B27A-F04700B82FFB\\",\\n \\"JobId\\": \\"job-jcs4mmyangk7r2zdqz\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteExperiment' => [
+ 'summary' => '删除PAI Designer工作流草稿。',
+ 'path' => '/api/v1/experiments/{ExperimentId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -455,49 +456,141 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '14191',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-i1udvvwm2rlvxug29n',
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3'],
+ ],
],
],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '删除工作流草稿',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExperiment'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'paidesigner:DeletePipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteExperimentFolder' => [
+ 'path' => '/api/v1/experimentfolders/{FolderId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13803',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FolderId',
+ 'in' => 'path',
+ 'schema' => ['description' => '文件夹ID。', 'type' => 'string', 'required' => false, 'example' => 'folder-xzf7t785nka4ch7qce'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求Body。',
+ 'title' => 'Schema of Response',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'Content' => [
- 'description' => '工作流草稿内容。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{"metadata":{"name":"实验名称","desc":"实验描述"},"nodes":[],"edges":[],"globalParams":[],"globalSettings":[]}',
- ],
- 'Version' => [
- 'description' => '更新前的工作流草稿版本，要求与工作流草稿的当前版本一致，否则无法更新成功。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '11',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'],
],
- 'required' => false,
],
],
],
+ 'title' => '删除工作流草稿文件夹',
+ 'summary' => '删除工作流草稿文件夹。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExperimentFolder'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'paidesigner:DeletePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\"\\n}","type":"json"}]',
+ ],
+ 'GetAlgoTree' => [
+ 'path' => '/api/v1/algo/tree',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13795',
+ 'abilityTreeNodes' => ['FEATURElearnZAMNTS'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['description' => '获取指定源的算法列表，默认为PaiStudio。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
@@ -505,79 +598,204 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Version' => [
- 'description' => '更新后工作流草稿的版本。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8CAA642F-EFEB-5F87-8F2F-ACD58B15FA03'],
+ 'Data' => ['description' => '算法定义。', 'type' => 'object', 'example' => '[{}]'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Version\\": 12\\n}","type":"json"}]',
- 'title' => '更新工作流草稿的内容',
- ],
- 'PublishExperiment' => [
- 'summary' => '将工作流草稿发布到工作空间，让工作空间所有用户可见。',
- 'path' => '/api/v1/experiments/{ExperimentId}/publish',
- 'methods' => [
- 'put',
+ 'title' => '获取算法树',
+ 'summary' => '获取算法树。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgoTree'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgoTree',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8CAA642F-EFEB-5F87-8F2F-ACD58B15FA03\\",\\n \\"Data\\": [\\n {}\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetAlgorithmDef' => [
+ 'path' => '/api/v1/algorithm/def',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '92519',
- 'abilityTreeNodes' => [
- 'FEATURElearn01UVDS',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '19291',
+ 'abilityTreeNodes' => ['FEATURElearnZAMNTS'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
+ 'name' => 'Provider',
+ 'in' => 'query',
+ 'schema' => ['description' => '算法的提供者，官方算法为pai。', 'type' => 'string', 'required' => true, 'example' => 'pai'],
+ ],
+ [
+ 'name' => 'Identifier',
+ 'in' => 'query',
+ 'schema' => ['description' => '算法的identifier。', 'type' => 'string', 'required' => true, 'example' => 'logisticregression_binary'],
+ ],
+ [
+ 'name' => 'AlgoVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => '算法的版本。', 'type' => 'string', 'required' => true, 'example' => 'v1'],
+ ],
+ [
+ 'name' => 'Signature',
+ 'in' => 'query',
+ 'schema' => ['description' => '算法的signature，假如为空会取最近的版本。', 'type' => 'string', 'required' => false, 'example' => '49c9904dc177eb4d58f68915f35315b6fc6ee2db'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B4F16666-FD54-5D9D-A362-53A4C66692DF'],
+ 'Spec' => ['description' => '算法定义的Spec。', 'type' => 'object', 'example' => '{}'],
+ ],
],
],
+ ],
+ 'title' => '获取算法定义',
+ 'summary' => '获取算法定义',
+ 'changeSet' => [
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmDef'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4F16666-FD54-5D9D-A362-53A4C66692DF\\",\\n \\"Spec\\": {}\\n}","type":"json"}]',
+ ],
+ 'GetAlgorithmDefs' => [
+ 'summary' => '批量获取算法定义。',
+ 'path' => '/api/v1/algorithm/defs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '19292',
+ 'abilityTreeNodes' => ['FEATURElearnZAMNTS'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Timestamp',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前已缓存的时间戳，会返回此时间戳到服务端最新时间戳之间的算法列表。'."\n"
+ .'不传直接返回全量的最新列表。', 'type' => 'string', 'required' => false, 'example' => '1709950208'],
+ ],
+ [
+ 'name' => 'LatestTimestamp',
+ 'in' => 'query',
+ 'schema' => ['description' => '服务端返回的最新版本的时间戳，不传则自动获取。', 'type' => 'string', 'required' => false, 'example' => '1709950208'],
+ ],
+ [
+ 'name' => 'RangeStart',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页获取算法定义，当前页的范围起始点，闭区间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'RangeEnd',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页获取算法定义，当前页的范围结束点，开区间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求Body。',
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'FolderId' => [
- 'title' => '公共目录Id',
- 'description' => '公共文件夹ID，root表示公共的根目录。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'root',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
+ 'Specs' => [
+ 'description' => '算法定义列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '算法定义。', 'type' => 'object', 'example' => '{}'],
],
],
- 'required' => false,
],
],
],
+ 'title' => '批量获取算法定义',
+ 'changeSet' => [
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmDefs'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Specs\\": [\\n {}\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetAlgorithmTree' => [
+ 'path' => '/api/v1/algorithm/tree',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '19289',
+ 'abilityTreeNodes' => ['FEATURElearnZAMNTS'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['description' => '获取指定源的算法列表，默认为PaiStudio。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '工作空间ID。指定工作空间ID后，将根据当前工作空间是否开通GPU资源对算法树结果进行过滤。', 'description' => '工作空间ID。指定工作空间ID后，将根据当前工作空间是否开通GPU资源对算法树结果进行过滤。', 'type' => 'string', 'required' => false, 'example' => '12345'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
@@ -585,33 +803,47 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '5A26A7FA-EEF0-5A6B-BA76-06067547C11F',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '46B59732-033F-5C96-9B15-1E05E7705548'],
+ 'Tree' => [
+ 'description' => '算法树。',
+ 'type' => 'array',
+ 'items' => ['description' => '算法定义。', 'type' => 'object', 'example' => '{'."\n"
+ .' "name": "Tensorflow",'."\n"
+ .' "nodeType": "algo",'."\n"
+ .' "icon": "yyyy",'."\n"
+ .' "metadata": {'."\n"
+ .' "provider": "pai",'."\n"
+ .' "identifier": "evaluate-tensorflow",'."\n"
+ .' "version": "v2",'."\n"
+ .' "signature": "49c9904dc177eb4d58f68915f35315b6fc6ee2db"'."\n"
+ .' },'."\n"
+ .' "doc": "http://www.aliyun.com/doc?id=11"'."\n"
+ .'}'],
+ ],
+ 'Timestamp' => ['description' => '算法树最后更新的时间戳。', 'type' => 'string', 'example' => '20210317101023'],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => '获取算法树',
+ 'summary' => '获取算法树。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-27T11:32:40.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => 'OpenAPI 下线'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A26A7FA-EEF0-5A6B-BA76-06067547C11F\\"\\n}","type":"json"}]',
- 'title' => '公开工作流草稿到工作空间',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmTree'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46B59732-033F-5C96-9B15-1E05E7705548\\",\\n \\"Tree\\": [\\n {\\n \\"name\\": \\"Tensorflow\\",\\n \\"nodeType\\": \\"algo\\",\\n \\"icon\\": \\"yyyy\\",\\n \\"metadata\\": {\\n \\"provider\\": \\"pai\\",\\n \\"identifier\\": \\"evaluate-tensorflow\\",\\n \\"version\\": \\"v2\\",\\n \\"signature\\": \\"49c9904dc177eb4d58f68915f35315b6fc6ee2db\\"\\n },\\n \\"doc\\": \\"http://www.aliyun.com/doc?id=11\\"\\n }\\n ],\\n \\"Timestamp\\": \\"20210317101023\\"\\n}","type":"json"}]',
],
'GetExperiment' => [
'summary' => '获取PAI Designer工作流草稿。',
'path' => '/api/v1/experiments/{ExperimentId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -621,10 +853,10 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '14195',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
@@ -646,96 +878,169 @@
'description' => '工作流草稿。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DD405810-73C9-5721-996A-EA04BCC4BBF2',
- ],
- 'ExperimentId' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- 'Name' => [
- 'description' => '工作流草稿名称。',
- 'type' => 'string',
- 'example' => 'Pipeline Draft Name',
- ],
- 'Description' => [
- 'description' => '工作流草稿描述。',
- 'type' => 'string',
- 'example' => 'Pipeline Draft Description',
- ],
- 'GmtCreateTime' => [
- 'description' => '创建UTC时间，日期格式ISO8601。',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'GmtModifiedTime' => [
- 'description' => '工作流修改的UTC时间，日期格式ISO8601。',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'Creator' => [
- 'description' => '创建人ID。',
- 'type' => 'string',
- 'example' => '13266*******76250',
- ],
- 'Source' => [
- 'description' => '工作流草稿来源。',
- 'type' => 'string',
- 'example' => 'PaiStudio',
- ],
- 'Version' => [
- 'description' => '工作流草稿版本，每次更新内容版本会自增。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'example' => '23487',
- ],
- 'Content' => [
- 'description' => '工作流草稿内容，json格式。',
- 'type' => 'string',
- 'example' => '{"nodes":[{"id":"id-4c50-1609236241393-76174","name":"读数据表","metadata":{"identifier":"data_source","version":"v1","provider":"pai"},"properties":[{"name":"hasPartition","value":false},{"name":"inputTableName","value":"pai_online_project.e_commerce_test_data"}],"position":{"x":427,"y":123}},{"id":"id-23ce-1609236252041-30106","name":"读数据表","metadata":{"identifier":"data_source","version":"v1","provider":"pai"},"properties":[{"name":"inputTableName","value":"pai_online_project.e_commerce_train_data"},{"name":"hasPartition","value":false}],"position":{"x":226,"y":127}},{"id":"id-97a7-1609236275421-84245","name":"DeepFM","metadata":{"identifier":"deepfm","version":"v1","provider":"pai"},"properties":[{"name":"trainModel","value":"train"},{"name":"arn","value":true},{"name":"cluster","value":"\\n{\\n \\"ps\\": {\\n \\"count\\": 2,\\n \\"cpu\\": 1000,\\n \\"memory\\": 40000\\n },\\n \\"worker\\": {\\n \\"count\\": 8,\\n \\"cpu\\": 1000,\\n \\"memory\\": 40000\\n }\\n}"}],"position":{"x":323,"y":345}}],"edges":[{"source":"id-23ce-1609236252041-30106","sourceAnchor":"outputTable","targetAnchor":"input1TableName","target":"id-97a7-1609236275421-84245"},{"source":"id-4c50-1609236241393-76174","sourceAnchor":"outputTable","targetAnchor":"input2TableName","target":"id-97a7-1609236275421-84245"}],"globalParams":[],"globalSettings":[]}',
- ],
- 'Options' => [
- 'description' => '工作流选项，json格式。',
- 'type' => 'string',
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DD405810-73C9-5721-996A-EA04BCC4BBF2'],
+ 'ExperimentId' => ['description' => '工作流草稿ID。', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ 'Name' => ['description' => '工作流草稿名称。', 'type' => 'string', 'example' => 'Pipeline Draft Name'],
+ 'Description' => ['description' => '工作流草稿描述。', 'type' => 'string', 'example' => 'Pipeline Draft Description'],
+ 'GmtCreateTime' => ['description' => '创建UTC时间，日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'GmtModifiedTime' => ['description' => '工作流修改的UTC时间，日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'Creator' => ['description' => '创建人ID。', 'type' => 'string', 'example' => '13266*******76250'],
+ 'Source' => ['description' => '工作流草稿来源。', 'type' => 'string', 'example' => 'PaiStudio'],
+ 'Version' => ['description' => '工作流草稿版本，每次更新内容版本会自增。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '23487'],
+ 'Content' => ['description' => '工作流草稿内容，json格式。', 'type' => 'string', 'example' => '{"nodes":[{"id":"id-4c50-1609236241393-76174","name":"读数据表","metadata":{"identifier":"data_source","version":"v1","provider":"pai"},"properties":[{"name":"hasPartition","value":false},{"name":"inputTableName","value":"pai_online_project.e_commerce_test_data"}],"position":{"x":427,"y":123}},{"id":"id-23ce-1609236252041-30106","name":"读数据表","metadata":{"identifier":"data_source","version":"v1","provider":"pai"},"properties":[{"name":"inputTableName","value":"pai_online_project.e_commerce_train_data"},{"name":"hasPartition","value":false}],"position":{"x":226,"y":127}},{"id":"id-97a7-1609236275421-84245","name":"DeepFM","metadata":{"identifier":"deepfm","version":"v1","provider":"pai"},"properties":[{"name":"trainModel","value":"train"},{"name":"arn","value":true},{"name":"cluster","value":"\\n{\\n \\"ps\\": {\\n \\"count\\": 2,\\n \\"cpu\\": 1000,\\n \\"memory\\": 40000\\n },\\n \\"worker\\": {\\n \\"count\\": 8,\\n \\"cpu\\": 1000,\\n \\"memory\\": 40000\\n }\\n}"}],"position":{"x":323,"y":345}}],"edges":[{"source":"id-23ce-1609236252041-30106","sourceAnchor":"outputTable","targetAnchor":"input1TableName","target":"id-97a7-1609236275421-84245"},{"source":"id-4c50-1609236241393-76174","sourceAnchor":"outputTable","targetAnchor":"input2TableName","target":"id-97a7-1609236275421-84245"}],"globalParams":[],"globalSettings":[]}'],
+ 'Options' => ['description' => '工作流选项，json格式。', 'type' => 'string', 'example' => '{"mlflow":{"experimentId":"exp-1"}}'],
'Accessibility' => [
'description' => '工作空间可见性，可能值为：'."\n"
.'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n"
.'- PUBLIC：在此工作空间中，对所有人可见。',
'type' => 'string',
- 'enumValueTitles' => [
- 'PUBLIC' => '公开',
- 'PRIVATE' => '私有',
- ],
+ 'enumValueTitles' => ['PUBLIC' => '公开', 'PRIVATE' => '私有'],
'example' => 'PUBLIC',
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD405810-73C9-5721-996A-EA04BCC4BBF2\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\",\\n \\"Name\\": \\"Pipeline Draft Name\\",\\n \\"Description\\": \\"Pipeline Draft Description\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Creator\\": \\"13266*******76250\\",\\n \\"Source\\": \\"PaiStudio\\",\\n \\"Version\\": 12,\\n \\"WorkspaceId\\": \\"23487\\",\\n \\"Content\\": \\"{\\\\\\"nodes\\\\\\":[{\\\\\\"id\\\\\\":\\\\\\"id-4c50-1609236241393-76174\\\\\\",\\\\\\"name\\\\\\":\\\\\\"读数据表\\\\\\",\\\\\\"metadata\\\\\\":{\\\\\\"identifier\\\\\\":\\\\\\"data_source\\\\\\",\\\\\\"version\\\\\\":\\\\\\"v1\\\\\\",\\\\\\"provider\\\\\\":\\\\\\"pai\\\\\\"},\\\\\\"properties\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"hasPartition\\\\\\",\\\\\\"value\\\\\\":false},{\\\\\\"name\\\\\\":\\\\\\"inputTableName\\\\\\",\\\\\\"value\\\\\\":\\\\\\"pai_online_project.e_commerce_test_data\\\\\\"}],\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":427,\\\\\\"y\\\\\\":123}},{\\\\\\"id\\\\\\":\\\\\\"id-23ce-1609236252041-30106\\\\\\",\\\\\\"name\\\\\\":\\\\\\"读数据表\\\\\\",\\\\\\"metadata\\\\\\":{\\\\\\"identifier\\\\\\":\\\\\\"data_source\\\\\\",\\\\\\"version\\\\\\":\\\\\\"v1\\\\\\",\\\\\\"provider\\\\\\":\\\\\\"pai\\\\\\"},\\\\\\"properties\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"inputTableName\\\\\\",\\\\\\"value\\\\\\":\\\\\\"pai_online_project.e_commerce_train_data\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"hasPartition\\\\\\",\\\\\\"value\\\\\\":false}],\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":226,\\\\\\"y\\\\\\":127}},{\\\\\\"id\\\\\\":\\\\\\"id-97a7-1609236275421-84245\\\\\\",\\\\\\"name\\\\\\":\\\\\\"DeepFM\\\\\\",\\\\\\"metadata\\\\\\":{\\\\\\"identifier\\\\\\":\\\\\\"deepfm\\\\\\",\\\\\\"version\\\\\\":\\\\\\"v1\\\\\\",\\\\\\"provider\\\\\\":\\\\\\"pai\\\\\\"},\\\\\\"properties\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"trainModel\\\\\\",\\\\\\"value\\\\\\":\\\\\\"train\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"arn\\\\\\",\\\\\\"value\\\\\\":true},{\\\\\\"name\\\\\\":\\\\\\"cluster\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\\\n{\\\\\\\\n \\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"count\\\\\\\\\\\\\\": 2,\\\\\\\\n \\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\": 1000,\\\\\\\\n \\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\": 40000\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"count\\\\\\\\\\\\\\": 8,\\\\\\\\n \\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\": 1000,\\\\\\\\n \\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\": 40000\\\\\\\\n }\\\\\\\\n}\\\\\\"}],\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":323,\\\\\\"y\\\\\\":345}}],\\\\\\"edges\\\\\\":[{\\\\\\"source\\\\\\":\\\\\\"id-23ce-1609236252041-30106\\\\\\",\\\\\\"sourceAnchor\\\\\\":\\\\\\"outputTable\\\\\\",\\\\\\"targetAnchor\\\\\\":\\\\\\"input1TableName\\\\\\",\\\\\\"target\\\\\\":\\\\\\"id-97a7-1609236275421-84245\\\\\\"},{\\\\\\"source\\\\\\":\\\\\\"id-4c50-1609236241393-76174\\\\\\",\\\\\\"sourceAnchor\\\\\\":\\\\\\"outputTable\\\\\\",\\\\\\"targetAnchor\\\\\\":\\\\\\"input2TableName\\\\\\",\\\\\\"target\\\\\\":\\\\\\"id-97a7-1609236275421-84245\\\\\\"}],\\\\\\"globalParams\\\\\\":[],\\\\\\"globalSettings\\\\\\":[]}\\",\\n \\"Options\\": \\"{\\\\\\"mlflow\\\\\\":{\\\\\\"experimentId\\\\\\":\\\\\\"exp-1\\\\\\"}}\\",\\n \\"Accessibility\\": \\"PUBLIC\\"\\n}","type":"json"}]',
'title' => '获取工作流草稿',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperiment'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD405810-73C9-5721-996A-EA04BCC4BBF2\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\",\\n \\"Name\\": \\"Pipeline Draft Name\\",\\n \\"Description\\": \\"Pipeline Draft Description\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Creator\\": \\"13266*******76250\\",\\n \\"Source\\": \\"PaiStudio\\",\\n \\"Version\\": 12,\\n \\"WorkspaceId\\": \\"23487\\",\\n \\"Content\\": \\"{\\\\\\"nodes\\\\\\":[{\\\\\\"id\\\\\\":\\\\\\"id-4c50-1609236241393-76174\\\\\\",\\\\\\"name\\\\\\":\\\\\\"读数据表\\\\\\",\\\\\\"metadata\\\\\\":{\\\\\\"identifier\\\\\\":\\\\\\"data_source\\\\\\",\\\\\\"version\\\\\\":\\\\\\"v1\\\\\\",\\\\\\"provider\\\\\\":\\\\\\"pai\\\\\\"},\\\\\\"properties\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"hasPartition\\\\\\",\\\\\\"value\\\\\\":false},{\\\\\\"name\\\\\\":\\\\\\"inputTableName\\\\\\",\\\\\\"value\\\\\\":\\\\\\"pai_online_project.e_commerce_test_data\\\\\\"}],\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":427,\\\\\\"y\\\\\\":123}},{\\\\\\"id\\\\\\":\\\\\\"id-23ce-1609236252041-30106\\\\\\",\\\\\\"name\\\\\\":\\\\\\"读数据表\\\\\\",\\\\\\"metadata\\\\\\":{\\\\\\"identifier\\\\\\":\\\\\\"data_source\\\\\\",\\\\\\"version\\\\\\":\\\\\\"v1\\\\\\",\\\\\\"provider\\\\\\":\\\\\\"pai\\\\\\"},\\\\\\"properties\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"inputTableName\\\\\\",\\\\\\"value\\\\\\":\\\\\\"pai_online_project.e_commerce_train_data\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"hasPartition\\\\\\",\\\\\\"value\\\\\\":false}],\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":226,\\\\\\"y\\\\\\":127}},{\\\\\\"id\\\\\\":\\\\\\"id-97a7-1609236275421-84245\\\\\\",\\\\\\"name\\\\\\":\\\\\\"DeepFM\\\\\\",\\\\\\"metadata\\\\\\":{\\\\\\"identifier\\\\\\":\\\\\\"deepfm\\\\\\",\\\\\\"version\\\\\\":\\\\\\"v1\\\\\\",\\\\\\"provider\\\\\\":\\\\\\"pai\\\\\\"},\\\\\\"properties\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"trainModel\\\\\\",\\\\\\"value\\\\\\":\\\\\\"train\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"arn\\\\\\",\\\\\\"value\\\\\\":true},{\\\\\\"name\\\\\\":\\\\\\"cluster\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\\\n{\\\\\\\\n \\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"count\\\\\\\\\\\\\\": 2,\\\\\\\\n \\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\": 1000,\\\\\\\\n \\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\": 40000\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"count\\\\\\\\\\\\\\": 8,\\\\\\\\n \\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\": 1000,\\\\\\\\n \\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\": 40000\\\\\\\\n }\\\\\\\\n}\\\\\\"}],\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":323,\\\\\\"y\\\\\\":345}}],\\\\\\"edges\\\\\\":[{\\\\\\"source\\\\\\":\\\\\\"id-23ce-1609236252041-30106\\\\\\",\\\\\\"sourceAnchor\\\\\\":\\\\\\"outputTable\\\\\\",\\\\\\"targetAnchor\\\\\\":\\\\\\"input1TableName\\\\\\",\\\\\\"target\\\\\\":\\\\\\"id-97a7-1609236275421-84245\\\\\\"},{\\\\\\"source\\\\\\":\\\\\\"id-4c50-1609236241393-76174\\\\\\",\\\\\\"sourceAnchor\\\\\\":\\\\\\"outputTable\\\\\\",\\\\\\"targetAnchor\\\\\\":\\\\\\"input2TableName\\\\\\",\\\\\\"target\\\\\\":\\\\\\"id-97a7-1609236275421-84245\\\\\\"}],\\\\\\"globalParams\\\\\\":[],\\\\\\"globalSettings\\\\\\":[]}\\",\\n \\"Options\\": \\"{\\\\\\"mlflow\\\\\\":{\\\\\\"experimentId\\\\\\":\\\\\\"exp-1\\\\\\"}}\\",\\n \\"Accessibility\\": \\"PUBLIC\\"\\n}","type":"json"}]',
+ ],
+ 'GetExperimentFolderChildren' => [
+ 'summary' => '列出某一个工作流草稿文件夹下的子文件夹或工作流草稿。',
+ 'path' => '/api/v1/experimentfolders/{FolderId}/children',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13806',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FolderId',
+ 'in' => 'path',
+ 'schema' => ['description' => '要列出成员的父文件夹ID，假如是root表示是根目录。', 'type' => 'string', 'required' => true, 'example' => 'folder-xzf7t7****ch7qce'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ ],
+ [
+ 'name' => 'OnlyFolder',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否只列出文件夹。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['description' => '创建来源。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
+ ],
+ [
+ 'name' => 'Accessibility',
+ 'in' => 'query',
+ 'schema' => ['title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC', 'description' => '工作空间可见性，可能值为：'."\n"
+ .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n"
+ .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => ['title' => '若FolderId为root，Accessibility为PRIVATE，这里代表私有根路径的所有者，默认为访问者自己', 'description' => '若FolderId为root，Accessibility为PRIVATE，这里代表私有根路径的所有者，默认为访问者自己', 'type' => 'string', 'required' => false, 'example' => '12345******13324'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
+ 'Items' => [
+ 'description' => '成员列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '成员详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '工作流草稿或工作流草稿文件夹的ID。', 'type' => 'string', 'example' => 'folder-xzf7t7****ch7qce'],
+ 'Name' => ['description' => '工作流草稿或工作流草稿文件夹的名称。', 'type' => 'string', 'example' => 'Pipeline draft name'],
+ 'Type' => ['description' => '目前有两种类型：'."\n"
+ .'* pipelinedraft：工作流草稿'."\n"
+ .'* dir：工作流草稿文件夹', 'type' => 'string', 'example' => 'dir'],
+ 'Icon' => ['description' => '工作流草稿或工作流草稿文件夹使用的图标，目前有icon-folder，icon-pipelinedraft。', 'type' => 'string', 'example' => 'icon-folder'],
+ 'Empty' => ['description' => '是否为空。', 'type' => 'boolean', 'example' => 'false'],
+ 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间，UTC 时间，日期格式 iso8601。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'GmtModifiedTime' => ['title' => '修改时间', 'description' => '修改时间，UTC 时间，日期格式 iso8601。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:51:33.028Z'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'title' => '获取工作流草稿文件夹下成员',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-23T04:23:32.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentFolderChildren'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftFolderChildren',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": 23,\\n \\"Items\\": [\\n {\\n \\"Id\\": \\"folder-xzf7t7****ch7qce\\",\\n \\"Name\\": \\"Pipeline draft name\\",\\n \\"Type\\": \\"dir\\",\\n \\"Icon\\": \\"icon-folder\\",\\n \\"Empty\\": false,\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetExperimentMeta' => [
'summary' => '查询工作流草稿Meta。',
'path' => '/api/v1/experiments/{ExperimentId}/meta',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -745,22 +1050,16 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '14188',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'title' => '实验 id',
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'schema' => ['title' => '实验 id', 'description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
],
],
'responses' => [
@@ -770,90 +1069,58 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6',
- ],
- 'ExperimentId' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- 'Name' => [
- 'description' => '工作流草稿名称。',
- 'type' => 'string',
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'description' => '工作流草稿描述。',
- 'type' => 'string',
- 'example' => 'Pipeline draft description',
- ],
- 'GmtCreateTime' => [
- 'description' => '创建UTC时间，时间格式为ISO8601。',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'GmtModifiedTime' => [
- 'description' => '工作流草稿修改 UTC 时间，日期格式ISO8601。',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'Creator' => [
- 'description' => '创建人ID。',
- 'type' => 'string',
- 'example' => '1326****76250',
- ],
- 'Source' => [
- 'description' => '工作流草稿来源。',
- 'type' => 'string',
- 'example' => 'PaiStudio',
- ],
- 'Version' => [
- 'description' => '工作流草稿版本，每次更新内容版本会自增。',
- 'type' => 'string',
- 'example' => '12',
- ],
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'example' => '23487',
- ],
- 'Options' => [
- 'description' => '工作流草稿选项。',
- 'type' => 'string',
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'],
+ 'ExperimentId' => ['description' => '工作流草稿ID。', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ 'Name' => ['description' => '工作流草稿名称。', 'type' => 'string', 'example' => 'Pipeline draft name'],
+ 'Description' => ['description' => '工作流草稿描述。', 'type' => 'string', 'example' => 'Pipeline draft description'],
+ 'GmtCreateTime' => ['description' => '创建UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'GmtModifiedTime' => ['description' => '工作流草稿修改 UTC 时间，日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'Creator' => ['description' => '创建人ID。', 'type' => 'string', 'example' => '1326****76250'],
+ 'Source' => ['description' => '工作流草稿来源。', 'type' => 'string', 'example' => 'PaiStudio'],
+ 'Version' => ['description' => '工作流草稿版本，每次更新内容版本会自增。', 'type' => 'string', 'example' => '12'],
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '23487'],
+ 'Options' => ['description' => '工作流草稿选项。', 'type' => 'string', 'example' => '{"mlflow":{"experimentId":"exp-1"}}'],
'Accessibility' => [
'description' => '工作空间可见性，可能值为：'."\n"
.'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n"
.'- PUBLIC：在此工作空间中，对所有人可见。',
'type' => 'string',
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
'example' => 'PUBLIC',
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\",\\n \\"Name\\": \\"Pipeline draft name\\",\\n \\"Description\\": \\"Pipeline draft description\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Creator\\": \\"1326****76250\\",\\n \\"Source\\": \\"PaiStudio\\",\\n \\"Version\\": \\"12\\",\\n \\"WorkspaceId\\": \\"23487\\",\\n \\"Options\\": \\"{\\\\\\"mlflow\\\\\\":{\\\\\\"experimentId\\\\\\":\\\\\\"exp-1\\\\\\"}}\\",\\n \\"Accessibility\\": \\"PUBLIC\\"\\n}","type":"json"}]',
'title' => '查询工作流草稿Meta',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentMeta'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\",\\n \\"Name\\": \\"Pipeline draft name\\",\\n \\"Description\\": \\"Pipeline draft description\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Creator\\": \\"1326****76250\\",\\n \\"Source\\": \\"PaiStudio\\",\\n \\"Version\\": \\"12\\",\\n \\"WorkspaceId\\": \\"23487\\",\\n \\"Options\\": \\"{\\\\\\"mlflow\\\\\\":{\\\\\\"experimentId\\\\\\":\\\\\\"exp-1\\\\\\"}}\\",\\n \\"Accessibility\\": \\"PUBLIC\\"\\n}","type":"json"}]',
],
'GetExperimentStatus' => [
'summary' => '获取工作流草稿以及工作流草稿中节点的状态。',
'path' => '/api/v1/experiments/{ExperimentId}/status',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -863,21 +1130,16 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '14237',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-4c60c4txtaexfum1zx',
- ],
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-4c60c4txtaexfum1zx'],
],
],
'responses' => [
@@ -887,21 +1149,13 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
'Status' => [
'description' => '工作流草稿状态，目前有Stopped和Running两个状态：'."\n"
.'* Running：工作流草稿有运行中的作业。'."\n"
.'* Stopped：工作流草稿中没有运行中的作业。',
'type' => 'string',
- 'enumValueTitles' => [
- 'Stopped' => 'Stopped',
- 'Running' => 'Running',
- ],
+ 'enumValueTitles' => ['Stopped' => 'Stopped', 'Running' => 'Running'],
'example' => 'Running',
],
'Nodes' => [
@@ -911,52 +1165,24 @@
'description' => '节点信息。',
'type' => 'object',
'properties' => [
- 'NodeId' => [
- 'description' => '工作流草稿中的节点ID。',
- 'type' => 'string',
- 'example' => 'id-2317-1608984201281-74996',
- ],
- 'JobId' => [
- 'description' => '该节点最近一次运行创建的工作流草稿作业ID。',
- 'type' => 'string',
- 'example' => 'job-mewqhd72nsrqujn1px',
- ],
- 'RunId' => [
- 'description' => '该节点最近一次运行创建的PaiFlow PipelineRun的ID。',
- 'type' => 'string',
- 'example' => 'flow-wayrh3k605s7i51wey',
- ],
- 'RunNodeId' => [
- 'description' => '该节点最近一次运行创建的PaiFlow PipelineRun中对应的节点ID。',
- 'type' => 'string',
- 'example' => 'node-6hc0eocnmzf4pk9njc',
- ],
- 'Status' => [
- 'description' => '任务状态，状态和paiflow中状态一致，目前状态有：'."\n"
- .'* Initialized: 初始化完成'."\n"
- .'* Starting：开始'."\n"
- .'* WorkflowServiceStarting：准备提交'."\n"
- .'* Running：运行中'."\n"
- .'* Succeeded：运行成功'."\n"
- .'* Failed：运行失败'."\n"
- .'* Terminating：终止中'."\n"
- .'* Terminated：已终止'."\n"
- .'* Unknown：未知'."\n"
- .'* Skipped：跳过（前序节点失败导致）'."\n"
- .'* ReadyToSchedule：准备运行（前序节点未完成导致）',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'StartedAt' => [
- 'description' => '任务开始时间。',
- 'type' => 'string',
- 'example' => '2021-01-21T17:12:35.232Z',
- ],
- 'FinishedAt' => [
- 'description' => '任务结束时间。',
- 'type' => 'string',
- 'example' => '2021-01-21T18:12:35.232Z',
- ],
+ 'NodeId' => ['description' => '工作流草稿中的节点ID。', 'type' => 'string', 'example' => 'id-2317-1608984201281-74996'],
+ 'JobId' => ['description' => '该节点最近一次运行创建的工作流草稿作业ID。', 'type' => 'string', 'example' => 'job-mewqhd72nsrqujn1px'],
+ 'RunId' => ['description' => '该节点最近一次运行创建的PaiFlow PipelineRun的ID。', 'type' => 'string', 'example' => 'flow-wayrh3k605s7i51wey'],
+ 'RunNodeId' => ['description' => '该节点最近一次运行创建的PaiFlow PipelineRun中对应的节点ID。', 'type' => 'string', 'example' => 'node-6hc0eocnmzf4pk9njc'],
+ 'Status' => ['description' => '任务状态，状态和paiflow中状态一致，目前状态有：'."\n"
+ .'* Initialized: 初始化完成'."\n"
+ .'* Starting：开始'."\n"
+ .'* WorkflowServiceStarting：准备提交'."\n"
+ .'* Running：运行中'."\n"
+ .'* Succeeded：运行成功'."\n"
+ .'* Failed：运行失败'."\n"
+ .'* Terminating：终止中'."\n"
+ .'* Terminated：已终止'."\n"
+ .'* Unknown：未知'."\n"
+ .'* Skipped：跳过（前序节点失败导致）'."\n"
+ .'* ReadyToSchedule：准备运行（前序节点未完成导致）', 'type' => 'string', 'example' => 'Running'],
+ 'StartedAt' => ['description' => '任务开始时间。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'],
+ 'FinishedAt' => ['description' => '任务结束时间。', 'type' => 'string', 'example' => '2021-01-21T18:12:35.232Z'],
],
],
],
@@ -964,53 +1190,98 @@
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Status\\": \\"Running\\",\\n \\"Nodes\\": [\\n {\\n \\"NodeId\\": \\"id-2317-1608984201281-74996\\",\\n \\"JobId\\": \\"job-mewqhd72nsrqujn1px\\",\\n \\"RunId\\": \\"flow-wayrh3k605s7i51wey\\",\\n \\"RunNodeId\\": \\"node-6hc0eocnmzf4pk9njc\\",\\n \\"Status\\": \\"Running\\",\\n \\"StartedAt\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"FinishedAt\\": \\"2021-01-21T18:12:35.232Z\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询工作流草稿状态',
- ],
- 'DeleteExperiment' => [
- 'summary' => '删除PAI Designer工作流草稿。',
- 'path' => '/api/v1/experiments/{ExperimentId}',
- 'methods' => [
- 'delete',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentStatus'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Status\\": \\"Running\\",\\n \\"Nodes\\": [\\n {\\n \\"NodeId\\": \\"id-2317-1608984201281-74996\\",\\n \\"JobId\\": \\"job-mewqhd72nsrqujn1px\\",\\n \\"RunId\\": \\"flow-wayrh3k605s7i51wey\\",\\n \\"RunNodeId\\": \\"node-6hc0eocnmzf4pk9njc\\",\\n \\"Status\\": \\"Running\\",\\n \\"StartedAt\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"FinishedAt\\": \\"2021-01-21T18:12:35.232Z\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetExperimentVisualizationMeta' => [
+ 'summary' => '获取工作流草稿可视化信息的Meta。',
+ 'path' => '/api/v1/experiments/{ExperimentId}/visualizationMeta',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '42908',
+ 'abilityTreeNodes' => ['FEATURElearnUEX4WU'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ ],
+ [
+ 'name' => 'NodeIds',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流草稿中的节点id列表，以英文逗号隔开，假如为空，则表示查询工作流草稿中的所有节点。', 'type' => 'string', 'required' => false, 'example' => 'node_id1,node_id2'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回结果。',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3',
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A84A1282-D3E7-5198-9E8E-2AD09C78C6C1'],
+ 'VisualizationMeta' => [
+ 'description' => '可视化Meta列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '可视化信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'node_id1'],
+ 'NodeName' => ['description' => '节点名称。', 'type' => 'string', 'example' => '直方图_1'],
+ 'Meta' => ['description' => '可视化数据Meta，json格式。', 'type' => 'string', 'example' => '{'."\n"
+ .' "locations": [{'."\n"
+ .' "id": "result_table",'."\n"
+ .' "location": {'."\n"
+ .' "project": "mulan_test_pre_1",'."\n"
+ .' "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n"
+ .' "table": "pai_temp_flow_qzkkjqic95olnrel1w_node_7hc1rdsa99gy2msbvc_visualizationTable"'."\n"
+ .' },'."\n"
+ .' "locationType": "MaxComputeTable"'."\n"
+ .' }],'."\n"
+ .' "components": [{'."\n"
+ .' "id": "histogram-chart",'."\n"
+ .' "dataId": "histogram_result"'."\n"
+ .' }],'."\n"
+ .' "dataInfos": [{'."\n"
+ .' "id": "histogram_result",'."\n"
+ .' "locationId": "result_table",'."\n"
+ .' "dataType": "json"'."\n"
+ .' }]'."\n"
+ .'}'],
+ ],
+ ],
],
],
],
@@ -1020,19 +1291,34 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3\\"\\n}","type":"json"}]',
- 'title' => '删除工作流草稿',
- ],
- 'ListExperiments' => [
- 'summary' => '获取PAI Designer的工作流草稿列表。',
- 'path' => '/api/v1/experiments',
- 'methods' => [
- 'get',
+ 'title' => '获取工作流草稿可视化的Meta',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-26T02:22:18.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentVisualizationMeta'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftVisualizationMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A84A1282-D3E7-5198-9E8E-2AD09C78C6C1\\",\\n \\"VisualizationMeta\\": [\\n {\\n \\"NodeId\\": \\"node_id1\\",\\n \\"NodeName\\": \\"直方图_1\\",\\n \\"Meta\\": \\"{\\\\n\\\\t\\\\\\"locations\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"id\\\\\\": \\\\\\"result_table\\\\\\",\\\\n\\\\t\\\\t\\\\\\"location\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\\\"project\\\\\\": \\\\\\"mulan_test_pre_1\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"endpoint\\\\\\": \\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"table\\\\\\": \\\\\\"pai_temp_flow_qzkkjqic95olnrel1w_node_7hc1rdsa99gy2msbvc_visualizationTable\\\\\\"\\\\n\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\\\"locationType\\\\\\": \\\\\\"MaxComputeTable\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"components\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"id\\\\\\": \\\\\\"histogram-chart\\\\\\",\\\\n\\\\t\\\\t\\\\\\"dataId\\\\\\": \\\\\\"histogram_result\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"dataInfos\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"id\\\\\\": \\\\\\"histogram_result\\\\\\",\\\\n\\\\t\\\\t\\\\\\"locationId\\\\\\": \\\\\\"result_table\\\\\\",\\\\n\\\\t\\\\t\\\\\\"dataType\\\\\\": \\\\\\"json\\\\\\"\\\\n\\\\t}]\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetExperimentsStatistics' => [
+ 'path' => '/api/v1/statistics/experiments',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1041,283 +1327,106 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '14194',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '61666',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '列表的页码，默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页的大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Order',
- 'in' => 'query',
- 'schema' => [
- 'description' => '排列顺序：'."\n"
- .'- DESC：降序。'."\n"
- .'- ASC：升序。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ASC' => 'ASC',
- 'DESC' => 'DESC',
- ],
- 'example' => 'DESC',
- ],
- ],
- [
- 'name' => 'ExperimentId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
- 'name' => 'Name',
+ 'name' => 'WorkspaceIds',
'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Pipeline draft name',
- ],
- ],
- [
- 'name' => 'Creator',
- 'in' => 'query',
- 'schema' => [
- 'description' => '创建人的UID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '13266******376250',
- ],
+ 'schema' => ['description' => '工作空间ID列表，多个ID间使用半角逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => '123,345'],
],
[
'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿创建来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
- ],
- [
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '34875',
- ],
- ],
- [
- 'name' => 'SortBy',
- 'in' => 'query',
- 'schema' => [
- 'description' => '排序依据。'."\n"
- .'* GmtCreate：创建时间。'."\n"
- .'* GmtModified：更新时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GmtCreate',
- ],
+ 'schema' => ['description' => '工作流草稿创建来源。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回结果。',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9708FB85-232F-5F9A-9D67-7F9CCCE20E06',
- ],
- 'Experiments' => [
- 'description' => '工作流草稿列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Data' => [
+ 'description' => '返回结果。',
'type' => 'array',
'items' => [
- 'description' => '工作流草稿详情。',
+ 'description' => '工作空间统计信息。',
'type' => 'object',
'properties' => [
- 'ExperimentId' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- 'Name' => [
- 'description' => '工作流草稿名称。',
- 'type' => 'string',
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'description' => '工作流草稿描述。',
- 'type' => 'string',
- 'example' => 'Pipeline draft description',
- ],
- 'GmtCreateTime' => [
- 'description' => '工作流草稿创建 UTC 时间，日期格式ISO8601。',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'GmtModifiedTime' => [
- 'description' => '工作流草稿修改 UTC 时间，日期格式ISO8601。',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'Creator' => [
- 'description' => '工作流草稿创建者的UID。',
- 'type' => 'string',
- 'example' => '1326*******76250',
- ],
- 'Source' => [
- 'description' => '工作流草稿创建来源。',
- 'type' => 'string',
- 'example' => 'PaiStudio',
- ],
- 'Version' => [
- 'description' => '工作流草稿当前版本。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'example' => '23487',
- ],
- 'Accessibility' => [
- 'description' => '工作流草稿的可见性，取值如下：'."\n"
- .'- PUBLIC：在此工作空间中，对所有人可见。'."\n"
- .'- PRIVATE：在此工作空间中，仅对您和管理员可见。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
- 'example' => 'PUBLIC',
- ],
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '16381'],
+ 'TotalCount' => ['description' => '该工作空间下所有的工作量草稿数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'CreateCount' => ['description' => '当前用户在该工作空间下创建的工作流草稿数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
- 'TotalCount' => [
- 'description' => '工作流草稿总数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '15',
- ],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9708FB85-232F-5F9A-9D67-7F9CCCE20E06\\",\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\",\\n \\"Name\\": \\"Pipeline draft name\\",\\n \\"Description\\": \\"Pipeline draft description\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Creator\\": \\"1326*******76250\\",\\n \\"Source\\": \\"PaiStudio\\",\\n \\"Version\\": 12,\\n \\"WorkspaceId\\": \\"23487\\",\\n \\"Accessibility\\": \\"PUBLIC\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]',
- 'title' => '获取工作流草稿列表',
- ],
- 'CreateJob' => [
- 'summary' => '创建工作流草稿的作业。',
- 'path' => '/api/v1/jobs',
- 'methods' => [
- 'post',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '统计工作空间中工作流草稿的数量',
+ 'summary' => '获取实验统计信息',
+ 'description' => '统计工作空间中工作流草稿的数量。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentsStatistics'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftsStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": [\\n {\\n \\"WorkspaceId\\": \\"16381\\",\\n \\"TotalCount\\": 20,\\n \\"CreateCount\\": 10\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetExperimentsUsersStatistics' => [
+ 'summary' => '获取实验或文件夹所有者列表',
+ 'path' => '/api/v1/statistics/experimentsusers',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '14185',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '92531',
+ 'abilityTreeNodes' => ['FEATURElearn1QDD9Y'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求',
- 'type' => 'object',
- 'properties' => [
- 'PipelineDraftId' => [
- 'title' => '工作流草稿ID。',
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'draft-o1p0k444nlq3cd50zz'."\n",
- ],
- 'ExperimentId' => [
- 'title' => '工作流草稿Id，已经废弃，建议使用PipelineDraftId。',
- 'description' => '工作流草稿ID，已经废弃，建议使用PipelineDraftId参数。',
- 'type' => 'string',
- 'deprecated' => true,
- 'required' => false,
- 'example' => 'draft-o1p0k444nlq3cd50zz',
- ],
- 'ExecuteType' => [
- 'description' => '作业执行类型。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'EXECUTE_ALL' => '运行工作流草稿中所有节点',
- 'EXECUTE_ONE' => '执行指定节点',
- 'EXECUTE_TO_HERE' => '从根节点执行到该节点',
- 'EXECUTE_FROM_HERE' => '从指定的节点开始运行',
- 'EXECUTE_CHILDREN' => '执行指定节点的下游节点',
- ],
- 'example' => 'EXECUTE_ALL',
- ],
- 'NodeId' => [
- 'description' => '工作流节点ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id-2d88-1608982098027-91558',
- ],
- 'Options' => [
- 'description' => '运行选项，json格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ ],
+ [
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流草稿创建来源', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
],
],
'responses' => [
@@ -1327,16 +1436,17 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '85082123-2A3F-52E7-B27A-F04700B82FFB',
- ],
- 'JobId' => [
- 'description' => '工作流草稿作业ID。',
- 'type' => 'string',
- 'example' => 'job-jcs4mmyangk7r2zdqz',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
+ 'Users' => [
+ 'description' => '用户列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '用户信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['description' => '用户的UID。', 'type' => 'string', 'example' => '12345******67890'],
+ ],
+ ],
],
],
],
@@ -1346,52 +1456,59 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85082123-2A3F-52E7-B27A-F04700B82FFB\\",\\n \\"JobId\\": \\"job-jcs4mmyangk7r2zdqz\\"\\n}","type":"json"}]',
- 'title' => '创建工作流草稿作业',
+ 'title' => '统计创建了工作流草稿的用户',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentsUsersStatistics'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftsUsersStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"12345******67890\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetJob' => [
'summary' => '查询工作流草稿作业详细信息。',
'path' => '/api/v1/jobs/{JobId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '14186',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'Verbose',
'in' => 'query',
- 'schema' => [
- 'description' => '是否查询任务详情。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否查询任务详情。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'JobId',
'in' => 'path',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'job-6xfhrofqx93y139fg3',
- ],
+ 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => 'job-6xfhrofqx93y139fg3'],
],
],
'responses' => [
@@ -1401,123 +1518,66 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
- ],
- 'ExperimentId' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'example' => '86995',
- ],
- 'JobId' => [
- 'description' => '作业ID。',
- 'type' => 'string',
- 'example' => 'job-6xfhrofqx93y139fg3'."\n",
- ],
- 'Snapshot' => [
- 'description' => '作业快照。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'ExecuteType' => [
- 'description' => '执行的类型:'."\n"
- .'- EXECUTE_ALL(运行工作流草稿中所有节点)'."\n"
- .'- EXECUTE_ONE(执行指定节点)'."\n"
- .'- EXECUTE_TO_HERE(从根节点执行到该节点)'."\n"
- .'- EXECUTE_FROM_HERE(从指定的节点开始运行)'."\n"
- .'- EXECUTE_CHILDREN(执行指定节点的下游节点)',
- 'type' => 'string',
- 'example' => 'EXECUTE_TO_HERE',
- ],
- 'NodeId' => [
- 'description' => '工作流草稿中的节点ID。',
- 'type' => 'string',
- 'example' => 'id-xxxxx',
- ],
- 'RunInfo' => [
- 'description' => '该作业对应的Pipeline Run的Manifests。',
- 'type' => 'string',
- 'example' => 'apiVersion: "core/v1"'."\n"
- .'metadata:'."\n"
- .' version: "v1"'."\n"
- .' identifier: "1de8f7c8-a9d8-4433-9e87-d95979ccab14"'."\n"
- .' annotations: {}'."\n"
- .'spec:'."\n"
- .' inputs:'."\n"
- .' artifacts: []'."\n"
- .' parameters:'."\n"
- .' - name: "execution"'."\n"
- .' type: "Map"'."\n"
- .' arguments:'."\n"
- .' artifacts: []'."\n"
- .' parameters: []'."\n"
- .' dependencies: []'."\n"
- .' initContainers: []'."\n"
- .' sideCarContainers: []'."\n"
- .' pipelines:'."\n"
- .' - apiVersion: "core/v1"'."\n"
- .' metadata:'."\n"
- .' provider: "pai"'."\n"
- .' name: "id-2d88-1608982098027-91558"'."\n"
- .' version: "v1"'."\n"
- .' identifier: "type_transform"'."\n"
- .' annotations: {}',
- ],
- 'RunId' => [
- 'description' => '对应的PaiFlow的Pipeline Run ID。',
- 'type' => 'string',
- 'example' => 'flow-lcs8ez11961l6urc3m',
- ],
- 'PaiflowNodeId' => [
- 'description' => 'PaiFlow中的Pipeline Run节点ID。',
- 'type' => 'string',
- 'example' => 'node-5dzotrnwyzfxmbwwc8'."\n",
- ],
- 'Creator' => [
- 'description' => '创建者用户ID。',
- 'type' => 'string',
- 'example' => '13266*******76250',
- ],
- 'Status' => [
- 'description' => '作业状态。取值：'."\n"
- .'- Initialized: 初始化完成'."\n"
- .'- Starting：开始'."\n"
- .'- WorkflowServiceStarting：准备提交'."\n"
- .'- Running：运行中'."\n"
- .'- Succeeded：运行成功'."\n"
- .'- Failed：运行失败'."\n"
- .'- Terminating：终止中'."\n"
- .'- Terminated：已终止'."\n"
- .'- Unknown：未知'."\n"
- .'- Skipped：跳过（前序节点失败导致）'."\n"
- .'- ReadyToSchedule：准备运行（前序节点未完成导致）',
- 'type' => 'string',
- 'example' => 'Succeeded',
- ],
- 'GmtCreateTime' => [
- 'description' => '作业创建时间。',
- 'type' => 'string',
- 'example' => '2021-01-21T17:12:35.232Z',
- ],
- 'Arguments' => [
- 'description' => 'PaiFlow Pipeline Run的Arguments。',
- 'type' => 'string',
- 'example' => '---'."\n"
- .'arguments:'."\n"
- .' parameters:'."\n"
- .' - name: "execution_maxcompute"'."\n"
- .' value:'."\n"
- .' endpoint: "http://service.cn-shanghai.maxcompute.aliyun.com/api"'."\n"
- .' odpsProject: "xxxxxxx"',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
+ 'ExperimentId' => ['description' => '工作流草稿ID。', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '86995'],
+ 'JobId' => ['description' => '作业ID。', 'type' => 'string', 'example' => 'job-6xfhrofqx93y139fg3'."\n"],
+ 'Snapshot' => ['description' => '作业快照。', 'type' => 'string', 'example' => '{}'],
+ 'ExecuteType' => ['description' => '执行的类型:'."\n"
+ .'- EXECUTE_ALL(运行工作流草稿中所有节点)'."\n"
+ .'- EXECUTE_ONE(执行指定节点)'."\n"
+ .'- EXECUTE_TO_HERE(从根节点执行到该节点)'."\n"
+ .'- EXECUTE_FROM_HERE(从指定的节点开始运行)'."\n"
+ .'- EXECUTE_CHILDREN(执行指定节点的下游节点)', 'type' => 'string', 'example' => 'EXECUTE_TO_HERE'],
+ 'NodeId' => ['description' => '工作流草稿中的节点ID。', 'type' => 'string', 'example' => 'id-xxxxx'],
+ 'RunInfo' => ['description' => '该作业对应的Pipeline Run的Manifests。', 'type' => 'string', 'example' => 'apiVersion: "core/v1"'."\n"
+ .'metadata:'."\n"
+ .' version: "v1"'."\n"
+ .' identifier: "1de8f7c8-a9d8-4433-9e87-d95979ccab14"'."\n"
+ .' annotations: {}'."\n"
+ .'spec:'."\n"
+ .' inputs:'."\n"
+ .' artifacts: []'."\n"
+ .' parameters:'."\n"
+ .' - name: "execution"'."\n"
+ .' type: "Map"'."\n"
+ .' arguments:'."\n"
+ .' artifacts: []'."\n"
+ .' parameters: []'."\n"
+ .' dependencies: []'."\n"
+ .' initContainers: []'."\n"
+ .' sideCarContainers: []'."\n"
+ .' pipelines:'."\n"
+ .' - apiVersion: "core/v1"'."\n"
+ .' metadata:'."\n"
+ .' provider: "pai"'."\n"
+ .' name: "id-2d88-1608982098027-91558"'."\n"
+ .' version: "v1"'."\n"
+ .' identifier: "type_transform"'."\n"
+ .' annotations: {}'],
+ 'RunId' => ['description' => '对应的PaiFlow的Pipeline Run ID。', 'type' => 'string', 'example' => 'flow-lcs8ez11961l6urc3m'],
+ 'PaiflowNodeId' => ['description' => 'PaiFlow中的Pipeline Run节点ID。', 'type' => 'string', 'example' => 'node-5dzotrnwyzfxmbwwc8'."\n"],
+ 'Creator' => ['description' => '创建者用户ID。', 'type' => 'string', 'example' => '13266*******76250'],
+ 'Status' => ['description' => '作业状态。取值：'."\n"
+ .'- Initialized: 初始化完成'."\n"
+ .'- Starting：开始'."\n"
+ .'- WorkflowServiceStarting：准备提交'."\n"
+ .'- Running：运行中'."\n"
+ .'- Succeeded：运行成功'."\n"
+ .'- Failed：运行失败'."\n"
+ .'- Terminating：终止中'."\n"
+ .'- Terminated：已终止'."\n"
+ .'- Unknown：未知'."\n"
+ .'- Skipped：跳过（前序节点失败导致）'."\n"
+ .'- ReadyToSchedule：准备运行（前序节点未完成导致）', 'type' => 'string', 'example' => 'Succeeded'],
+ 'GmtCreateTime' => ['description' => '作业创建时间。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'],
+ 'Arguments' => ['description' => 'PaiFlow Pipeline Run的Arguments。', 'type' => 'string', 'example' => '---'."\n"
+ .'arguments:'."\n"
+ .' parameters:'."\n"
+ .' - name: "execution_maxcompute"'."\n"
+ .' value:'."\n"
+ .' endpoint: "http://service.cn-shanghai.maxcompute.aliyun.com/api"'."\n"
+ .' odpsProject: "xxxxxxx"'],
],
],
],
@@ -1526,91 +1586,57 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\",\\n \\"WorkspaceId\\": \\"86995\\",\\n \\"JobId\\": \\"job-6xfhrofqx93y139fg3\\\\n\\",\\n \\"Snapshot\\": \\"{}\\",\\n \\"ExecuteType\\": \\"EXECUTE_TO_HERE\\",\\n \\"NodeId\\": \\"id-xxxxx\\",\\n \\"RunInfo\\": \\"apiVersion: \\\\\\"core/v1\\\\\\"\\\\nmetadata:\\\\n version: \\\\\\"v1\\\\\\"\\\\n identifier: \\\\\\"1de8f7c8-a9d8-4433-9e87-d95979ccab14\\\\\\"\\\\n annotations: {}\\\\nspec:\\\\n inputs:\\\\n artifacts: []\\\\n parameters:\\\\n - name: \\\\\\"execution\\\\\\"\\\\n type: \\\\\\"Map\\\\\\"\\\\n arguments:\\\\n artifacts: []\\\\n parameters: []\\\\n dependencies: []\\\\n initContainers: []\\\\n sideCarContainers: []\\\\n pipelines:\\\\n - apiVersion: \\\\\\"core/v1\\\\\\"\\\\n metadata:\\\\n provider: \\\\\\"pai\\\\\\"\\\\n name: \\\\\\"id-2d88-1608982098027-91558\\\\\\"\\\\n version: \\\\\\"v1\\\\\\"\\\\n identifier: \\\\\\"type_transform\\\\\\"\\\\n annotations: {}\\",\\n \\"RunId\\": \\"flow-lcs8ez11961l6urc3m\\",\\n \\"PaiflowNodeId\\": \\"node-5dzotrnwyzfxmbwwc8\\\\n\\",\\n \\"Creator\\": \\"13266*******76250\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Arguments\\": \\"---\\\\narguments:\\\\n parameters:\\\\n - name: \\\\\\"execution_maxcompute\\\\\\"\\\\n value:\\\\n endpoint: \\\\\\"http://service.cn-shanghai.maxcompute.aliyun.com/api\\\\\\"\\\\n odpsProject: \\\\\\"xxxxxxx\\\\\\"\\"\\n}","type":"json"}]',
'title' => '查询工作流草稿作业',
- ],
- 'ListJobs' => [
- 'summary' => '获取工作流草稿作业列表。',
- 'path' => '/api/v1/jobs',
- 'methods' => [
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\",\\n \\"WorkspaceId\\": \\"86995\\",\\n \\"JobId\\": \\"job-6xfhrofqx93y139fg3\\\\n\\",\\n \\"Snapshot\\": \\"{}\\",\\n \\"ExecuteType\\": \\"EXECUTE_TO_HERE\\",\\n \\"NodeId\\": \\"id-xxxxx\\",\\n \\"RunInfo\\": \\"apiVersion: \\\\\\"core/v1\\\\\\"\\\\nmetadata:\\\\n version: \\\\\\"v1\\\\\\"\\\\n identifier: \\\\\\"1de8f7c8-a9d8-4433-9e87-d95979ccab14\\\\\\"\\\\n annotations: {}\\\\nspec:\\\\n inputs:\\\\n artifacts: []\\\\n parameters:\\\\n - name: \\\\\\"execution\\\\\\"\\\\n type: \\\\\\"Map\\\\\\"\\\\n arguments:\\\\n artifacts: []\\\\n parameters: []\\\\n dependencies: []\\\\n initContainers: []\\\\n sideCarContainers: []\\\\n pipelines:\\\\n - apiVersion: \\\\\\"core/v1\\\\\\"\\\\n metadata:\\\\n provider: \\\\\\"pai\\\\\\"\\\\n name: \\\\\\"id-2d88-1608982098027-91558\\\\\\"\\\\n version: \\\\\\"v1\\\\\\"\\\\n identifier: \\\\\\"type_transform\\\\\\"\\\\n annotations: {}\\",\\n \\"RunId\\": \\"flow-lcs8ez11961l6urc3m\\",\\n \\"PaiflowNodeId\\": \\"node-5dzotrnwyzfxmbwwc8\\\\n\\",\\n \\"Creator\\": \\"13266*******76250\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Arguments\\": \\"---\\\\narguments:\\\\n parameters:\\\\n - name: \\\\\\"execution_maxcompute\\\\\\"\\\\n value:\\\\n endpoint: \\\\\\"http://service.cn-shanghai.maxcompute.aliyun.com/api\\\\\\"\\\\n odpsProject: \\\\\\"xxxxxxx\\\\\\"\\"\\n}","type":"json"}]',
+ ],
+ 'GetMCTableSchema' => [
+ 'summary' => '获取MaxCompute表的Scheme。',
+ 'path' => '/api/v1/datasources/maxcompute/tables/{TableName}/schema',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '14206',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14093',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-8up80bg0k1q23stml6',
- ],
- ],
- [
- 'name' => 'Creator',
- 'in' => 'query',
- 'schema' => [
- 'description' => '创建人的UID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '13266*******76250',
- ],
- ],
- [
- 'name' => 'Order',
- 'in' => 'query',
- 'schema' => [
- 'description' => '默认按创建时间排序，排列顺序：'."\n"
- .'- DESC：降序。'."\n"
- .'- ASC：升序。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ASC' => 'ASC',
- 'DESC' => 'DESC',
- ],
- 'example' => 'DESC',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。默认值：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'TableName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'MaxCompute表名。', 'type' => 'string', 'required' => true, 'example' => 'table_name', 'pattern' => '^([a-zA-Z][a-zA-Z0-9_]*\\.)?[a-zA-Z0-9_]+$'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的大小，默认为20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
],
],
'responses' => [
@@ -1620,88 +1646,29 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Jobs' => [
- 'description' => '作业列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Columns' => [
+ 'description' => '列信息。',
'type' => 'array',
'items' => [
- 'description' => '作业详情。',
+ 'description' => 'MaxCompute表列。',
'type' => 'object',
'properties' => [
- 'ExperimentId' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-4x4iv3a9enuxw4vgka',
- ],
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'example' => '94436',
- ],
- 'JobId' => [
- 'description' => '任务 ID。',
- 'type' => 'string',
- 'example' => 'job-mewqhd72nsrqujn1px',
- ],
- 'ExecuteType' => [
- 'description' => '执行的类型:'."\n"
- .'- EXECUTE_ALL(运行工作流草稿中所有节点)'."\n"
- .'- EXECUTE_ONE(执行指定节点)'."\n"
- .'- EXECUTE_TO_HERE(从根节点执行到该节点)'."\n"
- .'- EXECUTE_FROM_HERE(从指定的节点开始运行)'."\n"
- .'- EXECUTE_CHILDREN(执行指定节点的下游节点)',
- 'type' => 'string',
- 'example' => 'EXECUTE_ALL',
- ],
- 'NodeId' => [
- 'description' => '工作流草稿中的节点ID。',
- 'type' => 'string',
- 'example' => 'nodeId1',
- ],
- 'RunId' => [
- 'description' => '对应的PaiFlow的Pipeline Run ID。',
- 'type' => 'string',
- 'example' => 'flow-aayfouai80i980ncvz',
- ],
- 'PaiflowNodeId' => [
- 'description' => 'PaiFlow中的Pipeline Run节点ID。',
- 'type' => 'string',
- 'example' => 'node-xdfasf8ewxfdaddl',
- ],
- 'Creator' => [
- 'description' => '创建人的UID。',
- 'type' => 'string',
- 'example' => '17677*******89598',
- ],
- 'Status' => [
- 'description' => '作业的状态，目前状态有：'."\n"
- .'* Initialized: 初始化完成'."\n"
- .'* Starting：开始'."\n"
- .'* WorkflowServiceStarting：准备提交'."\n"
- .'* Running：运行中'."\n"
- .'* Succeeded：运行成功'."\n"
- .'* Failed：运行失败'."\n"
- .'* Terminating：终止中'."\n"
- .'* Terminated：已终止'."\n"
- .'* Unknown：未知'."\n"
- .'* Skipped：跳过（前序节点失败导致）'."\n"
- .'* ReadyToSchedule：准备运行（前序节点未完成导致）',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'GmtCreateTime' => [
- 'description' => '创建时间，UTC 时间，日期格式 iso8601。',
- 'type' => 'string',
- 'example' => '2021-01-21T17:12:35.232Z',
+ 'Name' => ['description' => '列名。', 'type' => 'string', 'example' => 'column1'],
+ 'Type' => ['description' => '列类型。', 'type' => 'string', 'example' => 'STRING'],
+ 'Preview' => [
+ 'description' => '列内数据预览。',
+ 'type' => 'array',
+ 'items' => ['description' => '列中数据。', 'type' => 'string', 'example' => '123'],
],
],
],
],
+ 'PartitionColumns' => [
+ 'description' => '分区列，假如为空说明是非分区表。',
+ 'type' => 'array',
+ 'items' => ['description' => '分区列名。', 'type' => 'string', 'example' => 'dt'],
+ ],
],
],
],
@@ -1710,43 +1677,69 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Jobs\\": [\\n {\\n \\"ExperimentId\\": \\"draft-4x4iv3a9enuxw4vgka\\",\\n \\"WorkspaceId\\": \\"94436\\",\\n \\"JobId\\": \\"job-mewqhd72nsrqujn1px\\",\\n \\"ExecuteType\\": \\"EXECUTE_ALL\\",\\n \\"NodeId\\": \\"nodeId1\\",\\n \\"RunId\\": \\"flow-aayfouai80i980ncvz\\",\\n \\"PaiflowNodeId\\": \\"node-xdfasf8ewxfdaddl\\",\\n \\"Creator\\": \\"17677*******89598\\",\\n \\"Status\\": \\"Running\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取工作流草稿作业列表',
- ],
- 'StopJob' => [
- 'summary' => '停止工作流草稿作业。',
- 'path' => '/api/v1/jobs/{JobId}/stop',
- 'methods' => [
- 'put',
+ 'title' => '获取MaxCompute表的Schema',
+ 'changeSet' => [
+ ['createdAt' => '2023-07-18T02:23:20.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMCTableSchema'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetMCTableSchema',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Columns\\": [\\n {\\n \\"Name\\": \\"column1\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Preview\\": [\\n \\"123\\"\\n ]\\n }\\n ],\\n \\"PartitionColumns\\": [\\n \\"dt\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetNodeInputSchema' => [
+ 'summary' => '获取节点输入Schema。',
+ 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/schema',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '14209',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14196',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '作业ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'job-i4vmjfsv5i1kowo4ih',
- ],
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'experiment-rbvg5wzljzjhc9ks92'],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作流草稿中的节点ID。', 'type' => 'string', 'required' => true, 'example' => 'ff1f33b0-426a-46bb-bb30-4a5648058079'],
+ ],
+ [
+ 'name' => 'InputId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实验节点输入桩名称，若为空则获取整个节点合并后的Schema。', 'type' => 'string', 'required' => false, 'example' => 'inputTable'],
+ ],
+ [
+ 'name' => 'InputIndex',
+ 'in' => 'query',
+ 'schema' => ['description' => '可变桩时使用，标明是可变桩扩展的第几个桩，从 0 开始编号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
],
'responses' => [
@@ -1756,57 +1749,82 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '431C53C4-BDD0-588F-8081-4437B00852B5',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'CEB07647-8A5D-56F1-8B99-361BCF51402F'],
+ 'ColNames' => [
+ 'description' => '输入表各个列的名称。',
+ 'type' => 'array',
+ 'items' => ['description' => '列名。', 'type' => 'string', 'example' => 'col1'],
+ ],
+ 'ColTypes' => [
+ 'description' => '输入表各个列的类型。',
+ 'type' => 'array',
+ 'items' => ['description' => '列类型。', 'type' => 'string', 'example' => 'STRING'],
],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"431C53C4-BDD0-588F-8081-4437B00852B5\\"\\n}","type":"json"}]',
- 'title' => '停止工作流草稿作业',
- ],
- 'StopExperiment' => [
- 'summary' => '停止工作流草稿提交的所有运行中的作业，停止是异步操作，接口返回后，需要等待一段时间才能停止成功。',
- 'path' => '/api/v1/experiments/{ExperimentId}/stop',
- 'methods' => [
- 'post',
+ 'title' => '获取节点输入Schema',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeInputSchema'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetNodeInputSchema',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB07647-8A5D-56F1-8B99-361BCF51402F\\",\\n \\"ColNames\\": [\\n \\"col1\\"\\n ],\\n \\"ColTypes\\": [\\n \\"STRING\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetNodeOutput' => [
+ 'summary' => '获取某个节点的输出模型信息。',
+ 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/outputs/{OutputId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '14236',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14234',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-i1udvvwm2rlvxug29n',
- ],
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作流草稿中的节点ID。', 'type' => 'string', 'required' => true, 'example' => 'node-5dzotrnwyzfxmbwwc8'],
+ ],
+ [
+ 'name' => 'OutputId',
+ 'in' => 'path',
+ 'schema' => ['description' => '算法节点输出端口id。', 'type' => 'string', 'required' => true, 'example' => 'outputId'],
+ ],
+ [
+ 'name' => 'OutputIndex',
+ 'in' => 'query',
+ 'schema' => ['description' => '可变长节点的index，从0开始。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
],
'responses' => [
@@ -1816,203 +1834,244 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '601FD8B1-78EB-5220-844C-92AC2EDAF7E1'],
+ 'NodeName' => ['description' => '节点名称。', 'type' => 'string', 'example' => '逻辑回归二分类-1'],
+ 'AlgoName' => ['description' => '算法名称。', 'type' => 'string', 'example' => '逻辑回归二分类'],
+ 'DisplayName' => ['description' => '展示名称。', 'type' => 'string', 'example' => '逻辑回归二分类-2-outputModel'],
+ 'Type' => ['description' => '类型，有Model、DataSet', 'type' => 'string', 'example' => 'Model'],
+ 'Value' => ['description' => 'Output的内容，不同Type的Output对应的key不一样。', 'type' => 'object', 'example' => '{'."\n"
+ .' "name": "model_flow_wayrh3k605s7i51wey_node_7n3tstbuhr36t0ukiz_model",'."\n"
+ .' "modelType": "OfflineModel",'."\n"
+ .' "labelCol": "_c2",'."\n"
+ .' "features": "pm10,so2,co,no2",'."\n"
+ .' "gmtCreateTime": "2021-01-21T17:12:35.232Z",'."\n"
+ .' "gmtModifiedTime": "2021-01-21T17:12:35.232Z",'."\n"
+ .' "parameters": {'."\n"
+ .' "epsilon": "0.000001",'."\n"
+ .' "enableSparse": "false",'."\n"
+ .' "regularizedLevel": "1",'."\n"
+ .' "roleArn": "true",'."\n"
+ .' "maxIter": "100",'."\n"
+ .' "regularizedType": "None",'."\n"
+ .' "generatePmml": "true"'."\n"
+ .' }'."\n"
+ .'}'],
+ 'LocationType' => ['description' => '模型位置：'."\n"
+ .'* MaxComputeTable: MaxCompute表'."\n"
+ .'* OSS: OSS', 'type' => 'string', 'example' => 'MaxComputeTable'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
- 'title' => '停止工作流草稿所有作业',
- ],
- 'CreateExperimentFolder' => [
- 'summary' => '创建工作流草稿文件夹。',
- 'path' => '/api/v1/experimentfolders',
- 'methods' => [
- 'post',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '获取某个节点的输出模型信息',
+ 'changeSet' => [
+ ['createdAt' => '2021-03-01T06:16:56.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeOutput'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftNodeOutput',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"601FD8B1-78EB-5220-844C-92AC2EDAF7E1\\",\\n \\"NodeName\\": \\"逻辑回归二分类-1\\",\\n \\"AlgoName\\": \\"逻辑回归二分类\\",\\n \\"DisplayName\\": \\"逻辑回归二分类-2-outputModel\\",\\n \\"Type\\": \\"Model\\",\\n \\"Value\\": {\\n \\"name\\": \\"model_flow_wayrh3k605s7i51wey_node_7n3tstbuhr36t0ukiz_model\\",\\n \\"modelType\\": \\"OfflineModel\\",\\n \\"labelCol\\": \\"_c2\\",\\n \\"features\\": \\"pm10,so2,co,no2\\",\\n \\"gmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"gmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"parameters\\": {\\n \\"epsilon\\": \\"0.000001\\",\\n \\"enableSparse\\": \\"false\\",\\n \\"regularizedLevel\\": \\"1\\",\\n \\"roleArn\\": \\"true\\",\\n \\"maxIter\\": \\"100\\",\\n \\"regularizedType\\": \\"None\\",\\n \\"generatePmml\\": \\"true\\"\\n }\\n },\\n \\"LocationType\\": \\"MaxComputeTable\\"\\n}","type":"json"}]',
+ ],
+ 'GetTemplate' => [
+ 'summary' => '获取PAI Studio中指定模板',
+ 'path' => '/api/v1/templates/{TemplateId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '13799',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14197',
+ 'abilityTreeNodes' => ['FEATURElearnP4ZCX3', 'FEATURElearnEACGUC'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求Body。',
- 'type' => 'object',
- 'properties' => [
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '45699',
- ],
- 'Name' => [
- 'description' => '工作流草稿名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Pipeline draft name',
- ],
- 'ParentFolderId' => [
- 'description' => '父文件夹ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder-xxfdjhfxdfad',
- ],
- 'Source' => [
- 'description' => '工作流草稿创建来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
- 'Accessibility' => [
- 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PUBLIC',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'TemplateId',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true, 'example' => 'template-12345', 'description' => ''],
+ ],
+ [
+ 'name' => 'Verbose',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
- ],
- 'FolderId' => [
- 'description' => '新建的文件夹的ID。',
- 'type' => 'string',
- 'example' => 'folder-xxfdjhfxduxd',
+ 'RequestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => 'Id of the request'],
+ 'TemplateId' => ['type' => 'string', 'example' => 'template-12345', 'description' => ''],
+ 'Name' => ['type' => 'string', 'description' => ''],
+ 'ImageLink' => ['type' => 'string', 'example' => 'URL://xxx', 'description' => ''],
+ 'DocLink' => ['type' => 'string', 'example' => 'URL://xxx', 'description' => ''],
+ 'Detail' => ['type' => 'string', 'description' => ''],
+ 'Description' => ['type' => 'string', 'description' => ''],
+ 'Content' => ['type' => 'string', 'example' => '{ "metadata": { "name": "实验名称", "id": "pai_exp_xxxdfafafasfa", "desc": "实验描述", }, "nodes": [ ], "edges": [ ], "globalParams": [ ], "globalSettings":[ ] }', 'description' => ''],
+ 'SourceType' => ['type' => 'string', 'description' => ''],
+ 'SourceId' => ['type' => 'string', 'description' => ''],
+ 'TemplateType' => ['type' => 'string', 'description' => ''],
+ 'Labels' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'object', 'description' => ''],
+ 'description' => '',
],
],
+ 'description' => 'Schema of Response',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"FolderId\\": \\"folder-xxfdjhfxduxd\\"\\n}","type":"json"}]',
- 'title' => '创建工作流草稿文件夹',
- ],
- 'UpdateExperimentFolder' => [
- 'summary' => '更新工作量草稿文件夹。',
- 'path' => '/api/v1/experimentfolders/{FolderId}',
- 'methods' => [
- 'put',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'changeSet' => [
+ ['createdAt' => '2022-12-02T05:58:37.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"TemplateId\\": \\"template-12345\\",\\n \\"Name\\": \\"\\",\\n \\"ImageLink\\": \\"URL://xxx\\",\\n \\"DocLink\\": \\"URL://xxx\\",\\n \\"Detail\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Content\\": \\"{ \\\\\\"metadata\\\\\\": { \\\\\\"name\\\\\\": \\\\\\"实验名称\\\\\\", \\\\\\"id\\\\\\": \\\\\\"pai_exp_xxxdfafafasfa\\\\\\", \\\\\\"desc\\\\\\": \\\\\\"实验描述\\\\\\", }, \\\\\\"nodes\\\\\\": [ ], \\\\\\"edges\\\\\\": [ ], \\\\\\"globalParams\\\\\\": [ ], \\\\\\"globalSettings\\\\\\":[ ] }\\",\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"TemplateType\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListAuthRoles' => [
+ 'summary' => '获取授权角色列表。',
+ 'path' => '/api/v1/authorization/roles',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '13802',
- 'abilityTreeNodes' => [
- 'FEATURElearn1QDD9Y',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '21720',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求Body。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '新的工作流草稿文件夹名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder1',
- ],
- 'ParentFolderId' => [
- 'description' => '新的文件夹父节点ID，为空表示不修改父目录。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder-xzf7t785nka4c2334',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
[
- 'name' => 'FolderId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '文件夹的ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-xzf7t785nka4ch7qce',
- ],
+ 'name' => 'IsGenerateToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否生成STS临时Token，已经废弃。', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '相应结果。',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8E2C1BB9-57C4-5051-9EF2-570ADC03A164'],
+ 'Roles' => [
+ 'description' => '角色列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '角色信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleName' => ['description' => '角色名称。', 'type' => 'string', 'example' => 'AliyunODPSPAIDefaultRole'],
+ 'RoleARN' => ['description' => '角色的arn。', 'type' => 'string', 'example' => 'acs:ram::1557********904:role/aliyunodpspaidefaultrole'],
+ 'IsEnabled' => ['description' => '角色是否可用。', 'type' => 'string', 'example' => 'true'],
+ 'Token' => [
+ 'description' => '角色凭证信息，已经废弃。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SecurityToken' => ['description' => 'STS生成security token。', 'type' => 'string', 'example' => 'CAISggJ1q6Ft5B2yf***************aAaDf+bmceH2MNtNe9XtmTXJytadQ2T0RT8uOA+4kSypOPxSHjdjmnQjbdA/Q9MyNtTErQ/m45RNsg=='],
+ 'AccessKeyId' => ['description' => 'STS生成access id。', 'type' => 'string', 'example' => 'STS.NU************TT5LoC'],
+ 'AccessKeySecret' => ['description' => 'STS生成access key。', 'type' => 'string', 'example' => 'E1h2n66Duo1D**********c79JVk59R6i'],
+ 'Expiration' => ['description' => '过期时间。', 'type' => 'string', 'example' => '2021-03-19T19:14:42Z'],
+ ],
+ ],
+ 'RoleType' => ['description' => 'Role的类型。', 'type' => 'string', 'example' => 'PaiStudio'],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]',
- 'title' => '更新工作流草稿文件夹',
- ],
- 'GetExperimentFolderChildren' => [
- 'summary' => '列出某一个工作流草稿文件夹下的子文件夹或工作流草稿。',
- 'path' => '/api/v1/experimentfolders/{FolderId}/children',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E2C1BB9-57C4-5051-9EF2-570ADC03A164\\",\\n \\"Roles\\": [\\n {\\n \\"RoleName\\": \\"AliyunODPSPAIDefaultRole\\",\\n \\"RoleARN\\": \\"acs:ram::1557********904:role/aliyunodpspaidefaultrole\\",\\n \\"IsEnabled\\": \\"true\\",\\n \\"Token\\": {\\n \\"SecurityToken\\": \\"CAISggJ1q6Ft5B2yf***************aAaDf+bmceH2MNtNe9XtmTXJytadQ2T0RT8uOA+4kSypOPxSHjdjmnQjbdA/Q9MyNtTErQ/m45RNsg==\\",\\n \\"AccessKeyId\\": \\"STS.NU************TT5LoC\\",\\n \\"AccessKeySecret\\": \\"E1h2n66Duo1D**********c79JVk59R6i\\",\\n \\"Expiration\\": \\"2021-03-19T19:14:42Z\\"\\n },\\n \\"RoleType\\": \\"PaiStudio\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取授权角色列表',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-06T08:49:28.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAuthRoles'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListAuthRoles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListExperiments' => [
+ 'summary' => '获取PAI Designer的工作流草稿列表。',
+ 'path' => '/api/v1/experiments',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2022,75 +2081,66 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '13806',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14194',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'FolderId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '要列出成员的父文件夹ID，假如是root表示是根目录。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-xzf7t7****ch7qce',
- ],
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '列表的页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'schema' => ['description' => '分页的大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'OnlyFolder',
+ 'name' => 'Order',
'in' => 'query',
'schema' => [
- 'description' => '是否只列出文件夹。',
- 'type' => 'boolean',
+ 'description' => '排列顺序：'."\n"
+ .'- DESC：降序。'."\n"
+ .'- ASC：升序。',
+ 'type' => 'string',
'required' => false,
- 'example' => 'true',
+ 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'],
+ 'example' => 'DESC',
],
],
[
+ 'name' => 'ExperimentId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => false, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流草稿名称。', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft name'],
+ ],
+ [
+ 'name' => 'Creator',
+ 'in' => 'query',
+ 'schema' => ['description' => '创建人的UID。', 'type' => 'string', 'required' => false, 'example' => '13266******376250'],
+ ],
+ [
'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => '创建来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'schema' => ['description' => '工作流草稿创建来源。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
],
[
- 'name' => 'Accessibility',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '工作空间可见性，可能值为：'."\n"
- .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n"
- .'- PUBLIC：在此工作空间中，对所有人可见。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PUBLIC',
- ],
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '34875'],
],
[
- 'name' => 'UserId',
+ 'name' => 'SortBy',
'in' => 'query',
- 'schema' => [
- 'title' => '若FolderId为root，Accessibility为PRIVATE，这里代表私有根路径的所有者，默认为访问者自己',
- 'description' => '若FolderId为root，Accessibility为PRIVATE，这里代表私有根路径的所有者，默认为访问者自己',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345******13324',
- ],
+ 'schema' => ['description' => '排序依据。'."\n"
+ .'* GmtCreate：创建时间。'."\n"
+ .'* GmtModified：更新时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreate'],
],
],
'responses' => [
@@ -2100,323 +2150,508 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'TotalCount' => [
- 'description' => '总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'Items' => [
- 'description' => '成员列表。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9708FB85-232F-5F9A-9D67-7F9CCCE20E06'],
+ 'Experiments' => [
+ 'description' => '工作流草稿列表。',
'type' => 'array',
'items' => [
- 'description' => '成员详情。',
+ 'description' => '工作流草稿详情。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '工作流草稿或工作流草稿文件夹的ID。',
- 'type' => 'string',
- 'example' => 'folder-xzf7t7****ch7qce',
- ],
- 'Name' => [
- 'description' => '工作流草稿或工作流草稿文件夹的名称。',
- 'type' => 'string',
- 'example' => 'Pipeline draft name',
- ],
- 'Type' => [
- 'description' => '目前有两种类型：'."\n"
- .'* pipelinedraft：工作流草稿'."\n"
- .'* dir：工作流草稿文件夹',
- 'type' => 'string',
- 'example' => 'dir',
- ],
- 'Icon' => [
- 'description' => '工作流草稿或工作流草稿文件夹使用的图标，目前有icon-folder，icon-pipelinedraft。',
- 'type' => 'string',
- 'example' => 'icon-folder',
- ],
- 'Empty' => [
- 'description' => '是否为空。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'GmtCreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间，UTC 时间，日期格式 iso8601。',
- 'type' => 'string',
- 'format' => 'iso8601',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间，UTC 时间，日期格式 iso8601。',
+ 'ExperimentId' => ['description' => '工作流草稿ID。', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ 'Name' => ['description' => '工作流草稿名称。', 'type' => 'string', 'example' => 'Pipeline draft name'],
+ 'Description' => ['description' => '工作流草稿描述。', 'type' => 'string', 'example' => 'Pipeline draft description'],
+ 'GmtCreateTime' => ['description' => '工作流草稿创建 UTC 时间，日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'GmtModifiedTime' => ['description' => '工作流草稿修改 UTC 时间，日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'Creator' => ['description' => '工作流草稿创建者的UID。', 'type' => 'string', 'example' => '1326*******76250'],
+ 'Source' => ['description' => '工作流草稿创建来源。', 'type' => 'string', 'example' => 'PaiStudio'],
+ 'Version' => ['description' => '工作流草稿当前版本。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '23487'],
+ 'Accessibility' => [
+ 'description' => '工作流草稿的可见性，取值如下：'."\n"
+ .'- PUBLIC：在此工作空间中，对所有人可见。'."\n"
+ .'- PRIVATE：在此工作空间中，仅对您和管理员可见。',
'type' => 'string',
- 'format' => 'iso8601',
- 'example' => '2021-01-30T12:51:33.028Z',
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
+ 'example' => 'PUBLIC',
],
],
],
],
+ 'TotalCount' => ['description' => '工作流草稿总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": 23,\\n \\"Items\\": [\\n {\\n \\"Id\\": \\"folder-xzf7t7****ch7qce\\",\\n \\"Name\\": \\"Pipeline draft name\\",\\n \\"Type\\": \\"dir\\",\\n \\"Icon\\": \\"icon-folder\\",\\n \\"Empty\\": false,\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取工作流草稿文件夹下成员',
- ],
- 'DeleteExperimentFolder' => [
- 'summary' => '删除工作流草稿文件夹。',
- 'path' => '/api/v1/experimentfolders/{FolderId}',
- 'methods' => [
- 'delete',
+ 'title' => '获取工作流草稿列表',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExperiments'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListPipelineDrafts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9708FB85-232F-5F9A-9D67-7F9CCCE20E06\\",\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\",\\n \\"Name\\": \\"Pipeline draft name\\",\\n \\"Description\\": \\"Pipeline draft description\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Creator\\": \\"1326*******76250\\",\\n \\"Source\\": \\"PaiStudio\\",\\n \\"Version\\": 12,\\n \\"WorkspaceId\\": \\"23487\\",\\n \\"Accessibility\\": \\"PUBLIC\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]',
+ ],
+ 'ListImageLabels' => [
+ 'summary' => '列举标签',
+ 'path' => '/api/v1/image/labels',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '13803',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '20007',
+ 'abilityTreeNodes' => ['FEATURElearnAFIS9K'],
],
'parameters' => [
[
- 'name' => 'FolderId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '文件夹ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder-xzf7t785nka4ch7qce',
- ],
+ 'name' => 'LabelKeys',
+ 'in' => 'query',
+ 'schema' => ['title' => '标签列表，以逗号分隔', 'type' => 'string', 'example' => 'ImageType,Framework,Platform', 'description' => '标签列表，以逗号分隔'],
+ ],
+ [
+ 'name' => 'LabelFilter',
+ 'in' => 'query',
+ 'schema' => ['title' => 'image过滤条件，获取满足条件的image的所有label', 'type' => 'string', 'example' => 'a=b,c=d', 'description' => 'image过滤条件，获取满足条件的image的所有label'],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => ['title' => '镜像id', 'type' => 'string', 'description' => '镜像id'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6',
+ 'requestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => 'Id of the request'],
+ 'Labels' => [
+ 'title' => '镜像标签',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '键', 'type' => 'string', 'description' => '键'],
+ 'Value' => ['title' => '值', 'type' => 'string', 'description' => '值'],
+ ],
+ 'description' => '',
+ ],
+ 'description' => '镜像标签',
],
+ 'TotalCount' => ['title' => '符合过滤条件的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'description' => '符合过滤条件的数量'],
],
+ 'description' => 'Schema of Response',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\"\\n}","type":"json"}]',
- 'title' => '删除工作流草稿文件夹',
- ],
- 'GetAlgorithmTree' => [
- 'summary' => '获取算法树。',
- 'path' => '/api/v1/algorithm/tree',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-08T08:41:16.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageLabels'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListImageLabels',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]',
+ ],
+ 'ListImages' => [
+ 'path' => '/api/v1/images',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '19289',
- 'abilityTreeNodes' => [
- 'FEATURElearnZAMNTS',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '20013',
+ 'abilityTreeNodes' => ['FEATURElearnAFIS9K'],
],
'parameters' => [
[
- 'name' => 'Source',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '获取指定源的算法列表，默认为PaiStudio。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'schema' => ['title' => '镜像名称，支持模糊搜索', 'type' => 'string', 'description' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间ID。指定工作空间ID后，将根据当前工作空间是否开通GPU资源对算法树结果进行过滤。',
- 'description' => '工作空间ID。指定工作空间ID后，将根据当前工作空间是否开通GPU资源对算法树结果进行过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'schema' => ['title' => '分页，从1开始，默认1', 'type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '页大小，默认20', 'type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'type' => 'string', 'example' => 'GmtCreateTime', 'description' => ''],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向： ASC - 升序 DESC - 降序', 'type' => 'string', 'description' => ''],
+ ],
+ [
+ 'name' => 'Labels',
+ 'in' => 'query',
+ 'schema' => ['title' => '过滤值 以逗号分隔', 'type' => 'string', 'example' => 'Framework="Tensorflow 1.0",Framework="Tensorflow 2.0",Platform="GPU"', 'description' => ''],
+ ],
+ [
+ 'name' => 'Verbose',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否显示非必要信息：Labels', 'type' => 'boolean', 'example' => 'true', 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '46B59732-033F-5C96-9B15-1E05E7705548',
- ],
- 'Tree' => [
- 'description' => '算法树。',
+ 'requestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => ''],
+ 'TotalCount' => ['title' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'description' => ''],
+ 'Images' => [
+ 'title' => '镜像列表',
'type' => 'array',
'items' => [
- 'description' => '算法定义。',
'type' => 'object',
- 'example' => '{'."\n"
- .' "name": "Tensorflow",'."\n"
- .' "nodeType": "algo",'."\n"
- .' "icon": "yyyy",'."\n"
- .' "metadata": {'."\n"
- .' "provider": "pai",'."\n"
- .' "identifier": "evaluate-tensorflow",'."\n"
- .' "version": "v2",'."\n"
- .' "signature": "49c9904dc177eb4d58f68915f35315b6fc6ee2db"'."\n"
- .' },'."\n"
- .' "doc": "http://www.aliyun.com/doc?id=11"'."\n"
- .'}',
+ 'properties' => [
+ 'Name' => ['title' => '镜像名称', 'type' => 'string', 'description' => ''],
+ 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z', 'description' => ''],
+ 'Description' => ['title' => '镜像描述', 'type' => 'string', 'description' => ''],
+ 'ImageUri' => ['title' => '镜像地址，包含版本号', 'type' => 'string', 'description' => ''],
+ 'Labels' => [
+ 'title' => '镜像标签，是个map',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => 'Key', 'type' => 'string', 'description' => ''],
+ 'Value' => ['title' => 'Value', 'type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ 'description' => '',
+ ],
+ 'ImageId' => ['title' => '镜像id', 'type' => 'string', 'example' => 'image-tzi7f9czc0cxs9s45t', 'description' => ''],
+ ],
+ 'description' => '',
],
- ],
- 'Timestamp' => [
- 'description' => '算法树最后更新的时间戳。',
- 'type' => 'string',
- 'example' => '20210317101023',
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46B59732-033F-5C96-9B15-1E05E7705548\\",\\n \\"Tree\\": [\\n {\\n \\"name\\": \\"Tensorflow\\",\\n \\"nodeType\\": \\"algo\\",\\n \\"icon\\": \\"yyyy\\",\\n \\"metadata\\": {\\n \\"provider\\": \\"pai\\",\\n \\"identifier\\": \\"evaluate-tensorflow\\",\\n \\"version\\": \\"v2\\",\\n \\"signature\\": \\"49c9904dc177eb4d58f68915f35315b6fc6ee2db\\"\\n },\\n \\"doc\\": \\"http://www.aliyun.com/doc?id=11\\"\\n }\\n ],\\n \\"Timestamp\\": \\"20210317101023\\"\\n}","type":"json"}]',
- 'title' => '获取算法树',
- ],
- 'GetAlgorithmDef' => [
- 'summary' => '获取算法定义',
- 'path' => '/api/v1/algorithm/def',
- 'methods' => [
- 'get',
+ 'summary' => '列举已注册镜像',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T04:59:02.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"TotalCount\\": 2,\\n \\"Images\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Description\\": \\"\\",\\n \\"ImageUri\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImageId\\": \\"image-tzi7f9czc0cxs9s45t\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListJobs' => [
+ 'summary' => '获取工作流草稿作业列表。',
+ 'path' => '/api/v1/jobs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '19291',
- 'abilityTreeNodes' => [
- 'FEATURElearnZAMNTS',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14206',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'Provider',
+ 'name' => 'ExperimentId',
'in' => 'query',
- 'schema' => [
- 'description' => '算法的提供者，官方算法为pai。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pai',
- ],
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-8up80bg0k1q23stml6'],
],
[
- 'name' => 'Identifier',
+ 'name' => 'Creator',
'in' => 'query',
- 'schema' => [
- 'description' => '算法的identifier。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'logisticregression_binary',
- ],
+ 'schema' => ['description' => '创建人的UID。', 'type' => 'string', 'required' => false, 'example' => '13266*******76250'],
],
[
- 'name' => 'AlgoVersion',
+ 'name' => 'Order',
'in' => 'query',
'schema' => [
- 'description' => '算法的版本。',
+ 'description' => '默认按创建时间排序，排列顺序：'."\n"
+ .'- DESC：降序。'."\n"
+ .'- ASC：升序。',
'type' => 'string',
- 'required' => true,
- 'example' => 'v1',
+ 'required' => false,
+ 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'],
+ 'example' => 'DESC',
],
],
[
- 'name' => 'Signature',
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页码。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的大小，默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '算法的signature，假如为空会取最近的版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '49c9904dc177eb4d58f68915f35315b6fc6ee2db',
+ 'title' => 'Schema of Response',
+ 'description' => '响应结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Jobs' => [
+ 'description' => '作业列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '作业详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExperimentId' => ['description' => '工作流草稿ID。', 'type' => 'string', 'example' => 'draft-4x4iv3a9enuxw4vgka'],
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '94436'],
+ 'JobId' => ['description' => '任务 ID。', 'type' => 'string', 'example' => 'job-mewqhd72nsrqujn1px'],
+ 'ExecuteType' => ['description' => '执行的类型:'."\n"
+ .'- EXECUTE_ALL(运行工作流草稿中所有节点)'."\n"
+ .'- EXECUTE_ONE(执行指定节点)'."\n"
+ .'- EXECUTE_TO_HERE(从根节点执行到该节点)'."\n"
+ .'- EXECUTE_FROM_HERE(从指定的节点开始运行)'."\n"
+ .'- EXECUTE_CHILDREN(执行指定节点的下游节点)', 'type' => 'string', 'example' => 'EXECUTE_ALL'],
+ 'NodeId' => ['description' => '工作流草稿中的节点ID。', 'type' => 'string', 'example' => 'nodeId1'],
+ 'RunId' => ['description' => '对应的PaiFlow的Pipeline Run ID。', 'type' => 'string', 'example' => 'flow-aayfouai80i980ncvz'],
+ 'PaiflowNodeId' => ['description' => 'PaiFlow中的Pipeline Run节点ID。', 'type' => 'string', 'example' => 'node-xdfasf8ewxfdaddl'],
+ 'Creator' => ['description' => '创建人的UID。', 'type' => 'string', 'example' => '17677*******89598'],
+ 'Status' => ['description' => '作业的状态，目前状态有：'."\n"
+ .'* Initialized: 初始化完成'."\n"
+ .'* Starting：开始'."\n"
+ .'* WorkflowServiceStarting：准备提交'."\n"
+ .'* Running：运行中'."\n"
+ .'* Succeeded：运行成功'."\n"
+ .'* Failed：运行失败'."\n"
+ .'* Terminating：终止中'."\n"
+ .'* Terminated：已终止'."\n"
+ .'* Unknown：未知'."\n"
+ .'* Skipped：跳过（前序节点失败导致）'."\n"
+ .'* ReadyToSchedule：准备运行（前序节点未完成导致）', 'type' => 'string', 'example' => 'Running'],
+ 'GmtCreateTime' => ['description' => '创建时间，UTC 时间，日期格式 iso8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '获取工作流草稿作业列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListJobs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Jobs\\": [\\n {\\n \\"ExperimentId\\": \\"draft-4x4iv3a9enuxw4vgka\\",\\n \\"WorkspaceId\\": \\"94436\\",\\n \\"JobId\\": \\"job-mewqhd72nsrqujn1px\\",\\n \\"ExecuteType\\": \\"EXECUTE_ALL\\",\\n \\"NodeId\\": \\"nodeId1\\",\\n \\"RunId\\": \\"flow-aayfouai80i980ncvz\\",\\n \\"PaiflowNodeId\\": \\"node-xdfasf8ewxfdaddl\\",\\n \\"Creator\\": \\"17677*******89598\\",\\n \\"Status\\": \\"Running\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListNodeOutputs' => [
+ 'summary' => '获取工作流草稿节点的输出模型。',
+ 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/outputs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14233',
+ 'abilityTreeNodes' => ['FEATURElearnZNL1NN'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作流草稿中的节点ID。', 'type' => 'string', 'required' => true, 'example' => 'node-5dzotrnwyzfxmbwwc8'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回结果。',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'B4F16666-FD54-5D9D-A362-53A4C66692DF',
- ],
- 'Spec' => [
- 'description' => '算法定义的Spec。',
- 'type' => 'object',
- 'example' => '{}',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Outputs' => [
+ 'description' => '节点的模型列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '模型信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DisplayName' => ['description' => '模型名称，格式是{NodeName}-{outputId}。', 'type' => 'string', 'example' => '逻辑回归二分类-2-outputModel'],
+ 'Type' => ['description' => '类型，有Model、DataSet。', 'type' => 'string', 'example' => 'Model'],
+ 'OutputId' => ['description' => '算法节点输出端口id。', 'type' => 'string', 'example' => 'outputModel'],
+ 'OutputIndex' => ['description' => '可变长节点的index，从0开始。', 'type' => 'string', 'example' => '0'],
+ 'Value' => ['description' => 'Output的内容，不同Type的Output对应的key不一样。', 'type' => 'object', 'example' => '{'."\n"
+ .' "name": "model_flow_wayrh3k605s7i51wey_node_7n3tstbuhr36t0ukiz_model",'."\n"
+ .' "modelType": "OfflineModel",'."\n"
+ .' "labelCol": "_c2",'."\n"
+ .' "features": "pm10,so2,co,no2",'."\n"
+ .' "gmtCreateTime": "2021-01-21T17:12:35.232Z",'."\n"
+ .' "gmtModifiedTime": "2021-01-21T17:12:35.232Z",'."\n"
+ .' "parameters": {'."\n"
+ .' "epsilon": "0.000001",'."\n"
+ .' "enableSparse": "false",'."\n"
+ .' "regularizedLevel": "1",'."\n"
+ .' "roleArn": "true",'."\n"
+ .' "maxIter": "100",'."\n"
+ .' "regularizedType": "None",'."\n"
+ .' "generatePmml": "true"'."\n"
+ .' }'."\n"
+ .'}'],
+ 'NodeName' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'node1'],
+ 'AlgoName' => ['description' => '算法名称。', 'type' => 'string', 'example' => '逻辑回归二分类'],
+ 'LocationType' => ['description' => '模型位置：'."\n"
+ .'* MaxComputeTable: MaxCompute表'."\n"
+ .'* OSS: OSS', 'type' => 'string', 'example' => 'MaxComputeTable'],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4F16666-FD54-5D9D-A362-53A4C66692DF\\",\\n \\"Spec\\": {}\\n}","type":"json"}]',
- 'title' => '获取算法定义',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '获取节点的输出模型',
+ 'changeSet' => [
+ ['createdAt' => '2021-03-01T06:17:03.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeOutputs'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListPipelineDraftNodeOutputs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Outputs\\": [\\n {\\n \\"DisplayName\\": \\"逻辑回归二分类-2-outputModel\\",\\n \\"Type\\": \\"Model\\",\\n \\"OutputId\\": \\"outputModel\\",\\n \\"OutputIndex\\": \\"0\\",\\n \\"Value\\": {\\n \\"name\\": \\"model_flow_wayrh3k605s7i51wey_node_7n3tstbuhr36t0ukiz_model\\",\\n \\"modelType\\": \\"OfflineModel\\",\\n \\"labelCol\\": \\"_c2\\",\\n \\"features\\": \\"pm10,so2,co,no2\\",\\n \\"gmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"gmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"parameters\\": {\\n \\"epsilon\\": \\"0.000001\\",\\n \\"enableSparse\\": \\"false\\",\\n \\"regularizedLevel\\": \\"1\\",\\n \\"roleArn\\": \\"true\\",\\n \\"maxIter\\": \\"100\\",\\n \\"regularizedType\\": \\"None\\",\\n \\"generatePmml\\": \\"true\\"\\n }\\n },\\n \\"NodeName\\": \\"node1\\",\\n \\"AlgoName\\": \\"逻辑回归二分类\\",\\n \\"LocationType\\": \\"MaxComputeTable\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListRecentExperiments' => [
- 'summary' => '获取当前用户最近更新或创建的工作流草稿。',
'path' => '/api/v1/recentexperiments',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2426,33 +2661,23 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '61667',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'Order',
'in' => 'query',
- 'schema' => [
- 'description' => '按修改时间排序，默认DESC：'."\n"
- .'- DESC：降序。'."\n"
- .'- ASC：升序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DESC',
- ],
+ 'schema' => ['description' => '按修改时间排序，默认DESC：'."\n"
+ .'- DESC：降序。'."\n"
+ .'- ASC：升序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿创建来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'schema' => ['description' => '工作流草稿创建来源。', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio'],
],
[
'name' => 'Type',
@@ -2463,44 +2688,24 @@
.' - Created：最近创建过的工作流草稿列表',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Modified' => 'Modified',
- 'Created' => 'Created',
- ],
+ 'enumValueTitles' => ['Modified' => 'Modified', 'Created' => 'Created'],
'example' => 'Modified',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '86995',
- ],
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '86995'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时的页码，默认值为1。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '分页查询时的页码，默认值为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的大小，默认为10。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '分页查询时每页的大小，默认为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
],
'responses' => [
@@ -2510,12 +2715,7 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'Experiments' => [
'description' => '工作流草稿列表。',
'type' => 'array',
@@ -2523,56 +2723,18 @@
'description' => '工作流草稿详情。',
'type' => 'object',
'properties' => [
- 'ExperimentId' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-76p70ye0gwv3vbur55',
- ],
- 'Name' => [
- 'description' => '工作流草稿名称。',
- 'type' => 'string',
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'description' => '工作流草稿描述。',
- 'type' => 'string',
- 'example' => 'Pipeline draft description',
- ],
- 'RecentGmtModifiedTime' => [
- 'description' => '该用户最近对工作流草稿的修改 UTC 时间，日期格式ISO8601。',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'Source' => [
- 'description' => '工作流草稿创建来源。',
- 'type' => 'string',
- 'example' => 'PaiStudio',
- ],
- 'ModifyCnt' => [
- 'description' => '该用户对该实验的修改次数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'example' => '15821',
- ],
- 'WorkspaceName' => [
- 'description' => '工作空间名称。',
- 'type' => 'string',
- 'example' => 'Workspace name',
- ],
+ 'ExperimentId' => ['description' => '工作流草稿ID。', 'type' => 'string', 'example' => 'draft-76p70ye0gwv3vbur55'],
+ 'Name' => ['description' => '工作流草稿名称。', 'type' => 'string', 'example' => 'Pipeline draft name'],
+ 'Description' => ['description' => '工作流草稿描述。', 'type' => 'string', 'example' => 'Pipeline draft description'],
+ 'RecentGmtModifiedTime' => ['description' => '该用户最近对工作流草稿的修改 UTC 时间，日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'Source' => ['description' => '工作流草稿创建来源。', 'type' => 'string', 'example' => 'PaiStudio'],
+ 'ModifyCnt' => ['description' => '该用户对该实验的修改次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '15821'],
+ 'WorkspaceName' => ['description' => '工作空间名称。', 'type' => 'string', 'example' => 'Workspace name'],
],
],
],
- 'TotalCount' => [
- 'description' => '工作流草稿总数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '23',
- ],
+ 'TotalCount' => ['description' => '工作流草稿总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'],
],
],
],
@@ -2581,133 +2743,101 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"draft-76p70ye0gwv3vbur55\\",\\n \\"Name\\": \\"Pipeline draft name\\",\\n \\"Description\\": \\"Pipeline draft description\\",\\n \\"RecentGmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Source\\": \\"PaiStudio\\",\\n \\"ModifyCnt\\": 10,\\n \\"WorkspaceId\\": \\"15821\\",\\n \\"WorkspaceName\\": \\"Workspace name\\"\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]',
'title' => '获取最近的工作流草稿',
+ 'summary' => '获取当前用户最近更新或创建的工作流草稿。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentExperiments'],
+ ],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"draft-76p70ye0gwv3vbur55\\",\\n \\"Name\\": \\"Pipeline draft name\\",\\n \\"Description\\": \\"Pipeline draft description\\",\\n \\"RecentGmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Source\\": \\"PaiStudio\\",\\n \\"ModifyCnt\\": 10,\\n \\"WorkspaceId\\": \\"15821\\",\\n \\"WorkspaceName\\": \\"Workspace name\\"\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]',
],
'ListTemplates' => [
'summary' => '获取PAI Studio中指定模板列表',
'path' => '/api/v1/templates',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '14198',
- 'abilityTreeNodes' => [
- 'FEATURElearnEACGUC',
- ],
+ 'abilityTreeNodes' => ['FEATURElearnEACGUC'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '20', 'description' => ''],
],
[
'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'example' => 'PaiStudio', 'description' => ''],
],
[
'name' => 'List',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'example' => 'types',
- ],
+ 'schema' => ['type' => 'string', 'example' => 'types', 'description' => ''],
],
[
'name' => 'TagId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'example' => 'template-tag-12345',
- ],
+ 'schema' => ['type' => 'string', 'example' => 'template-tag-12345', 'description' => ''],
],
[
'name' => 'Order',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'example' => 'DESC',
- ],
+ 'schema' => ['type' => 'string', 'example' => 'DESC', 'description' => ''],
],
[
'name' => 'TypeId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'example' => 'template-type-12345',
- ],
+ 'schema' => ['type' => 'string', 'example' => 'template-type-12345', 'description' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => ''],
],
[
'name' => 'TemplateType',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => ''],
],
[
'name' => 'Label',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => ''],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => ''],
],
[
'name' => 'Verbose',
'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- ],
+ 'schema' => ['type' => 'boolean', 'description' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => ''],
],
],
'responses' => [
@@ -2716,15 +2846,8 @@
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => 'Id of the request'],
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '15', 'description' => ''],
'TemplateData' => [
'type' => 'array',
'items' => [
@@ -2733,84 +2856,48 @@
'Template' => [
'type' => 'object',
'properties' => [
- 'TemplateId' => [
- 'type' => 'string',
- 'example' => 'template-rbvg5wzljzjhc9ks92',
- ],
- 'Content' => [
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Description' => [
- 'type' => 'string',
- ],
- 'Detail' => [
- 'type' => 'string',
- ],
- 'DocLink' => [
- 'type' => 'string',
- 'example' => 'url://xxx',
- ],
- 'ImageLink' => [
- 'type' => 'string',
- 'example' => 'url://xxx',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'GmtCreateTime' => [
- 'type' => 'string',
- 'format' => 'iso8601',
- ],
- 'GmtModifiedTime' => [
- 'type' => 'string',
- 'format' => 'iso8601',
- ],
- 'Creator' => [
- 'type' => 'string',
- ],
+ 'TemplateId' => ['type' => 'string', 'example' => 'template-rbvg5wzljzjhc9ks92', 'description' => ''],
+ 'Content' => ['type' => 'string', 'example' => '{}', 'description' => ''],
+ 'Description' => ['type' => 'string', 'description' => ''],
+ 'Detail' => ['type' => 'string', 'description' => ''],
+ 'DocLink' => ['type' => 'string', 'example' => 'url://xxx', 'description' => ''],
+ 'ImageLink' => ['type' => 'string', 'example' => 'url://xxx', 'description' => ''],
+ 'Name' => ['type' => 'string', 'description' => ''],
+ 'GmtCreateTime' => ['type' => 'string', 'format' => 'iso8601', 'description' => ''],
+ 'GmtModifiedTime' => ['type' => 'string', 'format' => 'iso8601', 'description' => ''],
+ 'Creator' => ['type' => 'string', 'description' => ''],
'Labels' => [
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- ],
+ 'items' => ['type' => 'object', 'description' => ''],
+ 'description' => '',
],
],
+ 'description' => '',
],
'TemplateTag' => [
'type' => 'object',
'properties' => [
- 'Name' => [
- 'type' => 'string',
- 'example' => 'PyTorch',
- ],
- 'TagId' => [
- 'type' => 'string',
- 'example' => 'template-tag-rbvg5wzljzjhc9ks92',
- ],
- 'TypeId' => [
- 'type' => 'string',
- 'example' => 'template-tag-type-rbvg5wzljzjhc9ks92',
- ],
+ 'Name' => ['type' => 'string', 'example' => 'PyTorch', 'description' => ''],
+ 'TagId' => ['type' => 'string', 'example' => 'template-tag-rbvg5wzljzjhc9ks92', 'description' => ''],
+ 'TypeId' => ['type' => 'string', 'example' => 'template-tag-type-rbvg5wzljzjhc9ks92', 'description' => ''],
],
+ 'description' => '',
],
'TemplateType' => [
'type' => 'object',
'properties' => [
- 'TypeId' => [
- 'type' => 'string',
- 'example' => 'templatetagtype-rbvg5wzljzjhc9ks92',
- ],
- 'Name' => [
- 'type' => 'string',
- 'example' => '行业分类',
- ],
+ 'TypeId' => ['type' => 'string', 'example' => 'templatetagtype-rbvg5wzljzjhc9ks92', 'description' => ''],
+ 'Name' => ['type' => 'string', 'example' => '行业分类', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
+ 'description' => '',
],
],
+ 'description' => 'Schema of Response',
],
],
],
@@ -2818,154 +2905,153 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '',
- ],
- 'GetTemplate' => [
- 'summary' => '获取PAI Studio中指定模板',
- 'path' => '/api/v1/templates/{TemplateId}',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-02T05:58:37.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'],
+ ],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"TotalCount\\": 15,\\n \\"TemplateData\\": [\\n {\\n \\"Template\\": {\\n \\"TemplateId\\": \\"template-rbvg5wzljzjhc9ks92\\",\\n \\"Content\\": \\"{}\\",\\n \\"Description\\": \\"\\",\\n \\"Detail\\": \\"\\",\\n \\"DocLink\\": \\"url://xxx\\",\\n \\"ImageLink\\": \\"url://xxx\\",\\n \\"Name\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Creator\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"TemplateTag\\": {\\n \\"Name\\": \\"PyTorch\\",\\n \\"TagId\\": \\"template-tag-rbvg5wzljzjhc9ks92\\",\\n \\"TypeId\\": \\"template-tag-type-rbvg5wzljzjhc9ks92\\"\\n },\\n \\"TemplateType\\": {\\n \\"TypeId\\": \\"templatetagtype-rbvg5wzljzjhc9ks92\\",\\n \\"Name\\": \\"行业分类\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'MigrateExperimentFolders' => [
+ 'path' => '/api/v1/migrate/folders',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '14197',
- 'abilityTreeNodes' => [
- 'FEATURElearnP4ZCX3',
- 'FEATURElearnEACGUC',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '93906',
+ 'abilityTreeNodes' => ['FEATURElearn01UVDS'],
],
'parameters' => [
[
- 'name' => 'TemplateId',
- 'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'example' => 'template-12345',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
],
[
- 'name' => 'Verbose',
+ 'name' => 'IsOwner',
'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => '是否只迁移自己的。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'Accessibility',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流草稿的可见性，取值如下：'."\n"
+ .'- PUBLIC：在此工作空间中，对所有人可见。'."\n"
+ .'- PRIVATE：在此工作空间中，仅对您和管理员可见。', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'TemplateId' => [
- 'type' => 'string',
- 'example' => 'template-12345',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'ImageLink' => [
- 'type' => 'string',
- 'example' => 'URL://xxx',
- ],
- 'DocLink' => [
- 'type' => 'string',
- 'example' => 'URL://xxx',
- ],
- 'Detail' => [
- 'type' => 'string',
- ],
- 'Description' => [
- 'type' => 'string',
- ],
- 'Content' => [
- 'type' => 'string',
- 'example' => '{ "metadata": { "name": "实验名称", "id": "pai_exp_xxxdfafafasfa", "desc": "实验描述", }, "nodes": [ ], "edges": [ ], "globalParams": [ ], "globalSettings":[ ] }',
- ],
- 'SourceType' => [
- 'type' => 'string',
- ],
- 'SourceId' => [
- 'type' => 'string',
- ],
- 'TemplateType' => [
- 'type' => 'string',
- ],
- 'Labels' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9CFA2665-1FFE-5929-8468-C14C25890486'],
+ 'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NO_PERMISSION'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'FolderIdMapping' => [
+ 'description' => '迁移结果，返回值是一个Map，key是userId。',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'object', 'description' => 'Studio 1.0实验ID到工作流草稿ID的映射关系，key是实验ID，value是工作流草稿ID。', 'example' => '{'."\n"
+ .' "user1": {'."\n"
+ .' 123 :"draft-xxxx"'."\n"
+ .' }'."\n"
+ .'}'],
],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => '从Studio 1.0迁移工作流草稿目录',
+ 'summary' => '迁移PAI Studio 1.0的实验目录',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-15T06:49:21.000Z', 'description' => 'OpenAPI 下线'],
],
- 'responseDemo' => '',
- ],
- 'GetExperimentsStatistics' => [
- 'summary' => '获取实验统计信息',
- 'path' => '/api/v1/statistics/experiments',
- 'methods' => [
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateExperimentFolders'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:MigrateExperimentFolders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CFA2665-1FFE-5929-8468-C14C25890486\\",\\n \\"Code\\": \\"NO_PERMISSION\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"FolderIdMapping\\": {\\n \\"key\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'MigrateExperiments' => [
+ 'summary' => '从Studio 1.0迁移工作流草稿到Designer',
+ 'path' => '/api/v1/migrate/experiments',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '61666',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '93908',
+ 'abilityTreeNodes' => ['FEATURElearn01UVDS'],
],
'parameters' => [
[
- 'name' => 'WorkspaceIds',
+ 'name' => 'SourceExpId',
'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID列表，多个ID间使用半角逗号（,）分隔。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123,345',
- ],
+ 'schema' => ['description' => 'Studio1.0中的实验ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
- 'name' => 'Source',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿创建来源。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ ],
+ [
+ 'name' => 'DestFolderId',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标文件夹ID。', 'type' => 'string', 'required' => true, 'example' => 'folder-12321313'],
+ ],
+ [
+ 'name' => 'Accessibility',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作空间可见性，可能值为：'."\n"
+ .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n"
+ .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE'],
+ ],
+ [
+ 'name' => 'UpdateIfExists',
+ 'in' => 'query',
+ 'schema' => ['description' => '假如已经存在是否更新。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'IsOwner',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否只迁移自己的。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -2975,146 +3061,51 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
+ 'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'NO_PERMISSION'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'NotExistError'],
'Data' => [
'description' => '返回结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '工作空间统计信息。',
- 'type' => 'object',
- 'properties' => [
- 'WorkspaceId' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'example' => '16381',
- ],
- 'TotalCount' => [
- 'description' => '该工作空间下所有的工作量草稿数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'CreateCount' => [
- 'description' => '当前用户在该工作空间下创建的工作流草稿数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- ],
+ 'type' => 'object',
+ 'properties' => [
+ 'ExperimentId' => ['description' => '工作流草稿ID。', 'type' => 'string', 'example' => 'draft-8u3ck2or5pw2i4auhf'],
+ 'AlreadyExists' => ['description' => '是否已经存在。', 'type' => 'boolean', 'example' => 'true'],
+ 'Updated' => ['description' => '是否更新了。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Data\\": [\\n {\\n \\"WorkspaceId\\": \\"16381\\",\\n \\"TotalCount\\": 20,\\n \\"CreateCount\\": 10\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '统计工作空间中工作流草稿的数量',
- 'description' => '统计工作空间中工作流草稿的数量。',
- ],
- 'GetExperimentsUsersStatistics' => [
- 'summary' => '获取实验或文件夹所有者列表',
- 'path' => '/api/v1/statistics/experimentsusers',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'title' => '从Studio 1.0迁移工作流草稿到Designer',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-15T06:49:21.000Z', 'description' => 'OpenAPI 下线'],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '92531',
- 'abilityTreeNodes' => [
- 'FEATURElearn1QDD9Y',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateExperiments'],
],
],
- 'parameters' => [
- [
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿创建来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
- ],
- 'Users' => [
- 'description' => '用户列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '用户信息。',
- 'type' => 'object',
- 'properties' => [
- 'UserId' => [
- 'description' => '用户的UID。',
- 'type' => 'string',
- 'example' => '12345******67890',
- ],
- ],
- ],
- ],
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:MigrateExperiments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"12345******67890\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '统计创建了工作流草稿的用户',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"Code\\": \\"NO_PERMISSION\\",\\n \\"Message\\": \\"NotExistError\\",\\n \\"Data\\": {\\n \\"ExperimentId\\": \\"draft-8u3ck2or5pw2i4auhf\\",\\n \\"AlreadyExists\\": true,\\n \\"Updated\\": true\\n }\\n}","type":"json"}]',
],
'PreviewMCTable' => [
'summary' => '预览MaxCompute表数据。',
'path' => '/api/v1/datasources/maxcompute/tables/{TableName}/preview',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3127,64 +3118,36 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '14096',
- 'abilityTreeNodes' => [
- 'FEATURElearnUEX4WU',
- ],
+ 'abilityTreeNodes' => ['FEATURElearnUEX4WU'],
],
'parameters' => [
[
'name' => 'TableName',
'in' => 'path',
- 'schema' => [
- 'description' => 'MaxCompute表名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dwd_hb_user_fdsaf_hi',
- ],
+ 'schema' => ['description' => 'MaxCompute表名。', 'type' => 'string', 'required' => true, 'example' => 'dwd_hb_user_fdsaf_hi'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Partition',
'in' => 'query',
- 'schema' => [
- 'description' => 'MaxCompute表分区，可以为空。'."\n"
- .'* 单分区：p1=123'."\n"
- .'* 多级分区：p1=123/p2=456'."\n"
- .'* 多个分区：p1=123,p1=456',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pt=20240805',
- ],
+ 'schema' => ['description' => 'MaxCompute表分区，可以为空。'."\n"
+ .'* 单分区：p1=123'."\n"
+ .'* 多级分区：p1=123/p2=456'."\n"
+ .'* 多个分区：p1=123,p1=456', 'type' => 'string', 'required' => false, 'example' => 'pt=20240805'],
],
[
'name' => 'Endpoint',
'in' => 'query',
- 'schema' => [
- 'description' => 'MaxCompute的Endpoint。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'http://service.cn-hangzhou-vpc.maxcompute.aliyun-inc.com/api',
- ],
+ 'schema' => ['description' => 'MaxCompute的Endpoint。', 'type' => 'string', 'required' => true, 'example' => 'http://service.cn-hangzhou-vpc.maxcompute.aliyun-inc.com/api'],
],
[
'name' => 'Limit',
'in' => 'query',
- 'schema' => [
- 'description' => '返回数量，返回行数，默认1000。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1000',
- ],
+ 'schema' => ['description' => '返回数量，返回行数，默认1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'],
],
],
'responses' => [
@@ -3194,278 +3157,81 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
'Content' => [
'description' => '预览的数据行列表。',
'type' => 'array',
'items' => [
'description' => '数据列表，每个colume一个数据。',
'type' => 'array',
- 'items' => [
- 'description' => '表字段数据。',
- 'type' => 'string',
- 'example' => '123',
- ],
+ 'items' => ['description' => '表字段数据。', 'type' => 'string', 'example' => '123'],
],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Content\\": [\\n [\\n \\"123\\"\\n ]\\n ]\\n}","type":"json"}]',
'title' => '预览MaxCompute表',
- ],
- 'GetMCTableSchema' => [
- 'summary' => '获取MaxCompute表的Scheme。',
- 'path' => '/api/v1/datasources/maxcompute/tables/{TableName}/schema',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-02T01:55:23.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-03-01T06:17:00.000Z', 'description' => '请求参数发生变更'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreviewMCTable'],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '14093',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'TableName',
- 'in' => 'path',
- 'schema' => [
- 'description' => 'MaxCompute表名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table_name',
- 'pattern' => '^([a-zA-Z][a-zA-Z0-9_]*\\.)?[a-zA-Z0-9_]+$',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Columns' => [
- 'description' => '列信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'MaxCompute表列。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '列名。',
- 'type' => 'string',
- 'example' => 'column1',
- ],
- 'Type' => [
- 'description' => '列类型。',
- 'type' => 'string',
- 'example' => 'STRING',
- ],
- 'Preview' => [
- 'description' => '列内数据预览。',
- 'type' => 'array',
- 'items' => [
- 'description' => '列中数据。',
- 'type' => 'string',
- 'example' => '123',
- ],
- ],
- ],
- ],
- ],
- 'PartitionColumns' => [
- 'description' => '分区列，假如为空说明是非分区表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '分区列名。',
- 'type' => 'string',
- 'example' => 'dt',
- ],
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:PreviewMCTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Columns\\": [\\n {\\n \\"Name\\": \\"column1\\",\\n \\"Type\\": \\"STRING\\",\\n \\"Preview\\": [\\n \\"123\\"\\n ]\\n }\\n ],\\n \\"PartitionColumns\\": [\\n \\"dt\\"\\n ]\\n}","type":"json"}]',
- 'title' => '获取MaxCompute表的Schema',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Content\\": [\\n [\\n \\"123\\"\\n ]\\n ]\\n}","type":"json"}]',
],
- 'SearchMCTables' => [
- 'summary' => '在当前工作空间关联的MaxCompute project中搜索MaxCompute表。',
- 'path' => '/api/v1/datasources/maxcompute/tables',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'PublishExperiment' => [
+ 'summary' => '将工作流草稿发布到工作空间，让工作空间所有用户可见。',
+ 'path' => '/api/v1/experiments/{ExperimentId}/publish',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'abilityTreeCode' => '14091',
- 'abilityTreeNodes' => [
- 'FEATURElearnUEX4WU',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '92519',
+ 'abilityTreeNodes' => ['FEATURElearn01UVDS'],
],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
],
[
- 'name' => 'Keyword',
- 'in' => 'query',
- 'schema' => [
- 'description' => '搜索关键字，可用 "." 分隔，代表 项目名.表名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'project.table_name_prefix',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应结果。',
+ 'description' => '请求Body。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
- ],
- 'Tables' => [
- 'description' => '搜索到的表列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '表名。',
- 'type' => 'string',
- 'example' => 'table_name',
- ],
- ],
+ 'FolderId' => ['title' => '公共目录Id', 'description' => '公共文件夹ID，root表示公共的根目录。', 'type' => 'string', 'required' => true, 'example' => 'root'],
],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Tables\\": [\\n \\"table_name\\"\\n ]\\n}","type":"json"}]',
- 'title' => '搜索MaxCompute表',
- ],
- 'GetNodeInputSchema' => [
- 'summary' => '获取节点输入Schema。',
- 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/schema',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '14196',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'experiment-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
- 'name' => 'NodeId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿中的节点ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ff1f33b0-426a-46bb-bb30-4a5648058079',
- ],
- ],
- [
- 'name' => 'InputId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实验节点输入桩名称，若为空则获取整个节点合并后的Schema。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inputTable',
- ],
- ],
- [
- 'name' => 'InputIndex',
- 'in' => 'query',
- 'schema' => [
- 'description' => '可变桩时使用，标明是可变桩扩展的第几个桩，从 0 开始编号。',
- 'type' => 'integer',
- 'format' => 'int32',
'required' => false,
- 'example' => '0',
],
],
],
@@ -3473,187 +3239,66 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应结果。',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'CEB07647-8A5D-56F1-8B99-361BCF51402F',
- ],
- 'ColNames' => [
- 'description' => '输入表各个列的名称。',
- 'type' => 'array',
- 'items' => [
- 'description' => '列名。',
- 'type' => 'string',
- 'example' => 'col1',
- ],
- ],
- 'ColTypes' => [
- 'description' => '输入表各个列的类型。',
- 'type' => 'array',
- 'items' => [
- 'description' => '列类型。',
- 'type' => 'string',
- 'example' => 'STRING',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A26A7FA-EEF0-5A6B-BA76-06067547C11F'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB07647-8A5D-56F1-8B99-361BCF51402F\\",\\n \\"ColNames\\": [\\n \\"col1\\"\\n ],\\n \\"ColTypes\\": [\\n \\"STRING\\"\\n ]\\n}","type":"json"}]',
- 'title' => '获取节点输入Schema',
- ],
- 'GetExperimentVisualizationMeta' => [
- 'summary' => '获取工作流草稿可视化信息的Meta。',
- 'path' => '/api/v1/experiments/{ExperimentId}/visualizationMeta',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'title' => '公开工作流草稿到工作空间',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'OpenAPI 下线'],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '42908',
- 'abilityTreeNodes' => [
- 'FEATURElearnUEX4WU',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishExperiment'],
],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
- 'name' => 'NodeIds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿中的节点id列表，以英文逗号隔开，假如为空，则表示查询工作流草稿中的所有节点。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'node_id1,node_id2',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应结果。',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A84A1282-D3E7-5198-9E8E-2AD09C78C6C1',
- ],
- 'VisualizationMeta' => [
- 'description' => '可视化Meta列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '可视化信息。',
- 'type' => 'object',
- 'properties' => [
- 'NodeId' => [
- 'description' => '节点ID。',
- 'type' => 'string',
- 'example' => 'node_id1',
- ],
- 'NodeName' => [
- 'description' => '节点名称。',
- 'type' => 'string',
- 'example' => '直方图_1',
- ],
- 'Meta' => [
- 'description' => '可视化数据Meta，json格式。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "locations": [{'."\n"
- .' "id": "result_table",'."\n"
- .' "location": {'."\n"
- .' "project": "mulan_test_pre_1",'."\n"
- .' "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n"
- .' "table": "pai_temp_flow_qzkkjqic95olnrel1w_node_7hc1rdsa99gy2msbvc_visualizationTable"'."\n"
- .' },'."\n"
- .' "locationType": "MaxComputeTable"'."\n"
- .' }],'."\n"
- .' "components": [{'."\n"
- .' "id": "histogram-chart",'."\n"
- .' "dataId": "histogram_result"'."\n"
- .' }],'."\n"
- .' "dataInfos": [{'."\n"
- .' "id": "histogram_result",'."\n"
- .' "locationId": "result_table",'."\n"
- .' "dataType": "json"'."\n"
- .' }]'."\n"
- .'}',
- ],
- ],
- ],
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:PublishPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A84A1282-D3E7-5198-9E8E-2AD09C78C6C1\\",\\n \\"VisualizationMeta\\": [\\n {\\n \\"NodeId\\": \\"node_id1\\",\\n \\"NodeName\\": \\"直方图_1\\",\\n \\"Meta\\": \\"{\\\\n\\\\t\\\\\\"locations\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"id\\\\\\": \\\\\\"result_table\\\\\\",\\\\n\\\\t\\\\t\\\\\\"location\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\\\"project\\\\\\": \\\\\\"mulan_test_pre_1\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"endpoint\\\\\\": \\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\\\"table\\\\\\": \\\\\\"pai_temp_flow_qzkkjqic95olnrel1w_node_7hc1rdsa99gy2msbvc_visualizationTable\\\\\\"\\\\n\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\\\"locationType\\\\\\": \\\\\\"MaxComputeTable\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"components\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"id\\\\\\": \\\\\\"histogram-chart\\\\\\",\\\\n\\\\t\\\\t\\\\\\"dataId\\\\\\": \\\\\\"histogram_result\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"dataInfos\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"id\\\\\\": \\\\\\"histogram_result\\\\\\",\\\\n\\\\t\\\\t\\\\\\"locationId\\\\\\": \\\\\\"result_table\\\\\\",\\\\n\\\\t\\\\t\\\\\\"dataType\\\\\\": \\\\\\"json\\\\\\"\\\\n\\\\t}]\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取工作流草稿可视化的Meta',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A26A7FA-EEF0-5A6B-BA76-06067547C11F\\"\\n}","type":"json"}]',
],
'QueryExperimentVisualizationData' => [
'summary' => '获取工作流草稿可视化数据。',
'path' => '/api/v1/experiments/{ExperimentId}/visualizationDataQuery',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
'abilityTreeCode' => '42909',
- 'abilityTreeNodes' => [
- 'FEATURElearnUEX4WU',
- ],
+ 'abilityTreeNodes' => ['FEATURElearnUEX4WU'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'title' => 'experiment id',
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'schema' => ['title' => 'experiment id', 'description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
],
[
'name' => 'body',
@@ -3666,39 +3311,16 @@
'description' => '可视化请求。',
'type' => 'object',
'properties' => [
- 'NodeId' => [
- 'title' => 'node id',
- 'description' => '工作流草稿中的节点ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'node-2dfd8xfjda',
- ],
+ 'NodeId' => ['title' => 'node id', 'description' => '工作流草稿中的节点ID。', 'type' => 'string', 'required' => false, 'example' => 'node-2dfd8xfjda'],
'VisualizationDataIds' => [
'title' => 'dataId列表',
'description' => '需要查询的DataId列表，假如DataId为空，则返回该节点下所有的data数据。',
'type' => 'array',
- 'items' => [
- 'description' => '需要查询的DataId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dataId1',
- ],
- 'required' => false,
- ],
- 'StartTime' => [
- 'title' => '开始时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必选',
- 'description' => '开始时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必选。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'EndTime' => [
- 'title' => '结束时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必填',
- 'description' => '结束时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必填。',
- 'type' => 'string',
+ 'items' => ['description' => '需要查询的DataId。', 'type' => 'string', 'required' => false, 'example' => 'dataId1'],
'required' => false,
- 'example' => '2021-01-30T12:51:33.028Z',
],
+ 'StartTime' => ['title' => '开始时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必选', 'description' => '开始时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必选。', 'type' => 'string', 'required' => false, 'example' => '2021-01-30T12:51:33.028Z'],
+ 'EndTime' => ['title' => '结束时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必填', 'description' => '结束时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必填。', 'type' => 'string', 'required' => false, 'example' => '2021-01-30T12:51:33.028Z'],
],
'required' => false,
],
@@ -3713,12 +3335,7 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7'],
'VisualizationData' => [
'description' => '可视化数据列表。',
'type' => 'array',
@@ -3726,26 +3343,10 @@
'description' => '可视化数据。',
'type' => 'object',
'properties' => [
- 'NodeId' => [
- 'description' => '工作流草稿中的节点ID。',
- 'type' => 'string',
- 'example' => 'node-ux55ier8axzo2xelcc',
- ],
- 'DataId' => [
- 'description' => '可视化数据ID。',
- 'type' => 'string',
- 'example' => 'dataId1',
- ],
- 'Data' => [
- 'description' => '可视化数据。',
- 'type' => 'string',
- 'example' => '1,2,3,4,5',
- ],
- 'CreateTime' => [
- 'description' => '数据生成时间，UTC 时间，日期格式 iso8601。',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
+ 'NodeId' => ['description' => '工作流草稿中的节点ID。', 'type' => 'string', 'example' => 'node-ux55ier8axzo2xelcc'],
+ 'DataId' => ['description' => '可视化数据ID。', 'type' => 'string', 'example' => 'dataId1'],
+ 'Data' => ['description' => '可视化数据。', 'type' => 'string', 'example' => '1,2,3,4,5'],
+ 'CreateTime' => ['description' => '数据生成时间，UTC 时间，日期格式 iso8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
],
],
],
@@ -3757,42 +3358,59 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\",\\n \\"VisualizationData\\": [\\n {\\n \\"NodeId\\": \\"node-ux55ier8axzo2xelcc\\",\\n \\"DataId\\": \\"dataId1\\",\\n \\"Data\\": \\"1,2,3,4,5\\",\\n \\"CreateTime\\": \\"2021-01-30T12:51:33.028Z\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取工作流草稿可视化数据',
- ],
- 'GetAlgoTree' => [
- 'summary' => '获取算法树。',
- 'path' => '/api/v1/algo/tree',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-26T02:22:18.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryExperimentVisualizationData'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:QueryPipelineDraftVisualizationData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\",\\n \\"VisualizationData\\": [\\n {\\n \\"NodeId\\": \\"node-ux55ier8axzo2xelcc\\",\\n \\"DataId\\": \\"dataId1\\",\\n \\"Data\\": \\"1,2,3,4,5\\",\\n \\"CreateTime\\": \\"2021-01-30T12:51:33.028Z\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'SearchMCTables' => [
+ 'summary' => '在当前工作空间关联的MaxCompute project中搜索MaxCompute表。',
+ 'path' => '/api/v1/datasources/maxcompute/tables',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '13795',
- 'abilityTreeNodes' => [
- 'FEATURElearnZAMNTS',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14091',
+ 'abilityTreeNodes' => ['FEATURElearnUEX4WU'],
],
'parameters' => [
[
- 'name' => 'Source',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '获取指定源的算法列表，默认为PaiStudio。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => '搜索关键字，可用 "." 分隔，代表 项目名.表名。', 'type' => 'string', 'required' => true, 'example' => 'project.table_name_prefix'],
],
],
'responses' => [
@@ -3802,287 +3420,131 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '8CAA642F-EFEB-5F87-8F2F-ACD58B15FA03',
- ],
- 'Data' => [
- 'description' => '算法定义。',
- 'type' => 'object',
- 'example' => '[{}]',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
+ 'Tables' => [
+ 'description' => '搜索到的表列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '表名。', 'type' => 'string', 'example' => 'table_name'],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8CAA642F-EFEB-5F87-8F2F-ACD58B15FA03\\",\\n \\"Data\\": [\\n {}\\n ]\\n}","type":"json"}]',
- 'title' => '获取算法树',
- ],
- 'ListNodeOutputs' => [
- 'summary' => '获取工作流草稿节点的输出模型。',
- 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/outputs',
- 'methods' => [
- 'get',
+ 'title' => '搜索MaxCompute表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMCTables'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:SearchMCTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Tables\\": [\\n \\"table_name\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'StopExperiment' => [
+ 'summary' => '停止工作流草稿提交的所有运行中的作业，停止是异步操作，接口返回后，需要等待一段时间才能停止成功。',
+ 'path' => '/api/v1/experiments/{ExperimentId}/stop',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '14233',
- 'abilityTreeNodes' => [
- 'FEATURElearnZNL1NN',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14236',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
- 'name' => 'NodeId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿中的节点ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'node-5dzotrnwyzfxmbwwc8',
- ],
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-i1udvvwm2rlvxug29n'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应结果。',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Outputs' => [
- 'description' => '节点的模型列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '模型信息。',
- 'type' => 'object',
- 'properties' => [
- 'DisplayName' => [
- 'description' => '模型名称，格式是{NodeName}-{outputId}。',
- 'type' => 'string',
- 'example' => '逻辑回归二分类-2-outputModel',
- ],
- 'Type' => [
- 'description' => '类型，有Model、DataSet。',
- 'type' => 'string',
- 'example' => 'Model',
- ],
- 'OutputId' => [
- 'description' => '算法节点输出端口id。',
- 'type' => 'string',
- 'example' => 'outputModel',
- ],
- 'OutputIndex' => [
- 'description' => '可变长节点的index，从0开始。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Value' => [
- 'description' => 'Output的内容，不同Type的Output对应的key不一样。',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "name": "model_flow_wayrh3k605s7i51wey_node_7n3tstbuhr36t0ukiz_model",'."\n"
- .' "modelType": "OfflineModel",'."\n"
- .' "labelCol": "_c2",'."\n"
- .' "features": "pm10,so2,co,no2",'."\n"
- .' "gmtCreateTime": "2021-01-21T17:12:35.232Z",'."\n"
- .' "gmtModifiedTime": "2021-01-21T17:12:35.232Z",'."\n"
- .' "parameters": {'."\n"
- .' "epsilon": "0.000001",'."\n"
- .' "enableSparse": "false",'."\n"
- .' "regularizedLevel": "1",'."\n"
- .' "roleArn": "true",'."\n"
- .' "maxIter": "100",'."\n"
- .' "regularizedType": "None",'."\n"
- .' "generatePmml": "true"'."\n"
- .' }'."\n"
- .'}',
- ],
- 'NodeName' => [
- 'description' => '节点名称。',
- 'type' => 'string',
- 'example' => 'node1',
- ],
- 'AlgoName' => [
- 'description' => '算法名称。',
- 'type' => 'string',
- 'example' => '逻辑回归二分类',
- ],
- 'LocationType' => [
- 'description' => '模型位置：'."\n"
- .'* MaxComputeTable: MaxCompute表'."\n"
- .'* OSS: OSS',
- 'type' => 'string',
- 'example' => 'MaxComputeTable',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Outputs\\": [\\n {\\n \\"DisplayName\\": \\"逻辑回归二分类-2-outputModel\\",\\n \\"Type\\": \\"Model\\",\\n \\"OutputId\\": \\"outputModel\\",\\n \\"OutputIndex\\": \\"0\\",\\n \\"Value\\": {\\n \\"name\\": \\"model_flow_wayrh3k605s7i51wey_node_7n3tstbuhr36t0ukiz_model\\",\\n \\"modelType\\": \\"OfflineModel\\",\\n \\"labelCol\\": \\"_c2\\",\\n \\"features\\": \\"pm10,so2,co,no2\\",\\n \\"gmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"gmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"parameters\\": {\\n \\"epsilon\\": \\"0.000001\\",\\n \\"enableSparse\\": \\"false\\",\\n \\"regularizedLevel\\": \\"1\\",\\n \\"roleArn\\": \\"true\\",\\n \\"maxIter\\": \\"100\\",\\n \\"regularizedType\\": \\"None\\",\\n \\"generatePmml\\": \\"true\\"\\n }\\n },\\n \\"NodeName\\": \\"node1\\",\\n \\"AlgoName\\": \\"逻辑回归二分类\\",\\n \\"LocationType\\": \\"MaxComputeTable\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取节点的输出模型',
- ],
- 'GetNodeOutput' => [
- 'summary' => '获取某个节点的输出模型信息。',
- 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/outputs/{OutputId}',
- 'methods' => [
- 'get',
+ 'title' => '停止工作流草稿所有作业',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopExperiment'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:StopPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
+ ],
+ 'StopJob' => [
+ 'path' => '/api/v1/jobs/{JobId}/stop',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '14234',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14209',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
- 'name' => 'NodeId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '工作流草稿中的节点ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'node-5dzotrnwyzfxmbwwc8',
- ],
- ],
- [
- 'name' => 'OutputId',
+ 'name' => 'JobId',
'in' => 'path',
- 'schema' => [
- 'description' => '算法节点输出端口id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'outputId',
- ],
- ],
- [
- 'name' => 'OutputIndex',
- 'in' => 'query',
- 'schema' => [
- 'description' => '可变长节点的index，从0开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '作业ID。', 'type' => 'string', 'required' => true, 'example' => 'job-i4vmjfsv5i1kowo4ih'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回结果。',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '601FD8B1-78EB-5220-844C-92AC2EDAF7E1',
- ],
- 'NodeName' => [
- 'description' => '节点名称。',
- 'type' => 'string',
- 'example' => '逻辑回归二分类-1',
- ],
- 'AlgoName' => [
- 'description' => '算法名称。',
- 'type' => 'string',
- 'example' => '逻辑回归二分类',
- ],
- 'DisplayName' => [
- 'description' => '展示名称。',
- 'type' => 'string',
- 'example' => '逻辑回归二分类-2-outputModel',
- ],
- 'Type' => [
- 'description' => '类型，有Model、DataSet',
- 'type' => 'string',
- 'example' => 'Model',
- ],
- 'Value' => [
- 'description' => 'Output的内容，不同Type的Output对应的key不一样。',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "name": "model_flow_wayrh3k605s7i51wey_node_7n3tstbuhr36t0ukiz_model",'."\n"
- .' "modelType": "OfflineModel",'."\n"
- .' "labelCol": "_c2",'."\n"
- .' "features": "pm10,so2,co,no2",'."\n"
- .' "gmtCreateTime": "2021-01-21T17:12:35.232Z",'."\n"
- .' "gmtModifiedTime": "2021-01-21T17:12:35.232Z",'."\n"
- .' "parameters": {'."\n"
- .' "epsilon": "0.000001",'."\n"
- .' "enableSparse": "false",'."\n"
- .' "regularizedLevel": "1",'."\n"
- .' "roleArn": "true",'."\n"
- .' "maxIter": "100",'."\n"
- .' "regularizedType": "None",'."\n"
- .' "generatePmml": "true"'."\n"
- .' }'."\n"
- .'}',
- ],
- 'LocationType' => [
- 'description' => '模型位置：'."\n"
- .'* MaxComputeTable: MaxCompute表'."\n"
- .'* OSS: OSS',
- 'type' => 'string',
- 'example' => 'MaxComputeTable',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '431C53C4-BDD0-588F-8081-4437B00852B5'],
],
],
],
@@ -4091,51 +3553,65 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"601FD8B1-78EB-5220-844C-92AC2EDAF7E1\\",\\n \\"NodeName\\": \\"逻辑回归二分类-1\\",\\n \\"AlgoName\\": \\"逻辑回归二分类\\",\\n \\"DisplayName\\": \\"逻辑回归二分类-2-outputModel\\",\\n \\"Type\\": \\"Model\\",\\n \\"Value\\": {\\n \\"name\\": \\"model_flow_wayrh3k605s7i51wey_node_7n3tstbuhr36t0ukiz_model\\",\\n \\"modelType\\": \\"OfflineModel\\",\\n \\"labelCol\\": \\"_c2\\",\\n \\"features\\": \\"pm10,so2,co,no2\\",\\n \\"gmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"gmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"parameters\\": {\\n \\"epsilon\\": \\"0.000001\\",\\n \\"enableSparse\\": \\"false\\",\\n \\"regularizedLevel\\": \\"1\\",\\n \\"roleArn\\": \\"true\\",\\n \\"maxIter\\": \\"100\\",\\n \\"regularizedType\\": \\"None\\",\\n \\"generatePmml\\": \\"true\\"\\n }\\n },\\n \\"LocationType\\": \\"MaxComputeTable\\"\\n}","type":"json"}]',
- 'title' => '获取某个节点的输出模型信息',
- ],
- 'ListAuthRoles' => [
- 'summary' => '获取授权角色列表。',
- 'path' => '/api/v1/authorization/roles',
- 'methods' => [
- 'get',
+ 'title' => '停止工作流草稿作业',
+ 'summary' => '停止工作流草稿作业。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopJob'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:StopJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"431C53C4-BDD0-588F-8081-4437B00852B5\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateExperimentContent' => [
+ 'path' => '/api/v1/experiments/{ExperimentId}/content',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '21720',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14191',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-i1udvvwm2rlvxug29n'],
],
[
- 'name' => 'IsGenerateToken',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '是否生成STS临时Token，已经废弃。',
- 'type' => 'string',
+ 'description' => '请求Body。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '工作流草稿内容。', 'type' => 'string', 'required' => true, 'example' => '{"metadata":{"name":"实验名称","desc":"实验描述"},"nodes":[],"edges":[],"globalParams":[],"globalSettings":[]}'],
+ 'Version' => ['description' => '更新前的工作流草稿版本，要求与工作流草稿的当前版本一致，否则无法更新成功。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11'],
+ ],
'required' => false,
- 'example' => 'true',
],
],
],
@@ -4146,158 +3622,161 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '8E2C1BB9-57C4-5051-9EF2-570ADC03A164',
- ],
- 'Roles' => [
- 'description' => '角色列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '角色信息。',
- 'type' => 'object',
- 'properties' => [
- 'RoleName' => [
- 'description' => '角色名称。',
- 'type' => 'string',
- 'example' => 'AliyunODPSPAIDefaultRole',
- ],
- 'RoleARN' => [
- 'description' => '角色的arn。',
- 'type' => 'string',
- 'example' => 'acs:ram::1557********904:role/aliyunodpspaidefaultrole',
- ],
- 'IsEnabled' => [
- 'description' => '角色是否可用。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Token' => [
- 'description' => '角色凭证信息，已经废弃。',
- 'type' => 'object',
- 'properties' => [
- 'SecurityToken' => [
- 'description' => 'STS生成security token。',
- 'type' => 'string',
- 'example' => 'CAISggJ1q6Ft5B2yf***************aAaDf+bmceH2MNtNe9XtmTXJytadQ2T0RT8uOA+4kSypOPxSHjdjmnQjbdA/Q9MyNtTErQ/m45RNsg==',
- ],
- 'AccessKeyId' => [
- 'description' => 'STS生成access id。',
- 'type' => 'string',
- 'example' => 'STS.NU************TT5LoC',
- ],
- 'AccessKeySecret' => [
- 'description' => 'STS生成access key。',
- 'type' => 'string',
- 'example' => 'E1h2n66Duo1D**********c79JVk59R6i',
- ],
- 'Expiration' => [
- 'description' => '过期时间。',
- 'type' => 'string',
- 'example' => '2021-03-19T19:14:42Z',
- ],
- ],
- ],
- 'RoleType' => [
- 'description' => 'Role的类型。',
- 'type' => 'string',
- 'example' => 'PaiStudio。',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Version' => ['description' => '更新后工作流草稿的版本。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E2C1BB9-57C4-5051-9EF2-570ADC03A164\\",\\n \\"Roles\\": [\\n {\\n \\"RoleName\\": \\"AliyunODPSPAIDefaultRole\\",\\n \\"RoleARN\\": \\"acs:ram::1557********904:role/aliyunodpspaidefaultrole\\",\\n \\"IsEnabled\\": \\"true\\",\\n \\"Token\\": {\\n \\"SecurityToken\\": \\"CAISggJ1q6Ft5B2yf***************aAaDf+bmceH2MNtNe9XtmTXJytadQ2T0RT8uOA+4kSypOPxSHjdjmnQjbdA/Q9MyNtTErQ/m45RNsg==\\",\\n \\"AccessKeyId\\": \\"STS.NU************TT5LoC\\",\\n \\"AccessKeySecret\\": \\"E1h2n66Duo1D**********c79JVk59R6i\\",\\n \\"Expiration\\": \\"2021-03-19T19:14:42Z\\"\\n },\\n \\"RoleType\\": \\"PaiStudio。\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取授权角色列表',
- ],
- 'ListImages' => [
- 'summary' => '列举已注册镜像',
- 'path' => '/api/v1/images',
- 'methods' => [
- 'get',
+ 'title' => '更新工作流草稿的内容',
+ 'summary' => '更新工作流草稿的内容。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExperimentContent'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:UpdatePipelineDraftContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Version\\": 12\\n}","type":"json"}]',
+ ],
+ 'UpdateExperimentFolder' => [
+ 'path' => '/api/v1/experimentfolders/{FolderId}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '20013',
- 'abilityTreeNodes' => [
- 'FEATURElearnAFIS9K',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13802',
+ 'abilityTreeNodes' => ['FEATURElearn1QDD9Y'],
],
'parameters' => [
[
- 'name' => 'Name',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '镜像名称，支持模糊搜索',
- 'type' => 'string',
+ 'description' => '请求Body。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '新的工作流草稿文件夹名称。', 'type' => 'string', 'required' => false, 'example' => 'folder1'],
+ 'ParentFolderId' => ['description' => '新的文件夹父节点ID，为空表示不修改父目录。', 'type' => 'string', 'required' => false, 'example' => 'folder-xzf7t785nka4c2334'],
+ ],
+ 'required' => false,
],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页，从1开始，默认1',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'name' => 'FolderId',
+ 'in' => 'path',
+ 'schema' => ['description' => '文件夹的ID。', 'type' => 'string', 'required' => true, 'example' => 'folder-xzf7t785nka4ch7qce'],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '页大小，默认20',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => 'Schema of Response',
+ 'description' => '相应结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
+ ],
],
],
+ ],
+ 'title' => '更新工作流草稿文件夹',
+ 'summary' => '更新工作量草稿文件夹。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExperimentFolder'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SortBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'type' => 'string',
- 'example' => 'GmtCreateTime',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:UpdatePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]',
+ ],
+ 'UpdateExperimentMeta' => [
+ 'path' => '/api/v1/experiments/{ExperimentId}/meta',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Order',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序方向： ASC - 升序 DESC - 降序',
- 'type' => 'string',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14190',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'Labels',
- 'in' => 'query',
- 'schema' => [
- 'title' => '过滤值 以逗号分隔',
- 'type' => 'string',
- 'example' => 'Framework="Tensorflow 1.0",Framework="Tensorflow 2.0",Platform="GPU"',
- ],
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => '工作流草稿ID。', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
],
[
- 'name' => 'Verbose',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '是否显示非必要信息：Labels',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '请求Body。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '工作流草稿名称。', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft name'],
+ 'Description' => ['description' => '工作流草稿描述。', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft description'],
+ 'FolderId' => ['description' => '工作流草稿更新后的所属的文件夹ID。'."\n"
+ .'* 如果该值不为空，将工作流草稿移动到该文件夹。'."\n"
+ .'* 如果为空，不移动。'."\n"
+ .'* 如果为root，且Accessibility为PUBILC，移动到公共根目录'."\n"
+ .'* 如果为root，且Accessibility为PRIVATE，移动到自己的根目录', 'type' => 'string', 'required' => false, 'example' => 'folder-xfd782efd08wex'],
+ 'Options' => ['description' => '工作流草稿选项。', 'type' => 'string', 'required' => false, 'example' => '{"mlflow":{"experimentId":"exp-1"}}'],
+ 'Accessibility' => [
+ 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
+ 'description' => '工作流草稿的可见性，取值如下：'."\n"
+ .'- PUBLIC：在此工作空间中，对所有人可见。'."\n"
+ .'- PRIVATE：在此工作空间中，仅对您和管理员可见。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
+ 'example' => 'PUBLIC',
+ ],
+ ],
+ 'required' => false,
],
],
],
@@ -4305,632 +3784,805 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
+ 'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'Images' => [
- 'title' => '镜像列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '镜像名称',
- 'type' => 'string',
- ],
- 'GmtCreateTime' => [
- 'title' => '创建 UTC 时间，日期格式 iso8601',
- 'type' => 'string',
- 'example' => '2021-01-21T17:12:35.232Z',
- ],
- 'Description' => [
- 'title' => '镜像描述',
- 'type' => 'string',
- ],
- 'ImageUri' => [
- 'title' => '镜像地址，包含版本号',
- 'type' => 'string',
- ],
- 'Labels' => [
- 'title' => '镜像标签，是个map',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => 'Key',
- 'type' => 'string',
- ],
- 'Value' => [
- 'title' => 'Value',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'ImageId' => [
- 'title' => '镜像id',
- 'type' => 'string',
- 'example' => 'image-tzi7f9czc0cxs9s45t',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
],
],
],
],
- 'responseDemo' => '',
- ],
- 'ListImageLabels' => [
- 'summary' => '列举标签',
- 'path' => '/api/v1/image/labels',
- 'methods' => [
- 'get',
+ 'title' => '更新工作流草稿Meta',
+ 'summary' => '更新PAI Designer工作流草稿的Meta信息。',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExperimentMeta'],
+ ],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:UpdatePipelineDraftMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '20007',
- 'abilityTreeNodes' => [
- 'FEATURElearnAFIS9K',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\"\\n}","type":"json"}]',
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-northeast-1.aliyuncs.com', 'endpoint' => 'pai.ap-northeast-1.aliyuncs.com', 'vpc' => 'pai-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-northeast-2.aliyuncs.com', 'endpoint' => 'pai.ap-northeast-2.aliyuncs.com', 'vpc' => 'pai-vpc.ap-northeast-2.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-southeast-1.aliyuncs.com', 'endpoint' => 'pai.ap-southeast-1.aliyuncs.com', 'vpc' => 'pai-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-southeast-3.aliyuncs.com', 'endpoint' => 'pai.ap-southeast-3.aliyuncs.com', 'vpc' => 'pai-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-southeast-5.aliyuncs.com', 'endpoint' => 'pai.ap-southeast-5.aliyuncs.com', 'vpc' => 'pai-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-8', 'regionName' => '马来西亚（柔佛州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-southeast-8.aliyuncs.com', 'endpoint' => 'pai.ap-southeast-8.aliyuncs.com', 'vpc' => 'pai-vpc.ap-southeast-8.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-beijing.aliyuncs.com', 'endpoint' => 'pai.cn-beijing.aliyuncs.com', 'vpc' => 'pai-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-guangzhou.aliyuncs.com', 'endpoint' => 'pai.cn-guangzhou.aliyuncs.com', 'vpc' => 'pai-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-hangzhou.aliyuncs.com', 'endpoint' => 'pai.cn-hangzhou.aliyuncs.com', 'vpc' => 'pai-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-hongkong.aliyuncs.com', 'endpoint' => 'pai.cn-hongkong.aliyuncs.com', 'vpc' => 'pai-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-shanghai.aliyuncs.com', 'endpoint' => 'pai.cn-shanghai.aliyuncs.com', 'vpc' => 'pai-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-shenzhen.aliyuncs.com', 'endpoint' => 'pai.cn-shenzhen.aliyuncs.com', 'vpc' => 'pai-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'pai.cn-wulanchabu.aliyuncs.com', 'vpc' => 'pai-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pai.us-west-1.aliyuncs.com', 'endpoint' => 'pai.us-west-1.aliyuncs.com', 'vpc' => 'pai-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pai.us-east-1.aliyuncs.com', 'endpoint' => 'pai.us-east-1.aliyuncs.com', 'vpc' => 'pai-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pai.eu-central-1.aliyuncs.com', 'endpoint' => 'pai.eu-central-1.aliyuncs.com', 'vpc' => 'pai-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pai.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'pai.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'pai-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'DMS1000001', 'message' => 'Request failed.', 'http_code' => 500, 'description' => '请求失败'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CopyExperiment'],
+ ],
+ 'createdAt' => '2024-12-04T09:15:31.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateJob'],
+ ],
+ 'createdAt' => '2024-09-13T07:01:21.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'GetMCTableSchema'],
+ ],
+ 'createdAt' => '2023-07-18T02:23:23.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetTemplate'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListTemplates'],
+ ],
+ 'createdAt' => '2022-12-02T05:59:01.000Z',
+ 'description' => 'template',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'PreviewMCTable'],
+ ],
+ 'createdAt' => '2022-12-02T01:56:07.000Z',
+ 'description' => 'Add Limit parameters for PreviewMCTable.',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetExperimentFolderChildren'],
+ ],
+ 'createdAt' => '2022-11-23T04:25:13.000Z',
+ 'description' => 'Modify GetExperimentFolderChildren, add create and modified time.',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'GetAlgorithmTree'],
+ ],
+ 'createdAt' => '2022-09-27T11:33:40.000Z',
+ 'description' => 'GetAlgorithmTree 新增 WorkspaceId 可选入参，用于支持基于工作空间是否开通GPU的算法节点过滤',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'PreviewMCTable'],
+ ],
+ 'createdAt' => '2022-03-17T07:59:23.000Z',
+ 'description' => 'Support Preview Partition Table.',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetExperimentVisualizationMeta'],
+ ['description' => 'OpenAPI 下线', 'api' => 'QueryExperimentVisualizationData'],
+ ],
+ 'createdAt' => '2021-11-26T02:25:22.000Z',
+ 'description' => '新增可视化元信息和数据查询接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateExperimentMigrateValidation'],
+ ['description' => 'OpenAPI 下线', 'api' => 'MigrateExperimentFolders'],
+ ['description' => 'OpenAPI 下线', 'api' => 'MigrateExperiments'],
+ ],
+ 'createdAt' => '2021-11-18T05:35:05.000Z',
+ 'description' => '支持将PAI Studio 1.0实验迁移到2.0.',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CopyExperiment'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateExperiment'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateExperimentFolder'],
+ ['description' => '响应参数发生变更', 'api' => 'GetExperiment'],
+ ['description' => '请求参数发生变更', 'api' => 'GetExperimentFolderChildren'],
+ ['description' => '响应参数发生变更', 'api' => 'GetExperimentMeta'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetExperimentsUsersStatistics'],
+ ['description' => '响应参数发生变更', 'api' => 'ListExperiments'],
+ ['description' => 'OpenAPI 下线', 'api' => 'PublishExperiment'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateExperimentMeta'],
+ ],
+ 'createdAt' => '2021-11-03T13:42:35.000Z',
+ 'description' => '增加工作空间可见度字段Accessibility，PRIVATE：工作空间内私有；PUBLIC：工作空间内公有',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'GetAlgorithmDef'],
+ ['description' => '请求参数发生变更', 'api' => 'GetAlgorithmDefs'],
+ ],
+ 'createdAt' => '2021-08-18T02:50:28.000Z',
+ 'description' => 'GetAlgorithmDef接口变更',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetNodeOutput'],
+ ['description' => '响应参数发生变更', 'api' => 'ListNodeOutputs'],
+ ],
+ 'createdAt' => '2021-05-13T06:09:49.000Z',
+ 'description' => 'NodeOutputs中添加LocationType',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ListImageLabels'],
+ ],
+ 'createdAt' => '2021-04-08T08:41:39.000Z',
+ 'description' => 'done',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'AddImage'],
+ ['description' => 'OpenAPI 下线', 'api' => 'AddImageLabels'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetImage'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListImages'],
+ ['description' => 'OpenAPI 下线', 'api' => 'RemoveImage'],
+ ['description' => 'OpenAPI 下线', 'api' => 'RemoveImageLabels'],
+ ],
+ 'createdAt' => '2021-04-07T04:59:41.000Z',
+ 'description' => '发布镜像管理',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ListAuthRoles'],
+ ],
+ 'createdAt' => '2021-04-06T08:50:21.000Z',
+ 'description' => '增加ListAuthRoles接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAlgorithmDef'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAlgorithmDefs'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAlgorithmTree'],
+ ],
+ 'createdAt' => '2021-03-29T09:06:22.000Z',
+ 'description' => '更新algotree接口',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExperiment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentStatus'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentFolderChildren'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAuthRoles'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeInputSchema'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmTree'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExperiments'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExperimentFolder'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentMeta'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentsUsersStatistics'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeOutputs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateExperimentFolders'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExperimentMeta'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmDefs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExperimentFolder'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageLabels'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentExperiments'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgoTree'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyExperiment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperiment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeOutput'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryExperimentVisualizationData'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreviewMCTable'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentsStatistics'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateExperiments'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExperimentMigrateValidation'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopExperiment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchMCTables'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExperiment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishExperiment'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMCTableSchema'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExperimentFolder'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExperimentContent'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmDef'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentVisualizationMeta'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'PaiStudio',
+ 'productName' => '人工智能平台 PAI',
+ 'ramCodes' => ['pai', 'paidesigner', 'paiartlab'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetExperimentStatus',
+ 'description' => '查询工作流草稿状态',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'LabelKeys',
- 'in' => 'query',
- 'schema' => [
- 'title' => '标签列表，以逗号分隔',
- 'type' => 'string',
- 'example' => 'ImageType,Framework,Platform',
+ [
+ 'apiName' => 'QueryExperimentVisualizationData',
+ 'description' => '获取工作流草稿可视化数据',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:QueryPipelineDraftVisualizationData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'LabelFilter',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'image过滤条件，获取满足条件的image的所有label',
- 'type' => 'string',
- 'example' => 'a=b,c=d',
+ ],
+ [
+ 'apiName' => 'DeleteExperimentFolder',
+ 'description' => '删除工作流草稿文件夹',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'paidesigner:DeletePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'ImageId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '镜像id',
- 'type' => 'string',
+ ],
+ [
+ 'apiName' => 'GetNodeOutput',
+ 'description' => '获取某个节点的输出模型信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftNodeOutput',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'Labels' => [
- 'title' => '镜像标签',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '键',
- 'type' => 'string',
- ],
- 'Value' => [
- 'title' => '值',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'title' => '符合过滤条件的数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
+ [
+ 'apiName' => 'StopExperiment',
+ 'description' => '停止工作流草稿所有作业',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:StopPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '',
- ],
- 'MigrateExperiments' => [
- 'summary' => '从Studio 1.0迁移工作流草稿到Designer',
- 'path' => '/api/v1/migrate/experiments',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'ListAuthRoles',
+ 'description' => '获取授权角色列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListAuthRoles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'GetExperimentFolderChildren',
+ 'description' => '获取工作流草稿文件夹下成员',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftFolderChildren',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ListTemplates',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'CreateExperimentFolder',
+ 'description' => '创建工作流草稿文件夹',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreatePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteExperiment',
+ 'description' => '删除工作流草稿',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'paidesigner:DeletePipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'MigrateExperiments',
+ 'description' => '从Studio 1.0迁移工作流草稿到Designer',
'operationType' => 'none',
- 'abilityTreeCode' => '93908',
- 'abilityTreeNodes' => [
- 'FEATURElearn01UVDS',
+ 'ramAction' => [
+ 'action' => 'paidesigner:MigrateExperiments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'SourceExpId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Studio1.0中的实验ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12345',
+ [
+ 'apiName' => 'GetAlgoTree',
+ 'description' => '获取算法树',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgoTree',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
+ ],
+ [
+ 'apiName' => 'GetAlgorithmDef',
+ 'description' => '获取算法定义',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgorithmDef',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'DestFolderId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目标文件夹ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-12321313',
+ ],
+ [
+ 'apiName' => 'ListImages',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'Accessibility',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作空间可见性，可能值为：'."\n"
- .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n"
- .'- PUBLIC：在此工作空间中，对所有人可见。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PRIVATE',
+ ],
+ [
+ 'apiName' => 'GetExperimentMeta',
+ 'description' => '查询工作流草稿Meta',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'UpdateIfExists',
- 'in' => 'query',
- 'schema' => [
- 'description' => '假如已经存在是否更新。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ ],
+ [
+ 'apiName' => 'GetExperimentsUsersStatistics',
+ 'description' => '统计创建了工作流草稿的用户',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftsUsersStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'IsOwner',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否只迁移自己的。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ ],
+ [
+ 'apiName' => 'GetMCTableSchema',
+ 'description' => '获取MaxCompute表的Schema',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetMCTableSchema',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
- ],
- 'Code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'NO_PERMISSION',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'NotExistError',
- ],
- 'Data' => [
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'ExperimentId' => [
- 'description' => '工作流草稿ID。',
- 'type' => 'string',
- 'example' => 'draft-8u3ck2or5pw2i4auhf',
- ],
- 'AlreadyExists' => [
- 'description' => '是否已经存在。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Updated' => [
- 'description' => '是否更新了。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'GetAlgorithmTree',
+ 'description' => '获取算法树',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgorithmTree',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"Code\\": \\"NO_PERMISSION\\",\\n \\"Message\\": \\"NotExistError\\",\\n \\"Data\\": {\\n \\"ExperimentId\\": \\"draft-8u3ck2or5pw2i4auhf\\",\\n \\"AlreadyExists\\": true,\\n \\"Updated\\": true\\n }\\n}","type":"json"}]',
- 'title' => '从Studio 1.0迁移工作流草稿到Designer',
- ],
- 'CreateExperimentMigrateValidation' => [
- 'summary' => '创建工作流草稿迁移的校',
- 'path' => '/api/v1/migrate/experimentvalidation',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'CreateJob',
+ 'description' => '创建工作流草稿作业',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreateJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListJobs',
+ 'description' => '获取工作流草稿作业列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListJobs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'StopJob',
+ 'description' => '停止工作流草稿作业',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:StopJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '100051',
- 'abilityTreeNodes' => [
- 'FEATURElearn01UVDS',
+ [
+ 'apiName' => 'UpdateExperimentContent',
+ 'description' => '更新工作流草稿的内容',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:UpdatePipelineDraftContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'SourceExpId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Studio1.0中的实验ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123',
+ [
+ 'apiName' => 'MigrateExperimentFolders',
+ 'description' => '从Studio 1.0迁移工作流草稿目录',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:MigrateExperimentFolders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- ],
+ [
+ 'apiName' => 'ListImageLabels',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListImageLabels',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
- 'title' => '创建工作流草稿迁移的校验',
- ],
- 'MigrateExperimentFolders' => [
- 'summary' => '迁移PAI Studio 1.0的实验目录',
- 'path' => '/api/v1/migrate/folders',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'CopyExperiment',
+ 'description' => '复制工作流草稿',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CopyPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'UpdateExperimentFolder',
+ 'description' => '更新工作流草稿文件夹',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:UpdatePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CreateExperimentMigrateValidation',
+ 'description' => '创建工作流草稿迁移的校验',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreateExperimentMigrateValidation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'abilityTreeCode' => '93906',
- 'abilityTreeNodes' => [
- 'FEATURElearn01UVDS',
+ [
+ 'apiName' => 'ListExperiments',
+ 'description' => '获取工作流草稿列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListPipelineDrafts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作空间ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
+ [
+ 'apiName' => 'GetNodeInputSchema',
+ 'description' => '获取节点输入Schema',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetNodeInputSchema',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'IsOwner',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否只迁移自己的。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ ],
+ [
+ 'apiName' => 'GetAlgorithmDefs',
+ 'description' => '批量获取算法定义',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgorithmDefs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'Accessibility',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流草稿的可见性，取值如下：'."\n"
- .'- PUBLIC：在此工作空间中，对所有人可见。'."\n"
- .'- PRIVATE：在此工作空间中，仅对您和管理员可见。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PRIVATE',
+ ],
+ [
+ 'apiName' => 'GetExperimentVisualizationMeta',
+ 'description' => '获取工作流草稿可视化的Meta',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftVisualizationMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9CFA2665-1FFE-5929-8468-C14C25890486',
- ],
- 'Code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'NO_PERMISSION',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'FolderIdMapping' => [
- 'description' => '迁移结果，返回值是一个Map，key是userId。',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'description' => 'Studio 1.0实验ID到工作流草稿ID的映射关系，key是实验ID，value是工作流草稿ID。',
- 'example' => '{'."\n"
- .' "user1": {'."\n"
- .' 123 :"draft-xxxx"'."\n"
- .' }'."\n"
- .'}',
- ],
- ],
- ],
+ [
+ 'apiName' => 'SearchMCTables',
+ 'description' => '搜索MaxCompute表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:SearchMCTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CFA2665-1FFE-5929-8468-C14C25890486\\",\\n \\"Code\\": \\"NO_PERMISSION\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"FolderIdMapping\\": {\\n \\"key\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]',
- 'title' => '从Studio 1.0迁移工作流草稿目录',
- ],
- 'GetAlgorithmDefs' => [
- 'summary' => '批量获取算法定义。',
- 'path' => '/api/v1/algorithm/defs',
- 'methods' => [
- 'get',
+ [
+ 'apiName' => 'UpdateExperimentMeta',
+ 'description' => '更新工作流草稿Meta',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:UpdatePipelineDraftMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'GetExperiment',
+ 'description' => '获取工作流草稿',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'PreviewMCTable',
+ 'description' => '预览MaxCompute表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:PreviewMCTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRecentExperiments',
+ 'description' => '获取最近的工作流草稿',
'operationType' => 'list',
- 'abilityTreeCode' => '19292',
- 'abilityTreeNodes' => [
- 'FEATURElearnZAMNTS',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListRecentPipelineDrafts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'Timestamp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前已缓存的时间戳，会返回此时间戳到服务端最新时间戳之间的算法列表。'."\n"
- .'不传直接返回全量的最新列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1709950208',
+ [
+ 'apiName' => 'GetJob',
+ 'description' => '查询工作流草稿作业',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'LatestTimestamp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '服务端返回的最新版本的时间戳，不传则自动获取。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1709950208',
+ ],
+ [
+ 'apiName' => 'PublishExperiment',
+ 'description' => '公开工作流草稿到工作空间',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:PublishPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'RangeStart',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页获取算法定义，当前页的范围起始点，闭区间。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ ],
+ [
+ 'apiName' => 'GetExperimentsStatistics',
+ 'description' => '统计工作空间中工作流草稿的数量',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftsStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'RangeEnd',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页获取算法定义，当前页的范围结束点，开区间。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ ],
+ [
+ 'apiName' => 'ListNodeOutputs',
+ 'description' => '获取节点的输出模型',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListPipelineDraftNodeOutputs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
- ],
- 'Specs' => [
- 'description' => '算法定义列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '算法定义。',
- 'type' => 'object',
- 'example' => '{}',
- ],
- ],
- ],
+ [
+ 'apiName' => 'CreateExperiment',
+ 'description' => '创建工作流草稿',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreatePipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Specs\\": [\\n {}\\n ]\\n}","type":"json"}]',
- 'title' => '批量获取算法定义',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'pai.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'pai.cn-wulanchabu.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'pai.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'pai.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'pai.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'pai.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'pai.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'pai.ap-southeast-3.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'pai.ap-southeast-5.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'pai.eu-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'pai.cn-guangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'pai.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'pai.us-east-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'pai.us-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2',
- 'endpoint' => 'pai.ap-northeast-2.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'pai.cn-shanghai-finance-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-southeast-1',
- 'endpoint' => 'pai.us-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-7',
- 'endpoint' => 'pai.ap-southeast-7.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'pai.me-east-1.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 23:26:58 +0000