summaryrefslogtreecommitdiff
path: root/data/en_us/paistudio/2021-02-02
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/paistudio/2021-02-02')
-rw-r--r--data/en_us/paistudio/2021-02-02/api-docs.php6821
1 files changed, 3424 insertions, 3397 deletions
diff --git a/data/en_us/paistudio/2021-02-02/api-docs.php b/data/en_us/paistudio/2021-02-02/api-docs.php
index 0d27461..a8f03d4 100644
--- a/data/en_us/paistudio/2021-02-02/api-docs.php
+++ b/data/en_us/paistudio/2021-02-02/api-docs.php
@@ -1,103 +1,46 @@
<?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' => 'Workflow Draft',
+ 'children' => ['CopyExperiment', 'UpdateExperimentMeta', 'UpdateExperimentContent', 'PublishExperiment', 'GetExperimentMeta', 'GetExperimentStatus'],
'type' => 'directory',
- 'children' => [
- 'CreateExperiment',
- 'CopyExperiment',
- 'UpdateExperimentMeta',
- 'UpdateExperimentContent',
- 'PublishExperiment',
- 'GetExperiment',
- 'GetExperimentMeta',
- 'GetExperimentStatus',
- 'DeleteExperiment',
- 'ListExperiments',
- ],
+ 'title' => 'Workflow draft',
],
[
- 'id' => 197114,
- 'title' => 'Workflow Draft Job',
+ 'children' => ['GetJob', 'StopJob', 'StopExperiment'],
'type' => 'directory',
- 'children' => [
- 'CreateJob',
- 'GetJob',
- 'ListJobs',
- 'StopJob',
- 'StopExperiment',
- ],
+ 'title' => 'Workflow draft job',
],
[
- 'id' => 197111,
- 'title' => 'Workflow Draft Catalog',
+ 'children' => ['CreateExperimentFolder', 'UpdateExperimentFolder', 'GetExperimentFolderChildren', 'DeleteExperimentFolder'],
'type' => 'directory',
- 'children' => [
- 'CreateExperimentFolder',
- 'UpdateExperimentFolder',
- 'GetExperimentFolderChildren',
- 'DeleteExperimentFolder',
- ],
+ 'title' => 'Workflow draft folder',
],
[
- 'id' => 197169,
- 'title' => 'algorithm',
+ 'children' => ['GetAlgorithmTree', 'GetAlgorithmDef'],
'type' => 'directory',
- 'children' => [
- 'GetAlgorithmTree',
- 'GetAlgorithmDef',
- ],
+ 'title' => 'Algorithm',
],
[
- 'id' => 197189,
- 'title' => 'Other (documents not in the catalog)',
+ 'children' => ['ListRecentExperiments', 'GetExperimentsStatistics', 'GetExperimentsUsersStatistics', 'PreviewMCTable', 'GetMCTableSchema', 'SearchMCTables', 'GetNodeInputSchema', 'GetExperimentVisualizationMeta', 'QueryExperimentVisualizationData', 'GetAlgoTree', 'ListNodeOutputs', 'GetNodeOutput', 'ListAuthRoles', 'ListImageLabels', 'MigrateExperiments', 'CreateExperimentMigrateValidation', 'MigrateExperimentFolders', 'GetAlgorithmDefs'],
'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' => 'Others (documents not in the directory)',
+ ],
+ [
+ 'children' => ['CreateExperiment', 'CreateJob', 'DeleteExperiment', 'GetExperiment', 'GetTemplate', 'ListExperiments', 'ListImages', 'ListJobs', 'ListTemplates'],
+ 'type' => 'directory',
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateExperiment' => [
- 'summary' => '创建实验,或根据实验模版创建实验',
- '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 +50,10 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '14187',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '16683',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
@@ -118,101 +61,81 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request 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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-xfdafx093xxfd',
- ],
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '84972',
- ],
- 'TemplateId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'template-xze5df2scrxxz',
- ],
- 'Options' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
+ 'Name' => ['title' => '', 'description' => 'The name of the copied workflow draft. Maximum length: 128 characters. The name can contain Chinese and English characters.', 'type' => 'string', 'required' => true, 'example' => 'Pipeline draft name'],
+ 'Description' => ['title' => '', 'description' => 'The description of the workflow draft.', 'type' => 'string', 'example' => 'Pipeline draft description', 'required' => false],
+ 'Source' => ['title' => '', 'description' => 'The source from which the workflow draft is created.', 'type' => 'string', 'example' => 'PaiStudio', 'required' => false],
+ 'FolderId' => ['title' => '', 'description' => 'The folder ID to which the copied workflow draft belongs. This parameter is returned after you call [CreateExperimentFolder](~~2854071~~) to create a workflow draft folder.', 'type' => 'string', 'required' => true, 'example' => 'folder-erwx872xuryx'],
+ 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '84972'],
'Accessibility' => [
- 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The visibility of the workflow draft. Valid values:'."\n"
+ .'- PUBLIC: Visible to all members in the workspace.'."\n"
+ .'- PRIVATE: Visible only to you and administrators in the workspace.',
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
'example' => 'PUBLIC',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'The ID of the source workflow draft.', 'type' => 'string', 'required' => true, 'example' => 'draft-s2gf8fj160mqxyf0qd'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '42F23B58-3684-5443-848A-8DA81FF99712',
- ],
- 'ExperimentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6D161C28-9CB1-584E-8DD5-64441E32A5B3'],
+ 'ExperimentId' => ['description' => 'The ID of the copied workflow draft.', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\"\\n}","type":"json"}]',
- ],
- 'CopyExperiment' => [
- 'summary' => '复制实验',
- 'path' => '/api/v1/experiments/{ExperimentId}/copy',
- 'methods' => [
- 'post',
+ 'title' => 'Copy a workflow draft',
+ 'summary' => 'Copies a PAI Designer workflow draft.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-04T09:15:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D161C28-9CB1-584E-8DD5-64441E32A5B3\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\"\\n}","type":"json"}]',
+ ],
+ 'CreateExperiment' => [
+ 'summary' => 'Creates a PAI Designer workflow draft.',
+ 'path' => '/api/v1/experiments',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -222,10 +145,10 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '16683',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14187',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
@@ -233,105 +156,76 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The workflow draft.',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '实验名称,最大长度 128,可包含中英文',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-erwx872xuryx',
- ],
- 'WorkspaceId' => [
- 'title' => '实验创建的Workspace',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '84972',
- ],
+ 'Name' => ['description' => 'The name of the workflow draft.', 'type' => 'string', 'required' => true, 'example' => 'Pipeline draft name', 'title' => ''],
+ 'Description' => ['description' => 'The description of the workflow draft.', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft description', 'title' => ''],
+ 'Source' => ['description' => 'The source of the workflow draft.', 'type' => 'string', 'example' => 'PaiStudio', 'required' => false, 'title' => ''],
+ 'FolderId' => ['description' => 'The ID of the folder to which the workflow draft belongs.', 'type' => 'string', 'required' => true, 'example' => 'folder-xfdafx093xxfd', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '84972', 'title' => ''],
+ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'required' => false, 'example' => 'template-xze5df2scrxxz', 'title' => ''],
+ 'Options' => ['description' => 'The options of the workflow draft.', 'type' => 'string', 'example' => '{"mlflow":{"experimentId":"exp-1"}}', 'required' => false, 'title' => ''],
'Accessibility' => [
- 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The visibility of the workflow draft in the workspace. Valid values:'."\n"
+ .'- PRIVATE: visible only to you and administrators in the workspace.'."\n"
+ .'- PUBLIC: visible to all members in the workspace.',
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
'example' => 'PUBLIC',
],
],
'required' => false,
- ],
- ],
- [
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '实验Id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-s2gf8fj160mqxyf0qd',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '6D161C28-9CB1-584E-8DD5-64441E32A5B3',
- ],
- 'ExperimentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '42F23B58-3684-5443-848A-8DA81FF99712'],
+ 'ExperimentId' => ['description' => 'The ID of the workflow draft.', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D161C28-9CB1-584E-8DD5-64441E32A5B3\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\"\\n}","type":"json"}]',
- ],
- 'UpdateExperimentMeta' => [
- 'summary' => '更新实验的Meta信息',
- 'path' => '/api/v1/experiments/{ExperimentId}/meta',
- 'methods' => [
- 'put',
+ 'title' => 'Create a workflow draft',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExperiment'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreatePipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\",\\n \\"ExperimentId\\": \\"draft-rbvg5wzljzjhc9ks92\\"\\n}","type":"json"}]',
+ ],
+ 'CreateExperimentFolder' => [
+ 'summary' => 'Creates a workflow draft folder.',
+ 'path' => '/api/v1/experimentfolders',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -340,244 +234,201 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '14190',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13799',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request 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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder-xfd782efd08wex',
- ],
- 'Options' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
- 'Accessibility' => [
- 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
- 'example' => 'PUBLIC',
- ],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '45699', 'title' => ''],
+ 'Name' => ['description' => 'The name of the workflow draft.', 'type' => 'string', 'required' => true, 'example' => 'Pipeline draft name', 'title' => ''],
+ 'ParentFolderId' => ['description' => 'The parent folder ID.', 'type' => 'string', 'required' => false, 'example' => 'folder-xxfdjhfxdfad', 'title' => ''],
+ 'Source' => ['description' => 'The source from which the workflow draft is created.', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio', 'title' => ''],
+ 'Accessibility' => ['title' => '', 'description' => 'The visibility of the workflow draft in the workspace. Valid values:'."\n"
+ ."\n"
+ .'- PUBLIC'."\n"
+ .'- PRIVATE'."\n"
+ ."\n"
+ .'Default value: PUBLIC.', 'type' => 'string', 'example' => 'PUBLIC', 'required' => false],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
+ 'FolderId' => ['description' => 'The ID of the created folder.', 'type' => 'string', 'example' => 'folder-xxfdjhfxduxd', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\"\\n}","type":"json"}]',
- ],
- 'UpdateExperimentContent' => [
- 'summary' => '更新实验内容',
- 'path' => '/api/v1/experiments/{ExperimentId}/content',
- 'methods' => [
- 'put',
+ 'title' => 'Create a workflow draft folder',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'Request parameters changed'],
],
- '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' => 'All Resource', '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' => '14191',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '100051',
+ 'abilityTreeNodes' => ['FEATURElearn01UVDS'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-i1udvvwm2rlvxug29n',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{ "metadata": { "name": "实验名称", "id": "pai_exp_xxxdfafafasfa", "desc": "实验描述", }, "nodes": [ ], "edges": [ ], "globalParams": [ ], "globalSettings":[ ] }',
- ],
- 'Version' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '11',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'SourceExpId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The experiment ID in Studio 1.0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Version' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Version\\": 12\\n}","type":"json"}]',
- ],
- 'PublishExperiment' => [
- 'summary' => '发布实验',
- 'path' => '/api/v1/experiments/{ExperimentId}/publish',
- 'methods' => [
- 'put',
+ 'title' => 'Create a validation for workflow draft migration',
+ 'summary' => 'Creates a validation for workflow draft migration.',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-15T06:49:21.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'All Resource', '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',
- 'abilityTreeCode' => '92519',
- 'abilityTreeNodes' => [
- 'FEATURElearn01UVDS',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14185',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request body.',
'type' => 'object',
'properties' => [
- 'FolderId' => [
- 'title' => '公共目录Id',
- 'description' => '',
+ 'PipelineDraftId' => ['title' => '', 'description' => 'The workflow draft ID.', 'type' => 'string', 'required' => false, 'example' => 'draft-o1p0k444nlq3cd50zz'."\n"],
+ 'ExperimentId' => ['title' => '', 'description' => 'The workflow draft ID. This parameter is deprecated. Use PipelineDraftId instead.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'draft-o1p0k444nlq3cd50zz'],
+ 'ExecuteType' => [
+ 'description' => 'The job execution type. Valid values:'."\n"
+ .'- EXECUTE_ALL: runs all nodes in the workflow draft.'."\n"
+ .'- EXECUTE_ONE: runs the specified node.'."\n"
+ .'- EXECUTE_TO_HERE: runs from the root node to the specified node.'."\n"
+ .'- EXECUTE_FROM_HERE: runs from the specified node.'."\n"
+ .'- EXECUTE_CHILDREN: runs the downstream nodes of the specified node.',
+ 'enumValueTitles' => ['EXECUTE_ALL' => 'runs all nodes in the workflow draft.', 'EXECUTE_ONE' => 'runs the specified node.', 'EXECUTE_TO_HERE' => 'runs from the root node to the specified node.', 'EXECUTE_FROM_HERE' => 'runs from the specified node.', 'EXECUTE_CHILDREN' => 'runs the downstream nodes of the specified node.'],
'type' => 'string',
- 'required' => true,
- 'example' => 'root',
+ 'required' => false,
+ 'example' => 'EXECUTE_ALL',
+ 'title' => '',
],
+ 'NodeId' => ['description' => 'The workflow node ID.', 'type' => 'string', 'required' => false, 'example' => 'id-2d88-1608982098027-91558', 'title' => ''],
+ 'Options' => ['description' => 'The run options in JSON format.', 'type' => 'string', 'example' => '{"mlflow":{"experimentId":"exp-1"}}', 'required' => false, 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '5A26A7FA-EEF0-5A6B-BA76-06067547C11F',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '85082123-2A3F-52E7-B27A-F04700B82FFB'],
+ 'JobId' => ['description' => 'The workflow draft job ID.', 'type' => 'string', 'example' => 'job-jcs4mmyangk7r2zdqz', 'title' => ''],
],
+ 'example' => '',
],
],
],
@@ -585,254 +436,160 @@
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A26A7FA-EEF0-5A6B-BA76-06067547C11F\\"\\n}","type":"json"}]',
- ],
- 'GetExperiment' => [
- 'summary' => '获取实验信息',
- 'path' => '/api/v1/experiments/{ExperimentId}',
- 'methods' => [
- 'get',
+ 'title' => 'Create a workflow draft job',
+ 'summary' => 'Creates a job for a workflow draft.',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-13T07:01:16.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreateJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85082123-2A3F-52E7-B27A-F04700B82FFB\\",\\n \\"JobId\\": \\"job-jcs4mmyangk7r2zdqz\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteExperiment' => [
+ 'summary' => 'Deletes a PAI Designer workflow draft.',
+ 'path' => '/api/v1/experiments/{ExperimentId}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '14195',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DD405810-73C9-5721-996A-EA04BCC4BBF2',
- ],
- 'ExperimentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline Draft Name',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline Draft Description',
- ],
- 'GmtCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'GmtModifiedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'Creator' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1326689413376250',
- ],
- 'Source' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PaiStudio',
- ],
- 'Version' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '23487',
- ],
- 'Content' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
- 'Accessibility' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'PUBLIC' => '',
- 'PRIVATE' => '',
- ],
- 'example' => 'PUBLIC',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3'],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'GetExperimentMeta' => [
- 'summary' => '获取实验的元信息',
- 'path' => '/api/v1/experiments/{ExperimentId}/meta',
- 'methods' => [
- 'get',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Delete a workflow draft',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExperiment'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'paidesigner:DeletePipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '14188',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13803',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
+ 'name' => 'FolderId',
'in' => 'path',
- 'schema' => [
- 'title' => '实验 id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'schema' => ['description' => 'The folder ID.', 'type' => 'string', 'required' => false, 'example' => 'folder-xzf7t785nka4ch7qce', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6',
- ],
- 'ExperimentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline draft description',
- ],
- 'GmtCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'GmtModifiedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'Creator' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1326****76250',
- ],
- 'Source' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PaiStudio',
- ],
- 'Version' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12',
- ],
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '23487',
- ],
- 'Options' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
- 'Accessibility' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
- 'example' => 'PUBLIC',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'],
],
+ 'example' => '',
],
],
],
- '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',
+ 'title' => 'Delete a workflow draft folder',
+ 'summary' => 'Deletes a workflow draft folder.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExperimentFolder'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'paidesigner:DeletePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => [],
@@ -842,161 +599,140 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '14237',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13795',
+ 'abilityTreeNodes' => ['FEATURElearnZAMNTS'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-4c60c4txtaexfum1zx',
- ],
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source from which to retrieve the algorithm list. Default value: PaiStudio.', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Stopped' => 'Stopped',
- 'Running' => 'Running',
- ],
- 'example' => 'Running',
- ],
- 'Nodes' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'NodeId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'id-2317-1608984201281-74996',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'job-mewqhd72nsrqujn1px',
- ],
- 'RunId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'flow-wayrh3k605s7i51wey',
- ],
- 'RunNodeId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'node-6hc0eocnmzf4pk9njc',
- ],
- 'Status' => [
- 'description' => '',
- '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',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8CAA642F-EFEB-5F87-8F2F-ACD58B15FA03'],
+ 'Data' => ['description' => 'The algorithm definition.', 'type' => 'object', 'example' => '[{}]', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'DeleteExperiment' => [
- 'summary' => '删除实验',
- 'path' => '/api/v1/experiments/{ExperimentId}',
- 'methods' => [
- 'delete',
+ 'title' => 'Retrieve algorithm tree',
+ 'summary' => 'Retrieves the algorithm tree.',
+ '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' => 'All Resource', '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' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '19291',
+ 'abilityTreeNodes' => ['FEATURElearnZAMNTS'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'name' => 'Provider',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The provider of the algorithm. Set this parameter to pai for official algorithms.', 'type' => 'string', 'required' => true, 'example' => 'pai', 'title' => ''],
+ ],
+ [
+ 'name' => 'Identifier',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The identifier of the algorithm.', 'type' => 'string', 'required' => true, 'example' => 'logisticregression_binary', 'title' => ''],
+ ],
+ [
+ 'name' => 'AlgoVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The version of the algorithm.', 'type' => 'string', 'required' => true, 'example' => 'v1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Signature',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The signature of the algorithm. If this parameter is left empty, the latest version is used.', 'type' => 'string', 'required' => false, 'example' => '49c9904dc177eb4d58f68915f35315b6fc6ee2db', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B4F16666-FD54-5D9D-A362-53A4C66692DF'],
+ 'Spec' => ['description' => 'The spec of the algorithm definition.', 'type' => 'object', 'example' => '{}', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => 'Retrieve an algorithm definition',
+ 'summary' => 'Retrieves an algorithm definition.',
+ 'changeSet' => [
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => 'Request parameters changed'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3\\"\\n}","type":"json"}]',
- ],
- 'ListExperiments' => [
- 'summary' => '获取实验列表',
- 'path' => '/api/v1/experiments',
- 'methods' => [
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmDef'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgorithmDef',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4F16666-FD54-5D9D-A362-53A4C66692DF\\",\\n \\"Spec\\": {}\\n}","type":"json"}]',
+ ],
+ 'GetAlgorithmDefs' => [
+ 'summary' => 'Retrieves algorithm definitions in batches.',
+ 'path' => '/api/v1/algorithm/defs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1006,929 +742,756 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '14194',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '19292',
+ 'abilityTreeNodes' => ['FEATURElearnZAMNTS'],
],
'parameters' => [
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ASC' => 'ASC',
- 'DESC' => 'DESC',
- ],
- 'example' => 'DESC',
- ],
- ],
- [
- 'name' => 'ExperimentId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Pipeline draft name',
- ],
- ],
- [
- 'name' => 'Creator',
+ 'name' => 'Timestamp',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '13266******376250',
- ],
+ 'schema' => ['description' => 'The currently cached timestamp. The response includes the list of algorithms between this timestamp and the latest timestamp on the server. If this parameter is not specified, the full latest list is returned.', 'type' => 'string', 'required' => false, 'example' => '1709950208', 'title' => ''],
],
[
- 'name' => 'Source',
+ 'name' => 'LatestTimestamp',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'schema' => ['description' => 'The latest version timestamp returned by the server. If this parameter is not specified, the latest timestamp is automatically retrieved.', 'type' => 'string', 'required' => false, 'example' => '1709950208', 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'RangeStart',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '34875',
- ],
+ 'schema' => ['description' => 'The start of the range for the current page when retrieving algorithm definitions by page. The interval is closed at this end.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'SortBy',
+ 'name' => 'RangeEnd',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GmtCreate',
- ],
+ 'schema' => ['description' => 'The end of the range for the current page when retrieving algorithm definitions by page. The interval is open at this end.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '9708FB85-232F-5F9A-9D67-7F9CCCE20E06',
- ],
- 'Experiments' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
+ 'Specs' => [
+ 'description' => 'The list of algorithm definitions.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ExperimentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline draft description',
- ],
- 'GmtCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'GmtModifiedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'Creator' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1326*******76250',
- ],
- 'Source' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PaiStudio',
- ],
- 'Version' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '23487',
- ],
- 'Accessibility' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'PUBLIC' => 'PUBLIC',
- 'PRIVATE' => 'PRIVATE',
- ],
- 'example' => 'PUBLIC',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '15',
+ 'items' => ['description' => 'The algorithm definition.', 'type' => 'object', 'example' => '{}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'CreateJob' => [
- 'summary' => '创建一个工作流的作业',
- 'path' => '/api/v1/jobs',
- 'methods' => [
- 'post',
+ 'title' => 'Retrieve algorithm definitions in batches',
+ 'changeSet' => [
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmDefs'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgorithmDefs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '14185',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '19289',
+ 'abilityTreeNodes' => ['FEATURElearnZAMNTS'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'PipelineDraftId' => [
- 'title' => '工作流草稿ID。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'draft-o1p0k444nlq3cd50zz'."\n",
- ],
- 'ExperimentId' => [
- 'title' => '工作流草稿Id,已经废弃,建议使用PipelineDraftId。',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id-2d88-1608982098027-91558',
- ],
- 'Options' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"mlflow":{"experimentId":"exp-1"}}',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source from which to retrieve the algorithm list. Default value: PaiStudio.', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The workspace ID. If you specify a workspace ID, the algorithm tree results are filtered based on whether GPU resources are enabled for the workspace.', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '85082123-2A3F-52E7-B27A-F04700B82FFB',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'job-jcs4mmyangk7r2zdqz',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '46B59732-033F-5C96-9B15-1E05E7705548'],
+ 'Tree' => [
+ 'description' => 'The algorithm tree.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The algorithm definition.', '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"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'Timestamp' => ['description' => 'The timestamp when the algorithm tree was last updated.', 'type' => 'string', 'example' => '20210317101023', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => 'Retrieve algorithm tree',
+ 'summary' => 'Retrieves the algorithm tree.',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-27T11:32:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-03-29T08:16:51.000Z', 'description' => 'OpenAPI offline'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85082123-2A3F-52E7-B27A-F04700B82FFB\\",\\n \\"JobId\\": \\"job-jcs4mmyangk7r2zdqz\\"\\n}","type":"json"}]',
- ],
- 'GetJob' => [
- 'summary' => '获取一个PAI Studio作业详情',
- 'path' => '/api/v1/jobs/{JobId}',
- 'methods' => [
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmTree'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgorithmTree',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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' => 'Retrieves a PAI Designer workflow draft.',
+ 'path' => '/api/v1/experiments/{ExperimentId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '14186',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14195',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'Verbose',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'JobId',
+ 'name' => 'ExperimentId',
'in' => 'path',
'schema' => [
- 'description' => '',
+ 'description' => 'The workflow draft ID.',
+ 'enumValueTitles' => [],
'type' => 'string',
'required' => true,
- 'example' => 'job-6xfhrofqx93y139fg3',
+ 'example' => 'draft-rbvg5wzljzjhc9ks92',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The workflow draft.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
- ],
- 'ExperimentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '86995',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'job-6xfhrofqx93y139fg3'."\n",
- ],
- 'Snapshot' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'ExecuteType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EXECUTE_TO_HERE',
- ],
- 'NodeId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'id-xxxxx',
- ],
- 'RunInfo' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'flow-lcs8ez11961l6urc3m',
- ],
- 'PaiflowNodeId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'node-5dzotrnwyzfxmbwwc8'."\n",
- ],
- 'Creator' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '13266*******76250',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Succeeded',
- ],
- 'GmtCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-21T17:12:35.232Z',
- ],
- 'Arguments' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD405810-73C9-5721-996A-EA04BCC4BBF2'],
+ 'ExperimentId' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
+ 'Name' => ['description' => 'The name of the workflow draft.', 'type' => 'string', 'example' => 'Pipeline Draft Name', 'title' => ''],
+ 'Description' => ['description' => 'The description of the workflow draft.', 'type' => 'string', 'example' => 'Pipeline Draft Description', 'title' => ''],
+ 'GmtCreateTime' => ['description' => 'The creation time in UTC, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''],
+ 'GmtModifiedTime' => ['description' => 'The last modification time of the workflow in UTC, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''],
+ 'Creator' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '13266*******76250', 'title' => ''],
+ 'Source' => ['description' => 'The source of the workflow draft.', 'type' => 'string', 'example' => 'PaiStudio', 'title' => ''],
+ 'Version' => ['description' => 'The version of the workflow draft. The version is automatically incremented each time the content is updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '23487', 'title' => ''],
+ 'Content' => ['description' => 'The content of the workflow draft, in JSON format.', '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":[]}', 'title' => ''],
+ 'Options' => ['description' => 'The workflow options, in JSON format.', 'type' => 'string', 'example' => '{"mlflow":{"experimentId":"exp-1"}}', 'title' => ''],
+ 'Accessibility' => [
+ 'description' => 'The visibility of the workflow draft in the workspace. Valid values:'."\n"
+ .'- PRIVATE: Visible only to you and administrators in this workspace.'."\n"
+ .'- PUBLIC: Visible to all members in this workspace.',
+ 'enumValueTitles' => ['PUBLIC' => 'Public.', 'PRIVATE' => 'Private.'],
'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"',
+ 'example' => 'PUBLIC',
+ 'title' => '',
],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => 'Get workflow draft',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'Response parameters changed'],
],
- '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"}]',
- ],
- 'ListJobs' => [
- 'summary' => '获取作业详情',
- 'path' => '/api/v1/jobs',
- 'methods' => [
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperiment'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Lists the subfolders or workflow drafts within a specified workflow draft folder.',
+ 'path' => '/api/v1/experimentfolders/{FolderId}/children',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '14206',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '13806',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
+ 'name' => 'FolderId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The ID of the parent folder whose members you want to list. Set this parameter to root to specify the root directory.', 'type' => 'string', 'required' => true, 'example' => 'folder-xzf7t7****ch7qce', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-8up80bg0k1q23stml6',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''],
],
[
- 'name' => 'Creator',
+ 'name' => 'OnlyFolder',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '13266*******76250',
- ],
+ 'schema' => ['description' => 'Specifies whether to list only folders.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'Order',
+ 'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ASC' => 'ASC',
- 'DESC' => 'DESC',
- ],
- 'example' => 'DESC',
- ],
+ 'schema' => ['description' => 'The creation source.', 'type' => 'string', 'example' => 'PaiStudio', 'required' => false, 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'Accessibility',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The visibility within the workspace. Valid values:'."\n"
+ .'- PRIVATE: Visible only to you and administrators in this workspace.'."\n"
+ .'- PUBLIC: Visible to all users in this workspace.', 'type' => 'string', 'example' => 'PUBLIC', 'required' => false],
],
[
- 'name' => 'PageSize',
+ 'name' => 'UserId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'If FolderId is set to root and Accessibility is set to PRIVATE, this parameter specifies the owner of the private root path. Default value: the current visitor.', 'type' => 'string', 'required' => false, 'example' => '12345******13324'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Jobs' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''],
+ 'Items' => [
+ 'description' => 'The list of members.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The member details.',
'type' => 'object',
'properties' => [
- 'ExperimentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'draft-4x4iv3a9enuxw4vgka',
- ],
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '94436',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'job-mewqhd72nsrqujn1px',
- ],
- 'ExecuteType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EXECUTE_ALL',
- ],
- 'NodeId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'nodeId1',
- ],
- 'RunId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'flow-aayfouai80i980ncvz',
- ],
- 'PaiflowNodeId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'node-xdfasf8ewxfdaddl',
- ],
- 'Creator' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '17677*******89598',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'GmtCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-21T17:12:35.232Z',
- ],
+ 'Id' => ['description' => 'The ID of the workflow draft or workflow draft folder.', 'type' => 'string', 'example' => 'folder-xzf7t7****ch7qce', 'title' => ''],
+ 'Name' => ['description' => 'The name of the workflow draft or workflow draft folder.', 'type' => 'string', 'example' => 'Pipeline draft name', 'title' => ''],
+ 'Type' => ['description' => 'The type. Valid values:'."\n"
+ .'* pipelinedraft: a workflow draft.'."\n"
+ .'* dir: a workflow draft folder.', 'type' => 'string', 'example' => 'dir', 'title' => ''],
+ 'Icon' => ['description' => 'The icon used by the workflow draft or workflow draft folder. Valid values: icon-folder and icon-pipelinedraft.', 'type' => 'string', 'example' => 'icon-folder', 'title' => ''],
+ 'Empty' => ['description' => 'Indicates whether the folder is empty.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'GmtCreateTime' => ['title' => '', 'description' => 'The creation time in UTC, in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:51:33.028Z'],
+ 'GmtModifiedTime' => ['title' => '', 'description' => 'The modification time in UTC, in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:51:33.028Z'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => 'List members in a workflow draft folder',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-23T04:23:32.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'Request parameters changed'],
],
- '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"}]',
- ],
- 'StopJob' => [
- 'summary' => '停止一个实验的作业',
- 'path' => '/api/v1/jobs/{JobId}/stop',
- 'methods' => [
- 'put',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentFolderChildren'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftFolderChildren',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Queries the metadata of a workflow draft.',
+ 'path' => '/api/v1/experiments/{ExperimentId}/meta',
+ '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' => '14188',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'job-i4vmjfsv5i1kowo4ih',
- ],
+ 'schema' => ['title' => '', 'description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'],
+ 'ExperimentId' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
+ 'Name' => ['description' => 'The name of the workflow draft.', 'type' => 'string', 'example' => 'Pipeline draft name', 'title' => ''],
+ 'Description' => ['description' => 'The description of the workflow draft.', 'type' => 'string', 'example' => 'Pipeline draft description', 'title' => ''],
+ 'GmtCreateTime' => ['description' => 'The creation time in UTC, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''],
+ 'GmtModifiedTime' => ['description' => 'The last modification time of the workflow draft in UTC, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''],
+ 'Creator' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '1326****76250', 'title' => ''],
+ 'Source' => ['description' => 'The source of the workflow draft.', 'type' => 'string', 'example' => 'PaiStudio', 'title' => ''],
+ 'Version' => ['description' => 'The version of the workflow draft. The version is incremented each time the content is updated.', 'type' => 'string', 'example' => '12', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '23487', 'title' => ''],
+ 'Options' => ['description' => 'The options of the workflow draft.', 'type' => 'string', 'example' => '{"mlflow":{"experimentId":"exp-1"}}', 'title' => ''],
+ 'Accessibility' => [
+ 'description' => 'The visibility of the workspace. Valid values:'."\n"
+ .'- PRIVATE: Visible only to you and administrators in this workspace.'."\n"
+ .'- PUBLIC: Visible to all users in this workspace.',
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
'type' => 'string',
- 'example' => '431C53C4-BDD0-588F-8081-4437B00852B5',
+ 'example' => 'PUBLIC',
+ 'title' => '',
],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => 'Query workflow draft metadata',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'Response parameters changed'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"431C53C4-BDD0-588F-8081-4437B00852B5\\"\\n}","type":"json"}]',
- ],
- 'StopExperiment' => [
- 'summary' => '停止实验所有运行中的作业',
- 'path' => '/api/v1/experiments/{ExperimentId}/stop',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentMeta'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Retrieves the status of a workflow draft and the nodes within it.',
+ 'path' => '/api/v1/experiments/{ExperimentId}/status',
+ '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' => '14237',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-i1udvvwm2rlvxug29n',
- ],
+ 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-4c60c4txtaexfum1zx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
+ 'Status' => [
+ 'description' => 'The workflow draft status. Valid values:'."\n"
+ .'* Running: The workflow draft has running jobs.'."\n"
+ .'* Stopped: The workflow draft has no running jobs.',
+ 'enumValueTitles' => ['Stopped' => 'Stopped', 'Running' => 'Running'],
'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
+ 'example' => 'Running',
+ 'title' => '',
+ ],
+ 'Nodes' => [
+ 'description' => 'The node statuses in the workflow draft.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The node information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeId' => ['description' => 'The node ID in the workflow draft.', 'type' => 'string', 'example' => 'id-2317-1608984201281-74996', 'title' => ''],
+ 'JobId' => ['description' => 'The workflow draft job ID created by the most recent run of the node.', 'type' => 'string', 'example' => 'job-mewqhd72nsrqujn1px', 'title' => ''],
+ 'RunId' => ['description' => 'The ID of the PaiFlow PipelineRun created by the most recent run of the node.', 'type' => 'string', 'example' => 'flow-wayrh3k605s7i51wey', 'title' => ''],
+ 'RunNodeId' => ['description' => 'The node ID in the PaiFlow PipelineRun that corresponds to the most recent run of the node.', 'type' => 'string', 'example' => 'node-6hc0eocnmzf4pk9njc', 'title' => ''],
+ 'Status' => ['description' => 'The task status. The status is consistent with the status in PaiFlow. Valid values:'."\n"
+ .'* Initialized: Initialization is complete.'."\n"
+ .'* Starting: The task is starting.'."\n"
+ .'* WorkflowServiceStarting: The task is being prepared for submission.'."\n"
+ .'* Running: The task is running.'."\n"
+ .'* Succeeded: The task succeeded.'."\n"
+ .'* Failed: The task failed.'."\n"
+ .'* Terminating: The task is being terminated.'."\n"
+ .'* Terminated: The task is terminated.'."\n"
+ .'* Unknown: The task status is unknown.'."\n"
+ .'* Skipped: The task is skipped because a preceding node failed.'."\n"
+ .'* ReadyToSchedule: The task is ready to run because a preceding node has not completed.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'StartedAt' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z', 'title' => ''],
+ 'FinishedAt' => ['description' => 'The task end time.', 'type' => 'string', 'example' => '2021-01-21T18:12:35.232Z', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
- ],
- 'CreateExperimentFolder' => [
- 'summary' => '创建算法文件夹',
- 'path' => '/api/v1/experimentfolders',
- 'methods' => [
- 'post',
+ 'title' => 'Query workflow draft status',
+ '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' => 'All Resource', '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' => 'Obtains the visualization meta information of a workflow draft.',
+ 'path' => '/api/v1/experiments/{ExperimentId}/visualizationMeta',
+ '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' => '42908',
+ 'abilityTreeNodes' => ['FEATURElearnUEX4WU'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '45699',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Pipeline draft name',
- ],
- 'ParentFolderId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder-xxfdjhfxdfad',
- ],
- 'Source' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
- 'Accessibility' => [
- 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PUBLIC',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
+ ],
+ [
+ 'name' => 'NodeIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The list of node IDs in the workflow draft, separated by commas. If this parameter is left empty, all nodes in the workflow draft are queried.', 'type' => 'string', 'example' => 'node_id1,node_id2', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
- ],
- 'FolderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'folder-xxfdjhfxduxd',
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A84A1282-D3E7-5198-9E8E-2AD09C78C6C1'],
+ 'VisualizationMeta' => [
+ 'description' => 'The list of visualization metadata.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The visualization information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'node_id1', 'title' => ''],
+ 'NodeName' => ['description' => 'The node name.', 'type' => 'string', 'example' => '直方图_1', 'title' => ''],
+ 'Meta' => ['description' => 'The visualization data meta in JSON format.', '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"
+ .'}', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"FolderId\\": \\"folder-xxfdjhfxduxd\\"\\n}","type":"json"}]',
- ],
- 'UpdateExperimentFolder' => [
- 'summary' => '更新算法文件夹',
- 'path' => '/api/v1/experimentfolders/{FolderId}',
- 'methods' => [
- 'put',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Get Visualization Meta of Workflow Draft',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-26T02:22:18.000Z', 'description' => 'OpenAPI offline'],
],
- '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' => 'All Resource', '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' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '13802',
- 'abilityTreeNodes' => [
- 'FEATURElearn1QDD9Y',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '61666',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder1',
- ],
- 'ParentFolderId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder-xzf7t785nka4c2334',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'WorkspaceIds',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The list of workspace IDs. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '123,345', 'title' => ''],
],
[
- 'name' => 'FolderId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-xzf7t785nka4ch7qce',
- ],
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source from which the stream draft was created.', 'type' => 'string', 'example' => 'PaiStudio', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Data' => [
+ 'description' => 'The returned result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The workspace statistics information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '16381', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of stream drafts in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'CreateCount' => ['description' => 'The number of stream drafts created by the current user in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]',
- ],
- 'GetExperimentFolderChildren' => [
- 'summary' => '获取算法文件夹下的内容',
- 'path' => '/api/v1/experimentfolders/{FolderId}/children',
- 'methods' => [
- 'get',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Count stream drafts in a workspace',
+ 'summary' => 'Retrieves experiment statistics information.',
+ 'description' => 'Counts the number of stream drafts in a workspace.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentsStatistics'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftsStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Retrieves the list of owners of experiments or folders.',
+ 'path' => '/api/v1/statistics/experimentsusers',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1937,394 +1500,406 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '13806',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '92531',
+ 'abilityTreeNodes' => ['FEATURElearn1QDD9Y'],
],
'parameters' => [
[
- 'name' => 'FolderId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'folder-xzf7t7****ch7qce',
- ],
- ],
- [
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
- ],
- [
- 'name' => 'OnlyFolder',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''],
],
[
'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
- ],
- [
- 'name' => 'Accessibility',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PUBLIC',
- ],
- ],
- [
- 'name' => 'UserId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '若FolderId为root,Accessibility为PRIVATE,这里代表私有根路径的所有者,默认为访问者自己',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345******13324',
- ],
+ 'schema' => ['description' => 'The source from which the workflow draft is created.', 'type' => 'string', 'example' => 'PaiStudio', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'Items' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
+ 'Users' => [
+ 'description' => 'The list of users.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The user information.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'folder-xzf7t7****ch7qce',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline draft name',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dir',
- ],
- 'Icon' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'icon-folder',
- ],
- 'Empty' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'GmtCreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'format' => 'iso8601',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'GmtModifiedTime' => [
- 'title' => '修改时间',
- 'description' => '',
- 'type' => 'string',
- 'format' => 'iso8601',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
+ 'UserId' => ['description' => 'The UID of the user.', 'type' => 'string', 'example' => '12345******67890', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'DeleteExperimentFolder' => [
- 'summary' => '删除算法文件夹',
- 'path' => '/api/v1/experimentfolders/{FolderId}',
- 'methods' => [
- 'delete',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'List users who created workflow drafts',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentsUsersStatistics'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftsUsersStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Queries the details of a stream draft job.',
+ 'path' => '/api/v1/jobs/{JobId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '13803',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14186',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'FolderId',
+ 'name' => 'Verbose',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to query task details.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'JobId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'folder-xzf7t785nka4ch7qce',
- ],
+ 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'job-6xfhrofqx93y139fg3', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
+ 'ExperimentId' => ['description' => 'The stream draft ID.', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '86995', 'title' => ''],
+ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'job-6xfhrofqx93y139fg3'."\n", 'title' => ''],
+ 'Snapshot' => ['description' => 'The job snapshot.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'ExecuteType' => ['description' => 'The execution type. Valid values:'."\n"
+ .'- EXECUTE_ALL: runs all nodes in the stream draft.'."\n"
+ .'- EXECUTE_ONE: runs a specified node.'."\n"
+ .'- EXECUTE_TO_HERE: runs from the root node to the specified node.'."\n"
+ .'- EXECUTE_FROM_HERE: runs from the specified node.'."\n"
+ .'- EXECUTE_CHILDREN: runs the downstream nodes of the specified node.', 'type' => 'string', 'example' => 'EXECUTE_TO_HERE', 'title' => ''],
+ 'NodeId' => ['description' => 'The node ID in the stream draft.', 'type' => 'string', 'example' => 'id-xxxxx', 'title' => ''],
+ 'RunInfo' => ['description' => 'The manifests of the pipeline run that corresponds to the job.', '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: {}', 'title' => ''],
+ 'RunId' => ['description' => 'The pipeline run ID in PAIFlow.', 'type' => 'string', 'example' => 'flow-lcs8ez11961l6urc3m', 'title' => ''],
+ 'PaiflowNodeId' => ['description' => 'The pipeline run node ID in PAIFlow.', 'type' => 'string', 'example' => 'node-5dzotrnwyzfxmbwwc8'."\n", 'title' => ''],
+ 'Creator' => ['description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '13266*******76250', 'title' => ''],
+ 'Status' => ['description' => 'The job status. Valid values:'."\n"
+ .'- Initialized: The job is initialized.'."\n"
+ .'- Starting: The job is starting.'."\n"
+ .'- WorkflowServiceStarting: The job is being prepared for submission.'."\n"
+ .'- Running: The job is running.'."\n"
+ .'- Succeeded: The job succeeded.'."\n"
+ .'- Failed: The job failed.'."\n"
+ .'- Terminating: The job is being terminated.'."\n"
+ .'- Terminated: The job is terminated.'."\n"
+ .'- Unknown: The job status is unknown.'."\n"
+ .'- Skipped: The job is skipped because a predecessor node failed.'."\n"
+ .'- ReadyToSchedule: The job is ready to run because a predecessor node has not completed.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
+ 'GmtCreateTime' => ['description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z', 'title' => ''],
+ 'Arguments' => ['description' => 'The arguments of the PAIFlow pipeline run.', '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"', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\"\\n}","type":"json"}]',
- ],
- 'GetAlgorithmTree' => [
- 'summary' => '获取算法树',
- 'path' => '/api/v1/algorithm/tree',
- 'methods' => [
- 'get',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Query stream draft job details',
+ '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' => 'All Resource', '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' => 'Retrieves the schema of a MaxCompute table.',
+ 'path' => '/api/v1/datasources/maxcompute/tables/{TableName}/schema',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '19289',
- 'abilityTreeNodes' => [
- 'FEATURElearnZAMNTS',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14093',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'name' => 'TableName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the MaxCompute table.', 'type' => 'string', 'required' => true, 'pattern' => '^([a-zA-Z][a-zA-Z0-9_]*\\.)?[a-zA-Z0-9_]+$', 'example' => 'table_name', 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间ID。指定工作空间ID后,将根据当前工作空间是否开通GPU资源对算法树结果进行过滤。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '46B59732-033F-5C96-9B15-1E05E7705548',
- ],
- 'Tree' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Columns' => [
+ 'description' => 'The column information.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The MaxCompute table column.',
'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' => ['description' => 'The column name.', 'type' => 'string', 'example' => 'column1', 'title' => ''],
+ 'Type' => ['description' => 'The column type.', 'type' => 'string', 'example' => 'STRING', 'title' => ''],
+ 'Preview' => [
+ 'description' => 'The data preview of the column.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The data in the column.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'Timestamp' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20210317101023',
+ 'PartitionColumns' => [
+ 'description' => 'The partition columns. If this parameter is empty, the table is a non-partitioned table.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The partition column name.', 'type' => 'string', 'example' => 'dt', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'GetAlgorithmDef' => [
- 'summary' => '获取算法定义',
- 'path' => '/api/v1/algorithm/def',
- 'methods' => [
- 'get',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Retrieve the schema of a maxCompute table',
+ 'changeSet' => [
+ ['createdAt' => '2023-07-18T02:23:20.000Z', 'description' => 'Request parameters changed'],
+ ],
+ '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' => 'All Resource', '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' => 'Retrieves the input schema of a node.',
+ 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/schema',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '19291',
- 'abilityTreeNodes' => [
- 'FEATURElearnZAMNTS',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14196',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'Provider',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'pai',
- ],
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'experiment-rbvg5wzljzjhc9ks92', 'title' => ''],
],
[
- 'name' => 'Identifier',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'logisticregression_binary',
- ],
+ 'name' => 'NodeId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The node ID in the workflow draft.', 'type' => 'string', 'required' => true, 'example' => 'ff1f33b0-426a-46bb-bb30-4a5648058079', 'title' => ''],
],
[
- 'name' => 'AlgoVersion',
+ 'name' => 'InputId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v1',
- ],
+ 'schema' => ['description' => 'The name of the input port of the experiment node. If this parameter is left empty, the merged schema of the entire node is returned.', 'type' => 'string', 'example' => 'inputTable', 'required' => false, 'title' => ''],
],
[
- 'name' => 'Signature',
+ 'name' => 'InputIndex',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5vqe4Sgtzw8E6opyK3HkK+nzYlY=',
- ],
+ 'schema' => ['description' => 'The index of the variable port extension, starting from 0. This parameter is used when the port is a variable port.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B4F16666-FD54-5D9D-A362-53A4C66692DF',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CEB07647-8A5D-56F1-8B99-361BCF51402F'],
+ 'ColNames' => [
+ 'description' => 'The names of the columns in the input table.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The column name.', 'type' => 'string', 'example' => 'col1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'Spec' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '{}',
+ 'ColTypes' => [
+ 'description' => 'The types of the columns in the input table.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The column type.', 'type' => 'string', 'example' => 'STRING', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4F16666-FD54-5D9D-A362-53A4C66692DF\\",\\n \\"Spec\\": {}\\n}","type":"json"}]',
- ],
- 'ListRecentExperiments' => [
- 'summary' => '获取最近的实验',
- 'path' => '/api/v1/recentexperiments',
- 'methods' => [
- 'get',
+ 'title' => 'Get node input 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' => 'All Resource', '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' => 'Gets the output model information of a specific node.',
+ 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/outputs/{OutputId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2333,508 +1908,657 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '61667',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14234',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'Order',
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The node ID in the workflow draft.', 'type' => 'string', 'required' => true, 'example' => 'node-5dzotrnwyzfxmbwwc8', 'title' => ''],
+ ],
+ [
+ 'name' => 'OutputId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The output port ID of the algorithm node.', 'type' => 'string', 'required' => true, 'example' => 'outputId', 'title' => ''],
+ ],
+ [
+ 'name' => 'OutputIndex',
'in' => 'query',
+ 'schema' => ['description' => 'The index of a variable-length node, starting from 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DESC',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '601FD8B1-78EB-5220-844C-92AC2EDAF7E1'],
+ 'NodeName' => ['description' => 'The node name.', 'type' => 'string', 'example' => '逻辑回归二分类-1', 'title' => ''],
+ 'AlgoName' => ['description' => 'The algorithm name.', 'type' => 'string', 'example' => '逻辑回归二分类', 'title' => ''],
+ 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => '逻辑回归二分类-2-outputModel', 'title' => ''],
+ 'Type' => ['description' => 'The type. Valid values: Model, DataSet.', 'type' => 'string', 'example' => 'Model', 'title' => ''],
+ 'Value' => ['description' => 'The content of the output. Different output types correspond to different keys.', '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"
+ .'}', 'title' => ''],
+ 'LocationType' => ['description' => 'The model location. Valid values:'."\n"
+ .'* MaxComputeTable: MaxCompute table.'."\n"
+ .'* OSS: OSS.', 'type' => 'string', 'example' => 'MaxComputeTable', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Get the output model information of a specific node',
+ 'changeSet' => [
+ ['createdAt' => '2021-03-01T06:16:56.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeOutput'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftNodeOutput',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Retrieves a specified template in PAI Studio.',
+ 'path' => '/api/v1/templates/{TemplateId}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14197',
+ 'abilityTreeNodes' => ['FEATURElearnP4ZCX3', 'FEATURElearnEACGUC'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'required' => true, 'example' => 'template-12345', 'description' => '', 'title' => ''],
+ ],
[
- 'name' => 'Type',
+ 'name' => 'Verbose',
'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Modified' => 'Modified',
- 'Created' => 'Created',
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => ''],
+ 'TemplateId' => ['type' => 'string', 'example' => 'template-12345', 'description' => '', 'title' => ''],
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ImageLink' => ['type' => 'string', 'example' => 'URL://xxx', 'description' => '', 'title' => ''],
+ 'DocLink' => ['type' => 'string', 'example' => 'URL://xxx', 'description' => '', 'title' => ''],
+ 'Detail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Content' => ['type' => 'string', 'example' => '{ "metadata": { "name": "实验名称", "id": "pai_exp_xxxdfafafasfa", "desc": "实验描述", }, "nodes": [ ], "edges": [ ], "globalParams": [ ], "globalSettings":[ ] }', 'description' => '', 'title' => ''],
+ 'SourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'SourceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TemplateType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Labels' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
],
- 'example' => 'Modified',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'changeSet' => [
+ ['createdAt' => '2022-12-02T05:58:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '86995',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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"}]',
+ 'title' => '',
+ ],
+ 'ListAuthRoles' => [
+ 'summary' => 'Get the list of authorization roles.',
+ 'path' => '/api/v1/authorization/roles',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PageNumber',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '21720',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'IsGenerateToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'Specifies whether to generate an STS temporary token. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Experiments' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8E2C1BB9-57C4-5051-9EF2-570ADC03A164'],
+ 'Roles' => [
+ 'description' => 'The list of roles.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The role information.',
'type' => 'object',
'properties' => [
- 'ExperimentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'draft-76p70ye0gwv3vbur55',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline draft name',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pipeline draft description',
- ],
- 'RecentGmtModifiedTime' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '15821',
- ],
- 'WorkspaceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Workspace name',
+ 'RoleName' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'AliyunODPSPAIDefaultRole', 'title' => ''],
+ 'RoleARN' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the role.', 'type' => 'string', 'example' => 'acs:ram::1557********904:role/aliyunodpspaidefaultrole', 'title' => ''],
+ 'IsEnabled' => ['description' => 'Indicates whether the role is available.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'Token' => [
+ 'description' => 'The role credential information. This parameter is deprecated.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SecurityToken' => ['description' => 'The security token generated by STS.', 'type' => 'string', 'example' => 'CAISggJ1q6Ft5B2yf***************aAaDf+bmceH2MNtNe9XtmTXJytadQ2T0RT8uOA+4kSypOPxSHjdjmnQjbdA/Q9MyNtTErQ/m45RNsg==', 'title' => ''],
+ 'AccessKeyId' => ['description' => 'The AccessKey ID generated by STS.', 'type' => 'string', 'example' => 'STS.NU************TT5LoC', 'title' => ''],
+ 'AccessKeySecret' => ['description' => 'The AccessKey secret generated by STS.', 'type' => 'string', 'example' => 'E1h2n66Duo1D**********c79JVk59R6i', 'title' => ''],
+ 'Expiration' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2021-03-19T19:14:42Z', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RoleType' => ['description' => 'The type of the role.', 'type' => 'string', 'example' => 'PaiStudio', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '23',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ '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' => 'Get the list of authorization roles',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-06T08:49:28.000Z', 'description' => 'OpenAPI offline'],
],
- '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',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAuthRoles'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListAuthRoles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListExperiments' => [
+ 'summary' => 'Retrieves a list of workflow drafts in PAI Designer.',
+ 'path' => '/api/v1/experiments',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '14198',
- 'abilityTreeNodes' => [
- 'FEATURElearnEACGUC',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14194',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number of the list. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false, 'title' => ''],
],
[
- 'name' => 'Source',
+ 'name' => 'Order',
'in' => 'query',
'schema' => [
+ 'description' => 'The sort order. Valid values:'."\n"
+ .'- DESC: descending order.'."\n"
+ .'- ASC: ascending order.',
+ 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'],
'type' => 'string',
+ 'example' => 'DESC',
'required' => false,
- 'example' => 'PaiStudio',
+ 'title' => '',
],
],
[
- 'name' => 'List',
+ 'name' => 'ExperimentId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'example' => 'types',
- ],
+ 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92', 'required' => false, 'title' => ''],
],
[
- 'name' => 'TagId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'example' => 'template-tag-12345',
- ],
+ 'schema' => ['description' => 'The workflow draft name.', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft name', 'title' => ''],
],
[
- 'name' => 'Order',
+ 'name' => 'Creator',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'example' => 'DESC',
- ],
+ 'schema' => ['description' => 'The UID of the creator.', 'type' => 'string', 'example' => '13266******376250', 'required' => false, 'title' => ''],
],
[
- 'name' => 'TypeId',
+ 'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'example' => 'template-type-12345',
- ],
+ 'schema' => ['description' => 'The source from which the workflow draft was created.', 'type' => 'string', 'example' => 'PaiStudio', 'required' => false, 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '34875', 'title' => ''],
],
[
- 'name' => 'TemplateType',
+ 'name' => 'SortBy',
'in' => 'query',
+ 'schema' => ['description' => 'The field by which to sort results. Valid values:'."\n"
+ .'* GmtCreate: the time when the workflow draft was created.'."\n"
+ .'* GmtModified: the time when the workflow draft was last modified.', 'type' => 'string', 'example' => 'GmtCreate', 'required' => false, 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9708FB85-232F-5F9A-9D67-7F9CCCE20E06'],
+ 'Experiments' => [
+ 'description' => 'The list of workflow drafts.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the workflow draft.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExperimentId' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
+ 'Name' => ['description' => 'The workflow draft name.', 'type' => 'string', 'example' => 'Pipeline draft name', 'title' => ''],
+ 'Description' => ['description' => 'The description of the workflow draft.', 'type' => 'string', 'example' => 'Pipeline draft description', 'title' => ''],
+ 'GmtCreateTime' => ['description' => 'The time when the workflow draft was created, in UTC. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''],
+ 'GmtModifiedTime' => ['description' => 'The time when the workflow draft was last modified, in UTC. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''],
+ 'Creator' => ['description' => 'The UID of the workflow draft creator.', 'type' => 'string', 'example' => '1326*******76250', 'title' => ''],
+ 'Source' => ['description' => 'The source from which the workflow draft was created.', 'type' => 'string', 'example' => 'PaiStudio', 'title' => ''],
+ 'Version' => ['description' => 'The current version of the workflow draft.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '23487', 'title' => ''],
+ 'Accessibility' => [
+ 'description' => 'The visibility of the workflow draft. Valid values:'."\n"
+ .'- PUBLIC: The workflow draft is visible to all members in the workspace.'."\n"
+ .'- PRIVATE: The workflow draft is visible only to you and administrators in the workspace.',
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
+ 'type' => 'string',
+ 'example' => 'PUBLIC',
+ 'title' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TotalCount' => ['description' => 'The total number of workflow drafts.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'title' => 'List workflow drafts',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExperiments'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Label',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListPipelineDrafts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Lists labels.',
+ 'path' => '/api/v1/image/labels',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Name',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '20007',
+ 'abilityTreeNodes' => ['FEATURElearnAFIS9K'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'LabelKeys',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['title' => '', 'description' => 'A comma-separated list of labels.', 'type' => 'string', 'example' => 'ImageType,Framework,Platform'],
],
[
- 'name' => 'Verbose',
+ 'name' => 'LabelFilter',
'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- ],
+ 'schema' => ['title' => '', 'description' => 'The image filter condition. Retrieves all labels of images that meet the specified condition.', 'type' => 'string', 'example' => 'a=b,c=d'],
],
[
- 'name' => 'SortBy',
+ 'name' => 'ImageId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['title' => '', 'description' => 'The image ID.', 'type' => 'string', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
- 'TemplateData' => [
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => ''],
+ 'Labels' => [
+ 'title' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- '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',
- ],
- 'Labels' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- ],
- ],
- ],
- ],
- 'TemplateTag' => [
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'type' => 'string',
- 'example' => 'PyTorch',
- ],
- 'TagId' => [
- 'type' => 'string',
- 'example' => 'template-tag-rbvg5wzljzjhc9ks92',
- ],
- 'TypeId' => [
- 'type' => 'string',
- 'example' => 'template-tag-type-rbvg5wzljzjhc9ks92',
- ],
- ],
- ],
- 'TemplateType' => [
- 'type' => 'object',
- 'properties' => [
- 'TypeId' => [
- 'type' => 'string',
- 'example' => 'templatetagtype-rbvg5wzljzjhc9ks92',
- ],
- 'Name' => [
- 'type' => 'string',
- 'example' => '行业分类',
- ],
- ],
- ],
+ 'Key' => ['title' => '', 'description' => 'The key.', 'type' => 'string', 'example' => ''],
+ 'Value' => ['title' => '', 'description' => 'The value.', 'type' => 'string', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The image labels.',
+ 'example' => '',
],
+ 'TotalCount' => ['title' => '', 'description' => 'The number of results that match the filter condition.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'changeSet' => [
+ ['createdAt' => '2021-04-08T08:41:16.000Z', 'description' => 'OpenAPI offline'],
],
- 'responseDemo' => null,
- ],
- 'GetTemplate' => [
- 'summary' => '获取PAI Studio中指定模板',
- 'path' => '/api/v1/templates/{TemplateId}',
- 'methods' => [
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageLabels'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListImageLabels',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]',
+ 'title' => '',
+ ],
+ 'ListImages' => [
+ 'path' => '/api/v1/images',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '14197',
- 'abilityTreeNodes' => [
- 'FEATURElearnP4ZCX3',
- 'FEATURElearnEACGUC',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '20013',
+ 'abilityTreeNodes' => ['FEATURElearnAFIS9K'],
],
'parameters' => [
[
- 'name' => 'TemplateId',
- 'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'example' => 'template-12345',
- ],
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'type' => 'string', 'example' => 'GmtCreateTime', 'description' => ''],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
+ ],
+ [
+ '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' => [
- 'type' => 'boolean',
- ],
+ 'schema' => ['title' => '', 'type' => 'boolean', 'example' => 'true', 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'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' => [
+ 'requestId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'TotalCount' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'description' => ''],
+ 'Images' => [
+ 'title' => '',
'type' => 'array',
'items' => [
'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'GmtCreateTime' => ['title' => '', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z', 'description' => ''],
+ 'Description' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'ImageUri' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'Labels' => [
+ 'title' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'Value' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'example' => '',
+ ],
+ 'ImageId' => ['title' => '', 'type' => 'string', 'example' => 'image-tzi7f9czc0cxs9s45t', 'description' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'summary' => 'Lists registered images.',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T04:59:02.000Z', 'description' => 'OpenAPI offline'],
],
- 'responseDemo' => null,
- ],
- 'GetExperimentsStatistics' => [
- 'summary' => '获取实验的统计信息',
- 'path' => '/api/v1/statistics/experiments',
- 'methods' => [
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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"}]',
+ 'title' => '',
+ ],
+ 'ListJobs' => [
+ 'summary' => 'Retrieves the list of jobs for a workflow draft.',
+ 'path' => '/api/v1/jobs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2843,75 +2567,98 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '61666',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14206',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'WorkspaceIds',
+ 'name' => 'ExperimentId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123,345',
- ],
+ 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-8up80bg0k1q23stml6', 'title' => ''],
],
[
- 'name' => 'Source',
+ 'name' => 'Creator',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UID of the creator.', 'type' => 'string', 'required' => false, 'example' => '13266*******76250', 'title' => ''],
+ ],
+ [
+ 'name' => 'Order',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The sort order. Jobs are sorted by creation time by default. Valid values:'."\n"
+ .'- DESC: descending order.'."\n"
+ .'- ASC: ascending order.',
+ 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'],
'type' => 'string',
'required' => false,
- 'example' => 'PaiStudio',
+ 'example' => 'DESC',
+ 'title' => '',
],
],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page for a paged query. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Data' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Jobs' => [
+ 'description' => 'The list of jobs.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The job details.',
'type' => 'object',
'properties' => [
- 'WorkspaceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '16381',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'CreateCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
+ 'ExperimentId' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'example' => 'draft-4x4iv3a9enuxw4vgka', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '94436', 'title' => ''],
+ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'job-mewqhd72nsrqujn1px', 'title' => ''],
+ 'ExecuteType' => ['description' => 'The execution type. Valid values:'."\n"
+ .'- EXECUTE_ALL: runs all nodes in the workflow draft.'."\n"
+ .'- EXECUTE_ONE: runs a specified node.'."\n"
+ .'- EXECUTE_TO_HERE: runs from the root node to the specified node.'."\n"
+ .'- EXECUTE_FROM_HERE: runs from the specified node.'."\n"
+ .'- EXECUTE_CHILDREN: runs the downstream nodes of the specified node.', 'type' => 'string', 'example' => 'EXECUTE_ALL', 'title' => ''],
+ 'NodeId' => ['description' => 'The node ID in the workflow draft.', 'type' => 'string', 'example' => 'nodeId1', 'title' => ''],
+ 'RunId' => ['description' => 'The corresponding PaiFlow Pipeline Run ID.', 'type' => 'string', 'example' => 'flow-aayfouai80i980ncvz', 'title' => ''],
+ 'PaiflowNodeId' => ['description' => 'The Pipeline Run node ID in PaiFlow.', 'type' => 'string', 'example' => 'node-xdfasf8ewxfdaddl', 'title' => ''],
+ 'Creator' => ['description' => 'The UID of the creator.', 'type' => 'string', 'example' => '17677*******89598', 'title' => ''],
+ 'Status' => ['description' => 'The status of the job. Valid values:'."\n"
+ .'* Initialized: The job is initialized.'."\n"
+ .'* Starting: The job is starting.'."\n"
+ .'* WorkflowServiceStarting: The job is being submitted.'."\n"
+ .'* Running: The job is running.'."\n"
+ .'* Succeeded: The job succeeded.'."\n"
+ .'* Failed: The job failed.'."\n"
+ .'* Terminating: The job is being terminated.'."\n"
+ .'* Terminated: The job is terminated.'."\n"
+ .'* Unknown: The job status is unknown.'."\n"
+ .'* Skipped: The job is skipped because a preceding node failed.'."\n"
+ .'* ReadyToSchedule: The job is ready to run because a preceding node has not completed.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'GmtCreateTime' => ['description' => 'The creation time in UTC, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
@@ -2919,18 +2666,33 @@
'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"}]',
- ],
- 'GetExperimentsUsersStatistics' => [
- 'summary' => '获取实验或文件夹所有者列表',
- 'path' => '/api/v1/statistics/experimentsusers',
- 'methods' => [
- 'get',
+ 'title' => 'Get workflow draft job list',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListJobs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Retrieves the output models of a node in a workflow draft.',
+ 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/outputs',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2939,63 +2701,76 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '92531',
- 'abilityTreeNodes' => [
- 'FEATURElearn1QDD9Y',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14233',
+ 'abilityTreeNodes' => ['FEATURElearnZNL1NN'],
],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The ID of the workflow draft.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
],
[
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'name' => 'NodeId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The ID of the node in the workflow draft.', 'type' => 'string', 'required' => true, 'example' => 'node-5dzotrnwyzfxmbwwc8', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
- ],
- 'Users' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Outputs' => [
+ 'description' => 'The list of models for the node.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The model information.',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12345******67890',
- ],
+ 'DisplayName' => ['description' => 'The model name in the format of {NodeName}-{outputId}.', 'type' => 'string', 'example' => '逻辑回归二分类-2-outputModel', 'title' => ''],
+ 'Type' => ['description' => 'The type. Valid values:'."\n"
+ .'- Model'."\n"
+ .'- DataSet.', 'type' => 'string', 'example' => 'Model', 'title' => ''],
+ 'OutputId' => ['description' => 'The output port ID of the algorithm node.', 'type' => 'string', 'example' => 'outputModel', 'title' => ''],
+ 'OutputIndex' => ['description' => 'The index of the variable-length node, starting from 0.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'Value' => ['description' => 'The content of the output. Different output types correspond to different keys.', '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"
+ .'}', 'title' => ''],
+ 'NodeName' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'node1', 'title' => ''],
+ 'AlgoName' => ['description' => 'The algorithm name.', 'type' => 'string', 'example' => '逻辑回归二分类', 'title' => ''],
+ 'LocationType' => ['description' => 'The model location. Valid values:'."\n"
+ .'* MaxComputeTable: MaxCompute table.'."\n"
+ .'* OSS: OSS.', 'type' => 'string', 'example' => 'MaxComputeTable', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
@@ -3003,18 +2778,34 @@
'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"}]',
- ],
- 'PreviewMCTable' => [
- 'summary' => '预览Maxcompute表数据',
- 'path' => '/api/v1/datasources/maxcompute/tables/{TableName}/preview',
- 'methods' => [
- 'get',
+ 'title' => 'Get output models of a node',
+ 'changeSet' => [
+ ['createdAt' => '2021-03-01T06:17:03.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeOutputs'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListPipelineDraftNodeOutputs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => [
+ 'path' => '/api/v1/recentexperiments',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3023,197 +2814,275 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '14096',
- 'abilityTreeNodes' => [
- 'FEATURElearnUEX4WU',
- ],
+ 'abilityTreeCode' => '61667',
+ 'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
- 'name' => 'TableName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dwd_hb_user_fdsaf_hi',
- ],
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Sort by modification time. Default value: DESC.'."\n"
+ .'- DESC: descending order.'."\n"
+ .'- ASC: ascending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'schema' => ['description' => 'The source from which the workflow draft was created.', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio', 'title' => ''],
],
[
- 'name' => 'Partition',
+ 'name' => 'Type',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The query type. Valid values:'."\n"
+ .' - Modified: the list of recently modified workflow drafts.'."\n"
+ .' - Created: the list of recently created workflow drafts.',
+ 'enumValueTitles' => ['Modified' => 'Modified', 'Created' => 'Created'],
'type' => 'string',
'required' => false,
- 'example' => 'pt=20240805',
+ 'example' => 'Modified',
+ 'title' => '',
],
],
[
- 'name' => 'Endpoint',
+ 'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'http://service.cn-hangzhou-vpc.maxcompute.aliyun-inc.com/api',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '86995', 'title' => ''],
],
[
- 'name' => 'Limit',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1000',
- ],
+ 'schema' => ['description' => 'The page number for paginated queries. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page for paginated queries. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
- ],
- 'Content' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Experiments' => [
+ 'description' => 'The list of workflow drafts.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
+ 'description' => 'The details of a workflow draft.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExperimentId' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'example' => 'draft-76p70ye0gwv3vbur55', 'title' => ''],
+ 'Name' => ['description' => 'The workflow draft name.', 'type' => 'string', 'example' => 'Pipeline draft name', 'title' => ''],
+ 'Description' => ['description' => 'The workflow draft description.', 'type' => 'string', 'example' => 'Pipeline draft description', 'title' => ''],
+ 'RecentGmtModifiedTime' => ['description' => 'The UTC time when the user most recently modified the workflow draft. The date is in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''],
+ 'Source' => ['description' => 'The source from which the workflow draft was created.', 'type' => 'string', 'example' => 'PaiStudio', 'title' => ''],
+ 'ModifyCnt' => ['description' => 'The number of modifications that the user made to this experiment.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '15821', 'title' => ''],
+ 'WorkspaceName' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'Workspace name', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'The total number of workflow drafts.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Content\\": [\\n [\\n \\"123\\"\\n ]\\n ]\\n}","type":"json"}]',
- ],
- 'GetMCTableSchema' => [
- 'summary' => '获取MaxCompute表schema',
- 'path' => '/api/v1/datasources/maxcompute/tables/{TableName}/schema',
- 'methods' => [
- 'get',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Get recent workflow drafts',
+ 'summary' => 'Gets the workflow drafts that were recently updated or created by the current user.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentExperiments'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListRecentPipelineDrafts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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' => 'Retrieves a list of specified templates in PAI Studio.',
+ 'path' => '/api/v1/templates',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '14093',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14198',
+ 'abilityTreeNodes' => ['FEATURElearnEACGUC'],
],
'parameters' => [
[
- 'name' => 'TableName',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'table_name',
- 'pattern' => '^([a-zA-Z][a-zA-Z0-9_]*\\.)?[a-zA-Z0-9_]+$',
- ],
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '20', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'example' => 'PaiStudio', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'List',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'types', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'TagId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'template-tag-12345', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'DESC', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'TypeId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'template-type-12345', 'description' => '', 'title' => ''],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'TemplateType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'Label',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'Verbose',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Columns' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => ''],
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '15', 'description' => '', 'title' => ''],
+ 'TemplateData' => [
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'Name' => [
+ 'Template' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['type' => 'string', 'example' => 'template-rbvg5wzljzjhc9ks92', 'description' => '', 'title' => ''],
+ 'Content' => ['type' => 'string', 'example' => '{}', 'description' => '', 'title' => ''],
+ 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Detail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DocLink' => ['type' => 'string', 'example' => 'url://xxx', 'description' => '', 'title' => ''],
+ 'ImageLink' => ['type' => 'string', 'example' => 'url://xxx', 'description' => '', 'title' => ''],
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtCreateTime' => ['type' => 'string', 'format' => 'iso8601', 'description' => '', 'title' => '', 'example' => ''],
+ 'GmtModifiedTime' => ['type' => 'string', 'format' => 'iso8601', 'description' => '', 'title' => '', 'example' => ''],
+ 'Creator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Labels' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'column1',
+ 'title' => '',
+ 'example' => '',
],
- 'Type' => [
+ 'TemplateTag' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['type' => 'string', 'example' => 'PyTorch', 'description' => '', 'title' => ''],
+ 'TagId' => ['type' => 'string', 'example' => 'template-tag-rbvg5wzljzjhc9ks92', 'description' => '', 'title' => ''],
+ 'TypeId' => ['type' => 'string', 'example' => 'template-tag-type-rbvg5wzljzjhc9ks92', 'description' => '', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'STRING',
+ 'title' => '',
+ 'example' => '',
],
- 'Preview' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
+ 'TemplateType' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TypeId' => ['type' => 'string', 'example' => 'templatetagtype-rbvg5wzljzjhc9ks92', 'description' => '', 'title' => ''],
+ 'Name' => ['type' => 'string', 'example' => '行业分类', 'description' => '', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- ],
- 'PartitionColumns' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
'description' => '',
- 'type' => 'string',
- 'example' => 'dt',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
@@ -3221,288 +3090,372 @@
'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"}]',
- ],
- 'SearchMCTables' => [
- 'summary' => '搜索MaxCompute表',
- 'path' => '/api/v1/datasources/maxcompute/tables',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-02T05:58:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
+ 'title' => '',
+ ],
+ 'MigrateExperimentFolders' => [
+ 'path' => '/api/v1/migrate/folders',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '14091',
- 'abilityTreeNodes' => [
- 'FEATURElearnUEX4WU',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '93906',
+ 'abilityTreeNodes' => ['FEATURElearn01UVDS'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''],
],
[
- 'name' => 'Keyword',
+ 'name' => 'IsOwner',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to migrate only your own experiments.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'Accessibility',
'in' => 'query',
+ 'schema' => ['description' => 'The visibility of the workflow draft. Valid values:'."\n"
+ .'- PUBLIC: visible to all members in the workspace.'."\n"
+ .'- PRIVATE: visible only to you and administrators in the workspace.', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'project.table_name_prefix',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9CFA2665-1FFE-5929-8468-C14C25890486'],
+ 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'NO_PERMISSION', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
+ 'FolderIdMapping' => [
+ 'description' => 'The migration result. The return value is a map in which the key is the user ID.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The mapping from Studio 1.0 experiment IDs to workflow draft IDs. The key is the experiment ID and the value is the workflow draft ID.', 'type' => 'object', 'example' => '{'."\n"
+ .' "user1": {'."\n"
+ .' 123 :"draft-xxxx"'."\n"
+ .' }'."\n"
+ .'}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
],
+ 'title' => 'Migrate workflow draft directory from studio 1.0',
+ 'summary' => 'Migrates the experiment directory from PAI Studio 1.0.',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-15T06:49:21.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateExperimentFolders'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:MigrateExperimentFolders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Migrates a workflow draft from Studio 1.0 to Designer.',
+ 'path' => '/api/v1/migrate/experiments',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '93908',
+ 'abilityTreeNodes' => ['FEATURElearn01UVDS'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SourceExpId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The experiment ID in Studio 1.0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''],
+ ],
+ [
+ 'name' => 'DestFolderId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination folder ID.', 'type' => 'string', 'required' => true, 'example' => 'folder-12321313', 'title' => ''],
+ ],
+ [
+ 'name' => 'Accessibility',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace visibility. Valid values:'."\n"
+ .'- PRIVATE: Visible only to you and administrators in this workspace.'."\n"
+ .'- PUBLIC: Visible to all users in this workspace.', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE', 'title' => ''],
+ ],
+ [
+ 'name' => 'UpdateIfExists',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to update the workflow draft if it already exists.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsOwner',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to migrate only your own workflow drafts.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
- ],
- 'Tables' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'table_name',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
+ 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'NO_PERMISSION', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'NotExistError', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExperimentId' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'example' => 'draft-8u3ck2or5pw2i4auhf', 'title' => ''],
+ 'AlreadyExists' => ['description' => 'Indicates whether the workflow draft already exists.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Updated' => ['description' => 'Indicates whether the workflow draft was updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Tables\\": [\\n \\"table_name\\"\\n ]\\n}","type":"json"}]',
- ],
- 'GetNodeInputSchema' => [
- 'summary' => '获取实验节点输入桩的输入表的格式',
- 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/schema',
- 'methods' => [
- 'get',
+ 'title' => 'Migrate a workflow draft from studio 1.0 to designer',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-15T06:49:21.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateExperiments'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:MigrateExperiments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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"}]',
+ ],
+ 'PreviewMCTable' => [
+ 'summary' => 'Previews data in a MaxCompute table.',
+ 'path' => '/api/v1/datasources/maxcompute/tables/{TableName}/preview',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '14196',
- 'abilityTreeNodes' => [
- 'FEATURElearnWUYTTV',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '14096',
+ 'abilityTreeNodes' => ['FEATURElearnUEX4WU'],
],
'parameters' => [
[
- 'name' => 'ExperimentId',
+ 'name' => 'TableName',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'experiment-rbvg5wzljzjhc9ks92',
- ],
+ 'schema' => ['description' => 'The name of the MaxCompute table.', 'type' => 'string', 'required' => true, 'example' => 'dwd_hb_user_fdsaf_hi', 'title' => ''],
],
[
- 'name' => 'NodeId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ff1f33b0-426a-46bb-bb30-4a5648058079',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''],
],
[
- 'name' => 'InputId',
+ 'name' => 'Partition',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inputTable',
- ],
+ 'schema' => ['description' => 'The partition of the MaxCompute table. This parameter can be left empty.'."\n"
+ .'* Single partition: p1=123'."\n"
+ .'* Multi-level partition: p1=123/p2=456'."\n"
+ .'* Multiple partitions: p1=123,p1=456', 'type' => 'string', 'required' => false, 'example' => 'pt=20240805', 'title' => ''],
],
[
- 'name' => 'InputIndex',
+ 'name' => 'Endpoint',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'The endpoint of MaxCompute.', 'type' => 'string', 'required' => true, 'example' => 'http://service.cn-hangzhou-vpc.maxcompute.aliyun-inc.com/api', 'title' => ''],
+ ],
+ [
+ 'name' => 'Limit',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of rows to return. Default value: 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CEB07647-8A5D-56F1-8B99-361BCF51402F',
- ],
- 'ColNames' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'col1',
- ],
- ],
- 'ColTypes' => [
- 'description' => '',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
+ 'Content' => [
+ 'description' => 'The list of previewed data rows.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'STRING',
+ 'description' => 'The data list. Each column contains one data entry.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The table field data.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB07647-8A5D-56F1-8B99-361BCF51402F\\",\\n \\"ColNames\\": [\\n \\"col1\\"\\n ],\\n \\"ColTypes\\": [\\n \\"STRING\\"\\n ]\\n}","type":"json"}]',
- ],
- 'GetExperimentVisualizationMeta' => [
- 'summary' => '查询实验的可视化meta',
- 'path' => '/api/v1/experiments/{ExperimentId}/visualizationMeta',
- 'methods' => [
- 'get',
+ 'title' => 'Preview a maxCompute table',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-02T01:55:23.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-03-01T06:17:00.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreviewMCTable'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:PreviewMCTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Content\\": [\\n [\\n \\"123\\"\\n ]\\n ]\\n}","type":"json"}]',
+ ],
+ 'PublishExperiment' => [
+ 'summary' => 'Publishes a workflow draft to the workspace, making it visible to all users in the workspace.',
+ 'path' => '/api/v1/experiments/{ExperimentId}/publish',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '42908',
- 'abilityTreeNodes' => [
- 'FEATURElearnUEX4WU',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '92519',
+ 'abilityTreeNodes' => ['FEATURElearn01UVDS'],
],
'parameters' => [
[
'name' => 'ExperimentId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
],
[
- 'name' => 'NodeIds',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FolderId' => ['title' => '', 'description' => 'The public folder ID. A value of root indicates the root directory of the public folders.', 'type' => 'string', 'required' => true, 'example' => 'root'],
+ ],
'required' => false,
- 'example' => 'node_id1,node_id2',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A84A1282-D3E7-5198-9E8E-2AD09C78C6C1',
- ],
- 'VisualizationMeta' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'NodeId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'node_id1',
- ],
- 'NodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Meta' => [
- 'description' => '',
- '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"
- .'}',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A26A7FA-EEF0-5A6B-BA76-06067547C11F'],
],
+ 'example' => '',
],
],
],
@@ -3510,138 +3463,116 @@
'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' => 'Publish a workflow draft to the workspace',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishExperiment'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:PublishPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A26A7FA-EEF0-5A6B-BA76-06067547C11F\\"\\n}","type":"json"}]',
],
'QueryExperimentVisualizationData' => [
- 'summary' => '查询实验的可视化数据',
+ 'summary' => 'Query visualization data of a workflow draft.',
'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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
+ 'schema' => ['title' => '', 'description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request body.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Visualization request.',
'type' => 'object',
'properties' => [
- 'NodeId' => [
- 'title' => 'node id',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'node-2dfd8xfjda',
- ],
+ 'NodeId' => ['title' => '', 'description' => 'The node ID in the workflow draft.', 'type' => 'string', 'required' => false, 'example' => 'node-2dfd8xfjda'],
'VisualizationDataIds' => [
- 'title' => 'dataId列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of DataIds to query. If DataId is empty, all data under the node is returned.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dataId1',
- ],
+ 'items' => ['description' => 'The DataId to query.', 'type' => 'string', 'example' => 'dataId1', 'required' => false, 'title' => ''],
'required' => false,
+ 'example' => '',
],
- 'StartTime' => [
- 'title' => '开始时间,UTC 时间,日期格式 iso8601,闭区间,对流算法必选',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
- 'EndTime' => [
- 'title' => '结束时间,UTC 时间,日期格式 iso8601,闭区间,对流算法必填',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
+ 'StartTime' => ['title' => '', 'description' => 'Start time in UTC, date format ISO 8601, closed interval, required for streaming algorithms.', 'type' => 'string', 'required' => false, 'example' => '2021-01-30T12:51:33.028Z'],
+ 'EndTime' => ['title' => '', 'description' => 'End time in UTC, date format ISO 8601, closed interval, required for streaming algorithms.', 'type' => 'string', 'required' => false, 'example' => '2021-01-30T12:51:33.028Z'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => true,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response result.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7'],
'VisualizationData' => [
- 'description' => '',
+ 'description' => 'List of visualization data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Visualization data.',
'type' => 'object',
'properties' => [
- 'NodeId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'node-ux55ier8axzo2xelcc',
- ],
- 'DataId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dataId1',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1,2,3,4,5',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-01-30T12:51:33.028Z',
- ],
+ 'NodeId' => ['description' => 'The node ID in the workflow draft.', 'type' => 'string', 'example' => 'node-ux55ier8axzo2xelcc', 'title' => ''],
+ 'DataId' => ['description' => 'The visualization data ID.', 'type' => 'string', 'example' => 'dataId1', 'title' => ''],
+ 'Data' => ['description' => 'The visualization data.', 'type' => 'string', 'example' => '1,2,3,4,5', 'title' => ''],
+ 'CreateTime' => ['description' => 'The data creation time in UTC, date format ISO 8601.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
@@ -3649,313 +3580,199 @@
'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"}]',
- ],
- 'GetAlgoTree' => [
- 'summary' => '获取算法树',
- 'path' => '/api/v1/algo/tree',
- 'methods' => [
- 'get',
+ 'title' => 'Query Visualization Data of Workflow Draft',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-26T02:22:18.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryExperimentVisualizationData'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:QueryPipelineDraftVisualizationData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'Searches for MaxCompute tables in the MaxCompute project associated with the current workspace.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PaiStudio',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The search keyword. You can use a period (.) as a separator to specify the project name and table name in the format of project_name.table_name.', 'type' => 'string', 'required' => true, 'example' => 'project.table_name_prefix', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '8CAA642F-EFEB-5F87-8F2F-ACD58B15FA03',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '[{}]',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
+ 'Tables' => [
+ 'description' => 'The list of tables found.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'table_name', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8CAA642F-EFEB-5F87-8F2F-ACD58B15FA03\\",\\n \\"Data\\": [\\n {}\\n ]\\n}","type":"json"}]',
- ],
- 'ListNodeOutputs' => [
- 'summary' => '获取某个节点的输出模型列表',
- 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/outputs',
- 'methods' => [
- 'get',
+ 'title' => 'Search for maxCompute tables',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Tables\\": [\\n \\"table_name\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'StopExperiment' => [
+ 'summary' => 'Stops all running jobs submitted by the pipeline draft. The stop operation is asynchronous. After the API returns, you need to wait for a period of time before the jobs are successfully stopped.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
- 'name' => 'NodeId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'node-5dzotrnwyzfxmbwwc8',
- ],
+ 'schema' => ['description' => 'The pipeline draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-i1udvvwm2rlvxug29n', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Outputs' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'DisplayName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Model',
- ],
- 'OutputId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'outputModel',
- ],
- 'OutputIndex' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "table": "table_name",'."\n"
- .' "locationType": "MaxComputeTable"'."\n"
- .'}',
- ],
- 'NodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'node1',
- ],
- 'AlgoName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'LocationType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MaxComputeTable',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'GetNodeOutput' => [
- 'summary' => '获取某个节点的输出模型信息',
- 'path' => '/api/v1/experiments/{ExperimentId}/nodes/{NodeId}/outputs/{OutputId}',
- 'methods' => [
- 'get',
+ 'title' => 'Stop All Pipeline Draft Jobs',
+ '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' => 'All Resource', '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'draft-rbvg5wzljzjhc9ks92',
- ],
- ],
- [
- 'name' => 'NodeId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'node-5dzotrnwyzfxmbwwc8',
- ],
- ],
- [
- 'name' => 'OutputId',
+ 'name' => 'JobId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'outputId',
- ],
- ],
- [
- 'name' => 'OutputIndex',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => 'job-i4vmjfsv5i1kowo4ih', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '601FD8B1-78EB-5220-844C-92AC2EDAF7E1',
- ],
- 'NodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'AlgoName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DisplayName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Model',
- ],
- 'Value' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'MaxComputeTable',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '431C53C4-BDD0-588F-8081-4437B00852B5'],
],
+ 'example' => '',
],
],
],
@@ -3963,835 +3780,1045 @@
'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"}]',
- ],
- 'ListAuthRoles' => [
- 'summary' => '获取授权角色列表',
- 'path' => '/api/v1/authorization/roles',
- 'methods' => [
- 'get',
+ 'title' => 'Stop a workflow stream draft job',
+ 'summary' => 'Stops a workflow stream draft job.',
+ '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' => 'All Resource', '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'name' => 'ExperimentId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The stream draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-i1udvvwm2rlvxug29n', 'title' => ''],
],
[
- 'name' => 'IsGenerateToken',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => 'The stream draft content.', 'type' => 'string', 'required' => true, 'example' => '{"metadata":{"name":"实验名称","desc":"实验描述"},"nodes":[],"edges":[],"globalParams":[],"globalSettings":[]}', 'title' => ''],
+ 'Version' => ['description' => 'The stream draft version before the update. This value must match the current version of the stream draft. Otherwise, the update fails.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11', 'title' => ''],
+ ],
'required' => false,
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'acs:ram::1557********904:role/aliyunodpspaidefaultrole',
- ],
- 'IsEnabled' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Token' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SecurityToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CAISggJ1q6Ft5B2yf***************aAaDf+bmceH2MNtNe9XtmTXJytadQ2T0RT8uOA+4kSypOPxSHjdjmnQjbdA/Q9MyNtTErQ/m45RNsg==',
- ],
- 'AccessKeyId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'STS.NU************TT5LoC',
- ],
- 'AccessKeySecret' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E1h2n66Duo1D**********c79JVk59R6i',
- ],
- 'Expiration' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-03-19T19:14:42Z',
- ],
- ],
- ],
- 'RoleType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PaiStudio。',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Version' => ['description' => 'The version of the stream draft after the update.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'ListImages' => [
- 'summary' => '列举已注册镜像',
- 'path' => '/api/v1/images',
- 'methods' => [
- 'get',
+ 'title' => 'Update stream draft content',
+ 'summary' => 'Updates the content of a stream draft.',
+ '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' => 'All Resource', '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' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The new name of the workflow draft folder.', 'type' => 'string', 'required' => false, 'example' => 'folder1', 'title' => ''],
+ 'ParentFolderId' => ['description' => 'The ID of the new parent folder. If this parameter is left empty, the parent folder is not changed.', 'type' => 'string', 'required' => false, 'example' => 'folder-xzf7t785nka4c2334', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页,从1开始,默认1',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'name' => 'FolderId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The ID of the folder.', 'type' => 'string', 'required' => true, 'example' => 'folder-xzf7t785nka4ch7qce', 'title' => ''],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '页大小,默认20',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The response result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'title' => 'Update a workflow draft folder',
+ 'summary' => 'Updates a workflow draft folder.',
+ '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' => 'All Resource', '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' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''],
],
[
- 'name' => 'Verbose',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '是否显示非必要信息:Labels',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => 'The request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The name of the workflow draft.', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft name', 'title' => ''],
+ 'Description' => ['description' => 'The description of the workflow draft.', 'type' => 'string', 'required' => false, 'example' => 'Pipeline draft description', 'title' => ''],
+ 'FolderId' => ['description' => 'The ID of the folder to which the workflow draft is moved after the update.'."\n"
+ .'* If this parameter is set to a non-empty value, the workflow draft is moved to the specified folder.'."\n"
+ .'* If this parameter is left empty, the workflow draft is not moved.'."\n"
+ .'* If this parameter is set to root and Accessibility is set to PUBLIC, the workflow draft is moved to the public root directory.'."\n"
+ .'* If this parameter is set to root and Accessibility is set to PRIVATE, the workflow draft is moved to your own root directory.', 'type' => 'string', 'required' => false, 'example' => 'folder-xfd782efd08wex', 'title' => ''],
+ 'Options' => ['description' => 'The options of the workflow draft.', 'type' => 'string', 'example' => '{"mlflow":{"experimentId":"exp-1"}}', 'required' => false, 'title' => ''],
+ 'Accessibility' => [
+ 'title' => '',
+ 'description' => 'The visibility of the workflow draft. Valid values:'."\n"
+ .'- PUBLIC: Visible to all members in the workspace.'."\n"
+ .'- PRIVATE: Visible only to you and administrators in the workspace.',
+ 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'],
+ 'type' => 'string',
+ 'example' => 'PUBLIC',
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response.',
'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' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => null,
- ],
- 'ListImageLabels' => [
- 'summary' => '列举标签',
- 'path' => '/api/v1/image/labels',
- 'methods' => [
- 'get',
+ 'title' => 'Update workflow draft metadata',
+ 'summary' => 'Updates the metadata of a PAI Designer workflow draft.',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'Request parameters changed'],
],
- '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' => 'All Resource', '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' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Malaysia (Johor)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pai.cn-beijing.aliyuncs.com', 'endpoint' => 'pai.cn-beijing.aliyuncs.com', 'vpc' => 'pai-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pai.cn-guangzhou.aliyuncs.com', 'endpoint' => 'pai.cn-guangzhou.aliyuncs.com', 'vpc' => 'pai-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pai.cn-hangzhou.aliyuncs.com', 'endpoint' => 'pai.cn-hangzhou.aliyuncs.com', 'vpc' => 'pai-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pai.cn-hongkong.aliyuncs.com', 'endpoint' => 'pai.cn-hongkong.aliyuncs.com', 'vpc' => 'pai-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pai.cn-shanghai.aliyuncs.com', 'endpoint' => 'pai.cn-shanghai.aliyuncs.com', 'vpc' => 'pai-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pai.cn-shenzhen.aliyuncs.com', 'endpoint' => 'pai.cn-shenzhen.aliyuncs.com', 'vpc' => 'pai-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pai.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'pai.cn-wulanchabu.aliyuncs.com', 'vpc' => 'pai-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'Request parameters changed', 'api' => 'CopyExperiment'],
+ ],
+ 'createdAt' => '2024-12-04T09:15:31.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateJob'],
+ ],
+ 'createdAt' => '2024-09-13T07:01:21.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'GetMCTableSchema'],
+ ],
+ 'createdAt' => '2023-07-18T02:23:23.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetTemplate'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTemplates'],
+ ],
+ 'createdAt' => '2022-12-02T05:59:01.000Z',
+ 'description' => 'template',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'PreviewMCTable'],
+ ],
+ 'createdAt' => '2022-12-02T01:56:07.000Z',
+ 'description' => 'Add Limit parameters for PreviewMCTable.',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetExperimentFolderChildren'],
+ ],
+ 'createdAt' => '2022-11-23T04:25:13.000Z',
+ 'description' => 'Modify GetExperimentFolderChildren, add create and modified time.',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'GetAlgorithmTree'],
+ ],
+ 'createdAt' => '2022-09-27T11:33:40.000Z',
+ 'description' => 'GetAlgorithmTree 新增 WorkspaceId 可选入参,用于支持基于工作空间是否开通GPU的算法节点过滤',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'PreviewMCTable'],
+ ],
+ 'createdAt' => '2022-03-17T07:59:23.000Z',
+ 'description' => 'Support Preview Partition Table.',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetExperimentVisualizationMeta'],
+ ['description' => 'OpenAPI offline', 'api' => 'QueryExperimentVisualizationData'],
+ ],
+ 'createdAt' => '2021-11-26T02:25:22.000Z',
+ 'description' => '新增可视化元信息和数据查询接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateExperimentMigrateValidation'],
+ ['description' => 'OpenAPI offline', 'api' => 'MigrateExperimentFolders'],
+ ['description' => 'OpenAPI offline', 'api' => 'MigrateExperiments'],
+ ],
+ 'createdAt' => '2021-11-18T05:35:05.000Z',
+ 'description' => '支持将PAI Studio 1.0实验迁移到2.0.',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CopyExperiment'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateExperiment'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateExperimentFolder'],
+ ['description' => 'Response parameters changed', 'api' => 'GetExperiment'],
+ ['description' => 'Request parameters changed', 'api' => 'GetExperimentFolderChildren'],
+ ['description' => 'Response parameters changed', 'api' => 'GetExperimentMeta'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetExperimentsUsersStatistics'],
+ ['description' => 'Response parameters changed', 'api' => 'ListExperiments'],
+ ['description' => 'OpenAPI offline', 'api' => 'PublishExperiment'],
+ ['description' => 'Request parameters changed', 'api' => 'UpdateExperimentMeta'],
+ ],
+ 'createdAt' => '2021-11-03T13:42:35.000Z',
+ 'description' => '增加工作空间可见度字段Accessibility,PRIVATE:工作空间内私有;PUBLIC:工作空间内公有',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'GetAlgorithmDef'],
+ ['description' => 'Request parameters changed', 'api' => 'GetAlgorithmDefs'],
+ ],
+ 'createdAt' => '2021-08-18T02:50:28.000Z',
+ 'description' => 'GetAlgorithmDef接口变更',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetNodeOutput'],
+ ['description' => 'Response parameters changed', 'api' => 'ListNodeOutputs'],
+ ],
+ 'createdAt' => '2021-05-13T06:09:49.000Z',
+ 'description' => 'NodeOutputs中添加LocationType',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListImageLabels'],
+ ],
+ 'createdAt' => '2021-04-08T08:41:39.000Z',
+ 'description' => 'done',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'AddImage'],
+ ['description' => 'OpenAPI offline', 'api' => 'AddImageLabels'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetImage'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListImages'],
+ ['description' => 'OpenAPI offline', 'api' => 'RemoveImage'],
+ ['description' => 'OpenAPI offline', 'api' => 'RemoveImageLabels'],
+ ],
+ 'createdAt' => '2021-04-07T04:59:41.000Z',
+ 'description' => '发布镜像管理',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListAuthRoles'],
+ ],
+ 'createdAt' => '2021-04-06T08:50:21.000Z',
+ 'description' => '增加ListAuthRoles接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetAlgorithmDef'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetAlgorithmDefs'],
+ ['description' => 'OpenAPI offline', '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' => 'Platform for AI',
+ 'ramCodes' => ['pai', 'paidesigner', 'paiartlab'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetExperimentStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'All Resource', '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' => 'All Resource', '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' => 'All Resource', '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' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => null,
- ],
- 'MigrateExperiments' => [
- 'summary' => '迁移PAI Studio 1.0的实验',
- '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'GetExperimentFolderChildren',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftFolderChildren',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ListTemplates',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'CreateExperimentFolder',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreatePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteExperiment',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'paidesigner:DeletePipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'MigrateExperiments',
+ 'description' => '',
'operationType' => 'none',
- 'abilityTreeCode' => '93908',
- 'abilityTreeNodes' => [
- 'FEATURElearn01UVDS',
+ 'ramAction' => [
+ 'action' => 'paidesigner:MigrateExperiments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'SourceExpId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
+ ],
+ [
+ 'apiName' => 'GetAlgorithmDef',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetAlgorithmDef',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'DestFolderId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Accessibility',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PRIVATE',
+ ],
+ [
+ 'apiName' => 'GetExperimentMeta',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'IsOwner',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ ],
+ [
+ 'apiName' => 'GetMCTableSchema',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetMCTableSchema',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '',
- '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' => 'All Resource', '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"}]',
- ],
- '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListJobs',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListJobs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'StopJob',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:StopJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'SourceExpId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123',
+ [
+ 'apiName' => 'MigrateExperimentFolders',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:MigrateExperimentFolders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
- ],
- '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'UpdateExperimentFolder',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:UpdatePipelineDraftFolder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CreateExperimentMigrateValidation',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'paidesigner:CreateExperimentMigrateValidation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
+ [
+ 'apiName' => 'GetNodeInputSchema',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetNodeInputSchema',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Accessibility',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PRIVATE',
+ ],
+ [
+ 'apiName' => 'GetExperimentVisualizationMeta',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraftVisualizationMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '9CFA2665-1FFE-5929-8468-C14C25890486',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NO_PERMISSION',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'FolderIdMapping' => [
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'description' => '',
- 'example' => '{'."\n"
- .' "user1": {'."\n"
- .' 123 :"draft-xxxx"'."\n"
- .' }'."\n"
- .'}',
- ],
- ],
- ],
+ [
+ 'apiName' => 'SearchMCTables',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'paidesigner:SearchMCTables',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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"}]',
- ],
- 'GetAlgorithmDefs' => [
- 'summary' => '批量获取算法定义',
- 'path' => '/api/v1/algorithm/defs',
- 'methods' => [
- 'get',
+ [
+ 'apiName' => 'UpdateExperimentMeta',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'paidesigner:UpdatePipelineDraftMeta',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'GetExperiment',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetPipelineDraft',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'PreviewMCTable',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:PreviewMCTable',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRecentExperiments',
+ 'description' => '',
'operationType' => 'list',
- 'abilityTreeCode' => '19292',
- 'abilityTreeNodes' => [
- 'FEATURElearnZAMNTS',
+ 'ramAction' => [
+ 'action' => 'paidesigner:ListRecentPipelineDrafts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'Timestamp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1709950208',
+ [
+ 'apiName' => 'GetJob',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'paidesigner:GetJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', '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' => 'All Resource', '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' => 'All Resource', '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' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Specs\\": [\\n {}\\n ]\\n}","type":"json"}]',
- ],
- ],
- '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' => [],
],
];