From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/paistudio/2020-04-28/api-docs.php | 257 +- data/en_us/paistudio/2020-11-23/api-docs.php | 280 - data/en_us/paistudio/2021-02-02/api-docs.php | 7029 +++++------ data/en_us/paistudio/2022-01-12/api-docs.php | 15544 +++++++++++-------------- 4 files changed, 10495 insertions(+), 12615 deletions(-) delete mode 100644 data/en_us/paistudio/2020-11-23/api-docs.php (limited to 'data/en_us/paistudio') diff --git a/data/en_us/paistudio/2020-04-28/api-docs.php b/data/en_us/paistudio/2020-04-28/api-docs.php index a5d6dc7..ea02529 100644 --- a/data/en_us/paistudio/2020-04-28/api-docs.php +++ b/data/en_us/paistudio/2020-04-28/api-docs.php @@ -1,19 +1,12 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'PaiStudio', - 'version' => '2020-04-28', - ], + 'info' => ['style' => 'RPC', 'product' => 'PaiStudio', 'version' => '2020-04-28'], 'directories' => [ [ 'id' => 348767, 'title' => 'Other', 'type' => 'directory', - 'children' => [ - 'AddModel', - 'CheckServiceLinkedRoleForDeleting', - ], + 'children' => ['AddModel', 'CheckServiceLinkedRoleForDeleting'], ], ], 'components' => [ @@ -21,13 +14,8 @@ ], 'apis' => [ 'AddModel' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -40,99 +28,52 @@ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Uri', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'FormatType', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '10000', 'minimum' => '0'], ], [ 'name' => 'Source', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '10000', 'minimum' => '0'], ], [ 'name' => 'StorageType', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '10000', 'minimum' => '0'], ], [ 'name' => 'FrameworkType', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '10000', 'minimum' => '0'], ], [ 'name' => 'ResourceOwnerType', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '0'], ], [ 'name' => 'Configuration', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'DefaultParams', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -140,25 +81,14 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'ErrCode' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'ErrMessage' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string'], + 'ErrCode' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], + 'ErrMessage' => ['type' => 'string'], 'Data' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'Id' => ['type' => 'integer', 'format' => 'int64'], ], ], ], @@ -167,23 +97,14 @@ ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'DMS1000001', - 'errorMessage' => 'Request failed.', - ], + ['errorCode' => 'DMS1000001', 'errorMessage' => 'Request failed.'], ], ], 'responseDemo' => null, ], 'CheckServiceLinkedRoleForDeleting' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -191,42 +112,27 @@ ], 'operationType' => 'read', 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RoleArn', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'DeletionTaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -234,25 +140,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Deletable' => [ - 'type' => 'boolean', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Deletable' => ['type' => 'boolean'], + 'RequestId' => ['type' => 'string'], 'RoleUsages' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Region' => [ - 'type' => 'string', - ], + 'Region' => ['type' => 'string'], 'Resources' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -266,81 +164,22 @@ ], ], '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', - ], + ['regionId' => 'cn-wulanchabu', 'endpoint' => 'pai.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'pai.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'endpoint' => 'pai.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'endpoint' => 'pai.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'endpoint' => 'pai.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'endpoint' => 'pai.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'endpoint' => 'pai.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'endpoint' => 'pai.cn-guangzhou.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' => 'cn-hangzhou', 'endpoint' => 'pai.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-8', 'endpoint' => 'pai.ap-southeast-8.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' => 'eu-central-1', 'endpoint' => 'pai.eu-central-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'pai.cn-shanghai-finance-1.aliyuncs.com'], ], ]; diff --git a/data/en_us/paistudio/2020-11-23/api-docs.php b/data/en_us/paistudio/2020-11-23/api-docs.php deleted file mode 100644 index ab89920..0000000 --- a/data/en_us/paistudio/2020-11-23/api-docs.php +++ /dev/null @@ -1,280 +0,0 @@ - '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'PaiStudio', - 'version' => '2020-11-23', - ], - 'directories' => [ - [ - 'id' => 0, - 'title' => '其它', - 'type' => 'directory', - 'children' => [ - 'ListExperiments', - ], - ], - ], - 'components' => [ - 'schemas' => [], - ], - 'apis' => [ - 'ListExperiments' => [ - 'path' => '/api/core/v1.0/experiments', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'APP' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - ], - ], - [ - 'name' => 'SortDirection', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'ExperimentId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'Scope', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'TotalCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Data' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'ParentUserId' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'Version' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ExperimentId' => [ - 'type' => 'string', - ], - 'GmtCreate' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Source' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'GmtModified' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Creator' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'errorCodes' => [], - 'responseDemo' => null, - ], - ], - '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', - ], - ], -]; 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 @@ '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,268 @@ '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'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExperimentFolder'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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', + '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' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'draft-i1udvvwm2rlvxug29n', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + ], + 'example' => '', + ], + ], + ], + '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'], + ], + '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', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14185', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], + ], + 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Content' => [ - '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' => '{ "metadata": { "name": "实验名称", "id": "pai_exp_xxxdfafafasfa", "desc": "实验描述", }, "nodes": [ ], "edges": [ ], "globalParams": [ ], "globalSettings":[ ] }', - ], - 'Version' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', + '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Version' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], + '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' => '', ], ], ], - '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', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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'], + ], + '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' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '92519', - 'abilityTreeNodes' => [ - 'FEATURElearn01UVDS', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'draft-rbvg5wzljzjhc9ks92', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FolderId' => [ - 'title' => '公共目录Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'root', - ], - ], - 'required' => false, - ], + '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' => '5A26A7FA-EEF0-5A6B-BA76-06067547C11F', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3'], ], + 'example' => '', ], ], ], @@ -585,139 +503,93 @@ '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' => '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' => '14195', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13803', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', + 'name' => 'FolderId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - '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' => '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' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'], ], + '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', + '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' => [], @@ -727,112 +599,59 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '14188', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13795', + 'abilityTreeNodes' => ['FEATURElearnZAMNTS'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'title' => '实验 id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'draft-rbvg5wzljzjhc9ks92', - ], + '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' => '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' => '8CAA642F-EFEB-5F87-8F2F-ACD58B15FA03'], + 'Data' => ['description' => 'The algorithm definition.', 'type' => 'object', 'example' => '[{}]', 'title' => ''], ], + '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' => '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' => [], @@ -842,161 +661,163 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '14237', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19291', + 'abilityTreeNodes' => ['FEATURElearnZAMNTS'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'draft-4c60c4txtaexfum1zx', - ], + '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' => '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' => 'B4F16666-FD54-5D9D-A362-53A4C66692DF'], + 'Spec' => ['description' => 'The spec of 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 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'], + ], + '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' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19292', + 'abilityTreeNodes' => ['FEATURElearnZAMNTS'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'draft-rbvg5wzljzjhc9ks92', - ], + 'name' => 'Timestamp', + 'in' => 'query', + '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' => 'LatestTimestamp', + 'in' => 'query', + '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' => 'RangeStart', + 'in' => 'query', + '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' => 'RangeEnd', + 'in' => 'query', + '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' => '2ABF5D32-C9EE-55AE-92EE-DB08E8988AD3', + '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' => 'The algorithm definition.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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'], ], - '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' => 'GetAlgorithmDefs'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -1005,625 +826,548 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '14194', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19289', + 'abilityTreeNodes' => ['FEATURElearnZAMNTS'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The source from which to retrieve the algorithm list. Default value: PaiStudio.', 'type' => 'string', 'required' => false, 'example' => 'PaiStudio', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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'], ], - [ - 'name' => 'Order', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => 'ASC', - 'DESC' => 'DESC', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + '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' => 'DESC', - ], - ], - [ - 'name' => 'ExperimentId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'draft-rbvg5wzljzjhc9ks92', + 'example' => '', ], ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Pipeline draft name', - ], + ], + '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'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmTree'], ], + ], + 'ramActions' => [ [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13266******376250', + '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' => [ [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PaiStudio', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14195', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], + ], + 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', + 'name' => 'ExperimentId', + 'in' => 'path', 'schema' => [ - 'description' => '', + 'description' => 'The workflow draft ID.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => '34875', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreate', + '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' => '', + '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' => '9708FB85-232F-5F9A-9D67-7F9CCCE20E06', - ], - 'Experiments' => [ - 'description' => '', - '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', + 'example' => 'PUBLIC', + 'title' => '', ], ], + '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' => 'Get workflow draft', + 'changeSet' => [ + ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'Response parameters changed'], + ], + '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' => 'create', - 'abilityTreeCode' => '14185', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13806', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], ], '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' => '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'OnlyFolder', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to list only folders.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The creation source.', 'type' => 'string', 'example' => 'PaiStudio', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + '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' => 'UserId', + 'in' => 'query', + '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' => '85082123-2A3F-52E7-B27A-F04700B82FFB', - ], - 'JobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'job-jcs4mmyangk7r2zdqz', + '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' => 'The member details.', + 'type' => 'object', + 'properties' => [ + '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\\": \\"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' => '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' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '14186', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14188', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], ], 'parameters' => [ [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'JobId', + 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'job-6xfhrofqx93y139fg3', - ], + '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' => '', - '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' => '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' => '---'."\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' => 'Query workflow draft metadata', + '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' => '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' => 'list', - 'abilityTreeCode' => '14206', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14237', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], ], 'parameters' => [ [ 'name' => 'ExperimentId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'draft-8up80bg0k1q23stml6', - ], + 'in' => 'path', + 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-4c60c4txtaexfum1zx', 'title' => ''], ], - [ - 'name' => 'Creator', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13266*******76250', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + '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' => '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' => '', ], ], + ], + 'title' => 'Query workflow draft status', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentStatus'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => 'ASC', - 'DESC' => 'DESC', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'DESC', ], ], + ], + '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' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '42908', + 'abilityTreeNodes' => ['FEATURElearnUEX4WU'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''], + ], + [ + 'name' => 'NodeIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Jobs' => [ - 'description' => '', + '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' => '', + 'description' => 'The visualization information.', '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', - ], + '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' => '', ], ], ], @@ -1631,58 +1375,87 @@ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Jobs\\": [\\n {\\n \\"ExperimentId\\": \\"draft-4x4iv3a9enuxw4vgka\\",\\n \\"WorkspaceId\\": \\"94436\\",\\n \\"JobId\\": \\"job-mewqhd72nsrqujn1px\\",\\n \\"ExecuteType\\": \\"EXECUTE_ALL\\",\\n \\"NodeId\\": \\"nodeId1\\",\\n \\"RunId\\": \\"flow-aayfouai80i980ncvz\\",\\n \\"PaiflowNodeId\\": \\"node-xdfasf8ewxfdaddl\\",\\n \\"Creator\\": \\"17677*******89598\\",\\n \\"Status\\": \\"Running\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'StopJob' => [ - 'summary' => '停止一个实验的作业', - 'path' => '/api/v1/jobs/{JobId}/stop', - 'methods' => [ - 'put', + 'title' => 'Get Visualization Meta of Workflow Draft', + 'changeSet' => [ + ['createdAt' => '2021-11-26T02:22:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentVisualizationMeta'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '14209', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '61666', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], ], 'parameters' => [ [ - 'name' => 'JobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'job-i4vmjfsv5i1kowo4ih', - ], + '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' => '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' => '431C53C4-BDD0-588F-8081-4437B00852B5', + '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' => '', ], ], ], @@ -1690,245 +1463,251 @@ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"431C53C4-BDD0-588F-8081-4437B00852B5\\"\\n}","type":"json"}]', - ], - 'StopExperiment' => [ - 'summary' => '停止实验所有运行中的作业', - 'path' => '/api/v1/experiments/{ExperimentId}/stop', - 'methods' => [ - 'post', + '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' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '14236', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92531', + 'abilityTreeNodes' => ['FEATURElearn1QDD9Y'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'draft-i1udvvwm2rlvxug29n', - ], + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'query', + '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', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'], + 'Users' => [ + 'description' => 'The list of users.', + 'type' => 'array', + 'items' => [ + 'description' => 'The user information.', + 'type' => 'object', + 'properties' => [ + '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}","type":"json"}]', - ], - 'CreateExperimentFolder' => [ - 'summary' => '创建算法文件夹', - 'path' => '/api/v1/experimentfolders', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'security' => [ - [ - 'AK' => [], - ], + 'title' => 'List users who created workflow drafts', + 'changeSet' => [ + ['createdAt' => '2021-11-02T06:15:14.000Z', 'description' => 'OpenAPI offline'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '13799', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExperimentsUsersStatistics'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - '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, - ], - ], - ], - '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', - ], - 'FolderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'folder-xxfdjhfxduxd', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftsUsersStatistics', + '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"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"12345******67890\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateExperimentFolder' => [ - 'summary' => '更新算法文件夹', - 'path' => '/api/v1/experimentfolders/{FolderId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetJob' => [ + 'summary' => 'Queries the details of a stream draft job.', + 'path' => '/api/v1/jobs/{JobId}', + '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' => '14186', + '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' => 'Verbose', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query task details.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'FolderId', + 'name' => 'JobId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - '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' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F', - ], + '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\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]', - ], - 'GetExperimentFolderChildren' => [ - 'summary' => '获取算法文件夹下的内容', - 'path' => '/api/v1/experimentfolders/{FolderId}/children', - 'methods' => [ - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query stream draft job details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'], + ], + ], + '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' => [], @@ -1937,904 +1716,849 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '13806', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], - ], - 'parameters' => [ - [ - 'name' => 'FolderId', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14093', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], + ], + 'parameters' => [ + [ + 'name' => 'TableName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'folder-xzf7t7****ch7qce', - ], + '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' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'OnlyFolder', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PaiStudio', - ], - ], - [ - 'name' => 'Accessibility', - 'in' => 'query', - 'schema' => [ - 'title' => '工作空间内可见性 PUBLIC; PRIVATE 默认PUBLIC', - 'description' => '', - '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 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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], - 'Items' => [ - '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', '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', + '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' => '', + ], + '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\\": \\"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', - ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'security' => [ - [ - 'AK' => [], - ], + 'title' => 'Retrieve the schema of a maxCompute table', + 'changeSet' => [ + ['createdAt' => '2023-07-18T02:23:20.000Z', 'description' => 'Request parameters changed'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '13803', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMCTableSchema'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'FolderId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'folder-xzf7t785nka4ch7qce', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetMCTableSchema', + '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"}]', + '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"}]', ], - 'GetAlgorithmTree' => [ - 'summary' => '获取算法树', - 'path' => '/api/v1/algorithm/tree', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => '19289', - 'abilityTreeNodes' => [ - 'FEATURElearnZAMNTS', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14196', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], ], 'parameters' => [ [ - 'name' => 'Source', + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'experiment-rbvg5wzljzjhc9ks92', 'title' => ''], + ], + [ + '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' => 'InputId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PaiStudio', - ], + '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' => 'WorkspaceId', + 'name' => 'InputIndex', 'in' => 'query', - 'schema' => [ - 'title' => '工作空间ID。指定工作空间ID后，将根据当前工作空间是否开通GPU资源对算法树结果进行过滤。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + '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' => '46B59732-033F-5C96-9B15-1E05E7705548', - ], - 'Tree' => [ - 'description' => '', + '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' => '', - '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" - .'}', - ], + 'items' => ['description' => 'The column name.', 'type' => 'string', 'example' => 'col1', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20210317101023', + '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\\": \\"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', + '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' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '19291', - 'abilityTreeNodes' => [ - 'FEATURElearnZAMNTS', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14234', + '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' => 'draft-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' => 'node-5dzotrnwyzfxmbwwc8', 'title' => ''], ], [ - 'name' => 'AlgoVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'name' => 'OutputId', + 'in' => 'path', + 'schema' => ['description' => 'The output port ID of the algorithm node.', 'type' => 'string', 'required' => true, 'example' => 'outputId', 'title' => ''], ], [ - 'name' => 'Signature', + 'name' => 'OutputIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5vqe4Sgtzw8E6opyK3HkK+nzYlY=', - ], + 'schema' => ['description' => 'The index of a variable-length node, starting from 0.', 'type' => 'string', 'required' => false, 'example' => '0', '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', - ], - 'Spec' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - ], + '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' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B4F16666-FD54-5D9D-A362-53A4C66692DF\\",\\n \\"Spec\\": {}\\n}","type":"json"}]', - ], - 'ListRecentExperiments' => [ - 'summary' => '获取最近的实验', - 'path' => '/api/v1/recentexperiments', - 'methods' => [ - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Get the output model information of a specific node', + 'changeSet' => [ + ['createdAt' => '2021-03-01T06:16:56.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeOutput'], + ], + ], + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftNodeOutput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '61667', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', + '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' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + 'name' => 'TemplateId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => true, 'example' => 'template-12345', 'description' => '', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'Verbose', 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PaiStudio', + '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' => '', + ], + ], + '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' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Modified' => 'Modified', - 'Created' => 'Created', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'Modified', ], ], + ], + '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' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '86995', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '21720', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], + ], + 'parameters' => [ [ - 'name' => 'PageNumber', + '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' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '20007', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], + ], + 'parameters' => [ [ - 'name' => 'Name', + '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' => [], + ], + '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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project.table_name_prefix', - ], + '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' => [ - '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' => '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' => '', ], ], ], - '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 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'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'get', - 'abilityTreeCode' => '14196', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '93908', + 'abilityTreeNodes' => ['FEATURElearn01UVDS'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'experiment-rbvg5wzljzjhc9ks92', - ], - ], + 'name' => 'SourceExpId', + 'in' => 'query', + 'schema' => ['description' => 'The experiment ID in Studio 1.0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', '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' => 'DestFolderId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'inputTable', - ], + 'schema' => ['description' => 'The destination folder ID.', 'type' => 'string', 'required' => true, 'example' => 'folder-12321313', 'title' => ''], ], [ - 'name' => 'InputIndex', + 'name' => 'Accessibility', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + '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' => 'CEB07647-8A5D-56F1-8B99-361BCF51402F', - ], - 'ColNames' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'col1', + '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' => '', ], - 'ColTypes' => [ - 'description' => '', + ], + 'example' => '', + ], + ], + ], + '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'], + ], + ], + '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', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14096', + 'abilityTreeNodes' => ['FEATURElearnUEX4WU'], + ], + 'parameters' => [ + [ + 'name' => 'TableName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the MaxCompute table.', 'type' => 'string', 'required' => true, 'example' => 'dwd_hb_user_fdsaf_hi', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Partition', + 'in' => 'query', + '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' => 'Endpoint', + 'in' => 'query', + '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' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + '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', - ], - 'required' => false, - ], - 'StartTime' => [ - 'title' => '开始时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必选', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'EndTime' => [ - 'title' => '结束时间，UTC 时间，日期格式 iso8601，闭区间，对流算法必填', - 'description' => '', - 'type' => 'string', + 'items' => ['description' => 'The DataId to query.', 'type' => 'string', 'example' => 'dataId1', 'required' => false, 'title' => ''], 'required' => false, - 'example' => '2021-01-30T12:51:33.028Z', + 'example' => '', ], + '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,179 +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'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryExperimentVisualizationData'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:QueryPipelineDraftVisualizationData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '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' => 'The pipeline draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-i1udvvwm2rlvxug29n', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'draft-rbvg5wzljzjhc9ks92', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + ], + 'example' => '', ], ], + ], + 'title' => 'Stop All Pipeline Draft Jobs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopExperiment'], + ], + ], + 'ramActions' => [ [ - 'name' => 'NodeId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'node-5dzotrnwyzfxmbwwc8', + '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' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14209', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'path', + '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' => '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' => '431C53C4-BDD0-588F-8081-4437B00852B5'], ], + 'example' => '', ], ], ], @@ -3829,969 +3780,1045 @@ '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 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' => 'get', - 'abilityTreeCode' => '14234', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14191', + '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', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'outputId', - ], + 'schema' => ['description' => 'The stream draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-i1udvvwm2rlvxug29n', 'title' => ''], ], [ - 'name' => 'OutputIndex', - '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' => '0', + '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' => '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'Version' => ['description' => 'The version of the stream draft after the update.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - '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' => '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' => '21720', - 'abilityTreeNodes' => [ - 'FEATURElearnWUYTTV', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13802', + 'abilityTreeNodes' => ['FEATURElearn1QDD9Y'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - '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, - 'example' => '12345', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'IsGenerateToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'FolderId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the folder.', 'type' => 'string', 'required' => true, 'example' => 'folder-xzf7t785nka4ch7qce', 'title' => ''], ], ], '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' => '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。', - ], - ], - ], - ], - ], - ], - ], - ], - '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', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '20013', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '镜像名称，支持模糊搜索', - 'type' => 'string', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页，从1开始，默认1', - 'type' => 'integer', - 'format' => 'int32', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小，默认20', - 'type' => 'integer', - 'format' => 'int32', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序字段', - 'type' => 'string', - 'example' => 'GmtCreateTime', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序方向： ASC - 升序 DESC - 降序', - 'type' => 'string', - ], - ], - [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'title' => '过滤值 以逗号分隔', - 'type' => 'string', - 'example' => 'Framework="Tensorflow 1.0",Framework="Tensorflow 2.0",Platform="GPU"', - ], - ], - [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'title' => '是否显示非必要信息：Labels', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of 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', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => null, - ], - 'ListImageLabels' => [ - 'summary' => '列举标签', - 'path' => '/api/v1/image/labels', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '20007', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], - ], - 'parameters' => [ - [ - 'name' => 'LabelKeys', - 'in' => 'query', - 'schema' => [ - 'title' => '标签列表，以逗号分隔', - 'type' => 'string', - 'example' => 'ImageType,Framework,Platform', - ], - ], - [ - 'name' => 'LabelFilter', - 'in' => 'query', - 'schema' => [ - 'title' => 'image过滤条件，获取满足条件的image的所有label', - 'type' => 'string', - 'example' => 'a=b,c=d', - ], - ], - [ - 'name' => 'ImageId', - 'in' => 'query', - 'schema' => [ - 'title' => '镜像id', - 'type' => 'string', - ], - ], - ], - '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', - ], - ], - ], - ], - ], - 'responseDemo' => null, - ], - 'MigrateExperiments' => [ - 'summary' => '迁移PAI Studio 1.0的实验', - 'path' => '/api/v1/migrate/experiments', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '93908', - 'abilityTreeNodes' => [ - 'FEATURElearn01UVDS', - ], - ], - 'parameters' => [ - [ - 'name' => 'SourceExpId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'DestFolderId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'folder-12321313', - ], - ], - [ - 'name' => 'Accessibility', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE', - ], - ], - [ - 'name' => 'UpdateIfExists', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'IsOwner', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 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', - ], - ], - ], - ], - ], - ], - ], - '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', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '100051', - 'abilityTreeNodes' => [ - 'FEATURElearn01UVDS', - ], - ], - 'parameters' => [ - [ - 'name' => 'SourceExpId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - ], - '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', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'], ], + 'example' => '', ], ], - ], - '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', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '93906', - 'abilityTreeNodes' => [ - 'FEATURElearn01UVDS', - ], - ], - 'parameters' => [ - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'IsOwner', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Accessibility', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE', - ], - ], - ], - '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" - .'}', - ], - ], - ], - ], - ], - ], - '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', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '19292', - 'abilityTreeNodes' => [ - 'FEATURElearnZAMNTS', - ], - ], - 'parameters' => [ - [ - 'name' => 'Timestamp', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1709950208', - ], - ], - [ - 'name' => 'LatestTimestamp', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1709950208', - ], + ], + 'title' => 'Update a workflow draft folder', + 'summary' => 'Updates a workflow draft folder.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExperimentFolder'], ], + ], + 'ramActions' => [ [ - 'name' => 'RangeStart', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + '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' => 'RangeEnd', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '14190', + 'abilityTreeNodes' => ['FEATURElearnWUYTTV'], + ], + 'parameters' => [ + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => 'The workflow draft ID.', 'type' => 'string', 'required' => true, 'example' => 'draft-rbvg5wzljzjhc9ks92', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + '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, - 'example' => '10', + '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' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', - ], - 'Specs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Specs\\": [\\n {}\\n ]\\n}","type":"json"}]', + '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'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExperimentMeta'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidesigner:UpdatePipelineDraftMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + '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' => [ [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'pai.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CopyExperiment'], + ], + 'createdAt' => '2024-12-04T09:15:31.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'pai.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateJob'], + ], + 'createdAt' => '2024-09-13T07:01:21.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'pai.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetMCTableSchema'], + ], + 'createdAt' => '2023-07-18T02:23:23.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'pai.cn-shanghai.aliyuncs.com', + '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', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'pai.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PreviewMCTable'], + ], + 'createdAt' => '2022-12-02T01:56:07.000Z', + 'description' => 'Add Limit parameters for PreviewMCTable.', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'pai.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetExperimentFolderChildren'], + ], + 'createdAt' => '2022-11-23T04:25:13.000Z', + 'description' => 'Modify GetExperimentFolderChildren, add create and modified time.', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'pai.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetAlgorithmTree'], + ], + 'createdAt' => '2022-09-27T11:33:40.000Z', + 'description' => 'GetAlgorithmTree 新增 WorkspaceId 可选入参，用于支持基于工作空间是否开通GPU的算法节点过滤', ], [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'pai.ap-southeast-3.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PreviewMCTable'], + ], + 'createdAt' => '2022-03-17T07:59:23.000Z', + 'description' => 'Support Preview Partition Table.', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'pai.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetExperimentVisualizationMeta'], + ['description' => 'OpenAPI offline', 'api' => 'QueryExperimentVisualizationData'], + ], + 'createdAt' => '2021-11-26T02:25:22.000Z', + 'description' => '新增可视化元信息和数据查询接口', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'pai.eu-central-1.aliyuncs.com', + '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.', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'pai.cn-guangzhou.aliyuncs.com', + '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：工作空间内公有', ], [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'pai.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetAlgorithmDef'], + ['description' => 'Request parameters changed', 'api' => 'GetAlgorithmDefs'], + ], + 'createdAt' => '2021-08-18T02:50:28.000Z', + 'description' => 'GetAlgorithmDef接口变更', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'pai.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetNodeOutput'], + ['description' => 'Response parameters changed', 'api' => 'ListNodeOutputs'], + ], + 'createdAt' => '2021-05-13T06:09:49.000Z', + 'description' => 'NodeOutputs中添加LocationType', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'pai.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListImageLabels'], + ], + 'createdAt' => '2021-04-08T08:41:39.000Z', + 'description' => 'done', ], [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'pai.ap-northeast-2.aliyuncs.com', + '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' => '发布镜像管理', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'pai.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListAuthRoles'], + ], + 'createdAt' => '2021-04-06T08:50:21.000Z', + 'description' => '增加ListAuthRoles接口', ], [ - 'regionId' => 'us-southeast-1', - 'endpoint' => 'pai.us-southeast-1.aliyuncs.com', + '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接口', ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'pai.ap-southeast-7.aliyuncs.com', + ], + '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'], ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'pai.me-east-1.aliyuncs.com', + ], + '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' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryExperimentVisualizationData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:QueryPipelineDraftVisualizationData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteExperimentFolder', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidesigner:DeletePipelineDraftFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNodeOutput', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftNodeOutput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopExperiment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidesigner:StopPipelineDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAuthRoles', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidesigner:ListAuthRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperimentFolderChildren', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftFolderChildren', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTemplates', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidesigner:ListTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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', + 'ramAction' => [ + 'action' => 'paidesigner:MigrateExperiments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAlgoTree', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetAlgoTree', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAlgorithmDef', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetAlgorithmDef', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListImages', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidesigner:ListImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperimentMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperimentsUsersStatistics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftsUsersStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMCTableSchema', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetMCTableSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAlgorithmTree', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetAlgorithmTree', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidesigner:CreateJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidesigner:ListJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopJob', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidesigner:StopJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateExperimentContent', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidesigner:UpdatePipelineDraftContent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'MigrateExperimentFolders', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paidesigner:MigrateExperimentFolders', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListImageLabels', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidesigner:ListImageLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CopyExperiment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidesigner:CopyPipelineDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateExperimentFolder', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidesigner:UpdatePipelineDraftFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateExperimentMigrateValidation', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidesigner:CreateExperimentMigrateValidation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListExperiments', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidesigner:ListPipelineDrafts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNodeInputSchema', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetNodeInputSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAlgorithmDefs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidesigner:GetAlgorithmDefs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperimentVisualizationMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftVisualizationMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SearchMCTables', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paidesigner:SearchMCTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateExperimentMeta', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidesigner:UpdatePipelineDraftMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperiment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PreviewMCTable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:PreviewMCTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + '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', + 'ramAction' => [ + 'action' => 'paidesigner:ListRecentPipelineDrafts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PublishExperiment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidesigner:PublishPipelineDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetExperimentsStatistics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidesigner:GetPipelineDraftsStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListNodeOutputs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidesigner:ListPipelineDraftNodeOutputs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateExperiment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidesigner:CreatePipelineDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; diff --git a/data/en_us/paistudio/2022-01-12/api-docs.php b/data/en_us/paistudio/2022-01-12/api-docs.php index ef34bca..0905ed0 100644 --- a/data/en_us/paistudio/2022-01-12/api-docs.php +++ b/data/en_us/paistudio/2022-01-12/api-docs.php @@ -1,8559 +1,5769 @@ '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'PaiStudio', - 'version' => '2022-01-12', - ], + 'info' => ['style' => 'ROA', 'product' => 'PaiStudio', 'version' => '2022-01-12'], 'directories' => [ [ - 'id' => 384361, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'UpdateResourceGroup', - 'GetResourceGroupTotal', - 'ListResourceGroups', - 'GetResourceGroupRequest', - 'DeleteResourceGroupMachineGroup', - 'GetNodeMetrics', - 'ListResourceGroupMachineGroups', - 'GetUserViewMetrics', - 'GetResourceGroupMachineGroup', - 'GetResourceGroup', - 'DeleteMachineGroup', - 'CreateResourceGroup', - 'DeleteResourceGroup', - 'GetMachineGroup', - ], - ], - [ - 'id' => 384376, - 'title' => null, + 'children' => ['GetResourceGroupTotal', 'GetResourceGroupRequest', 'DeleteResourceGroupMachineGroup', 'GetNodeMetrics', 'ListResourceGroupMachineGroups', 'GetUserViewMetrics', 'GetResourceGroupMachineGroup'], 'type' => 'directory', - 'children' => [ - 'CreateAlgorithm', - 'CreateAlgorithmVersion', - 'DeleteAlgorithm', - 'DeleteAlgorithmVersion', - 'GetAlgorithm', - 'GetAlgorithmVersion', - 'ListAlgorithms', - 'ListAlgorithmVersions', - 'UpdateAlgorithm', - 'UpdateAlgorithmVersion', - ], + 'title' => 'Resource group', ], [ - 'id' => 384387, - 'title' => null, + 'children' => ['CreateAlgorithm', 'CreateAlgorithmVersion', 'DeleteAlgorithm', 'DeleteAlgorithmVersion', 'GetAlgorithm', 'GetAlgorithmVersion', 'ListAlgorithms', 'ListAlgorithmVersions', 'UpdateAlgorithm', 'UpdateAlgorithmVersion'], 'type' => 'directory', - 'children' => [ - 'CreateTrainingJob', - 'CreateInstanceWebTerminal', - 'CheckInstanceWebTerminal', - 'DeleteTrainingJob', - 'DeleteTrainingJobLabels', - 'GetToken', - 'GetTrainingJob', - 'GetTrainingJobErrorInfo', - 'GetTrainingJobLatestMetrics', - 'ListTrainingJobs', - 'ListTrainingJobEvents', - 'ListTrainingJobInstanceEvents', - 'ListTrainingJobInstanceMetrics', - 'ListTrainingJobLogs', - 'ListTrainingJobMetrics', - 'ListTrainingJobOutputModels', - 'StopTrainingJob', - 'UpdateTrainingJobLabels', - ], + 'title' => 'Training algorithm', ], [ - 'id' => 384406, - 'title' => null, + 'children' => ['CreateTrainingJob', 'CreateInstanceWebTerminal', 'CheckInstanceWebTerminal', 'DeleteTrainingJob', 'DeleteTrainingJobLabels', 'GetTrainingJob', 'GetTrainingJobErrorInfo', 'GetTrainingJobLatestMetrics', 'ListTrainingJobs', 'ListTrainingJobEvents', 'ListTrainingJobInstanceEvents', 'ListTrainingJobInstanceMetrics', 'ListTrainingJobLogs', 'ListTrainingJobMetrics', 'ListTrainingJobOutputModels', 'StopTrainingJob', 'UpdateTrainingJobLabels'], 'type' => 'directory', - 'children' => [ - 'CreateQuota', - 'ListQuotas', - 'GetQuota', - 'UpdateQuota', - 'ScaleQuota', - 'DeleteQuota', - 'ListQuotaWorkloads', - ], + 'title' => 'Training job', ], [ - 'id' => 384414, - 'title' => null, + 'children' => ['ScaleQuota', 'ListQuotaWorkloads', 'ListQuotaActiveUserUsages'], 'type' => 'directory', - 'children' => [ - 'ListTagResources', - 'TagResources', - 'UntagResources', - ], + 'title' => 'Resource quota', ], [ - 'id' => 384418, - 'title' => null, + 'children' => ['GetSpotPriceHistory', 'ListNodeTypes', 'OperateNode', 'CreateQuota', 'CreateResourceGroup', 'DeleteMachineGroup', 'DeleteQuota', 'DeleteResourceGroup', 'GetMachineGroup', 'GetQuota', 'GetResourceGroup', 'GetToken', 'ListNodes', 'ListQuotas', 'ListResourceGroups', 'ListTagResources', 'TagResources', 'UntagResources', 'UpdateQuota', 'UpdateResourceGroup'], 'type' => 'directory', - 'children' => [ - 'ListNodes', - 'GetSpotPriceHistory', - 'OperateNode', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'ACS' => [ - 'title' => 'ACS Quota Related Configuration', - 'description' => '', - 'visibility' => 'public', + 'description' => 'ACS-related configuration.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'ACSQuotaId' => [ - 'title' => 'ACS Identifier', - 'description' => 'ACS Identifier', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'rq-3kbt2gtimmyw7fgfgothocvh', - 'backendName' => 'ACSQuotaId', - ], + 'ACSQuotaId' => ['description' => 'ACS resource ID.', 'title' => '', 'type' => 'string', 'example' => 'rq-3kbt2gtimmyw7fgfgothocvh'], 'AssociatedProducts' => [ - 'title' => 'Products that can use ACS Quota', - 'description' => '', - 'visibility' => 'public', + 'description' => 'Product codes that can use the ACS Quota.'."\n" + ."\n" + .'Constraints: '."\n" + .'You can select multiple sub-products, but some sub-products are mutually exclusive. The following combinations can be selected simultaneously: '."\n" + .'- PAI-DLC, PAI-DSW '."\n" + .'- PAI-EAS', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'PAI-DLC', - 'extendType' => 'true', - ], - 'backendName' => 'AssociatedProducts', + 'items' => ['description' => 'Product code of the product that uses ACS resources.', 'type' => 'string', 'example' => 'PAI-DLC', 'title' => ''], + 'example' => '', ], ], + 'example' => '', + ], + 'Action' => [ + 'title' => '任务操作配置', + 'description' => '操作配置', + 'type' => 'object', + 'properties' => [ + 'ActionType' => ['title' => '操作类型', 'type' => 'string'], + ], ], 'AlgorithmSpec' => [ - 'title' => 'Defines how the training job of the algorithm run.', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The algorithm definition.', + 'title' => '', 'type' => 'object', 'properties' => [ 'OutputChannels' => [ - 'title' => 'The outputs of the algorithm.', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The list of output channels for the algorithm.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Channel', - ], - 'backendName' => 'OutputChannels', - 'itemName' => 'OutputChannels', + 'items' => ['description' => 'An output channel for the algorithm.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Channel'], + 'example' => '', ], 'HyperParameters' => [ - 'title' => 'The hype parameter used by the algorithm.', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The list of hyperparameter definitions.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/HyperParameterDefinition', - ], - 'backendName' => 'HyperParameters', - 'itemName' => 'HyperParameters', + 'items' => ['description' => 'Hyperparameter definition. ', '$ref' => '#/components/schemas/HyperParameterDefinition', 'title' => '', 'example' => ''], + 'example' => '', ], 'JobType' => [ - 'title' => 'Job type of the training job while running the algorithm.', - 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The job type.', 'type' => 'string', - 'required' => true, 'example' => 'TFJob', - 'backendName' => 'JobType', - 'enum' => [ - 'TFJob', - 'PyTorchJob', - 'XGBoostJob', - 'ElasticBatchJob', - ], + 'required' => true, + 'enum' => ['TFJob', 'PyTorchJob', 'XGBoostJob', 'ElasticBatchJob'], ], 'Command' => [ - 'title' => 'The command used for submit the job.', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The list of commands to run the training task.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'python train.py', - 'extendType' => 'true', - ], + 'items' => ['description' => 'A command to run the training task.', 'type' => 'string', 'title' => '', 'example' => 'python train.py'], 'required' => true, - 'backendName' => 'Command', - 'itemName' => 'Command', + 'example' => '', ], 'MetricDefinitions' => [ - 'title' => 'The output metrics of the algorithm.', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The list of metric definitions for the training task.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/MetricDefinition', - ], - 'backendName' => 'MetricDefinitions', - 'itemName' => 'MetricDefinitions', + 'items' => ['description' => 'A metric definition for the training task.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/MetricDefinition'], + 'example' => '', ], 'InputChannels' => [ - 'title' => 'The input for the algorithm.', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The list of input channels for the algorithm.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Channel', - ], + 'items' => ['description' => 'Algorithm input channel. ', '$ref' => '#/components/schemas/Channel', 'title' => '', 'example' => ''], 'required' => false, - 'backendName' => 'InputChannels', - 'itemName' => 'InputChannels', - ], - 'SupportsDistributedTraining' => [ - 'title' => 'Indicates whether the algorithm support distributed training.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'SupportsDistributedTraining', - ], - 'Image' => [ - 'title' => 'The docker image used by the job of this algorithm.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0', - 'backendName' => 'Image', + 'example' => '', ], + 'SupportsDistributedTraining' => ['title' => '', 'description' => 'Indicates whether distributed training is supported.', 'type' => 'boolean', 'example' => 'true'], + 'Image' => ['title' => '', 'description' => 'The training runtime image.', 'type' => 'string', 'example' => 'registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0', 'required' => true], 'SupportedInstanceTypes' => [ - 'title' => 'A list of ECS instances that the algorithm can use to submit training job.', - 'description' => '', - 'visibility' => 'Public', + 'deprecated' => false, + 'description' => 'The list of supported elastic computing instance types for training.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs.g6.2xlarge', - 'extendType' => 'true', - ], - 'deprecated' => true, - 'backendName' => 'SupportedInstanceTypes', + 'items' => ['description' => 'A supported elastic computing instance type for training.', 'type' => 'string', 'title' => '', 'example' => 'ecs.g6.2xlarge'], + 'example' => '', ], 'ComputeResource' => [ - 'title' => 'Compute resource', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The compute resource definition.', + 'title' => '', 'type' => 'object', 'properties' => [ 'Policy' => [ - 'title' => 'Policy', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Computing resource configuration policy for the algorithm. ', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Version' => [ - 'title' => 'Policy Version', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'V1', - 'backendName' => 'Version', - ], - 'Value' => [ - 'title' => 'Policy Value', - 'description' => 'Policy Value', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '0', - 'backendName' => 'Value', - ], + 'Version' => ['description' => 'Policy version. ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'V1'], + 'Value' => ['description' => 'Policy content, serialized from a JSON array. ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '[{\\"MinTotalCount\\":1,\\"MaxTotalCount\\":4,\\"RolePolicies\\":{\\"chief\\":{\\"Count\\":1},\\"ps\\":{\\"Count\\":1},\\"worker\\":{\\"Percentage\\":100}}},{\\"MinTotalCount\\":5,\\"MaxTotalCount\\":10,\\"RolePolicies\\":{\\"chief\\":{\\"Count\\":1},\\"ps\\":{\\"Percentage\\":20},\\"worker\\":{\\"Percentage\\":80}}},{\\"MinTotalCount\\":11,\\"RolePolicies\\":{\\"chief\\":{\\"Count\\":1},\\"ps\\":{\\"Percentage\\":40},\\"worker\\":{\\"Percentage\\":60}}}]'], ], 'required' => true, - 'backendName' => 'Policy', + 'example' => '', ], ], - 'backendName' => 'ComputeResource', - ], - 'CodeDir' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'CodeDir', - '$ref' => '#/components/schemas/Location', + 'example' => '', ], + 'CodeDir' => ['description' => 'The custom code configuration.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Location'], 'Customization' => [ - 'title' => 'Customization', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The custom configuration.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'CodeDir' => [ - 'title' => 'CodeDir', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'CodeDir', - ], + 'CodeDir' => ['description' => 'Indicates whether custom-mounted code is used. ', 'title' => '', 'type' => 'boolean', 'example' => 'true'], ], - 'backendName' => 'Customization', + 'example' => '', ], 'ResourceRequirements' => [ - 'title' => 'Resource requirements.', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The resource requirements.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ConditionExpression', - ], - 'backendName' => 'ResourceRequirements', + 'items' => ['description' => 'Resource requirement expression. ', '$ref' => '#/components/schemas/ConditionExpression', 'title' => '', 'example' => ''], + 'example' => '', ], 'ProgressDefinitions' => [ - 'title' => 'ProgressDefinitions', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'You can use this feature to monitor the training progress.', + 'title' => '', 'type' => 'object', 'properties' => [ 'OverallProgress' => [ - 'title' => 'OverallProgress', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Monitors training progress.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'Description', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'training progress', - 'backendName' => 'Description', - ], - 'Regex' => [ - 'title' => 'Regex', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '^[0-9]+([.][0-9]+){0,1}$', - 'backendName' => 'Regex', - ], + 'Description' => ['title' => '', 'description' => 'The description of the monitoring definition.', 'type' => 'string', 'example' => 'training progress'], + 'Regex' => ['title' => '', 'description' => 'The regular expression for monitoring.', 'type' => 'string', 'example' => '^[0-9]+([.][0-9]+){0,1}$'], ], - 'backendName' => 'OverallProgress', + 'example' => '', ], 'RemainingTime' => [ - 'title' => 'RemainingTime', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The definition for monitoring the remaining training time.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'Description', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'training remaining time', - 'backendName' => 'Description', - ], - 'Regex' => [ - 'title' => 'Regex', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '^[0-9]+([.][0-9]+){0,1}$', - 'backendName' => 'Regex', - ], + 'Description' => ['title' => '', 'description' => 'The description of the monitoring definition.', 'type' => 'string', 'example' => 'training remaining time'], + 'Regex' => ['title' => '', 'description' => 'The regular expression for monitoring.', 'type' => 'string', 'example' => '^[0-9]+([.][0-9]+){0,1}$'], ], - 'backendName' => 'RemainingTime', + 'example' => '', ], ], - 'backendName' => 'ProgressDefinitions', + 'example' => '', ], ], + 'example' => '', ], - 'Channel' => [ - 'title' => 'A named input/output for the algorithm.', - 'description' => '', - 'visibility' => 'Public', + 'AllocatedHyperNodeDetail' => [ 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'A brief description for the channel.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'Description', - ], - 'Required' => [ - 'title' => 'Indicates whethe the channels is required.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'Required', - ], - 'Properties' => [ - 'title' => 'The properties of channel.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{}', - 'backendName' => 'Properties', - ], - 'Name' => [ - 'title' => 'The name of channel.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Model', - 'backendName' => 'Name', - ], - 'SupportedChannelTypes' => [ - 'title' => 'Supported Channel Types', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss', - 'extendType' => 'true', - ], - 'required' => false, - 'backendName' => 'SupportedChannelTypes', - ], + 'HyperNodeName' => ['title' => '', 'description' => 'The name of the hyper node.', 'type' => 'string', 'example' => ''], + 'AllocatedNodeNum' => ['title' => '', 'description' => 'The number of allocated nodes in the hyper node.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'TotalNodeNum' => ['title' => '', 'description' => 'The total number of nodes in the hyper node.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'EmptyNodeNum' => ['title' => '', 'description' => 'The number of idle nodes in the hyper node.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], ], + 'description' => 'Describes the resource allocation status of a hyper node.', + 'title' => '', + 'example' => '', ], - 'ConditionExpression' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'AssignNodeSpec' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => 'The key of the conditional expression.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'SupportedMachineTypes', - 'backendName' => 'Key', - ], - 'Operator' => [ - 'title' => 'The operator of the conditional expression', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'in', - 'backendName' => 'Operator', + 'EnableAssignNode' => ['type' => 'boolean'], + 'NodeNames' => ['type' => 'string'], + 'AntiAffinityNodeNames' => ['type' => 'string'], + ], + ], + 'BindingPolicy' => [ + 'title' => '', + 'description' => 'The policy for binding nodes.', + 'type' => 'object', + 'properties' => [ + 'NodeSpecCount' => ['title' => '', 'description' => 'The number of nodes to be selected by the scheduler.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'IncludeNodes' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The node ID to include.', 'type' => 'string', 'example' => 'lrnabc', 'title' => ''], + 'description' => 'A list of node IDs to include in the scheduling.', + 'example' => '', ], - 'Values' => [ - 'title' => 'The values of the conditional expression.', - 'description' => '', - 'visibility' => 'Public', + 'ExcludeNodes' => [ + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs.gn5-c4g1.xlarge', - 'extendType' => 'true', - ], - 'required' => true, - 'backendName' => 'Values', + 'items' => ['description' => 'The node ID to exclude.', 'type' => 'string', 'example' => 'lrndef', 'title' => ''], + 'description' => 'A list of node IDs to exclude from scheduling.', + 'example' => '', ], ], + 'example' => '', ], - 'ForwardInfo' => [ - 'title' => 'User VPC Forward Info', - 'description' => 'VPC Forward Info', - 'visibility' => 'Public', + 'CacheInfo' => [ 'type' => 'object', 'properties' => [ - 'NatGatewayId' => [ - 'title' => 'NAT Gateway ID', - 'description' => 'NAT Gateway ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'nat-7j4mka9wguxj', - 'backendName' => 'NatGatewayId', - ], - 'EipAllocationId' => [ - 'title' => 'EIP Allocation ID', - 'description' => 'EIP Allocation ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eip-h29r78ieufbih', - 'backendName' => 'EipAllocationId', - ], + 'MountPoint' => ['type' => 'string'], + 'Port' => ['type' => 'string'], ], ], - 'GPUInfo' => [ - 'title' => 'A short description of struct', - 'description' => 'pai resource group ecs spec', - 'visibility' => 'Public', + 'CacheService' => [ 'type' => 'object', 'properties' => [ - 'count' => [ + 'CacheServiceId' => ['description' => 'The unique identifier of the CacheService.', 'type' => 'string', 'title' => '', 'example' => ''], + 'QuotaId' => ['description' => 'The ID of the resource quota associated with the CacheService.', 'type' => 'string', 'title' => '', 'example' => ''], + 'UserVpc' => ['description' => 'The configuration of the user\'s VPC where the CacheService is deployed.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UserVpc'], + 'CacheInfos' => [ + 'type' => 'array', + 'items' => ['description' => 'An object containing details for a single cache instance.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/CacheInfo'], + 'description' => 'Information about each cache node in the service.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'count', + 'example' => '', ], - 'type' => [ + 'SupportedClientQuotaIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A supported client quota ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of quota IDs for clients that can connect to this CacheService.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'T4', - 'backendName' => 'type', + 'example' => '', ], + 'TenantId' => ['description' => 'The ID of the tenant that owns the CacheService.', 'type' => 'string', 'title' => '', 'example' => ''], + 'UserId' => ['description' => 'The ID of the user associated with the CacheService.', 'type' => 'string', 'title' => '', 'example' => ''], + 'CreatedBy' => ['description' => 'The user or entity that created the resource.', 'type' => 'string', 'title' => '', 'example' => ''], + 'GmtCreated' => ['description' => 'The time (in UTC, ISO 8601 format) when the CacheService was created.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Status' => ['description' => 'The current status of the CacheService. For example: `Creating`, `Available`, or `Deleting`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'SupportRDMA' => ['description' => 'Indicates whether the CacheService supports RDMA.', 'type' => 'string', 'title' => '', 'example' => ''], + 'NetworkType' => ['description' => 'The network type of the CacheService. For example, `VPC`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'ClusterId' => ['description' => 'The ID of the PAI cluster where the CacheService is deployed.', 'type' => 'string', 'title' => '', 'example' => ''], + 'IsSharded' => ['description' => 'Indicates whether the CacheService is sharded across multiple nodes.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'description' => 'Represents a PAI CacheService instance, including its configuration and status.', + 'title' => '', + 'example' => '', + ], + 'CapacityLock' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['type' => 'string'], + 'gmtCreated' => ['type' => 'string'], + 'gmtModified' => ['type' => 'string'], + 'lockProvider' => ['type' => 'string'], + 'privatePoolId' => ['type' => 'string'], + 'tenantId' => ['type' => 'string'], + 'instanceType' => ['type' => 'string'], + 'zoneId' => ['type' => 'string'], + 'paymentType' => ['type' => 'string'], + 'status' => ['type' => 'string'], + 'lastSyncTime' => ['type' => 'string'], + 'lastReconcileAttemptTime' => ['type' => 'string'], + 'crsReservationId' => ['type' => 'string'], + 'expireTime' => ['type' => 'string'], + 'operator' => ['type' => 'string'], + 'description' => ['type' => 'string'], + 'requestedCount' => ['type' => 'integer', 'format' => 'int32'], + 'lockedCount' => ['type' => 'integer', 'format' => 'int32'], + 'usedCount' => ['type' => 'integer', 'format' => 'int32'], + 'availableCount' => ['type' => 'integer', 'format' => 'int32'], ], ], - 'HyperParameterDefinition' => [ - 'title' => 'Definition of the input hyper parameter for the algorithm.', - 'description' => '', - 'visibility' => 'Public', + 'Channel' => [ + 'description' => 'Defines an input/output channel.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'DefaultValue' => [ - 'title' => 'Default value for the parameter.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'DefaultValue', - ], - 'Type' => [ - 'title' => 'Type of the parameter.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Integer', - 'backendName' => 'Type', - ], - 'Description' => [ - 'title' => 'Description for the parameter.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'Description' => ['description' => 'Channel description. ', 'title' => '', 'type' => 'string', 'example' => '模型输出。'], + 'Required' => ['description' => 'Indicates whether the channel must be configured. ', 'title' => '', 'type' => 'boolean', 'example' => 'true'], + 'Properties' => ['description' => 'Storage configuration of the channel. ', 'title' => '', 'type' => 'object', 'example' => '{}'], + 'Name' => ['description' => 'Channel name. ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'Model'], + 'SupportedChannelTypes' => [ + 'description' => 'List of storage classes supported by the channel. ', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'Storage class. ', 'type' => 'string', 'example' => 'oss', 'title' => ''], + 'required' => false, 'example' => '', - 'backendName' => 'Description', - ], - 'Required' => [ - 'title' => 'Indicates whether the parameter is required', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'Required', - ], - 'Name' => [ - 'title' => 'Name of the parameter.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'batch_size', - 'backendName' => 'Name', - ], - 'Range' => [ - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'Range', - '$ref' => '#/components/schemas/HyperParameterRange', - ], - 'DisplayName' => [ - 'title' => 'Display name of parameter.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Batch Size', - 'backendName' => 'DisplayName', ], ], + 'example' => '', ], - 'HyperParameterRange' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'ClusterSpec' => [ 'type' => 'object', 'properties' => [ - 'Enum' => [ - 'title' => 'Enumerated values for hyperparameters.', - 'description' => '', - 'visibility' => 'Public', + 'ClusterType' => ['type' => 'string'], + 'Image' => ['type' => 'string'], + 'DataSources' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'extendType' => 'true', - ], - 'required' => false, - 'backendName' => 'Enum', + 'items' => ['$ref' => '#/components/schemas/DataSource'], ], - 'MinLength' => [ - 'title' => 'Minimum length of string.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'MinLength', - ], - 'MaxLength' => [ - 'title' => 'Maximum length of string.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - 'backendName' => 'MaxLength', - ], - 'Minimum' => [ - 'title' => 'Minimum value.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'Minimum', + ], + ], + 'ComponentSpec' => [ + 'title' => 'Defines how the training job of the algorithm run.', + 'type' => 'object', + 'properties' => [ + 'OutputChannels' => [ + 'title' => 'The outputs of the algorithm.', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Channel'], ], - 'Maximum' => [ - 'title' => 'Maximum value.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10', - 'backendName' => 'Maximum', + 'HyperParameters' => [ + 'title' => 'The hype parameter used by the algorithm.', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/HyperParameterDefinition'], ], - 'ExclusiveMinimum' => [ - 'title' => 'Whether to exclude minimum values.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'ExclusiveMinimum', + 'JobType' => ['title' => 'Job type of the training job while running the algorithm.', 'type' => 'string', 'required' => true], + 'Command' => ['title' => 'The command used for submit the job.', 'type' => 'string', 'required' => true], + 'MetricDefinitions' => [ + 'title' => 'The output metrics of the algorithm.', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/MetricDefinition'], ], - 'ExclusiveMaximum' => [ - 'title' => 'Whether to exclude maximum values', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'ExclusiveMaximum', + 'InputChannels' => [ + 'title' => 'The input for the algorithm.', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Channel'], + 'required' => false, ], - 'Pattern' => [ - 'title' => 'Value Regex Pattern.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '^\\+?[1-9][0-9]*$', - 'backendName' => 'Pattern', + 'Image' => ['title' => 'The docker image used by the job of this algorithm.', 'type' => 'string', 'required' => true], + 'CodeDir' => ['$ref' => '#/components/schemas/Location'], + 'ResourceRequirements' => [ + 'title' => 'Resource requirements.', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ConditionExpression'], ], ], ], - 'JobSettings' => [ + 'ConditionExpression' => [ + 'description' => 'Resource requirement configuration.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'BusinessUserId' => [ + 'Key' => ['description' => 'The type of required resource.', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'SupportedMachineTypes'], + 'Operator' => ['description' => 'The criterion for evaluation.', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'in'], + 'Values' => [ + 'description' => 'List of resource values.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '166924', - 'backendName' => 'BusinessUserId', + 'type' => 'array', + 'items' => ['description' => 'Resource value.', 'type' => 'string', 'example' => 'ecs.gn5-c4g1.xlarge', 'title' => ''], + 'required' => true, + 'example' => '', ], - 'Caller' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SilkFlow', - 'backendName' => 'Caller', - ], - 'Tags' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + ], + 'example' => '', + ], + 'DataSource' => [ + 'type' => 'object', + 'properties' => [ + 'DataSourceId' => ['type' => 'string'], + 'MountPath' => ['type' => 'string'], + 'Uri' => ['type' => 'string'], + ], + ], + 'EcsSpec' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => ['type' => 'string', 'backendName' => 'InstanceType', 'description' => '', 'title' => '', 'example' => ''], + 'Cpu' => ['type' => 'integer', 'format' => 'int32', 'backendName' => 'Cpu', 'description' => '', 'title' => '', 'example' => ''], + 'Gpu' => ['type' => 'integer', 'format' => 'int32', 'backendName' => 'Gpu', 'description' => '', 'title' => '', 'example' => ''], + 'GpuType' => ['type' => 'string', 'backendName' => 'GpuType', 'description' => '', 'title' => '', 'example' => ''], + 'GpuTypeAlias' => ['type' => 'string', 'backendName' => 'GpuTypeAlias', 'description' => '', 'title' => '', 'example' => ''], + 'Memory' => ['type' => 'integer', 'format' => 'int32', 'backendName' => 'Memory', 'description' => '', 'title' => '', 'example' => ''], + 'SupportRDMA' => ['type' => 'boolean', 'backendName' => 'SupportRDMA', 'description' => '', 'title' => '', 'example' => ''], + 'EriQuantity' => ['type' => 'integer', 'format' => 'int32', 'backendName' => 'EriQuantity', 'description' => '', 'title' => '', 'example' => ''], + 'SupportSetNetworkCardIndex' => ['type' => 'boolean', 'backendName' => 'SupportSetNetworkCardIndex', 'description' => '', 'title' => '', 'example' => ''], + 'AcceleratorType' => ['type' => 'string', 'backendName' => 'AcceleratorType', 'description' => '', 'title' => '', 'example' => ''], + 'PlannedCpu' => ['type' => 'integer', 'format' => 'int32', 'backendName' => 'PlannedCpu', 'description' => '', 'title' => '', 'example' => ''], + 'PlannedMemory' => ['type' => 'integer', 'format' => 'int32', 'backendName' => 'PlannedMemory', 'description' => '', 'title' => '', 'example' => ''], + 'ResourceType' => ['type' => 'string', 'backendName' => 'ResourceType', 'description' => '', 'title' => '', 'example' => ''], + 'EcsImageId' => ['type' => 'string', 'backendName' => 'EcsImageId', 'description' => '', 'title' => '', 'example' => ''], + 'GpuGUSpec' => ['type' => 'string', 'backendName' => 'GpuGUSpec', 'description' => '', 'title' => '', 'example' => ''], + 'GpuMemory' => ['type' => 'integer', 'format' => 'int32', 'backendName' => 'GpuMemory', 'description' => '', 'title' => '', 'example' => ''], + 'MachineModel' => ['type' => 'string', 'backendName' => 'MachineModel', 'description' => '', 'title' => '', 'example' => ''], + 'SupportGPUShare' => ['type' => 'boolean', 'backendName' => 'SupportGPUShare', 'description' => '', 'title' => '', 'example' => ''], + 'NetworkMode' => ['type' => 'string', 'backendName' => 'NetworkMode', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EniCacheConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['type' => 'boolean'], + 'CachePoolSize' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '255'], + ], + ], + 'Event' => [ + 'type' => 'object', + 'properties' => [ + 'ObjectId' => ['description' => 'The object ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'TriggeredBy' => ['description' => 'The user or system that triggered the event.', 'type' => 'string', 'title' => '', 'example' => ''], + 'TriggerUserId' => ['description' => 'The trigger user ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'EventId' => ['description' => 'The unique ID of the event.', 'type' => 'string', 'title' => '', 'example' => ''], + 'EventType' => ['description' => 'The event type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'ObjectType' => ['description' => 'The object type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'TriggerTenantId' => ['description' => 'The trigger tenant ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'TriggerTime' => ['description' => 'The time the event was triggered, in UTC and ISO 8601 format.', 'type' => 'string', 'title' => '', 'example' => ''], + 'IsTruncated' => ['description' => 'Indicates if the returned data is incomplete.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Content' => ['description' => 'The event content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Function' => ['description' => 'The function associated with the event.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'A container for the event details.', + 'title' => '', + 'example' => '', + ], + 'Features' => [ + 'title' => '灰度功能', + 'description' => '灰度功能', + 'type' => 'object', + 'properties' => [ + 'Quota' => [ + 'title' => 'Quota功能', 'type' => 'object', - 'additionalProperties' => [ - 'visibility' => 'Public', - 'type' => 'string', + 'properties' => [ + 'IsEnabled' => ['title' => '是否开启', 'type' => 'boolean', 'example' => 'true'], ], - 'backendName' => 'Tags', - ], - 'PipelineId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'pid-123456', - 'backendName' => 'PipelineId', - ], - 'EnableTideResource' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'EnableTideResource', - ], - 'EnableErrorMonitoringInAIMaster' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'EnableErrorMonitoringInAIMaster', - ], - 'ErrorMonitoringArgs' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '--enable-log-hang-detection true', - 'backendName' => 'ErrorMonitoringArgs', - ], - 'EnableRDMA' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'EnableRDMA', - ], - 'EnableOssAppend' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'EnableOssAppend', ], - 'OversoldType' => [ + ], + ], + 'ForwardInfo' => [ + 'title' => '', + 'description' => 'VPC Forward Info', + 'type' => 'object', + 'properties' => [ + 'NatGatewayId' => ['title' => '', 'description' => 'NAT Gateway ID', 'type' => 'string', 'example' => 'nat-7j4mka9wguxj'], + 'EipAllocationId' => ['title' => '', 'description' => 'EIP Allocation ID', 'type' => 'string', 'example' => 'eip-h29r78ieufbih'], + ], + 'example' => '', + ], + 'GPUInfo' => [ + 'description' => 'PAI resource group ECS specification ', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'count' => ['description' => 'Quantity ', 'title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'type' => ['description' => 'Type ', 'title' => '', 'type' => 'string', 'example' => 'T4'], + ], + 'example' => '', + ], + 'GPUMetric' => [ + 'title' => 'A short description of struct', + 'description' => 'GPU指标', + 'type' => 'object', + 'properties' => [ + 'Index' => ['title' => 'GPU编号', 'type' => 'integer', 'format' => 'int64'], + 'Model' => ['title' => '显卡型号', 'type' => 'string'], + 'UsageRate' => ['title' => 'GPU使用率', 'type' => 'number', 'format' => 'float'], + 'Status' => ['title' => '卡状态', 'type' => 'integer', 'format' => 'int64', 'example' => '0：异常；1：正常'], + ], + ], + 'HyperParameterDefinition' => [ + 'description' => 'The hyperparameter definition.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'DefaultValue' => ['title' => '', 'description' => 'The default value of the hyperparameter.', 'type' => 'string', 'example' => '0'], + 'Type' => ['title' => '', 'description' => 'The type of the hyperparameter.', 'type' => 'string', 'example' => 'Integer', 'required' => true], + 'Description' => ['title' => '', 'description' => 'The description of the hyperparameter.', 'type' => 'string', 'example' => '参数定义了训练的batch_size。'], + 'Required' => ['title' => '', 'description' => 'Specifies whether the parameter is required.', 'type' => 'boolean', 'example' => 'true'], + 'Name' => ['title' => '', 'description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'batch_size', 'required' => true], + 'Range' => ['description' => 'The value range of the parameter.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/HyperParameterRange'], + 'DisplayName' => ['title' => '', 'description' => 'The display name of the parameter.', 'type' => 'string', 'example' => 'Batch Size'], + ], + 'example' => '', + ], + 'HyperParameterRange' => [ + 'description' => 'Hyperparameter value range.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Enum' => [ + 'description' => 'Hyperparameter enumeration list.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'AcceptQuotaOverSold', - 'backendName' => 'OversoldType', + 'type' => 'array', + 'items' => ['description' => 'Enumeration value.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'required' => false, + 'example' => '', ], - 'AdvancedSettings' => [ + 'MinLength' => ['title' => '', 'description' => 'Minimum length.', 'type' => 'integer', 'example' => '1', 'format' => 'int64'], + 'MaxLength' => ['title' => '', 'description' => 'Maximum length.', 'type' => 'integer', 'example' => '30', 'format' => 'int64'], + 'Minimum' => ['title' => '', 'description' => 'Minimum value.', 'type' => 'string', 'example' => '0'], + 'Maximum' => ['title' => '', 'description' => 'Maximum value.', 'type' => 'string', 'example' => '10'], + 'ExclusiveMinimum' => ['title' => '', 'description' => 'Whether the minimum value is exclusive.', 'type' => 'boolean', 'example' => 'true'], + 'ExclusiveMaximum' => ['title' => '', 'description' => 'Whether the maximum value is exclusive.', 'type' => 'boolean', 'example' => 'true'], + 'Pattern' => ['title' => '', 'description' => 'Regular expression.', 'type' => 'string', 'example' => '^\\+?[1-9][0-9]*$'], + ], + 'example' => '', + ], + 'JobSettings' => [ + 'description' => 'Additional job parameter settings.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'BusinessUserId' => ['title' => '', 'description' => 'User ID associated with the job.', 'type' => 'string', 'example' => '166924'], + 'Caller' => ['title' => '', 'description' => 'Caller.', 'type' => 'string', 'example' => 'SilkFlow'], + 'Tags' => [ + 'description' => 'Custom tags.', + 'additionalProperties' => ['description' => 'Custom tags. ', 'type' => 'string', 'title' => '', 'example' => ''], 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', - 'backendName' => 'AdvancedSettings', - ], - 'Driver' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '535.54.03', - 'backendName' => 'Driver', - ], - 'EnableSanityCheck' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'EnableSanityCheck', - ], - 'SanityCheckArgs' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFai', - 'backendName' => 'SanityCheckArgs', - ], - 'JobReservedMinutes' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'JobReservedMinutes', + 'example' => '', ], + 'PipelineId' => ['title' => '', 'description' => 'Workflow ID.', 'type' => 'string', 'example' => 'pid-123456'], + 'EnableTideResource' => ['title' => '', 'description' => 'Enable the job to use tide resources.', 'type' => 'boolean', 'example' => 'true'], + 'EnableErrorMonitoringInAIMaster' => ['title' => '', 'description' => 'Enable job fault tolerance monitoring.', 'type' => 'boolean', 'example' => 'false'], + 'ErrorMonitoringArgs' => ['title' => '', 'description' => 'Specify configuration parameters for fault tolerance monitoring, such as whether to enable log hang-based detection.', 'type' => 'string', 'example' => '--enable-log-hang-detection true'], + 'EnableRDMA' => ['title' => '', 'description' => 'Enable the job to use RDMA.', 'type' => 'boolean', 'example' => 'true'], + 'EnableOssAppend' => ['title' => '', 'description' => 'Enable OSS append writes.', 'type' => 'boolean', 'example' => 'true'], + 'OversoldType' => ['title' => '', 'description' => 'Job\'s oversold resource usage method (not accepted, accepted, or only accepted).', 'type' => 'string', 'example' => 'AcceptQuotaOverSold'], + 'AdvancedSettings' => ['title' => '', 'description' => 'Additional advanced parameter settings.', 'type' => 'object', 'example' => ''], + 'Driver' => ['title' => '', 'description' => 'NVIDIA driver configuration.', 'type' => 'string', 'example' => '535.54.03'], + 'EnableSanityCheck' => ['title' => '', 'description' => 'Enable computing power health check for the job.', 'type' => 'boolean', 'example' => 'true'], + 'SanityCheckArgs' => ['title' => '', 'description' => 'Configuration parameters for computing power health check.', 'type' => 'string', 'example' => '--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFai'], + 'JobReservedMinutes' => ['title' => '', 'description' => 'Duration in minutes to retain the job after completion.', 'type' => 'integer', 'example' => '30', 'format' => 'int32'], 'JobReservedPolicy' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Policy for retaining the job after completion.', 'type' => 'string', 'example' => 'Always', - 'backendName' => 'JobReservedPolicy', - 'enum' => [ - 'Always', - 'OnFailure', - 'OnSucceed', - ], + 'enum' => ['Always', 'OnFailure', 'OnSucceed'], ], ], - 'parseType' => 'struct', + 'example' => '', ], - 'Label' => [ + 'JobViewMetric' => [ 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'public', + 'description' => 'resource group metric', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => 'Key of label.', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'testAccTag', - 'backendName' => 'Key', - ], - 'Value' => [ - 'title' => 'Value of label.', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'nihao', - 'backendName' => 'Value', + 'ResourceGroupID' => ['title' => '资源组ID', 'type' => 'string', 'example' => 'rg17tmvwiokhzaxg'], + 'TotalCPU' => ['title' => '总的CPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'], + 'GPUUsageRate' => ['title' => 'GPU使用率', 'type' => 'string'], + 'TotalMemory' => ['title' => '总内存kb', 'type' => 'integer', 'format' => 'int64'], + 'TotalGPU' => ['title' => '总的GPU卡数', 'type' => 'integer', 'format' => 'int32'], + 'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'], + 'RequestCPU' => ['title' => '占用的CPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'RequestGPU' => ['title' => '占用的GPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'RequestMemory' => ['title' => '占用的内存kb', 'type' => 'integer', 'format' => 'int64'], + 'NetworkInputRate' => ['title' => '网络写入速率', 'type' => 'string'], + 'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'], + 'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'], + 'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'], + 'JobType' => ['title' => '任务类型dlc,dsw /etc', 'type' => 'string'], + 'UserId' => ['title' => '用户ID', 'type' => 'string'], + 'NodeNames' => [ + 'title' => '节点列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], + 'JobId' => ['title' => '任务ID', 'type' => 'string'], + ], + ], + 'Label' => [ + 'description' => 'label struct ', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the label. ', 'title' => '', 'type' => 'string', 'example' => 'testAccTag'], + 'Value' => ['description' => 'The value of the label. ', 'title' => '', 'type' => 'string', 'example' => 'nihao'], ], + 'example' => '', ], 'Location' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Code configuration.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'LocationType' => [ - 'title' => 'Location type, such as OSS,Git.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OSS', - 'backendName' => 'LocationType', - ], - 'LocationValue' => [ - 'title' => 'Location value.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => 'oss://${bucket_name}.oss-${region}.aliyuncs.com/oss/location/path/', - 'backendName' => 'LocationValue', - ], + 'LocationType' => ['description' => 'The code location type. Valid values: OSS and NAS.', 'title' => '', 'type' => 'string', 'example' => 'OSS'], + 'LocationValue' => ['description' => 'The code path.', 'title' => '', 'type' => 'object', 'example' => 'oss://${bucket_name}.oss-${region}.aliyuncs.com/oss/location/path/'], ], + 'example' => '', ], 'MachineGroup' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Machine group information', 'type' => 'object', 'properties' => [ - 'MachineGroupID' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mg1', - 'backendName' => 'MachineGroupID', - ], - 'ResourceGroupID' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rgf0zhfqn1d4ity2', - 'backendName' => 'ResourceGroupID', - ], - 'EcsCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'EcsCount', - ], - 'PaymentDuration' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2', - 'backendName' => 'PaymentDuration', - ], - 'EcsSpec' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs.c6.large', - 'backendName' => 'EcsSpec', - ], - 'GmtCreatedTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - 'backendName' => 'GmtCreatedTime', - ], - 'GmtExpiredTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-08-22T00:00:00Z'."\n", - 'backendName' => 'GmtExpiredTime', - ], - 'GmtModifiedTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - 'backendName' => 'GmtModifiedTime', - ], - 'GmtStartedTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - 'backendName' => 'GmtStartedTime', - ], - 'PaymentType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'PREPAY', - 'backendName' => 'PaymentType', - ], - 'PaymentDurationUnit' => [ - 'title' => 'region ID', - 'description' => 'region ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Monthly', - 'backendName' => 'PaymentDurationUnit', - ], - 'Status' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Success', - 'backendName' => 'Status', - ], - 'ReasonMessage' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '“”', - 'backendName' => 'ReasonMessage', - ], - 'ReasonCode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '“”', - 'backendName' => 'ReasonCode', - ], - 'CreatorID' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1612285282502324', - 'backendName' => 'CreatorID', - ], + 'Status' => ['description' => 'Machine group status ', 'title' => '', 'type' => 'string', 'example' => 'Success'], + 'EcsCount' => ['description' => 'Resource count ', 'title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GmtStartedTime' => ['description' => 'Start At ', 'title' => '', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'ResourceGroupID' => ['description' => 'Resource group ID ', 'title' => '', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'], + 'GmtCreatedTime' => ['description' => 'Creation Time ', 'title' => '', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'CreatorID' => ['description' => 'Machine group creator ID ', 'title' => '', 'type' => 'string', 'example' => '1612285282502324'], + 'ReasonMessage' => ['description' => 'Machine group fault message ', 'title' => '', 'type' => 'string', 'example' => '“”'], + 'PaymentDurationUnit' => ['description' => 'Region ID ', 'title' => '', 'type' => 'string', 'example' => 'Monthly'], + 'EcsSpec' => ['description' => 'ECS specification ', 'title' => '', 'type' => 'string', 'example' => 'ecs.c6.large'], 'SupportedDrivers' => [ + 'description' => 'List of NVIDIA GPU driver versions supported by the machine group ', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '470.199.02', - 'extendType' => 'true', - ], - 'backendName' => 'SupportedDrivers', - 'itemName' => 'DriverVersions', - ], - 'DefaultDriver' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '470.199.02', - 'backendName' => 'DefaultDriver', - ], - 'OrderInstanceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '“”', - 'backendName' => 'OrderInstanceId', + 'items' => ['description' => 'Driver version number ', 'type' => 'string', 'example' => '470.199.02', 'title' => ''], + 'example' => '', ], + 'PaymentDuration' => ['description' => 'Duration ', 'title' => '', 'type' => 'string', 'example' => '2'], + 'ReasonCode' => ['description' => 'Machine group error code ', 'title' => '', 'type' => 'string', 'example' => '“”'], + 'GmtModifiedTime' => ['description' => 'Update Time ', 'title' => '', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'DiskCapacity' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GmtExpiredTime' => ['description' => 'Expiration Time ', 'title' => '', 'type' => 'string', 'example' => '2023-08-22T00:00:00Z'."\n"], + 'OrderInstanceId' => ['description' => 'Order ID ', 'title' => '', 'type' => 'string', 'example' => '“”'], + 'DefaultDriver' => ['description' => 'Default driver supported by the machine group ', 'title' => '', 'type' => 'string', 'example' => '470.199.02'], + 'MachineGroupID' => ['description' => 'Machine Group ID ', 'title' => '', 'type' => 'string', 'example' => 'mg1'], + 'PaymentType' => ['description' => 'Payment type ', 'title' => '', 'type' => 'string', 'example' => 'PREPAY'], + 'DiskPL' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Cpu' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Gpu' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GpuMemory' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GpuType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Memory' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'ResourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AllocatableCpu' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'AllocatableMemory' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'SystemReservedCpu' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'SystemReservedMemory' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'Metric' => [ + 'description' => 'Metric data for resource groups.', 'title' => '', - 'description' => 'resource group metric', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Time' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'rg17tmvwiokhzaxg', - 'backendName' => 'Time', - ], - 'Value' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '23000', - 'backendName' => 'Value', - ], + 'Time' => ['description' => 'The UNIX timestamp.', 'title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'rg17tmvwiokh****'], + 'Value' => ['description' => 'The metric value.', 'title' => '', 'type' => 'string', 'example' => '23000'], ], + 'example' => '', ], 'MetricDefinition' => [ - 'title' => 'Describe the output metric of the algorithm.', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The definition for collecting training metrics.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'A brief description for the metric.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'Description', - ], - 'Regex' => [ - 'title' => 'Regex use to match the metrics from job log.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '.*train:loss=([-+]?[0-9]*\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*', - 'backendName' => 'Regex', - ], - 'Name' => [ - 'title' => 'The name of the metric.', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'loss', - 'backendName' => 'Name', - ], + 'Description' => ['title' => '', 'description' => 'The description of the metric.', 'type' => 'string', 'example' => '训练损失函数。'], + 'Regex' => ['title' => '', 'description' => 'The regular expression to collect metrics from logs.', 'type' => 'string', 'example' => '.*train:loss=([-+]?[0-9]*\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*', 'required' => true], + 'Name' => ['title' => '', 'description' => 'The name of the metric.', 'type' => 'string', 'example' => 'loss', 'required' => true], ], + 'example' => '', ], 'Node' => [ + 'description' => 'The details of a resource node.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'CreatorId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '281044699048527748', - 'backendName' => 'CreatorId', - ], - 'NodeName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'lingjxxxx', - 'backendName' => 'NodeName', - ], - 'NodeType' => [ + 'CreatorId' => ['title' => '', 'description' => 'The ID of the user who created the resource node.', 'type' => 'string', 'example' => '281044699048527748'], + 'NodeName' => ['title' => '', 'description' => 'The name of the resource node.', 'type' => 'string', 'example' => 'lingjxxxx'], + 'NodeType' => ['title' => '', 'description' => 'The instance type of the resource node.', 'type' => 'string', 'example' => 'ecs.c8i.xlarge'], + 'AcceleratorType' => ['title' => '', 'description' => 'The accelerator type of the resource node instance, such as CPU or GPU.', 'type' => 'string', 'example' => 'CPU'], + 'CPU' => ['title' => '', 'description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '4'], + 'Memory' => ['title' => '', 'description' => 'The memory size in GiB.', 'type' => 'string', 'example' => '8'], + 'GPU' => ['title' => '', 'description' => 'The number of GPUs.', 'type' => 'string', 'example' => '0'], + 'GPUType' => ['title' => '', 'description' => 'The GPU model.', 'type' => 'string', 'example' => '""'], + 'GPUMemory' => ['title' => '', 'description' => 'The GPU memory size in GiB.', 'type' => 'string', 'example' => ''], + 'NodeStatus' => ['title' => '', 'description' => 'The status of the resource node.', 'type' => 'string', 'example' => 'Ready'], + 'ReasonCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '""'], + 'ReasonMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '""'], + 'OrderStatus' => ['title' => '', 'description' => 'The order status of the resource node.', 'type' => 'string', 'example' => 'Ready'], + 'ResourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group to which the resource node belongs.', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'], + 'ResourceGroupName' => ['title' => '', 'description' => 'The name of the resource group to which the resource node belongs.', 'type' => 'string', 'example' => 'test'], + 'MachineGroupId' => ['title' => '', 'description' => 'The ID of the machine group to which the resource node belongs.', 'type' => 'string', 'example' => 'mg1234456'], + 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the resource node was created.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'deprecated' => true], + 'GmtCreatedTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the resource node was last modified.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'], + 'GmtExpiredTime' => ['title' => '', 'description' => 'The time when the resource node expires.', 'type' => 'string', 'example' => '2025-06-22T00:00:00Z'."\n"], + 'IsBound' => ['title' => '', 'description' => 'Indicates whether the node is bound to a quota.', 'type' => 'boolean', 'example' => 'false'], + 'BoundQuotas' => [ + 'description' => 'The list of quotas that are bound to the node.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs.c8i.xlarge', - 'backendName' => 'NodeType', + 'type' => 'array', + 'items' => ['description' => 'The details of a quota that is bound to the node.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QuotaIdName'], + 'example' => '', ], - 'AcceleratorType' => [ + 'RequestCPU' => ['title' => '', 'description' => 'The number of requested CPU cores.', 'type' => 'string', 'example' => '4'], + 'RequestMemory' => ['title' => '', 'description' => 'The requested memory size in GiB.', 'type' => 'string', 'example' => '8'], + 'RequestGPU' => ['title' => '', 'description' => 'The number of requested GPUs.', 'type' => 'string', 'example' => '0'], + 'LimitCPU' => ['title' => '', 'description' => 'The maximum number of CPU cores.', 'type' => 'string', 'example' => '4'], + 'LimitMemory' => ['title' => '', 'description' => 'The maximum memory size in GiB.', 'type' => 'string', 'example' => '8'], + 'LimitGPU' => ['title' => '', 'description' => 'The maximum number of GPUs.', 'type' => 'string', 'example' => '0'], + 'PodNum' => ['title' => '', 'description' => 'The number of pods on the node.', 'type' => 'integer', 'example' => '2', 'format' => 'int64'], + 'WorkloadNum' => ['title' => '', 'description' => 'The number of workloads on the node.', 'type' => 'integer', 'example' => '2', 'format' => 'int64'], + 'Users' => [ + 'description' => 'The user information.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'CPU', - 'backendName' => 'AcceleratorType', + 'type' => 'array', + 'items' => ['description' => 'The details of a user who is running workloads on the node.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UserInfo'], + 'example' => '', ], - 'CPU' => [ + 'HyperZone' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AvailabilityZone' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AllocatableCPU' => ['title' => '', 'description' => 'The number of allocatable CPU cores.', 'type' => 'string', 'example' => ''], + 'AllocatableMemory' => ['title' => '', 'description' => 'The amount of allocatable memory in GiB.', 'type' => 'string', 'example' => ''], + 'SystemReservedCPU' => ['title' => '', 'description' => 'The number of CPU cores that are reserved for the system.', 'type' => 'string', 'example' => ''], + 'SystemReservedMemory' => ['title' => '', 'description' => 'The amount of memory that is reserved for the system in GiB.', 'type' => 'string', 'example' => ''], + 'AncestorQuotaWorkloadNum' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'SelfQuotaWorkloadNum' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'DescendantQuotaWorkloadNum' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'DiskPL' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DiskCapacity' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'SubNodes' => [ 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '4', - 'backendName' => 'CPU', - ], - 'Memory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '8', - 'backendName' => 'Memory', - ], - 'GPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'GPU', - ], - 'GPUType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'GPUType', - ], - 'NodeStatus' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Ready', - 'backendName' => 'NodeStatus', - ], - 'ReasonCode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'ReasonCode', - ], - 'ReasonMessage' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'ReasonMessage', - ], - 'OrderStatus' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Ready', - 'backendName' => 'OrderStatus', - ], - 'ResourceGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rgf0zhfqn1d4ity2', - 'backendName' => 'ResourceGroupId', - ], - 'ResourceGroupName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'ResourceGroupName', - ], - 'MachineGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'mg1234456', - 'backendName' => 'MachineGroupId', - ], - 'GmtCreateTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - 'backendName' => 'GmtCreateTime', - ], - 'GmtModifiedTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - 'backendName' => 'GmtModifiedTime', - ], - 'GmtExpiredTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-06-22T00:00:00Z'."\n", - 'backendName' => 'GmtExpiredTime', - ], - 'IsBound' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'IsBound', - ], - 'BoundQuotas' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/QuotaIdName', - ], - 'backendName' => 'BoundQuotas', - ], - 'RequestCPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '4', - 'backendName' => 'RequestCPU', - ], - 'RequestMemory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '8', - 'backendName' => 'RequestMemory', - ], - 'RequestGPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'RequestGPU', - ], - 'LimitCPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '4', - 'backendName' => 'LimitCPU', - ], - 'LimitMemory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '8', - 'backendName' => 'LimitMemory', - ], - 'LimitGPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'LimitGPU', - ], - 'PodNum' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'PodNum', - ], - 'WorkloadNum' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'WorkloadNum', - ], - 'Users' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/UserInfo', - ], - 'backendName' => 'Users', + 'example' => '', ], ], + 'example' => '', ], 'NodeCordonParameters' => [ - 'visibility' => 'Public', + 'description' => 'Parameter settings for cordoning a node.', 'type' => 'object', 'properties' => [ - 'QuotaId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'QuotaId', - ], - 'WorkspaceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'WorkspaceId', - ], - 'Comment' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'Comment', - ], + 'QuotaId' => ['description' => 'Quota ID, used when disabling edge zone scheduling in a workspace ', 'title' => '', 'type' => 'string', 'example' => 'quota1dkoutl3tj1'], + 'WorkspaceId' => ['description' => 'Workspace ID, used when disabling edge zone scheduling in a workspace ', 'title' => '', 'type' => 'string', 'example' => '12345'], + 'Comment' => ['description' => 'User-configurable reason for disabling scheduling ', 'title' => '', 'type' => 'string', 'example' => 'this is a comment'], ], + 'title' => '', + 'example' => '', ], 'NodeDrainParameters' => [ - 'visibility' => 'Public', + 'description' => 'Parameters for the node drain operation.', 'type' => 'object', 'properties' => [ 'PodNames' => [ + 'description' => 'Delete specified pods ', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], - 'backendName' => 'PodNames', + 'items' => ['description' => 'Pod name ', 'title' => '', 'type' => 'string', 'example' => 'dlcxxxx-master-0'], + 'example' => '', ], 'PodFromSubProducts' => [ + 'description' => 'Delete pods of the specified job types ', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], - 'backendName' => 'PodFromSubProducts', + 'items' => ['description' => 'Job Type: dlc/dsw/eas/tensorboard ', 'title' => '', 'type' => 'string', 'example' => 'dlc'], + 'example' => '', + ], + 'Force' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'NodeGPUMetric' => [ + 'title' => '节点GPU指标', + 'description' => '节点GPU指标', + 'type' => 'object', + 'properties' => [ + 'NodeId' => ['title' => '节点ID', 'type' => 'string'], + 'NodeType' => ['title' => '节点类型', 'type' => 'string'], + 'GPUType' => ['title' => 'GPU类型', 'type' => 'string'], + 'GPUCount' => ['title' => 'GPU数量', 'type' => 'integer', 'format' => 'int32'], + 'AcceleratorType' => ['title' => '显卡类型', 'type' => 'string'], + 'TotalMemory' => ['title' => '总内存', 'type' => 'number', 'format' => 'float'], + 'UsedMemory' => ['title' => '已用内存', 'type' => 'number', 'format' => 'float'], + 'MemoryUtil' => ['title' => '内存使用率', 'type' => 'number', 'format' => 'float'], + 'GPUMetrics' => [ + 'title' => 'GPU指标', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/GPUMetric'], ], ], ], 'NodeMetric' => [ + 'description' => 'Resource group node metrics.', 'title' => '', - 'description' => 'resource group metric', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'NodeID' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '-i121212node', - 'backendName' => 'NodeID', - ], + 'NodeID' => ['description' => 'Edge zone ID. ', 'title' => '', 'type' => 'string', 'example' => '-i12****node'], 'Metrics' => [ + 'description' => 'Performance Metrics. ', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Metric', - ], + 'items' => ['description' => 'Metric information. ', '$ref' => '#/components/schemas/Metric', 'title' => '', 'example' => ''], 'example' => '23000', - 'backendName' => 'Metrics', - ], - 'GPUType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GU108', - 'backendName' => 'GPUType', ], + 'GPUType' => ['description' => 'The type of GPU. ', 'title' => '', 'type' => 'string', 'example' => 'GU108'], ], + 'example' => '', ], 'NodeOperationParameters' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'CordonParameters' => [ - 'visibility' => 'Public', - 'backendName' => 'CordonParameters', - '$ref' => '#/components/schemas/NodeCordonParameters', - ], - 'UncordonParameters' => [ - 'visibility' => 'Public', - 'backendName' => 'UncordonParameters', - '$ref' => '#/components/schemas/NodeUncordonParameters', - ], - 'DrainParameters' => [ - 'visibility' => 'Public', - 'backendName' => 'DrainParameters', - '$ref' => '#/components/schemas/NodeDrainParameters', + 'CordonParameters' => ['description' => 'Node cordon parameter settings', '$ref' => '#/components/schemas/NodeCordonParameters', 'title' => '', 'example' => ''], + 'UncordonParameters' => ['description' => 'Node uncordon parameter settings', '$ref' => '#/components/schemas/NodeUncordonParameters', 'title' => '', 'example' => ''], + 'DrainParameters' => ['description' => 'Node drain task instance parameter settings', '$ref' => '#/components/schemas/NodeDrainParameters', 'title' => '', 'example' => ''], + ], + 'description' => 'Node operation parameter settings', + 'title' => '', + 'example' => '', + ], + 'NodeOperationResult' => [ + 'title' => '节点操作结果', + 'description' => '节点操作结果', + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['title' => '节点名称', 'type' => 'string'], + 'Status' => ['title' => '节点操作状态', 'type' => 'string'], + 'Message' => ['title' => '节点操作状态信息', 'type' => 'string'], + ], + ], + 'NodePodInfo' => [ + 'title' => '节点上的Pod信息', + 'type' => 'object', + 'properties' => [ + 'PodName' => ['title' => 'Pod名称', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'Phase' => ['title' => 'Pod状态', 'type' => 'string', 'required' => false, 'example' => 'Running'], + 'PodNamespace' => ['title' => 'Pod所在namespace', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'PodIP' => ['title' => 'Pod ip地址', 'type' => 'string', 'example' => '192.168.2.2'], + 'ResourceSpec' => ['$ref' => '#/components/schemas/ResourceAmount'], + 'WorkloadType' => ['title' => 'Pod属于子产品', 'type' => 'string', 'example' => 'dlc'], + 'WorkloadId' => ['title' => '任务id/服务id', 'type' => 'string', 'example' => 'dlc19de9s6vn3acr'], + ], + ], + 'NodeSnapshot' => [ + 'title' => '节点快照', + 'description' => '节点快照', + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['title' => '节点名称', 'type' => 'string'], + 'RequestCPU' => ['title' => 'CPU用量', 'type' => 'string'], + 'RequestMemory' => ['title' => 'Memory用量', 'type' => 'string'], + 'RequestGPU' => ['title' => 'GPU用量', 'type' => 'string'], + 'Workloads' => [ + 'title' => '节点任务快照', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WorkloadId' => ['title' => '任务ID', 'type' => 'string'], + 'WorkloadType' => ['title' => '任务类型', 'type' => 'string'], + 'Name' => ['title' => '对应排队单元名称', 'type' => 'string'], + ], + ], ], + 'WorkloadNum' => ['title' => '节点workload数量', 'type' => 'integer', 'format' => 'int32'], + 'AncestorQuotaWorkloadNum' => ['title' => '使用祖先Quota的workload数量', 'type' => 'integer', 'format' => 'int32'], + 'SelfQuotaWorkloadNum' => ['title' => '使用本Quota的Workload数量', 'type' => 'integer', 'format' => 'int32'], + 'DescendantQuotaWorkloadNum' => ['title' => '使用子Quota的workload数量', 'type' => 'integer', 'format' => 'int32'], ], ], 'NodeSpec' => [ + 'description' => 'Specifications for a single resource.', 'title' => '', - 'description' => 'NodeSpec', - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Type' => [ + 'Type' => ['title' => '', 'description' => 'Type of the resource node specification.', 'type' => 'string', 'example' => 'ecs.g6.4xlarge'], + 'Count' => ['title' => '', 'description' => 'Number of resource nodes with this specification.', 'type' => 'integer', 'example' => '10', 'format' => 'int64'], + 'BindingPolicy' => ['title' => '', 'description' => 'Rule for attaching resource nodes.', 'example' => '', '$ref' => '#/components/schemas/BindingPolicy'], + 'HyperType' => ['title' => '', 'description' => 'Type of supernode to use. You cannot specify both a node specification and a supernode type.', 'type' => 'string', 'example' => ''], + ], + 'example' => '', + ], + 'NodeStatistics' => [ + 'type' => 'object', + 'properties' => [ + 'ActualMinResources' => ['title' => '', '$ref' => '#/components/schemas/StatisticsResources', 'description' => '', 'example' => ''], + 'SchedulableResources' => ['title' => '', '$ref' => '#/components/schemas/StatisticsResources', 'description' => '', 'example' => ''], + 'IdleResources' => ['title' => '', '$ref' => '#/components/schemas/StatisticsResources', 'description' => '', 'example' => ''], + 'SystemReservedResources' => ['title' => '', '$ref' => '#/components/schemas/StatisticsResources', 'description' => '', 'example' => ''], + 'HyperNodeDetails' => [ 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IdleNum' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Count' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ecs.g6.4xlarge', - 'backendName' => 'Type', + 'example' => '', ], - 'Count' => [ + 'GPUDetails' => [ 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IdleNum' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Count' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'backendName' => 'Count', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NodeType' => [ + 'title' => '资源节点规格详情', + 'description' => '资源节点规格', + 'type' => 'object', + 'properties' => [ + 'NodeType' => ['title' => '资源节点规格类型', 'type' => 'string', 'example' => 'ecs.g6.4xlarge'], + 'AcceleratorType' => ['title' => '资源节点规格加速器类型（CPU/GPU）', 'type' => 'string', 'example' => 'CPU'], + 'CPU' => ['title' => 'CPU核数', 'type' => 'string', 'example' => '16'], + 'Memory' => ['title' => '内存大小', 'type' => 'string', 'example' => '64Gi'], + 'GPU' => ['title' => 'GPU卡数', 'type' => 'string', 'example' => '0'], + 'GPUType' => ['title' => 'GPU卡类型', 'type' => 'string'], + 'GPUMemory' => ['title' => 'GPU显存', 'type' => 'string', 'example' => '80G'], + 'AllocatableCPU' => ['title' => '用户可分配CPU核数', 'type' => 'string'], + 'AllocatableMemory' => ['title' => '用户可分配内存大小', 'type' => 'string'], + 'SystemReservedCPU' => ['title' => '系统预留CPU核数', 'type' => 'string'], + 'SystemReservedMemory' => ['title' => '系统预留内存大小', 'type' => 'string'], + ], + ], + 'NodeTypeStatistic' => [ + 'title' => '资源节点规格统计信息', + 'description' => '资源节点规格统计', + 'type' => 'object', + 'properties' => [ + 'NodeType' => ['title' => '资源节点规格', 'type' => 'string', 'example' => 'ecs.g6.4xlarge'], + 'TotalCount' => ['title' => '该规格的资源节点总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'CanBeBoundCount' => ['title' => '该规格可被绑定的资源节点数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + ], ], 'NodeUncordonParameters' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'QuotaId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'QuotaId', - ], - 'WorkspaceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'WorkspaceId', + 'QuotaId' => ['title' => '', 'description' => 'Quota ID. You can use this ID when you start a workspace or disable scheduling nodes.', 'type' => 'string', 'example' => 'quota1ci8g793pgm'], + 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace that contains the node to uncordon.', 'type' => 'string', 'example' => '12345'], + ], + 'description' => 'Parameter settings for uncordoning a node.', + 'title' => '', + 'example' => '', + ], + 'NodeViewMetric' => [ + 'title' => '资源节点维度实时指标', + 'description' => 'resource group metric', + 'type' => 'object', + 'properties' => [ + 'NodeID' => ['title' => '节点ID', 'type' => 'string', 'example' => '-i121212node'], + 'NodeType' => ['title' => '显卡的类型', 'type' => 'string'], + 'MachineGroupID' => ['title' => '机器组ID', 'type' => 'string'], + 'CreatedTime' => ['title' => '节点导入时间', 'type' => 'string'], + 'RequestCPU' => ['title' => '已经使用的CPU', 'type' => 'integer', 'format' => 'int64'], + 'RequestMemory' => ['title' => '已经使用的内存', 'type' => 'integer', 'format' => 'int64'], + 'RequestGPU' => ['title' => '使用的GPU', 'type' => 'integer', 'format' => 'int64'], + 'NetworkInputRate' => ['title' => '网络输入速率', 'type' => 'string'], + 'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'], + 'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'], + 'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'], + 'TotalCPU' => ['title' => '总的CPU', 'type' => 'integer', 'format' => 'int64'], + 'TotalGPU' => ['title' => '总的GPU', 'type' => 'integer', 'format' => 'int64'], + 'TotalMemory' => ['title' => '总的内存', 'type' => 'integer', 'format' => 'int64'], + 'GPUType' => ['title' => '卡型', 'type' => 'string'], + 'UserNumber' => ['title' => '用户总数', 'type' => 'string'], + 'UserIDs' => [ + 'title' => '用户列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], + 'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'], + 'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'], + 'NodeStatus' => ['title' => '节点状态', 'type' => 'string'], + 'TotalTasks' => ['title' => '节点任务总数', 'type' => 'integer', 'format' => 'int64'], + 'TaskIdMap' => ['title' => '节点任务', 'type' => 'object'], + ], + ], + 'OversoldUsageConfig' => [ + 'type' => 'object', + 'properties' => [ + 'DisabledBy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Disabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Permission' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['title' => 'ResourceType', 'type' => 'string'], + 'IsEnabled' => ['title' => 'IsEnabled', 'type' => 'boolean'], ], ], + 'QueueInfo' => [ + 'title' => '任务排队信息', + 'description' => '队列信息', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '状态', 'type' => 'string', 'example' => 'Enqueued'], + 'QuotaId' => ['title' => '任务使用的Quota', 'type' => 'string', 'example' => '“quotamtl37ge7gkvdz”'], + 'UserName' => ['title' => '用户名', 'type' => 'string'], + 'WorkloadId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'dlcxxxx'], + 'Position' => ['title' => '队列位置', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'GmtEnqueuedTime' => ['title' => '入队时间', 'type' => 'string', 'example' => '“2023-06-22T00:00:00Z”'], + 'Priority' => ['title' => '任务优先级', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'GmtCreatedTime' => ['title' => '任务创建时间', 'type' => 'string'], + 'WorkloadType' => ['title' => '任务类型', 'type' => 'string', 'example' => 'dlc'], + 'WorkspaceId' => ['title' => '任务所在的工作空间', 'type' => 'string', 'example' => '“432524”'], + 'Resource' => ['title' => '使用资源情况', '$ref' => '#/components/schemas/ResourceAmount'], + 'Code' => ['title' => '错误码', 'type' => 'string', 'example' => 'roleMaximumResource'], + 'Reason' => ['title' => '错误消息', 'type' => 'string', 'example' => 'Current GPU Limit is 5, limited by Role PAI.AlgoDeveloper'], + 'UseOversoldResource' => ['type' => 'boolean'], + 'Name' => ['title' => '底层QueueUnit名称', 'type' => 'string', 'example' => 'test-label-79f5498dd-9qrzs'], + 'WorkloadStatus' => ['title' => 'dlc/dsw/eas 具体状态', 'type' => 'string', 'example' => 'PreAllocation'], + 'WorkloadName' => ['title' => '任务名称', 'type' => 'string'], + 'UserId' => ['title' => '创建者信息', 'type' => 'string'], + 'GmtPositionModifiedTime' => ['title' => '排队位置变化时间', 'type' => 'string', 'example' => '"2023-06-22T00:00:00Z"'], + 'CodeType' => ['title' => '错误类型', 'type' => 'string', 'example' => 'ConfigRule'], + 'GmtDequeuedTime' => ['title' => '出队列时间', 'type' => 'string', 'example' => '"2023-06-22T00:00:00Z"'], + 'WorkspaceName' => ['type' => 'string'], + 'QueueStrategy' => ['title' => '所在队列的出队策略', 'type' => 'string', 'example' => 'PaiStrategyIntelligent'], + ], + ], + 'QueueMeta' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the queue entry.', 'type' => 'string', 'example' => ''], + 'QuotaId' => ['title' => '', 'description' => 'The ID of the associated quota.', 'type' => 'string', 'example' => ''], + 'Position' => ['title' => '', 'description' => 'The position of the entry in the queue.', 'type' => 'string', 'example' => ''], + 'GmtEnqueuedTime' => ['title' => '', 'description' => 'The time the entry was added to the queue.', 'type' => 'string', 'example' => ''], + 'GmtPositionModifiedTime' => ['title' => '', 'description' => 'The last time the position of the entry was modified.', 'type' => 'string', 'example' => ''], + 'GmtDequeuedTime' => ['title' => '', 'description' => 'The time the entry was removed from the queue.', 'type' => 'string', 'example' => ''], + 'QueueStrategy' => ['title' => '', 'description' => 'The queuing strategy for the entry.', 'type' => 'string', 'example' => ''], + 'Resource' => ['title' => '', 'description' => 'The resources that the queue entry requires.', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'ScheduledResource' => ['title' => '', 'description' => 'The resources scheduled for the entry.', 'type' => 'string', 'example' => ''], + 'Status' => ['title' => '', 'description' => 'The current status of the entry.', 'type' => 'string', 'example' => ''], + 'UseOversoldResource' => ['title' => '', 'description' => 'Indicates whether the entry can use oversold resources.', 'type' => 'boolean', 'example' => ''], + ], + 'description' => 'Metadata for a queue entry.', + 'title' => '', + 'example' => '', + ], 'Quota' => [ + 'description' => 'The details of the quota.', 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'QuotaId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'quota12345', - 'backendName' => 'QuotaId', - ], - 'QuotaName' => [ + 'QuotaId' => ['title' => '', 'description' => 'The quota ID.', 'type' => 'string', 'example' => 'quota12345'], + 'QuotaName' => ['title' => '', 'description' => 'The quota name.', 'type' => 'string', 'example' => 'dlc-quota'], + 'ResourceType' => ['title' => '', 'description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- `Lingjun`'."\n" + ."\n" + .'- `ECS` (default)'."\n" + ."\n" + .'- `ACS`', 'type' => 'string', 'example' => 'ECS'], + 'ParentQuotaId' => ['title' => '', 'description' => 'The parent quota ID.', 'type' => 'string', 'example' => '""'], + 'ResourceGroupIds' => [ + 'description' => 'A list of resource group IDs.', 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'dlc-quota', - 'backendName' => 'QuotaName', + 'type' => 'array', + 'items' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'example' => 'rg69rj0leslw****'], + 'example' => '', ], - 'ResourceType' => [ + 'AllocateStrategy' => ['title' => '', 'description' => 'The resource allocation strategy. Currently, only `ByNodeSpec` is supported.', 'type' => 'string', 'example' => 'ByNodeSpec'], + 'Min' => ['title' => '', 'description' => 'The guaranteed resources.', 'example' => '', '$ref' => '#/components/schemas/ResourceSpec'], + 'Description' => ['title' => '', 'description' => 'The quota description.', 'type' => 'string', 'example' => 'this is a test quota'], + 'Labels' => [ + 'description' => 'The quota labels.', 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'ResourceType', + 'type' => 'array', + 'items' => ['description' => 'A key-value pair of the label.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Label'], + 'example' => '', ], - 'ParentQuotaId' => [ + 'CreatorId' => ['title' => '', 'description' => 'The ID of the user who created the quota.', 'type' => 'string', 'example' => '1884692****'], + 'LatestOperationId' => ['title' => '', 'description' => 'The ID of the most recent operation on the quota.', 'type' => 'string', 'example' => 'operation****'], + 'Status' => ['title' => '', 'description' => 'The quota status.', 'type' => 'string', 'example' => 'Ready'], + 'ReasonCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '“”'], + 'ReasonMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '“”'], + 'GmtCreatedTime' => ['title' => '', 'description' => 'The time when the quota was created.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the quota was last modified.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'QuotaDetails' => ['title' => '', 'description' => 'The quota details.', 'example' => '', '$ref' => '#/components/schemas/QuotaDetails'], + 'QuotaConfig' => ['title' => '', 'description' => 'The quota configuration.', 'example' => '', '$ref' => '#/components/schemas/QuotaConfig'], + 'Workspaces' => [ + 'description' => 'The workspaces that are associated with the quota.', 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'ParentQuotaId', + 'type' => 'array', + 'items' => ['description' => 'The details of an associated workspace.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/WorkspaceIdName'], + 'example' => '', ], - 'ResourceGroupIds' => [ + 'SubQuotas' => [ + 'description' => 'A list of sub-quotas.', 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'type' => 'string', - 'extendType' => 'true', - ], - 'backendName' => 'ResourceGroupIds', - 'itemName' => 'ResourceGroupIdItem', + 'items' => ['description' => 'The ID and name of a sub-quota.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QuotaIdName'], + 'example' => '', ], - 'AllocateStrategy' => [ - 'title' => '', + 'QueueStrategy' => ['title' => '', 'description' => 'The queuing strategy. Valid values:'."\n" + ."\n" + .'- `PaiStrategyIntelligent`: intelligent strategy.'."\n" + ."\n" + .'- `PaiStrategyBalance`: balanced strategy.'."\n" + ."\n" + .'- `PaiStrategyRoundRobin`: round-robin strategy.'."\n" + ."\n" + .'- `PaiStrategyStrictFIFO`: FIFO strategy.', 'type' => 'string', 'example' => 'PaiStrategyIntelligent'], + 'Version' => ['description' => 'The version.', 'type' => 'string', 'title' => '', 'example' => ''], + 'QuotaCluster' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/QuotaCluster'], + 'HyperZones' => [ 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'AllocateStrategy', - ], - 'Min' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'Min', - '$ref' => '#/components/schemas/ResourceSpec', + 'example' => '', ], - 'Description' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'Description', - ], - 'Labels' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'GPUType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'example' => '', + ], + 'QuotaCluster' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterType' => ['type' => 'string'], + 'Image' => ['type' => 'string'], + 'DataSources' => [ 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Label', - ], - 'backendName' => 'Labels', - 'itemName' => 'LabelItem', - ], - 'CreatorId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'CreatorId', - ], - 'LatestOperationId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'LatestOperationId', - ], - 'Status' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'Status', - ], - 'ReasonCode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'ReasonCode', - ], - 'ReasonMessage' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'ReasonMessage', - ], - 'GmtCreatedTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'GmtCreatedTime', - ], - 'GmtModifiedTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'GmtModifiedTime', - ], - 'QuotaDetails' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'QuotaDetails', - '$ref' => '#/components/schemas/QuotaDetails', + 'items' => ['$ref' => '#/components/schemas/DataSource'], ], - 'QuotaConfig' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'QuotaConfig', - '$ref' => '#/components/schemas/QuotaConfig', + 'Endpoints' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'Workspaces' => [ + 'Status' => ['type' => 'string'], + ], + ], + 'QuotaConfig' => [ + 'description' => 'The resource quota configurations.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'SupportRDMA' => ['title' => '', 'description' => 'Specifies whether RDMA is supported.', 'type' => 'boolean', 'example' => 'false'], + 'ClusterId' => ['title' => '', 'description' => 'The ID of the cluster where the quota resides.', 'type' => 'string', 'example' => 'ceeb3724255364***'], + 'UserVpc' => ['description' => 'The user VPC information.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/UserVpc'], + 'SupportGPUDrivers' => [ + 'description' => 'The GPU driver versions supported by the resource quota.', 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/WorkspaceIdName', - ], - 'backendName' => 'Workspaces', - 'itemName' => 'WorkspaceItem', + 'items' => ['description' => 'The GPU driver version.', 'type' => 'string', 'title' => '', 'example' => '470.199.02'], + 'example' => '', ], - 'SubQuotas' => [ + 'DefaultGPUDriver' => ['title' => '', 'description' => 'The default GPU driver version for the resource quota.', 'type' => 'string', 'example' => '470.199.02'], + 'ACS' => ['title' => '', 'description' => 'The ACS-related configurations.', 'example' => '', '$ref' => '#/components/schemas/ACS'], + 'ResourceSpecs' => [ + 'description' => 'The resource specification templates.', 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/QuotaIdName', - ], - 'backendName' => 'SubQuotas', - 'itemName' => 'SubQuotaItem', + 'items' => ['description' => 'A resource specification template.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/WorkspaceSpecs'], + 'example' => '', ], - 'QueueStrategy' => [ + 'EnablePreemptSubquotaWorkloads' => ['title' => '', 'description' => 'Specifies whether workloads in sub-quotas can be preempted.', 'type' => 'boolean', 'example' => 'false', 'deprecated' => false], + 'EnableSubQuotaPreemption' => ['title' => '', 'description' => 'Specifies whether resources in sub-quotas can be preempted.', 'type' => 'boolean', 'example' => ''], + 'SubQuotaPreemptionConfig' => ['title' => '', 'description' => 'The configuration for the sub-quota preemption task.', 'example' => '', '$ref' => '#/components/schemas/SubQuotaPreemptionConfig'], + 'EnableGPUShare' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'OversoldUsageConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/OversoldUsageConfig'], + 'SelfQuotaPreemptionConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SelfQuotaPreemptionConfig'], + 'EniCacheConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/EniCacheConfig'], + 'SandboxCacheConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SandboxCacheConfig'], + 'UseCase' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnableSelfQuotaPreemption' => ['title' => '', 'description' => 'Specifies whether guaranteed resources within this quota can be preempted.', 'type' => 'boolean', 'example' => ''], + 'ControlPlaneClusterId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IsEncryptedResource' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'WorkloadTypes' => [ 'title' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'backendName' => 'QueueStrategy', + 'example' => '', ], ], + 'example' => '', ], - 'QuotaConfig' => [ + 'QuotaDetails' => [ + 'description' => 'Details of the quota.', 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'SupportRDMA' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'SupportRDMA', - ], - 'ClusterId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ceeb3724255364664', - 'backendName' => 'ClusterId', + 'DesiredMinQuota' => ['description' => 'Total MinQuota amount requested by the User ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'ActualMinQuota' => ['description' => 'Total MinQuota amount actually assigned ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'RequestedQuota' => ['description' => 'Quota request amount ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'UsedQuota' => ['description' => 'Quota usage amount ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'AllocatedQuota' => ['description' => 'Total Quota usage information ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'SelfAllocatedQuota' => ['description' => 'Quota usage information at the current level ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'AncestorsAllocatedQuota' => ['description' => 'Quota usage information of ancestors ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'DescendantsAllocatedQuota' => ['description' => 'Quota usage information of descendants ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'SelfSubmittedQuota' => ['$ref' => '#/components/schemas/ResourceAmount', 'description' => '', 'title' => '', 'example' => ''], + 'AllocatableQuota' => ['description' => 'Quota amount assignable by the User ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'SystemReservedQuota' => ['description' => 'System-reserved Quota amount ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'NodeStatistics' => ['$ref' => '#/components/schemas/QuotaNodeStatistics', 'description' => '', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + 'QuotaIdName' => [ + 'description' => 'Resource Quota ID & Name ', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'QuotaId' => ['description' => 'Resource quota ID ', 'title' => '', 'type' => 'string', 'example' => 'quota12345'], + 'QuotaName' => ['description' => 'Resource quota name ', 'title' => '', 'type' => 'string', 'example' => 'dlc-quota'], + ], + 'example' => '', + ], + 'QuotaJobViewMetric' => [ + 'title' => '资源配额作业维度指标', + 'description' => 'quota job view metric', + 'type' => 'object', + 'properties' => [ + 'TotalCPU' => ['title' => '总的CPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'], + 'GPUUsageRate' => ['title' => 'GPU使用率', 'type' => 'string'], + 'TotalMemory' => ['title' => '总内存kb', 'type' => 'integer', 'format' => 'int64'], + 'TotalGPU' => ['title' => '总的GPU卡数', 'type' => 'integer', 'format' => 'int32'], + 'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'], + 'RequestCPU' => ['title' => '占用的CPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'RequestGPU' => ['title' => '占用的GPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'RequestMemory' => ['title' => '占用的内存kb', 'type' => 'integer', 'format' => 'int64'], + 'NetworkInputRate' => ['title' => '网络写入速率', 'type' => 'string'], + 'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'], + 'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'], + 'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'], + 'JobType' => ['title' => '任务类型dlc,dsw /etc', 'type' => 'string'], + 'UserId' => ['title' => '用户ID', 'type' => 'string'], + 'NodeNames' => [ + 'title' => '节点列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'UserVpc' => [ - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'UserVpc', - '$ref' => '#/components/schemas/UserVpc', + 'JobId' => ['title' => '任务ID', 'type' => 'string'], + ], + ], + 'QuotaMetric' => [ + 'title' => '资源配额指标', + 'description' => 'resource group metric', + 'type' => 'object', + 'properties' => [ + 'Metrics' => [ + 'title' => '性能指标', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Metric'], + 'example' => '23000', ], - 'SupportGPUDrivers' => [ + 'GPUType' => ['title' => '显卡的类型', 'type' => 'string'], + ], + ], + 'QuotaNodeStatistics' => [ + 'type' => 'object', + 'properties' => [ + 'ActualMinNodeNum' => ['title' => '', 'description' => 'The guaranteed minimum number of nodes available in the quota.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'ActualMinHyperNodeNum' => ['title' => '', 'description' => 'The guaranteed minimum number of hyper nodes available in the quota.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'AllocatedNodeNum' => ['title' => '', 'description' => 'The number of nodes currently allocated from the quota.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'AllocatedHyperNodeNum' => ['title' => '', 'description' => 'The number of hyper nodes currently allocated from the quota.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'EmptyNodeNum' => ['title' => '', 'description' => 'The number of allocated nodes currently idle.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'AllocatedHyperNodeDetails' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '470.199.02', - 'extendType' => 'true', - ], - 'backendName' => 'SupportGPUDrivers', + 'items' => ['$ref' => '#/components/schemas/AllocatedHyperNodeDetail', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The details of an allocated hyper node.', + 'example' => '', ], - 'DefaultGPUDriver' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '470.199.02', - 'backendName' => 'DefaultGPUDriver', + ], + 'description' => 'Provides statistics about node usage within a resource quota.', + 'title' => '', + 'example' => '', + ], + 'QuotaNodeViewMetric' => [ + 'title' => 'Quota内资源节点维度实时指标', + 'description' => 'quota node view metric', + 'type' => 'object', + 'properties' => [ + 'NodeID' => ['title' => '节点ID', 'type' => 'string', 'example' => '-i121212node'], + 'NodeType' => ['title' => '显卡的类型', 'type' => 'string'], + 'QuotaId' => ['title' => '资源配额ID', 'type' => 'string'], + 'CreatedTime' => ['title' => '节点导入时间', 'type' => 'string'], + 'RequestCPU' => ['title' => '已经使用的CPU', 'type' => 'integer', 'format' => 'int64'], + 'RequestMemory' => ['title' => '已经使用的内存', 'type' => 'integer', 'format' => 'int64'], + 'RequestGPU' => ['title' => '使用的GPU', 'type' => 'integer', 'format' => 'int64'], + 'NetworkInputRate' => ['title' => '网络输入速率', 'type' => 'string'], + 'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'], + 'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'], + 'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'], + 'TotalCPU' => ['title' => '总的CPU', 'type' => 'integer', 'format' => 'int64'], + 'TotalGPU' => ['title' => '总的GPU', 'type' => 'integer', 'format' => 'int64'], + 'TotalMemory' => ['title' => '总的内存', 'type' => 'integer', 'format' => 'int64'], + 'GPUType' => ['title' => '卡型', 'type' => 'string'], + 'UserNumber' => ['title' => '用户总数', 'type' => 'string'], + 'UserIDs' => [ + 'title' => '用户列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'ACS' => [ - 'title' => 'ACS conf', - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'ACS', - '$ref' => '#/components/schemas/ACS', + 'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'], + 'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'], + 'NodeStatus' => ['title' => '节点状态', 'type' => 'string'], + 'TotalTasks' => ['title' => '节点任务总数', 'type' => 'integer', 'format' => 'int64'], + 'TaskIdMap' => ['title' => '节点任务', 'type' => 'object'], + ], + ], + 'QuotaUser' => [ + 'title' => '资源配额用户', + 'type' => 'object', + 'properties' => [ + 'Username' => ['title' => '用户名', 'type' => 'string'], + 'UserId' => ['title' => '用户ID', 'type' => 'string'], + 'WorkloadCount' => ['title' => '任务负载数量', 'type' => 'integer', 'format' => 'int32'], + 'Resources' => [ + 'title' => '资源', + 'type' => 'object', + 'properties' => [ + 'Used' => ['title' => '已使用资源', '$ref' => '#/components/schemas/ResourceAmount'], + 'Submitted' => ['title' => '已提交资源', '$ref' => '#/components/schemas/ResourceAmount'], + ], ], ], ], - 'QuotaDetails' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'QuotaUserViewMetric' => [ + 'title' => '资源配额用户维度指标', + 'description' => 'quota user view metric', 'type' => 'object', 'properties' => [ - 'DesiredMinQuota' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'DesiredMinQuota', - '$ref' => '#/components/schemas/ResourceAmount', + 'TotalCPU' => ['title' => '总的CPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'], + 'GPUUsageRate' => ['title' => 'GPU使用率', 'type' => 'string'], + 'TotalMemory' => ['title' => '总内存kb', 'type' => 'integer', 'format' => 'int64'], + 'TotalGPU' => ['title' => '总的GPU卡数', 'type' => 'integer', 'format' => 'int32'], + 'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'], + 'RequestCPU' => ['title' => '占用的CPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'RequestGPU' => ['title' => '占用的GPU核心数', 'type' => 'integer', 'format' => 'int32'], + 'RequestMemory' => ['title' => '占用的内存kb', 'type' => 'integer', 'format' => 'int64'], + 'NetworkInputRate' => ['title' => '网络写入速率', 'type' => 'string'], + 'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'], + 'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'], + 'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'], + 'JobType' => ['title' => 'JOB类型', 'type' => 'string'], + 'UserId' => ['title' => '用户ID', 'type' => 'string'], + 'CPUNodeNumber' => ['title' => 'CPU节点的数量', 'type' => 'integer', 'format' => 'int32'], + 'GPUNodeNumber' => ['title' => 'GPU节点的数量', 'type' => 'integer', 'format' => 'int32'], + 'CpuJobNames' => [ + 'title' => 'CPU任务', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'ActualMinQuota' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'ActualMinQuota', - '$ref' => '#/components/schemas/ResourceAmount', + 'GpuJobNames' => [ + 'title' => 'GPU任务', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'RequestedQuota' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'RequestedQuota', - '$ref' => '#/components/schemas/ResourceAmount', + 'NodeNames' => [ + 'title' => '节点列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - 'UsedQuota' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'backendName' => 'UsedQuota', - '$ref' => '#/components/schemas/ResourceAmount', + 'CpuNodeNames' => [ + 'title' => 'CPU节点列表', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'GpuNodeNames' => [ + 'title' => 'GPU节点列表', + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], - 'QuotaIdName' => [ + 'ResourceAmount' => [ + 'description' => 'Resource amount ', 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'QuotaId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'quota12345', - 'backendName' => 'QuotaId', - ], - 'QuotaName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'dlc-quota', - 'backendName' => 'QuotaName', - ], + 'CPU' => ['description' => 'Total CPU ', 'title' => '', 'type' => 'string', 'example' => '100'], + 'Memory' => ['description' => 'Total memory ', 'title' => '', 'type' => 'string', 'example' => '100Gi'], + 'GPU' => ['description' => 'Total GPU cards ', 'title' => '', 'type' => 'string', 'example' => '16'], + 'GPUType' => ['description' => 'GPU card type ', 'title' => '', 'type' => 'string', 'example' => 'GPU'], ], + 'example' => '', ], - 'ResourceAmount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'ResourceDiagnosisDetail' => [ + 'title' => '资源诊断详情', + 'description' => '资源诊断详情', 'type' => 'object', 'properties' => [ - 'CPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '100', - 'backendName' => 'CPU', - ], - 'Memory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '100Gi', - 'backendName' => 'Memory', - ], - 'GPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '16', - 'backendName' => 'GPU', + 'Status' => ['title' => '诊断状态', 'type' => 'string'], + 'ExceedResources' => [ + 'title' => '超限资源', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'CPU'], ], - 'GPUType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'GPU', - 'backendName' => 'GPUType', + 'Limit' => ['title' => '资源限额', '$ref' => '#/components/schemas/ResourceAmount'], + 'Used' => ['title' => '资源用量', '$ref' => '#/components/schemas/ResourceAmount'], + 'WorkloadIds' => [ + 'title' => '相关Workload Id', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'dlc1234567890'], ], ], ], 'ResourceGroup' => [ + 'title' => '', + 'description' => 'A PAI resource group.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '', 'description' => 'The name of the PAI resource group.', 'type' => 'string', 'example' => 'RG1'], + 'ResourceGroupID' => ['title' => '', 'description' => 'The ID of the PAI resource group.', 'type' => 'string', 'example' => 'rg17tmvwiokh****'], + 'WorkspaceID' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '23000'], + 'UserVpc' => ['title' => '', 'description' => 'The VPC configuration.', '$ref' => '#/components/schemas/UserVpc', 'example' => ''], + 'GmtCreatedTime' => ['title' => '', 'description' => 'The time the PAI resource group was created.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'GmtModifiedTime' => ['title' => '', 'description' => 'The time the PAI resource group was last modified.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'CreatorID' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '161228528250****'], + 'NodeCount' => ['title' => '', 'description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'Version' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResourceType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + 'ResourceGroupMetric' => [ 'title' => 'A short description of struct', - 'description' => 'pai resource group', - 'visibility' => 'Public', + 'description' => 'resource group metric', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'pai resource group name', - 'description' => 'pai resource group name', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RG1', - 'backendName' => 'Name', - ], - 'ResourceGroupID' => [ - 'title' => 'pai resource group id', - 'description' => 'pai resource group id', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rg17tmvwiokhzaxg', - 'backendName' => 'ResourceGroupID', - ], - 'WorkspaceID' => [ - 'title' => 'pworkspace id', - 'description' => 'pworkspace id', - 'visibility' => 'Public', - 'type' => 'string', + 'ResourceGroupID' => ['title' => '资源组ID', 'type' => 'string', 'example' => 'rg17tmvwiokhzaxg'], + 'Metrics' => [ + 'title' => '性能指标', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Metric'], 'example' => '23000', - 'backendName' => 'WorkspaceID', - ], - 'UserVpc' => [ - 'title' => 'UserVpc', - 'description' => 'UserVpc', - 'visibility' => 'Public', - 'backendName' => 'UserVpc', - '$ref' => '#/components/schemas/UserVpc', - ], - 'GmtCreatedTime' => [ - 'title' => 'pai resource created time', - 'description' => 'pai resource created time', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - 'backendName' => 'GmtCreatedTime', - ], - 'GmtModifiedTime' => [ - 'title' => 'GmtModified', - 'description' => 'GmtModified', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - 'backendName' => 'GmtModifiedTime', - ], - 'CreatorID' => [ - 'title' => 'CreatorID', - 'description' => 'CreatorID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1612285282502324', - 'backendName' => 'CreatorID', - ], - 'NodeCount' => [ - 'title' => 'NodeCount', - 'description' => 'NodeCount', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'backendName' => 'NodeCount', ], + 'GpuType' => ['title' => '显卡的类型', 'type' => 'string'], ], ], + 'ResourceInfos' => [ + 'type' => 'object', + 'properties' => [ + 'UserName' => ['type' => 'string'], + 'GpuCardType' => ['type' => 'string'], + 'ClusterId' => ['type' => 'string'], + 'UserId' => ['type' => 'string'], + 'EcsSpec' => ['type' => 'string'], + 'RegionId' => ['type' => 'string'], + 'MaxQuota' => ['type' => 'integer', 'format' => 'int64'], + 'UsedQuota' => ['type' => 'integer', 'format' => 'int64'], + 'NetworkPodId' => ['type' => 'string'], + 'MachineModel' => ['type' => 'string'], + ], + ], + 'ResourceLimitDetails' => [ + 'title' => 'A short description of struct', + 'description' => '资源限制细节', + 'type' => 'object', + 'properties' => [ + 'GCLevel' => ['title' => 'GC 等级', 'type' => 'string'], + 'ResourceLimit' => ['title' => '资源限制详情', 'type' => 'object'], + 'ShouldIgnoreResourceCheck' => ['title' => '是否忽略资源检查', 'type' => 'boolean'], + ], + ], + 'ResourceOperation' => [ + 'title' => '', + 'description' => '资源变更', + 'type' => 'object', + 'properties' => [ + 'OperationId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'ObjectType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'ObjectId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'OperationType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'OperationSpecJson' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'OperationDescription' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'CreatorId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'Status' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'ReasonCode' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'ReasonMessage' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'GmtCreatedTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'GmtModifiedTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'GmtStartTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'GmtEndTime' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'example' => '', + ], 'ResourceSpec' => [ + 'description' => 'The allocation policy. This policy specifies the node specifications, the number of nodes, and the amount of resources.', 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'NodeSpecs' => [ + 'description' => 'The resource node specifications.', 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/NodeSpec', - ], - 'backendName' => 'NodeSpecs', + 'items' => ['description' => 'The specifications of a single node.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/NodeSpec'], + 'example' => '', ], ], + 'example' => '', ], - 'UserInfo' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'Rules' => [ + 'title' => '任务规则配置', + 'description' => '规则配置', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '161222222222', - 'backendName' => 'UserId', + 'Scheduling' => ['title' => '任务调度规则配置', '$ref' => '#/components/schemas/SchedulingRule'], + ], + ], + 'SandboxCacheConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['type' => 'boolean'], + ], + ], + 'SchedulingRule' => [ + 'title' => '任务调度配置', + 'description' => '任务调度配置', + 'type' => 'object', + 'properties' => [ + 'StartAt' => ['title' => '任务开始生效时间', 'type' => 'string'], + 'EndAt' => ['title' => '任务停止时间', 'type' => 'string'], + 'ExecuteOnce' => ['title' => '是否只执行一次', 'type' => 'boolean', 'required' => false], + 'CronTab' => ['title' => 'cron tab，当前只支持 分、时、日、月、周 五个配置，秒级别的配置会被丢弃', 'type' => 'string'], + ], + ], + 'SelfQuotaPreemptionConfig' => [ + 'type' => 'object', + 'properties' => [ + 'PreemptorPriorities' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '9', 'minimum' => '1'], ], - 'UserName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'UserName', + 'PreemptedPriorities' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '9', 'minimum' => '1'], + ], + 'PreemptedProducts' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], ], ], ], - 'UserViewMetric' => [ - 'title' => 'A short description of struct', - 'description' => 'resource group metric', - 'visibility' => 'Public', + 'SpotBidPreviewItem' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '', 'description' => 'The name of the spot bid preview.', 'type' => 'string', 'example' => ''], + 'jobName' => ['title' => '', 'description' => 'The name of the associated job.', 'type' => 'string', 'example' => ''], + 'instanceType' => ['title' => '', 'description' => 'The type of compute instance.', 'type' => 'string', 'example' => ''], + 'gcLevel' => ['title' => '', 'description' => 'The GC level for the spot instance.', 'type' => 'string', 'example' => ''], + 'replicas' => ['title' => '', 'description' => 'The number of instance replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'maxDiscount' => ['title' => '', 'description' => 'The maximum discount percentage from the on-demand price.', 'type' => 'number', 'format' => 'double', 'example' => ''], + 'phase' => ['title' => '', 'description' => 'The current phase of the spot bid preview. Valid values are `Pending`, `Active`, and `Failed`.', 'type' => 'string', 'example' => ''], + 'message' => ['title' => '', 'description' => 'A message that provides additional details about the current phase.', 'type' => 'string', 'example' => ''], + 'clusterId' => ['title' => '', 'description' => 'The ID of the cluster where resources are provisioned.', 'type' => 'string', 'example' => ''], + 'allowCrossHpnZone' => ['description' => 'Determines whether instances can be deployed across different High-Performance Network (HPN) zones. Defaults to `false`.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'active' => ['description' => 'Indicates whether the spot bid is active. If set to `false`, the bid is paused.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'description' => 'Details of a spot bid preview.', + 'title' => '', + 'example' => '', + ], + 'SpotPriceItem' => [ + 'title' => '抢占式实例价格', + 'description' => '抢占式实例价格', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['title' => '可用区ID', 'type' => 'string', 'example' => 'cn-wulanchabu-a'], + 'InstanceType' => ['title' => '抢占式实例类型', 'type' => 'string', 'example' => 'ml.gu8xf.8xlarge-gu108'], + 'SpotDiscount' => ['title' => '抢占式实例折扣', 'type' => 'number', 'format' => 'float', 'example' => '0.1'], + 'Timestamp' => ['title' => '抢占式实例当前价格时间戳', 'type' => 'string', 'example' => '2024-01-17T06:00:00Z'], + ], + ], + 'SpotStockInternalInfo' => [ + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'title' => '', 'example' => ''], + 'hpnZone' => ['description' => 'The ID of the high-performance network (HPN) zone.', 'type' => 'string', 'title' => '', 'example' => ''], + 'totalQuantity' => ['description' => 'The total number of Spot Instances.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => ''], + 'availableQuantity' => ['description' => 'The number of available Spot Instances.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => ''], + ], + 'description' => 'Stock information for Spot Instances.', + 'title' => '', + 'example' => '', + ], + 'SpotStockItem' => [ 'type' => 'object', 'properties' => [ - 'ResourceGroupId' => [ + 'instanceType' => ['title' => '', 'description' => 'The instance type.', 'type' => 'string', 'example' => ''], + 'stockStatus' => ['title' => '', 'description' => 'The stock status of the instance type. Valid values are `Available` and `SoldOut`.', 'type' => 'string', 'example' => ''], + 'internalInfo' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rg17tmvwiokhzaxg', - 'backendName' => 'ResourceGroupID', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/SpotStockInternalInfo', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'Internal information about the stock of the spot instance type.', + 'example' => '', ], - 'TotalCPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - 'backendName' => 'TotalCPU', - ], - 'CPUUsageRate' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'CPUUsageRate', - ], - 'GPUUsageRate' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'GPUUsageRate', - ], - 'TotalMemory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'TotalMemory', - ], - 'TotalGPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'TotalGPU', - ], - 'MemoryUsageRate' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'MemoryUsageRate', - ], - 'RequestCPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'backendName' => 'RequestCPU', - ], - 'RequestGPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'RequestGPU', - ], - 'RequestMemory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102400000', - 'backendName' => 'RequestMemory', - ], - 'NetworkInputRate' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'NetworkInputRate', - ], - 'NetworkOutputRate' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'NetworkOutputRate', - ], - 'DiskReadRate' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'DiskReadRate', - ], - 'DiskWriteRate' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'DiskWriteRate', - ], - 'JobType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'JobType', + ], + 'description' => 'Information about the stock of a spot instance type.', + 'title' => '', + 'example' => '', + ], + 'SpotStockPreview' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => ['title' => '', 'type' => 'string', 'example' => 'ml.gu8xf.8xlarge-gu108', 'description' => ''], + 'StockStatus' => ['title' => '', 'type' => 'string', 'example' => 'WithStock', 'description' => ''], + 'SpotDiscount' => ['title' => '', 'type' => 'number', 'format' => 'float', 'example' => '0.1', 'description' => ''], + 'ClusterId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AvailableQuantity' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + 'StatisticsDetails' => [ + 'type' => 'object', + 'properties' => [ + 'IdleNum' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Count' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'StatisticsResources' => [ + 'type' => 'object', + 'properties' => [ + 'NodeNum' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'HyperNodeNum' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CPU' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Memory' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GPU' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SubQuotaPreemptionConfig' => [ + 'title' => 'A short description of struct', + 'description' => '抢占子Quota配置', + 'type' => 'object', + 'properties' => [ + 'PreemptedPriorityUpperBound' => ['title' => '被抢占任务最高优先级', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'PreemptedProducts' => [ + 'title' => '可被抢占的任务类型', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'dlc'], ], - 'UserId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'backendName' => 'UserId', + ], + ], + 'Task' => [ + 'title' => '任务详情', + 'description' => '任务信息', + 'type' => 'object', + 'properties' => [ + 'QuotaId' => ['title' => '所属Quota ID', 'type' => 'string'], + 'TaskName' => ['title' => '任务名称', 'type' => 'string'], + 'TaskId' => ['title' => '任务ID', 'type' => 'string'], + 'Description' => ['title' => '任务描述', 'type' => 'string'], + 'Rules' => ['title' => '任务执行规则', '$ref' => '#/components/schemas/Rules'], + 'Actions' => [ + 'title' => '任务执行的操作', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Action'], ], - 'CPUNodeNumber' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'CPUNodeNumber', + 'UserId' => ['title' => '用户ID', 'type' => 'string'], + 'UserName' => ['title' => '用户名', 'type' => 'string'], + 'Status' => ['title' => '任务状态', 'type' => 'string'], + 'GmtCreatedTime' => ['title' => '任务创建时间', 'type' => 'string'], + 'GmtModifiedTime' => ['title' => '任务修改时间', 'type' => 'string'], + 'GmtActivatedTime' => ['title' => '任务激活时间', 'type' => 'string'], + 'GmtStoppedTime' => ['title' => '任务停止时间', 'type' => 'string'], + ], + ], + 'TaskInstance' => [ + 'title' => 'Quota 任务实例', + 'description' => 'Quota任务实例', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['title' => '任务ID', 'type' => 'string'], + 'TaskInstanceId' => ['title' => '任务实例ID', 'type' => 'string'], + 'UserId' => ['title' => '创建者ID', 'type' => 'string'], + 'TenantId' => ['title' => '云账号ID', 'type' => 'string'], + 'Status' => ['title' => '任务实例状态', 'type' => 'string'], + 'GmtCreatedTime' => ['title' => '实例创建时间', 'type' => 'string'], + 'GmtEndTime' => ['title' => '实例结束时间', 'type' => 'string'], + ], + ], + 'TaskInstanceEvent' => [ + 'title' => 'Quota Task Instance Event', + 'description' => 'Quota 任务实例消息', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '状态', 'type' => 'string'], + 'GmtStartTime' => ['title' => '开始运行时间', 'type' => 'string'], + 'GmtEndTime' => ['title' => '结束运行时间', 'type' => 'string'], + 'WorkloadType' => ['title' => '任务涉及子产品类型', 'type' => 'string'], + 'PodName' => ['title' => '任务涉及Pod名称', 'type' => 'string'], + 'Message' => ['title' => '消息内容', 'type' => 'string'], + ], + ], + 'TimeRangeFilter' => [ + 'title' => '时间范围定义，过滤使用', + 'description' => '时间范围搜索', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['title' => '开始时间', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'EndTime' => ['title' => '结束时间', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + ], + ], + 'UnschedulableNodeDetail' => [ + 'title' => '节点调度失败原因', + 'description' => '节点调度失败原因', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'title' => '节点列表', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'i-eabcsjiow'], ], - 'GPUNodeNumber' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'GPUNodeNumber', + 'Reason' => ['title' => '失败原因', 'type' => 'string'], + ], + ], + 'UserInfo' => [ + 'description' => 'User information ', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => 'User ID ', 'title' => '', 'type' => 'string', 'example' => '161222222222'], + 'UserName' => ['description' => 'username ', 'title' => '', 'type' => 'string', 'example' => 'test'], + ], + 'example' => '', + ], + 'UserQuotaPermission' => [ + 'title' => '用户在Quota上的权限', + 'description' => '用户在Quota上的权限', + 'type' => 'object', + 'properties' => [ + 'QuotaId' => ['title' => 'Quota ID', 'type' => 'string'], + 'Permissions' => [ + 'title' => '权限', + 'type' => 'array', + 'items' => ['type' => 'string'], ], + ], + ], + 'UserViewMetric' => [ + 'description' => 'Resource group metrics data.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['title' => '', 'description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rg17tmvwiokh****'], + 'TotalCPU' => ['title' => '', 'description' => 'Total number of CPU cores.', 'type' => 'integer', 'example' => '1000', 'format' => 'int32'], + 'CPUUsageRate' => ['title' => '', 'description' => 'CPU usage rate.', 'type' => 'string', 'example' => '59'], + 'GPUUsageRate' => ['title' => '', 'description' => 'GPU usage rate.', 'type' => 'string', 'example' => '10'], + 'TotalMemory' => ['title' => '', 'description' => 'Total memory, in KB.', 'type' => 'integer', 'example' => '10240', 'format' => 'int64'], + 'TotalGPU' => ['title' => '', 'description' => 'Total number of GPU cards.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'], + 'MemoryUsageRate' => ['title' => '', 'description' => 'Memory usage rate.', 'type' => 'string', 'example' => '20'], + 'RequestCPU' => ['title' => '', 'description' => 'Number of CPU cores allocated.', 'type' => 'integer', 'example' => '100', 'format' => 'int32'], + 'RequestGPU' => ['title' => '', 'description' => 'Number of GPU cores allocated.', 'type' => 'integer', 'example' => '10', 'format' => 'int32'], + 'RequestMemory' => ['title' => '', 'description' => 'Allocated memory, in KB.', 'type' => 'integer', 'example' => '102400000', 'format' => 'int64'], + 'NetworkInputRate' => ['title' => '', 'description' => 'The network input rate.', 'type' => 'string', 'example' => '1'], + 'NetworkOutputRate' => ['title' => '', 'description' => 'Network output rate.', 'type' => 'string', 'example' => '1'], + 'DiskReadRate' => ['title' => '', 'description' => 'Disk read rate.', 'type' => 'string', 'example' => '22'], + 'DiskWriteRate' => ['title' => '', 'description' => 'Disk write rate.', 'type' => 'string', 'example' => '22'], + 'JobType' => ['title' => '', 'description' => 'Job type.', 'type' => 'string', 'example' => 'PyTorch'], + 'UserId' => ['title' => '', 'description' => 'User ID.', 'type' => 'string', 'example' => '16111111****'], + 'CPUNodeNumber' => ['title' => '', 'description' => 'Number of CPU nodes.', 'type' => 'integer', 'example' => '2', 'format' => 'int32'], + 'GPUNodeNumber' => ['title' => '', 'description' => 'Number of GPU nodes.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'], 'CpuJobNames' => [ + 'description' => 'CPU jobs.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], - 'backendName' => 'CpuJobNames', + 'items' => ['description' => 'Job name.', 'type' => 'string', 'title' => '', 'example' => 'dlcxxxxx'], + 'example' => '', ], 'GpuJobNames' => [ + 'description' => 'GPU jobs.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], - 'backendName' => 'GpuJobNames', + 'items' => ['description' => 'Job name.', 'type' => 'string', 'title' => '', 'example' => 'dlcyyyyy'], + 'example' => '', ], 'NodeNames' => [ + 'description' => 'List of nodes.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], - 'backendName' => 'NodeNames', + 'items' => ['description' => 'Node name.', 'type' => 'string', 'title' => '', 'example' => 'lrnxxxxxx'], + 'example' => '', ], 'CpuNodeNames' => [ + 'description' => 'List of CPU nodes.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], - 'backendName' => 'CpuNodeNames', + 'items' => ['description' => 'Node name.', 'type' => 'string', 'title' => '', 'example' => 'ecixxxxxx'], + 'example' => '', ], 'GpuNodeNames' => [ + 'description' => 'List of GPU nodes.', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - ], - 'backendName' => 'GpuNodeNames', + 'items' => ['description' => 'Node name.', 'type' => 'string', 'title' => '', 'example' => 'lrnxxxxxxx'], + 'example' => '', ], ], + 'example' => '', ], 'UserVpc' => [ - 'title' => 'A short description of struct', + 'title' => '', 'description' => 'UserVpc', - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vpc-abcdef****', - 'backendName' => 'VpcId', - ], - 'SwitchId' => [ - 'title' => 'VSW ID', - 'description' => 'VSW ID', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vs-abcdef****', - 'backendName' => 'SwitchId', - ], - 'SecurityGroupId' => [ - 'title' => 'SecurityGroupID', - 'description' => 'SecurityGroupID', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'sg-abcdef****', - 'backendName' => 'SecurityGroupId', - ], + 'VpcId' => ['title' => '', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-abcdef****'], + 'SwitchId' => ['title' => '', 'description' => 'VSW ID', 'type' => 'string', 'example' => 'vs-abcdef****'], + 'SecurityGroupId' => ['title' => '', 'description' => 'SecurityGroupID', 'type' => 'string', 'example' => 'sg-abcdef****'], 'ExtendedCIDRs' => [ - 'title' => 'ExtendedCIDRs', + 'title' => '', 'description' => 'ExtendedCIDRs', - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'one cidr', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '"192.168.0.1/24"', - 'extendType' => 'true', - ], - 'backendName' => 'ExtendedCIDRs', - ], - 'RoleArn' => [ - 'title' => 'RoleArn', - 'description' => 'RoleArn', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole', - 'backendName' => 'RoleArn', - ], - 'DefaultRoute' => [ - 'title' => 'DefaultRoute', - 'description' => 'DefaultRoute', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'eth0', - 'backendName' => 'DefaultRoute', + 'items' => ['description' => 'one cidr', 'type' => 'string', 'example' => '"192.168.0.1/24"', 'title' => ''], + 'example' => '', ], + 'RoleArn' => ['title' => '', 'description' => 'RoleArn', 'type' => 'string', 'example' => 'acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole'], + 'DefaultRoute' => ['title' => '', 'description' => 'DefaultRoute', 'type' => 'string', 'example' => 'eth0'], + 'DefaultForwardInfo' => ['title' => '', '$ref' => '#/components/schemas/ForwardInfo', 'description' => '', 'example' => ''], ], + 'example' => '', ], - 'WorkspaceIdName' => [ + 'WorkloadInfo' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ + 'WorkloadId' => ['title' => '', 'description' => 'The unique, system-generated ID for the workload.', 'type' => 'string', 'example' => ''], + 'WorkloadName' => ['title' => '', 'description' => 'The user-defined name of the workload.', 'type' => 'string', 'example' => ''], + 'WorkloadType' => ['title' => '', 'description' => 'The type of the workload.', 'type' => 'string', 'example' => ''], + 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace that contains the workload.', 'type' => 'string', 'example' => ''], + 'WorkspaceName' => ['title' => '', 'description' => 'The name of the workspace that contains the workload.', 'type' => 'string', 'example' => ''], + 'WorkloadCreatedTime' => ['title' => '', 'description' => 'The creation time of the workload, in UTC format.', 'type' => 'string', 'example' => ''], + 'WorkloadStatus' => ['title' => '', 'description' => 'The current status of the workload. Possible values include `Pending`, `Running`, `Succeeded`, and `Failed`.', 'type' => 'string', 'example' => ''], + 'UserId' => ['title' => '', 'description' => 'The ID of the user who created the workload.', 'type' => 'string', 'example' => ''], + 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant that contains the workload.', 'type' => 'string', 'example' => ''], + 'UserName' => ['title' => '', 'description' => 'The name of the user who created the workload.', 'type' => 'string', 'example' => ''], + 'Priority' => ['title' => '', 'description' => 'The scheduling priority of the workload. A higher value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'IsScheduled' => ['title' => '', 'description' => 'Specifies whether the workload is scheduled. Valid values are `true` and `false`.', 'type' => 'string', 'example' => ''], + 'QueueMetas' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ws123456', - 'backendName' => 'WorkspaceId', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The metadata for a single queue.', '$ref' => '#/components/schemas/QueueMeta', 'example' => ''], + 'description' => 'A list of metadata for the queues associated with the workload.', + 'example' => '', ], ], + 'description' => 'The configuration and status of a workload.', + 'example' => '', + ], + 'WorkspaceIdName' => [ + 'description' => 'The workspace ID and name.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'ws123***'], + 'WorkspaceName' => ['description' => 'The workspace name.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'example' => '', ], 'WorkspaceSpec' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Specification template.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'SpecName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'spec_test', - 'backendName' => 'SpecName', - ], - 'IsGuaranteedValid' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'IsGuaranteedValid', - ], - 'IsOverSoldValid' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'IsOverSoldValid', - ], - 'Spec' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'backendName' => 'Spec', - '$ref' => '#/components/schemas/ResourceAmount', - ], - 'CodeType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'CodeType', - ], - 'Code' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'Code', - ], - 'Reason' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - 'backendName' => 'Reason', - ], + 'SpecName' => ['description' => 'Template Name ', 'title' => '', 'type' => 'string', 'example' => 'spec_test'], + 'IsGuaranteedValid' => ['description' => 'Indicates whether the use of guaranteed resources is valid. ', 'title' => '', 'type' => 'boolean', 'example' => 'true'], + 'IsOverSoldValid' => ['description' => 'Indicates whether the use of oversold resources is valid. ', 'title' => '', 'type' => 'boolean', 'example' => 'true'], + 'Spec' => ['description' => 'Specification resource information ', 'title' => '', '$ref' => '#/components/schemas/ResourceAmount', 'example' => ''], + 'CodeType' => ['description' => 'Type of invalidity reason when using guaranteed resources is invalid ', 'title' => '', 'type' => 'string', 'example' => '""'], + 'Code' => ['description' => 'Invalidity reason code when using guaranteed resources is invalid ', 'title' => '', 'type' => 'string', 'example' => '""'], + 'Reason' => ['description' => 'Invalidity reason content when using guaranteed resources is invalid ', 'title' => '', 'type' => 'string', 'example' => '""'], ], + 'example' => '', ], 'WorkspaceSpecs' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Specification template used for submitting workloads available within the workspace.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '122421', - 'backendName' => 'WorkspaceId', - ], - 'Product' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'DLC', - 'backendName' => 'Product', - ], + 'WorkspaceId' => ['description' => 'Workspace ID ', 'title' => '', 'type' => 'string', 'example' => '122421'], + 'Product' => ['description' => 'Applicable product (DLC, DSW, EAS, ...) ', 'title' => '', 'type' => 'string', 'example' => 'DLC'], 'Specs' => [ + 'description' => 'List of resource specifications ', 'title' => '', - 'description' => '', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/WorkspaceSpec', - ], - 'backendName' => 'Specs', + 'items' => ['description' => 'Template Configuration for workspace specifications.', '$ref' => '#/components/schemas/WorkspaceSpec', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], 'apis' => [ - 'UpdateResourceGroup' => [ - 'summary' => '更新Resource Group', - 'path' => '/api/v1/resources/{ResourceGroupID}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CheckInstanceWebTerminal' => [ + 'summary' => 'Checks the connection to the instance container.', + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/webterminals/action/check', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '143268', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'abilityTreeCode' => '199680', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ + [ + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the training task.', 'type' => 'string', 'required' => true, 'example' => 'traineyfz0m2hsfv', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'train1oxaqdiluad-master-0', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The check configuration.', 'type' => 'object', 'properties' => [ - 'UserVpc' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/UserVpc', - ], - 'Unbind' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'prophet', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_new_havpn_tf', - ], + 'CheckInfo' => ['description' => 'The check information.', 'type' => 'string', 'required' => false, 'example' => 'wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******', 'title' => ''], ], 'required' => false, - ], - ], - [ - 'name' => 'ResourceGroupID', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rgf0zhfqn1d4ity2', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7', - ], - 'ResourceGroupID' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rgf0zhfqn1d4ity2', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\"\\n}","type":"json"}]', - 'title' => 'UpdateResourceGroup', - ], - 'GetResourceGroupTotal' => [ - 'summary' => 'get resource group total resource by group id', - 'path' => '/api/v1/resources/data/total', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Validate the link to access the instance container.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateAlgorithm' => [ + 'summary' => 'Creates an algorithm.', + 'path' => '/api/v1/algorithms', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => [], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '145960', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupID', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rgf0zhfqn1d4ity2', - ], + 'name' => 'WorkspaceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'AlgorithmDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the algorithm.', 'type' => 'string', 'example' => 'Tongyi Qwen large language model training algorithm.', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'AlgorithmName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the algorithm.', 'type' => 'string', 'required' => false, 'example' => 'llm_training', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the algorithm.', 'type' => 'string', 'example' => 'Large language model training', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'totalCPU' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'totalMemory' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'totalGPU' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'totalGPUInfos' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/GPUInfo', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'], + 'AlgorithmId' => ['description' => 'The ID of the algorithm.', 'type' => 'string', 'example' => 'algo-xsldfvu1334', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCPU\\": 100,\\n \\"totalMemory\\": 300,\\n \\"totalGPU\\": 24,\\n \\"totalGPUInfos\\": [\\n {\\n \\"count\\": 0,\\n \\"type\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetResourceGroupTotal', - ], - 'ListResourceGroups' => [ - 'summary' => 'list resource group', - 'path' => '/api/v1/resources', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\"\\n}","type":"json"}]', + 'title' => 'Create algorithm', + 'changeSet' => [ + ['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-27T10:49:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAlgorithm'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:CreateAlgorithm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateAlgorithmVersion' => [ + 'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '124250', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - ], + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => 'pai resource group display name', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rgf0zhfqn1d4ity2', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页面容量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序, 枚举值 desc 或者 asc', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'name' => 'AlgorithmId', + 'in' => 'path', + 'schema' => ['description' => 'ID of the training algorithm.', 'type' => 'string', 'required' => false, 'example' => 'algo-xsldfvu1334', 'title' => ''], ], [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '用于排序的字段名，可选字段名：DisplayName, GmtCreated, GmtModified,RegionID Duration PricingCycle PayType', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DisplayName', - ], + 'name' => 'AlgorithmVersion', + 'in' => 'path', + 'schema' => ['description' => 'Algorithm version.', 'type' => 'string', 'required' => false, 'example' => 'v0.0.1', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => 'resource group的状态', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Creating', - ], + 'name' => 'AlgorithmSpec', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'Algorithm configuration.', '$ref' => '#/components/schemas/AlgorithmSpec', 'required' => false, 'title' => '', 'example' => ''], ], - [ - 'name' => 'ShowAll', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', + 'description' => 'Response schema.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'AlgorithmId' => ['description' => 'ID of the training algorithm.', 'type' => 'string', 'example' => 'algo-xsldfvu1334', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'Algorithm version.', 'type' => 'string', 'example' => 'v0.0.1', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'ComputingResourceProvider', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Ecs', - ], + ], + 'title' => 'Create an algorithm version', + 'summary' => 'Creates a version of an algorithm.', + 'changeSet' => [ + ['createdAt' => '2022-04-27T10:50:46.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAlgorithmVersion'], ], + ], + 'ramActions' => [ [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Lingjun', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:CreateAlgorithmVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateInstanceWebTerminal' => [ + 'summary' => 'You can create a link to access the container of the instance.', + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/webterminals', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceGroupIDs', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '199679', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ [ - 'name' => 'HasResource', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the training task.', 'type' => 'string', 'required' => true, 'example' => 'train1nc6686x36b', 'title' => ''], ], [ - 'name' => 'Versions', - 'in' => 'query', - 'schema' => [ - 'title' => '按照版本搜索。', - 'type' => 'string', - 'example' => '1.0', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'train1nc6686x36b-master-0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'ResourceGroups' => [ - 'title' => 'pai resource groups', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/ResourceGroup', - ], - 'example' => 'RG1', - ], - 'TotalCount' => [ - 'title' => 'list到的资源组的数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '9CFA2665-1FFE-5929-8468-C14C25890486', - ], + 'WebTerminalId' => ['description' => 'The ID of the web terminal used to access the instance container.', 'type' => 'string', 'example' => 'wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceGroups\\": [\\n {\\n \\"Name\\": \\"RG1\\",\\n \\"ResourceGroupID\\": \\"rg17tmvwiokhzaxg\\",\\n \\"WorkspaceID\\": \\"23000\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\"\\n ],\\n \\"RoleArn\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"\\",\\n \\"EipAllocationId\\": \\"\\"\\n }\\n },\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"CreatorID\\": \\"\\",\\n \\"NodeCount\\": 0,\\n \\"Version\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"9CFA2665-1FFE-5929-8468-C14C25890486\\"\\n}","type":"json"}]', - 'title' => 'ListResourceGroups', - ], - 'GetResourceGroupRequest' => [ - 'summary' => 'get resource group requested resource by resource group id', - 'path' => '/api/v1/resources/data/request', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Create a link to access the instance container', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WebTerminalId\\": \\"wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateQuota' => [ + 'summary' => 'Call the `CreateQuota` operation to create a quota.', + 'path' => '/api/v1/quotas', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => true, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '146159', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191129', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupID', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rgf0zhfqn1d4ity2', - ], - ], - [ - 'name' => 'PodStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'default' => 'Running', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestCPU' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'requestMemory' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'requestGPU' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', + 'QuotaName' => ['title' => '', 'description' => 'The name of the quota.', 'type' => 'string', 'required' => false, 'example' => 'test-quota'], + 'ResourceType' => ['title' => '', 'description' => 'The resource type of the quota. Valid values: Lingjun, ECS, and ACS. Default value: ECS.', 'type' => 'string', 'required' => false, 'example' => 'ECS'], + 'ParentQuotaId' => ['title' => '', 'description' => 'The ID of the parent quota.'."\n" + ."\n" + .'- If you do not specify this parameter, a root quota is created. Resources are allocated from a dedicated resource group.'."\n" + ."\n" + .'- If you specify this parameter, a child quota is created. Resources are allocated from the nodes that are bound to the root quota.', 'type' => 'string', 'required' => false, 'example' => 'quota1ci8g793pgm'], + 'ResourceGroupIds' => [ + 'description' => 'The IDs of the dedicated resource groups. The following constraints apply:'."\n" + ."\n" + .'- Only a root quota, for which `ParentQuotaId` is empty, can allocate nodes from a resource group.'."\n" + ."\n" + .'- The VPC configurations of the specified resource groups must be the same.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rgl593id9qqwkmbr', 'title' => ''], + 'required' => false, + 'example' => '', ], - 'requestGPUInfos' => [ - 'description' => '', + 'AllocateStrategy' => ['title' => '', 'description' => 'The allocation strategy for the quota. Only `ByNodeSpecs` is supported.', 'type' => 'string', 'required' => false, 'example' => 'ByNodeSpecs'], + 'Min' => ['description' => 'The minimum resources for the quota. You can define this in one of the following ways:'."\n" + ."\n" + .'- `ResourceAmount`: Specifies the CPU, memory, and GPU details.'."\n" + ."\n" + .'- `NodeSpecs`: Specifies the node specification and the number of nodes.'."\n" + ."\n" + .'Constraints:'."\n" + ."\n" + .'- If this quota allocates resources from a dedicated resource group, you must use the `NodeSpecs` method.'."\n" + ."\n" + .'- If this quota allocates resources from a parent quota, both methods are allowed. However, all its child quotas must use the same method.'."\n" + ."\n" + .'- All GPU specifications within the quota must have the same GPU type.'."\n" + ."\n" + .'- For quotas with the resource type set to ECS or Lingjun, only the `NodeSpecs` method can be used.', '$ref' => '#/components/schemas/ResourceSpec', 'required' => false, 'title' => '', 'example' => ''], + 'Description' => ['title' => '', 'description' => 'The description of the quota.', 'type' => 'string', 'required' => false, 'example' => 'this is a test quota'], + 'Labels' => [ + 'description' => 'The tags for the quota.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/GPUInfo', - ], + 'items' => ['description' => 'The tag.', '$ref' => '#/components/schemas/Label', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', ], + 'QuotaConfig' => ['description' => 'Constraints for the `QuotaConfig` parameter:'."\n" + ."\n" + .'- This parameter is ignored if the resource type is ECS or Lingjun.'."\n" + ."\n" + .'- If the resource type is ACS, the specified VPC and ACS configurations are applied.', '$ref' => '#/components/schemas/QuotaConfig', 'required' => false, 'title' => '', 'example' => ''], + 'QueueStrategy' => ['description' => 'The queuing strategy for the quota. Four strategies are supported:'."\n" + ."\n" + .'- `PaiStrategyIntelligent`: The intelligent strategy.'."\n" + ."\n" + .'- `PaiStrategyBalance`: The balance strategy.'."\n" + ."\n" + .'- `PaiStrategyRoundRobin`: The round-robin strategy.'."\n" + ."\n" + .'- `PaiStrategyStrictFIFO`: The FIFO strategy.', 'type' => 'string', 'required' => false, 'example' => 'PaiStrategyIntelligent', 'title' => ''], + 'ClusterSpec' => ['title' => '', 'description' => 'The native cluster specification for the quota.', '$ref' => '#/components/schemas/ClusterSpec', 'required' => false, 'example' => ''], ], - ], - ], - ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestCPU\\": 1,\\n \\"requestMemory\\": 2,\\n \\"requestGPU\\": 8,\\n \\"requestGPUInfos\\": [\\n {\\n \\"count\\": 0,\\n \\"type\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetResourceGroupRequest', - ], - 'DeleteResourceGroupMachineGroup' => [ - 'summary' => 'delete machine group', - 'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups/{MachineGroupID}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '125207', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], - ], - 'parameters' => [ - [ - 'name' => 'MachineGroupID', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'ResourceGroupID', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'MachineGroupID' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBF05F13-B24C-5129-9048-4FA684DCD579'], + 'QuotaId' => ['title' => '', 'description' => 'The quota ID.', 'type' => 'string', 'example' => 'quotad2kd8ljpsno'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'PaiStudio::2022-01-12::DeleteResourceGroupMachineGroup', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Resource Quota', + 'changeSet' => [ + ['createdAt' => '2025-11-06T13:03:33.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => null, - ], - 'GetNodeMetrics' => [ - 'summary' => 'get resource group node metrics', - 'path' => '/api/v1/resources/{ResourceGroupID}/nodemetrics/{MetricType}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:CreateQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF05F13-B24C-5129-9048-4FA684DCD579\\",\\n \\"QuotaId\\": \\"quotad2kd8ljpsno\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateResourceGroup' => [ + 'summary' => 'Use the CreateResourceGroup operation to create a resource group.', + 'path' => '/api/v1/resources', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => true, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '151753', - 'abilityTreeNodes' => [ - 'FEATURElearn8Y18OQ', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '125287', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupID', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rgf0zhfqn1d4ity2', - ], - ], - [ - 'name' => 'GPUType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'V100', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-07-08T02:23:30.292Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-07-10T10:17:06', - ], - ], - [ - 'name' => 'TimeStep', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1h', - ], - ], - [ - 'name' => 'Verbose', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'boolean', + 'description' => 'Request struct.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Resource group name.', 'type' => 'string', 'required' => false, 'example' => 'testResourceGroup', 'title' => ''], + 'Description' => ['description' => 'Resource group description.', 'type' => 'string', 'required' => false, 'example' => 'test_api_report', 'title' => ''], + 'UserVpc' => ['description' => 'VPC connectivity information for the resource group.', '$ref' => '#/components/schemas/UserVpc', 'required' => false, 'title' => '', 'example' => ''], + 'ResourceType' => ['description' => 'Resource type. Valid values:'."\n" + ."\n" + .'- Ecs: general computing resources'."\n" + ."\n" + .'- Lingjun: Lingjun resources', 'type' => 'string', 'required' => false, 'example' => 'Ecs', 'title' => ''], + 'ComputingResourceProvider' => ['description' => 'Compute resource type for the resource group.', 'type' => 'string', 'required' => false, 'example' => 'Ecs', 'title' => ''], + 'Tag' => [ + 'description' => 'List of tags to add. Maximum 20 items.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key of the instance. N ranges from 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['title' => '', 'description' => 'Tag value for the resource group. N ranges from 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'Version' => ['title' => '', 'description' => 'Resource group version. This parameter takes effect only when the resource type is ECS.', 'type' => 'string', 'example' => '1.0', 'required' => false], + ], 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'MetricType', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CpuUsageRate', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'NodesMetrics' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/NodeMetric', - ], - ], - 'ResourceGroupID' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rgf0zhfqn1d4ity2', - ], - 'MetricType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DiskWriteRate', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'."\n"], + 'ResourceGroupID' => ['description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'Cms::2019-01-01::DescribeMetricList', + 'title' => 'Create Resource Group', + 'changeSet' => [ + ['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-04T03:16:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-11T03:07:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-04T06:45:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-29T07:14:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResourceGroup'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:CreateResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NodesMetrics\\": [\\n {\\n \\"NodeID\\": \\"-i121212node\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": 0,\\n \\"Value\\": \\"23000\\"\\n }\\n ],\\n \\"GPUType\\": \\"\\"\\n }\\n ],\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"MetricType\\": \\"DiskWriteRate\\"\\n}","type":"json"}]', - 'title' => 'GetNodeMetrics', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\\\n\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ListResourceGroupMachineGroups' => [ - 'summary' => 'list machine groups', - 'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateTrainingJob' => [ + 'summary' => 'Create a training job.', + 'path' => '/api/v1/trainingjobs', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '125191', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '132535', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'CreatorID', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1612285282502326', - ], - ], - [ - 'name' => 'ResourceGroupID', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rgf0zhfqn1d4ity2', - ], - ], - [ - 'name' => 'PaymentType', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Request body parameters.', + 'type' => 'object', + 'properties' => [ + 'AlgorithmName' => ['description' => 'Algorithm name.', 'type' => 'string', 'required' => false, 'example' => 'ev_classification', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'Algorithm provider.', 'type' => 'string', 'required' => false, 'example' => 'pai', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'Algorithm version.', 'type' => 'string', 'required' => false, 'example' => 'v1.0.0', 'title' => ''], + 'ComputeResource' => [ + 'description' => 'Compute resource configuration.', + 'type' => 'object', + 'properties' => [ + 'EcsCount' => ['description' => 'Number of ECS instances.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'EcsSpec' => ['description' => 'ECS instance type.', 'type' => 'string', 'required' => false, 'example' => 'ecs.gn5-c8g1.2xlarge', 'title' => ''], + 'ResourceId' => ['description' => 'Resource quota ID.', 'type' => 'string', 'required' => false, 'example' => 'quotam670lixikcs', 'title' => ''], + 'InstanceCount' => ['description' => 'Number of instances used by the resource quota.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'InstanceSpec' => [ + 'description' => 'Resource quota instance configuration.', + 'type' => 'object', + 'properties' => [ + 'CPU' => ['description' => 'Number of CPU cores for the instance.', 'type' => 'string', 'required' => false, 'example' => '8', 'title' => ''], + 'Memory' => ['description' => 'Instance memory size, in GiB.', 'type' => 'string', 'required' => false, 'example' => '32', 'title' => ''], + 'SharedMemory' => ['description' => 'Instance shared memory size, in GB.', 'type' => 'string', 'required' => false, 'example' => '32', 'title' => ''], + 'GPU' => ['description' => 'Number of GPU cards for the instance.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'GPUType' => ['description' => 'GPU card type for the instance.', 'type' => 'string', 'required' => false, 'example' => 'V100', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'SpotSpec' => [ + 'description' => 'Spot instance configuration.', + 'type' => 'object', + 'properties' => [ + 'SpotStrategy' => ['description' => 'SpotStrategy: The preemption policy for the instance. Valid values:'."\n" + ."\n" + .'- SpotWithPriceLimit: Set a maximum price for the spot instance.'."\n" + ."\n" + .'- SpotAsPriceGo: The system automatically bids, following the current market price.', 'type' => 'string', 'required' => false, 'example' => 'SpotWithPriceLimit', 'title' => ''], + 'SpotDiscountLimit' => ['description' => 'Set the maximum hourly price discount for the instance. This parameter takes effect when SpotStrategy is set to SpotWithPriceLimit.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '9', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'UseSpotInstance' => ['description' => 'Specifies whether to use a spot instance.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'HyperParameters' => [ + 'description' => 'Training hyperparameters configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'Training hyperparameters configuration.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Parameter name.', 'type' => 'string', 'required' => false, 'example' => 'learning_rate', 'title' => ''], + 'Value' => ['description' => 'Parameter value.', 'type' => 'string', 'required' => false, 'example' => '0.0001', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'InputChannels' => [ + 'description' => 'Training input data configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'Training input data configuration.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Input data name.', 'type' => 'string', 'required' => false, 'example' => 'model', 'title' => ''], + 'DatasetId' => ['description' => 'Dataset ID.', 'type' => 'string', 'required' => false, 'example' => 'd-475megosidivjfgfq6', 'title' => ''], + 'VersionName' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'InputUri' => ['description' => 'Input data link.', 'type' => 'string', 'required' => false, 'example' => 'oss://pai-quickstart-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/modelscope/models/qwen2-0.5b/main/', 'title' => ''], + 'Options' => ['description' => 'Input data parameter configuration.', 'type' => 'string', 'required' => false, 'example' => '{"appendable": true}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'description' => 'Training job labels.', + 'type' => 'array', + 'items' => [ + 'description' => 'Training job labels.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Label key.', 'type' => 'string', 'required' => false, 'example' => 'CreatedBy', 'title' => ''], + 'Value' => ['description' => 'Label value.', 'type' => 'string', 'required' => false, 'example' => 'QuickStart', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'OutputChannels' => [ + 'description' => 'Training output data configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'Training output data configuration.', + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['description' => 'Dataset ID.', 'type' => 'string', 'required' => false, 'example' => 'd-475megosidivjfgfq6', 'title' => ''], + 'Name' => ['description' => 'Output data name.', 'type' => 'string', 'required' => false, 'example' => 'model', 'title' => ''], + 'OutputUri' => ['description' => 'Output data configuration.', 'type' => 'string', 'required' => false, 'example' => 'oss://pai-quickstart-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/modelscope/models/qwen2-0.5b/main/', 'title' => ''], + 'VersionName' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Scheduler' => [ + 'description' => 'Training job scheduling configuration.', + 'type' => 'object', + 'properties' => [ + 'MaxRunningTimeInSeconds' => ['description' => 'Maximum training runtime, in seconds. A value of 0 means no limit on the maximum runtime.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'MaxRunningTimeInMinutes' => ['description' => 'Maximum training runtime, in minutes. A value of 0 means no limit on the maximum runtime.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TrainingJobDescription' => ['description' => 'Training job description.', 'type' => 'string', 'required' => false, 'example' => 'qwen large language model training', 'title' => ''], + 'TrainingJobName' => ['description' => 'Training job name.', 'type' => 'string', 'required' => true, 'example' => 'qwen_llm', 'title' => ''], + 'WorkspaceId' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + 'AlgorithmSpec' => ['description' => 'Training job algorithm configuration.', '$ref' => '#/components/schemas/AlgorithmSpec', 'required' => false, 'title' => '', 'example' => ''], + 'CodeDir' => ['description' => 'Training job code configuration.', '$ref' => '#/components/schemas/Location', 'required' => false, 'title' => '', 'example' => ''], + 'RoleArn' => ['description' => 'Specify the ARN of the role. Format: acs:ram::$accountID:role/$roleName.', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1157703270994901:role/aliyunserviceroleforpaiworkspace', 'title' => ''], + 'UserVpc' => [ + 'description' => 'VPC configuration.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-dxiflssjx978sl', 'title' => ''], + 'SwitchId' => ['description' => 'vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vs-icrc813vdsfol', 'title' => ''], + 'SecurityGroupId' => ['description' => 'Security group ID.', 'type' => 'string', 'required' => false, 'example' => 'sg-qdfasd13sdasf', 'title' => ''], + 'ExtendedCIDRs' => [ + 'description' => 'Extended CIDR block configuration.', + 'type' => 'array', + 'items' => ['description' => 'Extended CIDR block configuration.', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1/24', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DefaultRoute' => ['description' => 'Default routing interface. \\`eth0\\` means the default route uses the PAI VPC. \\`eth1\\` means the default route uses the user VPC. The default is \\`eth0\\`.', 'type' => 'string', 'required' => false, 'example' => 'eth0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Settings' => ['description' => 'Additional training job parameter settings.', '$ref' => '#/components/schemas/JobSettings', 'required' => false, 'title' => '', 'example' => ''], + 'ExperimentConfig' => [ + 'description' => 'Training job experiment association configuration.', + 'type' => 'object', + 'properties' => [ + 'ExperimentId' => ['description' => 'Training job experiment ID.', 'type' => 'string', 'required' => false, 'example' => 'exp-ds9aefia90v', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Environments' => [ + 'description' => 'Training job environment variables.', + 'additionalProperties' => ['description' => 'Training job environment variables.', 'type' => 'string', 'example' => 'debug=true', 'title' => ''], + 'type' => 'object', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'PythonRequirements' => [ + 'description' => 'Training job Python package configuration.', + 'type' => 'array', + 'items' => ['description' => 'Training job Python package configuration.', 'type' => 'string', 'required' => false, 'example' => 'numpy', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Priority' => ['description' => 'Training job priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'AssignNodeSpec' => ['$ref' => '#/components/schemas/AssignNodeSpec', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'PREPAY', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PaymentDurationUnit', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', + 'description' => 'Schema of Response', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'TrainingJobId' => ['description' => 'Training job ID.', 'type' => 'string', 'example' => 'traineyfz0m2hsfv', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'PaymentDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + ], + 'title' => 'Create a training job', + 'changeSet' => [ + ['createdAt' => '2025-11-25T06:20:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-18T02:48:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-23T07:12:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-03T03:12:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-09T10:31:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-29T07:27:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-26T10:28:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-15T03:13:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-12T03:19:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-01T11:22:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-22T03:17:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-20T02:19:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-06T12:12:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-27T10:49:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrainingJob'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrainingJobId\\": \\"traineyfz0m2hsfv\\",\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteAlgorithm' => [ + 'summary' => 'Deletes an algorithm.', + 'path' => '/api/v1/algorithms/{AlgorithmId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EcsSpec', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.c6.large', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146690', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'name' => 'AlgorithmId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The algorithm ID.', 'type' => 'string', 'required' => false, 'example' => 'algo-sidjc8134hv'], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'description' => 'The response schema.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7'], + ], + 'example' => '', ], ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + ], + 'title' => 'Delete an algorithm', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlgorithm'], ], + ], + 'ramActions' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreatedTime', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pai:DeleteAlgorithm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteAlgorithmVersion' => [ + 'summary' => 'Deletes an algorithm version.', + 'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Ready', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146338', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ [ - 'name' => 'OrderInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '236553689400333', - ], + 'name' => 'AlgorithmId', + 'in' => 'path', + 'schema' => ['description' => 'The algorithm ID.', 'type' => 'string', 'required' => true, 'example' => 'algo-xsldfvu1334', 'title' => ''], ], [ - 'name' => 'MachineGroupIDs', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'AlgorithmVersion', + 'in' => 'path', + 'schema' => ['description' => 'The algorithm version.', 'type' => 'string', 'required' => true, 'example' => 'v0.0.1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', + 'title' => '', 'type' => 'object', 'properties' => [ - 'MachineGroups' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/MachineGroup', - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroups\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"EcsCount\\": 0,\\n \\"GmtStartedTime\\": \\"\\",\\n \\"ResourceGroupID\\": \\"\\",\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"CreatorID\\": \\"\\",\\n \\"ReasonMessage\\": \\"\\",\\n \\"PaymentDurationUnit\\": \\"\\",\\n \\"EcsSpec\\": \\"\\",\\n \\"SupportedDrivers\\": [\\n \\"470.199.02\\"\\n ],\\n \\"PaymentDuration\\": \\"\\",\\n \\"ReasonCode\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"DiskCapacity\\": 0,\\n \\"GmtExpiredTime\\": \\"\\",\\n \\"OrderInstanceId\\": \\"\\",\\n \\"DefaultDriver\\": \\"470.199.02\\",\\n \\"MachineGroupID\\": \\"mg1\\",\\n \\"PaymentType\\": \\"\\",\\n \\"DiskPL\\": \\"\\",\\n \\"Cpu\\": 0,\\n \\"Gpu\\": 0,\\n \\"GpuMemory\\": 0,\\n \\"GpuType\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"ResourceType\\": \\"\\",\\n \\"AllocatableCpu\\": 0,\\n \\"AllocatableMemory\\": 0,\\n \\"SystemReservedCpu\\": 0,\\n \\"SystemReservedMemory\\": 0\\n }\\n ],\\n \\"TotalCount\\": \\"4\\",\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]', - 'title' => 'ListResourceGroupMachineGroups', - ], - 'GetUserViewMetrics' => [ - 'summary' => 'get user view metrics', - 'path' => '/api/v1/resources/{ResourceGroupID}/usermetrics', - 'methods' => [ - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Delete an algorithm version', + 'changeSet' => [ + ['createdAt' => '2024-09-25T02:19:16.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlgorithmVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pai:DeleteAlgorithmVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteMachineGroup' => [ + 'summary' => 'Deletes a machine group.', + 'path' => '/api/v1/resources/machinegroups/{MachineGroupID}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '152476', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - 'FEATURElearn1N0SUT', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '124429', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupID', + 'name' => 'MachineGroupID', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rgf0zhfqn1d4ity2', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '86995', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'MachineGroupID' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => 'Response schema', + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + ], + 'staticInfo' => [ + 'substitutions' => ['PaiStudio::2022-01-12::DeleteMachineGroup'], + ], + 'changeSet' => [ + ['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMachineGroup'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'DeleteMachineGroup', + 'translator' => 'machine', + ], + 'DeleteQuota' => [ + 'summary' => 'You can delete a resource quota by using DeleteQuota.', + 'path' => '/api/v1/quotas/{QuotaId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '191219', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], + ], + 'parameters' => [ [ - 'name' => 'SortBy', - 'in' => 'query', + 'name' => 'QuotaId', + 'in' => 'path', + 'schema' => ['description' => 'The quota identifier to delete.', 'type' => 'string', 'required' => false, 'example' => 'quota1ci8g793pgm', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtModified', + 'description' => 'Schema of Response', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'title' => '', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'QuotaId' => ['description' => 'Quota ID.', 'title' => '', 'type' => 'string', 'example' => 'quotamtl37ge7gkvdz'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete resource quota', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:DeleteQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"QuotaId\\": \\"quotamtl37ge7gkvdz\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteResourceGroup' => [ + 'path' => '/api/v1/resources/{ResourceGroupID}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '125213', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], + ], + 'parameters' => [ [ - 'name' => 'TimeStep', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1h', - ], + 'name' => 'ResourceGroupID', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rgvl9d6utwcscukh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'ResourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rgf0zhfqn1d4ity2', - ], - 'UserMetrics' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/UserViewMetric', - ], - ], - 'Summary' => [ - 'description' => '', - '$ref' => '#/components/schemas/UserViewMetric', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'], + 'ResourceGroupID' => ['description' => 'The globally unique ID of the resource group.', 'type' => 'string', 'example' => 'rgvl9d6utwcscukh', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'PaiStudio::2022-01-12::GetQuotaUserViewMetrics', + 'title' => 'Delete resource group', + 'summary' => 'Deletes a resource group.', + 'changeSet' => [ + ['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceGroup'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pai:DeleteResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceGroupId\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"UserMetrics\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg17tmvwiokhzaxg\\",\\n \\"TotalCPU\\": 0,\\n \\"CPUUsageRate\\": \\"\\",\\n \\"GPUUsageRate\\": \\"\\",\\n \\"TotalMemory\\": 0,\\n \\"TotalGPU\\": 0,\\n \\"MemoryUsageRate\\": \\"\\",\\n \\"RequestCPU\\": 0,\\n \\"RequestGPU\\": 0,\\n \\"RequestMemory\\": 0,\\n \\"NetworkInputRate\\": \\"\\",\\n \\"NetworkOutputRate\\": \\"\\",\\n \\"DiskReadRate\\": \\"\\",\\n \\"DiskWriteRate\\": \\"\\",\\n \\"JobType\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"CPUNodeNumber\\": 0,\\n \\"GPUNodeNumber\\": 0,\\n \\"CpuJobNames\\": [\\n \\"\\"\\n ],\\n \\"GpuJobNames\\": [\\n \\"\\"\\n ],\\n \\"NodeNames\\": [\\n \\"\\"\\n ],\\n \\"CpuNodeNames\\": [\\n \\"\\"\\n ],\\n \\"GpuNodeNames\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Summary\\": {\\n \\"ResourceGroupId\\": \\"rg17tmvwiokhzaxg\\",\\n \\"TotalCPU\\": 0,\\n \\"CPUUsageRate\\": \\"\\",\\n \\"GPUUsageRate\\": \\"\\",\\n \\"TotalMemory\\": 0,\\n \\"TotalGPU\\": 0,\\n \\"MemoryUsageRate\\": \\"\\",\\n \\"RequestCPU\\": 0,\\n \\"RequestGPU\\": 0,\\n \\"RequestMemory\\": 0,\\n \\"NetworkInputRate\\": \\"\\",\\n \\"NetworkOutputRate\\": \\"\\",\\n \\"DiskReadRate\\": \\"\\",\\n \\"DiskWriteRate\\": \\"\\",\\n \\"JobType\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"CPUNodeNumber\\": 0,\\n \\"GPUNodeNumber\\": 0,\\n \\"CpuJobNames\\": [\\n \\"\\"\\n ],\\n \\"GpuJobNames\\": [\\n \\"\\"\\n ],\\n \\"NodeNames\\": [\\n \\"\\"\\n ],\\n \\"CpuNodeNames\\": [\\n \\"\\"\\n ],\\n \\"GpuNodeNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"Total\\": 2\\n}","type":"json"}]', - 'title' => 'GetUserViewMetrics', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"ResourceGroupID\\": \\"rgvl9d6utwcscukh\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GetResourceGroupMachineGroup' => [ - 'summary' => 'get machine group', + 'DeleteResourceGroupMachineGroup' => [ + 'summary' => 'Deletes the specified machine group from a resource group.', 'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups/{MachineGroupID}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '125186', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '125207', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ 'name' => 'MachineGroupID', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mgmioirqjgw6c5lg', - ], + 'schema' => ['description' => 'The machine group ID.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'ResourceGroupID', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rgf0zhfqn1d4ity2', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'example' => ''], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'MachineGroupID' => ['description' => 'The ID of the deleted machine group.', 'type' => 'string', 'title' => '', 'example' => ''], + 'RequestId' => ['description' => 'The request ID. Provide this ID to our technical support for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'required' => false, + 'description' => 'The response body.', + 'example' => '', ], ], ], + 'staticInfo' => [ + 'substitutions' => ['PaiStudio::2022-01-12::DeleteResourceGroupMachineGroup'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceGroupMachineGroup'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'DeleteResourceGroupMachineGroup', + 'translator' => 'machine', + ], + 'DeleteTrainingJob' => [ + 'path' => '/api/v1/trainingjobs/{TrainingJobId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '132982', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ + [ + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the training task.', 'type' => 'string', 'required' => false, 'example' => 'train76rcaupa2cz', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', + 'title' => '', 'type' => 'object', 'properties' => [ - 'MachineGroupID' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mgmioirqjgw6c5lg', - ], - 'ResourceGroupID' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rgf0zhfqn1d4ity2', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Ready', - ], - 'PaymentType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PREPAY', - ], - 'PaymentDurationUnit' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Month', - ], - 'PaymentDuration' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'EcsSpec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecs.c6.large', - ], - 'EcsCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GmtCreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - ], - 'GmtStartedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - ], - 'GmtExpiredTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z'."\n", - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E', - ], - 'Cpu' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'Gpu' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8', - ], - 'GpuType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A100', - ], - 'Memory' => [ - 'description' => '', - 'type' => 'string', - 'example' => '64', - ], - 'SupportedDrivers' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '535,550', - 'type' => 'string', - 'example' => '535,550', - ], - ], - 'DefaultDriver' => [ - 'description' => '', - 'type' => 'string', - 'example' => '535', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testMachineGroup', - ], - 'Tags' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TagKey' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'example' => 'TestKey', - ], - 'TagValue' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => 'TestValue', - ], - ], - ], - ], - 'AllocatableCpu' => [ - 'type' => 'string', - ], - 'AllocatableMemory' => [ - 'type' => 'string', - ], - 'SystemReservedCpu' => [ - 'type' => 'string', - ], - 'SystemReservedMemory' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4cc83062-9bcb-4ab3-979e-2e571a35834f', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"mgmioirqjgw6c5lg\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"Status\\": \\"Ready\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"PaymentDurationUnit\\": \\"Month\\",\\n \\"PaymentDuration\\": \\"1\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"EcsCount\\": 1,\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtStartedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtExpiredTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Cpu\\": \\"2\\",\\n \\"Gpu\\": \\"8\\",\\n \\"GpuType\\": \\"A100\\",\\n \\"Memory\\": \\"64\\",\\n \\"SupportedDrivers\\": [\\n \\"535,550\\"\\n ],\\n \\"DefaultDriver\\": \\"535\\",\\n \\"Name\\": \\"testMachineGroup\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"AllocatableCpu\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCpu\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\"\\n}","type":"json"}]', - 'title' => 'GetResourceGroupMachineGroup', - ], - 'GetResourceGroup' => [ - 'summary' => 'get resource group by group id', - 'path' => '/api/v1/resources/{ResourceGroupID}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Delete Training Job', + 'summary' => 'Deletes a training task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJob'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4cc83062-9bcb-4ab3-979e-2e571a35834f\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteTrainingJobLabels' => [ + 'summary' => 'Deletes the labels of a training task.', + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/labels', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '124255', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '132984', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupID', + 'name' => 'TrainingJobId', 'in' => 'path', - 'schema' => [ - 'title' => 'get pai resource group details by id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rgmhpp8ib5lprq9k', - ], - ], - [ - 'name' => 'IsAIWorkspaceDataEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the training task.', 'type' => 'string', 'required' => true, 'example' => 'trainw52bqlfjbjc', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'Keys', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The keys of the labels.', 'type' => 'string', 'required' => true, 'example' => 'RootModelID', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'GmtCreatedTime' => [ - 'title' => 'pai resource created time', - 'description' => '', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z'."\n", - ], - 'GmtModifiedTime' => [ - 'title' => 'pai resource group modified time', - 'description' => '', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z'."\n", - ], - 'RequestId' => [ - 'title' => 'request id', - 'description' => '', - 'type' => 'string', - 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'."\n", - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestResourceGroup', - ], - 'CreatorID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1612285282502324', - ], - 'WorkspaceID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35201', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Ready', - ], - 'UserVpc' => [ - 'description' => '', - '$ref' => '#/components/schemas/UserVpc', - ], - 'ComputingResourceProvider' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'Ecs' => 'Ecs', - 'Lingjun' => 'Lingjun', - ], - 'example' => 'ECS', - ], - 'ClusterID' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cb2c7bde30b774e46a329c', - ], - 'SupportRDMA' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ResourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Ecs', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testDescription', - ], - 'Tags' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TagKey' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'example' => 'testKey', - ], - 'TagValue' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => 'testValue', - ], - ], - ], - ], - 'Version' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\\\n\\",\\n \\"Name\\": \\"TestResourceGroup\\",\\n \\"CreatorID\\": \\"1612285282502324\\",\\n \\"WorkspaceID\\": \\"35201\\",\\n \\"Status\\": \\"Ready\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\"\\n ],\\n \\"RoleArn\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"\\",\\n \\"EipAllocationId\\": \\"\\"\\n }\\n },\\n \\"ComputingResourceProvider\\": \\"ECS\\",\\n \\"ClusterID\\": \\"cb2c7bde30b774e46a329c\\",\\n \\"SupportRDMA\\": true,\\n \\"ResourceType\\": \\"Ecs\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\"\\n }\\n ],\\n \\"Version\\": \\"\\"\\n}","type":"json"}]', - 'title' => 'GetResourceGroup', - ], - 'DeleteMachineGroup' => [ - 'summary' => 'delete machine group', - 'path' => '/api/v1/resources/machinegroups/{MachineGroupID}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Delete training job labels', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJobLabels'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetAlgorithm' => [ + 'summary' => 'Retrieves algorithm details.', + 'path' => '/api/v1/algorithms/{AlgorithmId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => true, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '124429', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'MachineGroupID', + 'name' => 'AlgorithmId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Algorithm ID.', 'type' => 'string', 'required' => false, 'example' => 'algo-xsldfvu1334', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'description' => 'Response schema.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'MachineGroupID' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'AlgorithmDescription' => ['description' => 'Algorithm description.', 'type' => 'string', 'example' => 'Large language model training.', 'title' => ''], + 'AlgorithmId' => ['description' => 'Algorithm ID.', 'type' => 'string', 'example' => 'algo-xsldfvu1334', 'title' => ''], + 'AlgorithmName' => ['description' => 'Algorithm name.', 'type' => 'string', 'example' => 'llm_training', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'Algorithm provider.', 'type' => 'string', 'example' => 'pai', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Time when the algorithm was created.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'Time when the algorithm was last updated.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'WorkspaceId' => ['description' => 'Workspace ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'UserId' => ['description' => 'User ID of the algorithm owner.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID of the algorithm owner.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'DisplayName' => ['description' => 'Display name of the algorithm.', 'type' => 'string', 'example' => 'llm_training', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'PaiStudio::2022-01-12::DeleteMachineGroup', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AlgorithmDescription\\": \\"Large language model training.\\",\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"TenantId\\": \\"123456789\\",\\n \\"DisplayName\\": \\"llm_training\\"\\n}","type":"json"}]', + 'title' => 'Retrieve algorithm details', + 'changeSet' => [ + ['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-27T10:49:58.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => null, - ], - 'CreateResourceGroup' => [ - 'summary' => '创建资源组', - 'path' => '/api/v1/resources', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithm'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:GetAlgorithm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'GetAlgorithmVersion' => [ + 'summary' => 'Retrieve details about an algorithm version.', + 'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '125287', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - 'FEATURElearn1N0SUT', - ], + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'AlgorithmId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the algorithm.', 'type' => 'string', 'required' => false, 'example' => 'algo-xsldfvu1334', 'title' => ''], + ], + [ + 'name' => 'AlgorithmVersion', + 'in' => 'path', + 'schema' => ['description' => 'The version of the algorithm.', 'type' => 'string', 'required' => false, 'example' => 'v0.0.1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'testResourceGroup', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_api_report', - ], - 'UserVpc' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/UserVpc', - ], - 'ResourceType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Ecs', - ], - 'ComputingResourceProvider' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Ecs', - ], - 'Tag' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Version' => [ - 'title' => '资源组版本，当前只在resource type为ECS时生效。', - 'type' => 'string', - 'example' => '1.0', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'."\n", - ], - 'ResourceGroupID' => [ - 'description' => 'ResourceGroup ID。', - 'type' => 'string', - 'example' => 'rgf0zhfqn1d4ity2', - ], + 'AlgorithmSpec' => ['description' => 'Details about the algorithm.', '$ref' => '#/components/schemas/AlgorithmSpec', 'title' => '', 'example' => ''], + 'AlgorithmId' => ['description' => 'The ID of the algorithm.', 'type' => 'string', 'example' => 'algo-xsldfvu1334', 'title' => ''], + 'AlgorithmName' => ['description' => 'The name of the algorithm.', 'type' => 'string', 'example' => 'llm_training', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'The provider of the algorithm.', 'type' => 'string', 'example' => 'pai', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'The version of the algorithm.', 'type' => 'string', 'example' => 'v0.0.1', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the algorithm was created.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the algorithm was last updated.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user who owns the algorithm.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'TenantId' => ['description' => 'The ID of the tenant who owns the algorithm.', 'type' => 'string', 'example' => '123456789', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\\\n\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\"\\n}","type":"json"}]', - 'title' => 'CreateResourceGroup', - ], - 'DeleteResourceGroup' => [ - 'summary' => '删除资源组', - 'path' => '/api/v1/resources/{ResourceGroupID}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', + 'title' => 'Obtain algorithm version details', + 'changeSet' => [ + ['createdAt' => '2022-04-27T10:50:46.000Z', 'description' => 'OpenAPI offline'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '125213', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmVersion'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'ResourceGroupID', - 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rgvl9d6utwcscukh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', - ], - 'ResourceGroupID' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rgvl9d6utwcscukh', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:GetAlgorithmVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"ResourceGroupID\\": \\"rgvl9d6utwcscukh\\"\\n}","type":"json"}]', - 'title' => 'DeleteResourceGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmSpec\\": {\\n \\"OutputChannels\\": [\\n {\\n \\"Description\\": \\"模型输出。\\",\\n \\"Required\\": true,\\n \\"Properties\\": {},\\n \\"Name\\": \\"Model\\",\\n \\"SupportedChannelTypes\\": [\\n \\"oss\\"\\n ]\\n }\\n ],\\n \\"HyperParameters\\": [\\n {\\n \\"DefaultValue\\": \\"0\\",\\n \\"Type\\": \\"Integer\\",\\n \\"Description\\": \\"参数定义了训练的batch_size。\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"batch_size\\",\\n \\"Range\\": {\\n \\"Enum\\": [\\n \\"0\\"\\n ],\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": \\"0\\",\\n \\"Maximum\\": \\"10\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"ExclusiveMaximum\\": true,\\n \\"Pattern\\": \\"^\\\\\\\\+?[1-9][0-9]*$\\"\\n },\\n \\"DisplayName\\": \\"Batch Size\\"\\n }\\n ],\\n \\"JobType\\": \\"TFJob\\",\\n \\"Command\\": [\\n \\"python train.py\\"\\n ],\\n \\"MetricDefinitions\\": [\\n {\\n \\"Description\\": \\"训练损失函数。\\",\\n \\"Regex\\": \\".*train:loss=([-+]?[0-9]*\\\\\\\\\\\\\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*\\",\\n \\"Name\\": \\"loss\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"Description\\": \\"模型输出。\\",\\n \\"Required\\": true,\\n \\"Properties\\": {},\\n \\"Name\\": \\"Model\\",\\n \\"SupportedChannelTypes\\": [\\n \\"oss\\"\\n ]\\n }\\n ],\\n \\"SupportsDistributedTraining\\": true,\\n \\"Image\\": \\"registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0\\",\\n \\"SupportedInstanceTypes\\": [\\n \\"ecs.g6.2xlarge\\"\\n ],\\n \\"ComputeResource\\": {\\n \\"Policy\\": {\\n \\"Version\\": \\"V1\\",\\n \\"Value\\": \\"[{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"MaxTotalCount\\\\\\\\\\\\\\":4,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":100}}},{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":5,\\\\\\\\\\\\\\"MaxTotalCount\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":20},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":80}}},{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":11,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":40},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":60}}}]\\"\\n }\\n },\\n \\"CodeDir\\": {\\n \\"LocationType\\": \\"OSS\\",\\n \\"LocationValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Customization\\": {\\n \\"CodeDir\\": true\\n },\\n \\"ResourceRequirements\\": [\\n {\\n \\"Key\\": \\"SupportedMachineTypes\\",\\n \\"Operator\\": \\"in\\",\\n \\"Values\\": [\\n \\"ecs.gn5-c4g1.xlarge\\"\\n ]\\n }\\n ],\\n \\"ProgressDefinitions\\": {\\n \\"OverallProgress\\": {\\n \\"Description\\": \\"training progress\\",\\n \\"Regex\\": \\"^[0-9]+([.][0-9]+){0,1}$\\"\\n },\\n \\"RemainingTime\\": {\\n \\"Description\\": \\"training remaining time\\",\\n \\"Regex\\": \\"^[0-9]+([.][0-9]+){0,1}$\\"\\n }\\n }\\n },\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"TenantId\\": \\"123456789\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], 'GetMachineGroup' => [ - 'summary' => 'get machine group', + 'summary' => 'Retrieves the details of a specific machine group.', 'path' => '/api/v1/resources/machinegroups/{MachineGroupID}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '124271', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - ], + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'], ], 'parameters' => [ [ 'name' => 'MachineGroupID', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the machine group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'MachineGroupID' => [ - 'type' => 'string', - ], - 'OrderID' => [ - 'type' => 'string', - ], - 'PAIResourceID' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - 'PayType' => [ - 'type' => 'string', - ], - 'PricingCycle' => [ - 'type' => 'string', - ], - 'Duration' => [ - 'type' => 'string', - ], - 'EcsType' => [ - 'type' => 'string', - ], - 'Count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RegionID' => [ - 'type' => 'string', - ], - 'GmtCreated' => [ - 'type' => 'string', - ], - 'GmtModified' => [ - 'type' => 'string', - ], - 'GmtStarted' => [ - 'type' => 'string', - ], - 'GmtExpired' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'MachineGroupID' => ['description' => 'The ID of the machine group.', 'type' => 'string', 'title' => '', 'example' => ''], + 'OrderID' => ['description' => 'The order ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'PAIResourceID' => ['description' => 'The PAI resource ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Status' => ['description' => 'The status of the machine group.', 'type' => 'string', 'title' => '', 'example' => ''], + 'PayType' => ['description' => 'The payment type. Valid values: `PostPay` (pay-as-you-go) and `PrePay` (subscription).', 'type' => 'string', 'title' => '', 'example' => ''], + 'PricingCycle' => ['description' => 'The billing cycle. This parameter is returned only when `PayType` is `PrePay`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Duration' => ['description' => 'The subscription duration. This parameter is returned only when `PayType` is `PrePay`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'EcsType' => ['description' => 'The ECS instance type of the machine group.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Count' => ['description' => 'The number of instances in the machine group.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'RegionID' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'GmtCreated' => ['description' => 'The time when the machine group was created.', 'type' => 'string', 'title' => '', 'example' => ''], + 'GmtModified' => ['description' => 'The time when the machine group was last modified.', 'type' => 'string', 'title' => '', 'example' => ''], + 'GmtStarted' => ['description' => 'The time when the machine group started.', 'type' => 'string', 'title' => '', 'example' => ''], + 'GmtExpired' => ['description' => 'The expiration time. This parameter is returned only when `PayType` is `PrePay`.', 'type' => 'string', 'title' => '', 'example' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => ''], 'SupportedDrivers' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'DefaultDriver' => [ - 'type' => 'string', - ], - 'OrderInstanceId' => [ - 'type' => 'string', + 'items' => ['description' => 'The driver name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The drivers that the machine group supports.', + 'title' => '', + 'example' => '', ], + 'DefaultDriver' => ['description' => 'The default driver.', 'type' => 'string', 'title' => '', 'example' => ''], + 'OrderInstanceId' => ['description' => 'The instance ID of the order.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'The returned data.', + 'example' => '', ], ], ], 'staticInfo' => [ - 'substitutions' => [ - 'PaiStudio::2022-01-12::GetMachineGroup', - ], + 'substitutions' => ['PaiStudio::2022-01-12::GetMachineGroup'], ], - ], - 'CreateAlgorithm' => [ - 'summary' => '创建新的算法', - 'path' => '/api/v1/algorithms', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-05-23T02:15:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-30T07:22:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMachineGroup'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"\\",\\n \\"OrderID\\": \\"\\",\\n \\"PAIResourceID\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"PayType\\": \\"\\",\\n \\"PricingCycle\\": \\"\\",\\n \\"Duration\\": \\"\\",\\n \\"EcsType\\": \\"\\",\\n \\"Count\\": 0,\\n \\"RegionID\\": \\"\\",\\n \\"GmtCreated\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"GmtStarted\\": \\"\\",\\n \\"GmtExpired\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"SupportedDrivers\\": [\\n \\"\\"\\n ],\\n \\"DefaultDriver\\": \\"\\",\\n \\"OrderInstanceId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'GetMachineGroup', + 'translator' => 'machine', + ], + 'GetNodeMetrics' => [ + 'path' => '/api/v1/resources/{ResourceGroupID}/nodemetrics/{MetricType}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '151753', + 'abilityTreeNodes' => ['FEATURElearn8Y18OQ'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'name' => 'ResourceGroupID', + 'in' => 'path', + 'schema' => ['description' => 'The resource group ID. Each resource group has a globally unique resource group ID. You can use the resource group ID to obtain information about the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], ], [ - 'name' => 'AlgorithmDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'GPUType', + 'in' => 'query', + 'schema' => ['description' => 'The GPU type. Valid values:'."\n" + .'- V100'."\n" + .'- A100'."\n" + .'- A10'."\n" + .'- T4'."\n" + .'- P100', 'type' => 'string', 'required' => false, 'example' => 'V100', 'title' => ''], ], [ - 'name' => 'AlgorithmName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm_training', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2024-07-08T02:23:30.292Z', 'title' => ''], ], [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2024-07-10T10:17:06', 'title' => ''], + ], + [ + 'name' => 'TimeStep', + 'in' => 'query', + 'schema' => ['description' => 'The time step. Default value: 5m. The supported time units are:'."\n" + ."\n" + .'- h: hours.'."\n" + ."\n" + .'- m: minutes.'."\n" + ."\n" + .'- s: seconds.'."\n" + ."\n" + .'If the value does not contain a unit, the default unit is s (seconds).', 'type' => 'string', 'required' => false, 'example' => '1h', 'title' => ''], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display non-essential information. Non-essential information currently includes Labels.'."\n" + .'Valid values:'."\n" + ."\n" + .'false: does not display non-essential information (default value)'."\n" + .'true: displays non-essential information'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'MetricType', + 'in' => 'path', + 'schema' => ['description' => 'The name of the metric to query.', 'type' => 'string', 'required' => true, 'example' => 'CpuUsageRate', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F', - ], - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-xsldfvu1334', + 'NodesMetrics' => [ + 'description' => 'The metric information of the nodes.', + 'type' => 'array', + 'items' => ['description' => 'The metric information of the node.', '$ref' => '#/components/schemas/NodeMetric', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'ResourceGroupID' => ['description' => 'The resource group ID. Each resource group has a globally unique resource group ID. You can use the resource group ID to obtain information about the resource group.', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], + 'MetricType' => ['description' => 'The name of the metric to query.', 'type' => 'string', 'example' => 'DiskWriteRate', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\"\\n}","type":"json"}]', - 'title' => 'CreateAlgorithm', - ], - 'CreateAlgorithmVersion' => [ - 'summary' => '创建一个新的算法版本', - 'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}', - 'methods' => [ - 'post', + 'staticInfo' => [ + 'substitutions' => ['Cms::2019-01-01::DescribeMetricList'], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Obtain the metric data at the node level', + 'summary' => 'You can call the GetNodeMetrics operation to obtain the metric information of resource group nodes.', + 'changeSet' => [ + ['createdAt' => '2022-08-29T02:34:36.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeMetrics'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NodesMetrics\\": [\\n {\\n \\"NodeID\\": \\"-i12****node\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": 0,\\n \\"Value\\": \\"23000\\"\\n }\\n ],\\n \\"GPUType\\": \\"GU108\\"\\n }\\n ],\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"MetricType\\": \\"DiskWriteRate\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetQuota' => [ + 'path' => '/api/v1/quotas/{QuotaId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191160', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], + ], 'parameters' => [ [ - 'name' => 'AlgorithmId', + 'name' => 'QuotaId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'algo-xsldfvu1334', - ], + 'schema' => ['description' => 'The ID of the resource quota.', 'type' => 'string', 'required' => false, 'example' => 'quota1ci8g79****', 'title' => ''], ], [ - 'name' => 'AlgorithmVersion', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v0.0.1', - ], + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return detailed information.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'AlgorithmSpec', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/AlgorithmSpec', - ], + 'name' => 'WithNodeMeta', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to return the metadata of nodes that are attached to the resource quota.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-xsldfvu1334', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'], + 'QuotaId' => ['title' => '', 'description' => 'The ID of the resource quota.', 'type' => 'string', 'example' => 'quotajradxh4****'], + 'QuotaName' => ['title' => '', 'description' => 'The name of the resource quota.', 'type' => 'string', 'example' => 'test-quota'], + 'ResourceType' => ['title' => '', 'description' => 'The resource type of the quota.', 'type' => 'string', 'example' => 'ECS'], + 'ParentQuotaId' => ['title' => '', 'description' => 'The ID of the parent resource quota.', 'type' => 'string', 'example' => 'quota1ci8g79****'], + 'ResourceGroupIds' => [ + 'description' => 'The resource groups that are associated with the resource quota.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg69rj0leslw****', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'AlgorithmVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'v0.0.1', + 'AllocateStrategy' => ['title' => '', 'description' => 'The resource allocation policy.', 'type' => 'string', 'example' => 'ByNodeSpec'], + 'Min' => ['description' => 'The configuration of the minimum quota.', '$ref' => '#/components/schemas/ResourceSpec', 'title' => '', 'example' => ''], + 'Description' => ['title' => '', 'description' => 'The description of the resource quota.', 'type' => 'string', 'example' => 'this is a test quota'], + 'Labels' => [ + 'description' => 'The labels of the resource quota.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The key-value pair of the label.', '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'CreatorId' => ['title' => '', 'description' => 'The ID of the user who created the resource quota.', 'type' => 'string', 'example' => '1884692****'], + 'LatestOperationId' => ['title' => '', 'description' => 'The ID of the most recent change to the resource quota.', 'type' => 'string', 'example' => 'operation****'], + 'Status' => ['title' => '', 'description' => 'The status of the resource quota.', 'type' => 'string', 'example' => 'Ready'], + 'ReasonCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '“”'], + 'ReasonMessage' => ['title' => '', 'description' => 'The cause of the error.', 'type' => 'string', 'example' => '“”'], + 'GmtCreatedTime' => ['title' => '', 'description' => 'The time when the resource quota was created.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the resource quota was last modified.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'], + 'QuotaDetails' => ['title' => '', 'description' => 'The details of the resource quota.', '$ref' => '#/components/schemas/QuotaDetails', 'example' => ''], + 'QuotaConfig' => ['description' => 'The configurations of the resource quota:'."\n" + ."\n" + .'- VPC information'."\n" + ."\n" + .'- Whether Remote Direct Memory Access (RDMA) is supported'."\n" + ."\n" + .'- ACS configurations, which take effect if the resource type is ACS', '$ref' => '#/components/schemas/QuotaConfig', 'title' => '', 'example' => ''], + 'Workspaces' => [ + 'description' => 'The workspaces that are associated with the resource quota.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The information about the associated workspaces.', '$ref' => '#/components/schemas/WorkspaceIdName', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'SubQuotas' => [ + 'description' => 'A list of sub-quotas of the resource quota.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The IDs of the sub-quotas.', '$ref' => '#/components/schemas/QuotaIdName', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'QueueStrategy' => ['description' => 'The queuing policy for tasks in the resource quota.', 'type' => 'string', 'example' => 'PaiStrategyIntelligent', 'title' => ''], + 'Version' => ['title' => '', 'description' => 'The version information. This parameter takes effect when ResourceType is set to ECS.', 'type' => 'string', 'example' => '1.0'], + 'HyperZones' => [ + 'description' => 'A list of high-performance network zones.', + 'title' => '', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The ID of a high-performance network zone.', 'type' => 'string', 'example' => 'A3'], + 'example' => '', ], + 'QuotaCluster' => ['title' => '', 'description' => 'The specifications and status of the cluster that is composed of resources within the quota.', '$ref' => '#/components/schemas/QuotaCluster', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\"\\n}","type":"json"}]', - 'title' => 'CreateAlgorithmVersion', - ], - 'DeleteAlgorithm' => [ - 'summary' => '删除算法', - 'path' => '/api/v1/algorithms/{AlgorithmId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Resource Quota Details', + 'summary' => 'Call GetQuota to retrieve the details of a resource quota. This helps you monitor current resource usage for effective resource management and planning.', + 'changeSet' => [ + ['createdAt' => '2025-11-12T09:21:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-11-06T13:03:33.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-09T05:27:33.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:GetQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"QuotaId\\": \\"quotajradxh4****\\",\\n \\"QuotaName\\": \\"test-quota\\",\\n \\"ResourceType\\": \\"ECS\\",\\n \\"ParentQuotaId\\": \\"quota1ci8g79****\\",\\n \\"ResourceGroupIds\\": [\\n \\"rg69rj0leslw****\\"\\n ],\\n \\"AllocateStrategy\\": \\"ByNodeSpec\\",\\n \\"Min\\": {\\n \\"NodeSpecs\\": [\\n {\\n \\"Type\\": \\"ecs.g6.4xlarge\\",\\n \\"Count\\": 10,\\n \\"BindingPolicy\\": {\\n \\"NodeSpecCount\\": 5,\\n \\"IncludeNodes\\": [\\n \\"lrnabc\\"\\n ],\\n \\"ExcludeNodes\\": [\\n \\"lrndef\\"\\n ]\\n },\\n \\"HyperType\\": \\"\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"this is a test quota\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"testAccTag\\",\\n \\"Value\\": \\"nihao\\"\\n }\\n ],\\n \\"CreatorId\\": \\"1884692****\\",\\n \\"LatestOperationId\\": \\"operation****\\",\\n \\"Status\\": \\"Ready\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"QuotaDetails\\": {\\n \\"DesiredMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"ActualMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"RequestedQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"NodeStatistics\\": {\\n \\"ActualMinNodeNum\\": 0,\\n \\"ActualMinHyperNodeNum\\": 0,\\n \\"AllocatedNodeNum\\": 0,\\n \\"AllocatedHyperNodeNum\\": 0,\\n \\"EmptyNodeNum\\": 0,\\n \\"AllocatedHyperNodeDetails\\": [\\n {\\n \\"HyperNodeName\\": \\"\\",\\n \\"AllocatedNodeNum\\": 0,\\n \\"TotalNodeNum\\": 0,\\n \\"EmptyNodeNum\\": 0\\n }\\n ]\\n }\\n },\\n \\"QuotaConfig\\": {\\n \\"SupportRDMA\\": false,\\n \\"ClusterId\\": \\"ceeb3724255364***\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"192.168.0.1/24\\\\\\"\\"\\n ],\\n \\"RoleArn\\": \\"acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"nat-7j4mka9wguxj\\",\\n \\"EipAllocationId\\": \\"eip-h29r78ieufbih\\"\\n }\\n },\\n \\"SupportGPUDrivers\\": [\\n \\"470.199.02\\"\\n ],\\n \\"DefaultGPUDriver\\": \\"470.199.02\\",\\n \\"ACS\\": {\\n \\"ACSQuotaId\\": \\"rq-3kbt2gtimmyw7fgfgothocvh\\",\\n \\"AssociatedProducts\\": [\\n \\"PAI-DLC\\"\\n ]\\n },\\n \\"ResourceSpecs\\": [\\n {\\n \\"WorkspaceId\\": \\"122421\\",\\n \\"Product\\": \\"DLC\\",\\n \\"Specs\\": [\\n {\\n \\"SpecName\\": \\"spec_test\\",\\n \\"IsGuaranteedValid\\": true,\\n \\"IsOverSoldValid\\": true,\\n \\"CodeType\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Reason\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n }\\n ],\\n \\"EnablePreemptSubquotaWorkloads\\": false,\\n \\"EnableSubQuotaPreemption\\": false,\\n \\"SubQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorityUpperBound\\": 9,\\n \\"PreemptedProducts\\": [\\n \\"dlc\\"\\n ]\\n },\\n \\"EnableGPUShare\\": false,\\n \\"OversoldUsageConfig\\": {\\n \\"DisabledBy\\": \\"\\",\\n \\"Disabled\\": false\\n },\\n \\"SelfQuotaPreemptionConfig\\": {\\n \\"PreemptorPriorities\\": [\\n 0\\n ],\\n \\"PreemptedPriorities\\": [\\n 0\\n ],\\n \\"PreemptedProducts\\": [\\n \\"\\"\\n ]\\n },\\n \\"EniCacheConfig\\": {\\n \\"Enabled\\": true,\\n \\"CachePoolSize\\": 0\\n },\\n \\"SandboxCacheConfig\\": {\\n \\"Enabled\\": true\\n },\\n \\"UseCase\\": \\"\\",\\n \\"EnableSelfQuotaPreemption\\": false,\\n \\"ControlPlaneClusterId\\": \\"\\",\\n \\"IsEncryptedResource\\": false,\\n \\"WorkloadTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"ws123***\\",\\n \\"WorkspaceName\\": \\"\\"\\n }\\n ],\\n \\"SubQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\",\\n \\"Version\\": \\"1.0\\",\\n \\"HyperZones\\": [\\n \\"A3\\"\\n ],\\n \\"QuotaCluster\\": {\\n \\"ClusterType\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"DataSourceId\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"Endpoints\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Status\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetResourceGroup' => [ + 'path' => '/api/v1/resources/{ResourceGroupID}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '146690', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124255', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'AlgorithmId', + 'name' => 'ResourceGroupID', 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The globally unique ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rgmhpp8ib5lprq9k'], + ], + [ + 'name' => 'IsAIWorkspaceDataEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Optional. Defaults to `true`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '算法Id', - 'description' => '', - 'type' => 'string', + 'description' => 'A list of up to 20 tags to add to the instance.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'algo-sidjc8134hv', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', + 'GmtCreatedTime' => ['title' => '', 'description' => 'The time when the resource group was created.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'."\n"], + 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the resource group was last modified.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'."\n"], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'."\n"], + 'Name' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'TestResourceGroup', 'title' => ''], + 'CreatorID' => ['description' => 'The ID of the user who created the resource group.', 'type' => 'string', 'example' => '1612285282502324', 'title' => ''], + 'WorkspaceID' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '35201', 'title' => ''], + 'Status' => ['description' => 'The status of the resource group.', 'type' => 'string', 'example' => 'Ready', 'title' => ''], + 'UserVpc' => ['description' => 'The details of the VPC connected to the resource group.', '$ref' => '#/components/schemas/UserVpc', 'title' => '', 'example' => ''], + 'ComputingResourceProvider' => [ + 'description' => 'The provider of computing resources for the resource group.', + 'enumValueTitles' => ['Ecs' => 'ECS', 'Lingjun' => 'Lingjun'], 'type' => 'string', - 'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7', + 'example' => 'ECS', + 'title' => '', + ], + 'ClusterID' => ['description' => 'The ID of the cluster to which the resource group belongs.', 'type' => 'string', 'example' => 'cb2c7bde30b774e46a329c', 'title' => ''], + 'SupportRDMA' => ['description' => 'Indicates whether the resource group supports RDMA.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ResourceType' => ['description' => 'The type of computing resource for the resource group.', 'type' => 'string', 'example' => 'Ecs', 'title' => ''], + 'Description' => ['description' => 'The description of the resource group.', 'type' => 'string', 'example' => 'testDescription', 'title' => ''], + 'Tags' => [ + 'description' => 'A list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'testKey'], + 'TagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'testValue'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Version' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\"\\n}","type":"json"}]', - 'title' => 'DeleteAlgorithm', - ], - 'DeleteAlgorithmVersion' => [ - 'summary' => '删除算法版本', - 'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}', - 'methods' => [ - 'delete', + 'title' => 'Get resource group details', + 'summary' => '`GetResourceGroup` retrieves details for a resource group.', + 'changeSet' => [ + ['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-04T03:16:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-05-11T03:07:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-10T09:57:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-06T05:56:43.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-04T06:45:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-03T03:11:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:GetResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\\\n\\",\\n \\"Name\\": \\"TestResourceGroup\\",\\n \\"CreatorID\\": \\"1612285282502324\\",\\n \\"WorkspaceID\\": \\"35201\\",\\n \\"Status\\": \\"Ready\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"192.168.0.1/24\\\\\\"\\"\\n ],\\n \\"RoleArn\\": \\"acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"nat-7j4mka9wguxj\\",\\n \\"EipAllocationId\\": \\"eip-h29r78ieufbih\\"\\n }\\n },\\n \\"ComputingResourceProvider\\": \\"ECS\\",\\n \\"ClusterID\\": \\"cb2c7bde30b774e46a329c\\",\\n \\"SupportRDMA\\": true,\\n \\"ResourceType\\": \\"Ecs\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\"\\n }\\n ],\\n \\"Version\\": \\"\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetResourceGroupMachineGroup' => [ + 'summary' => 'Call GetResourceGroupMachineGroup to retrieve the details of a machine group.', + 'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups/{MachineGroupID}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '146338', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '125186', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'AlgorithmId', + 'name' => 'MachineGroupID', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'algo-xsldfvu1334', - ], + 'schema' => ['description' => 'The ID of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'mgmioirqjgw6c5lg', 'title' => ''], ], [ - 'name' => 'AlgorithmVersion', + 'name' => 'ResourceGroupID', 'in' => 'path', + 'schema' => ['description' => 'The globally unique ID of the resource group. You can use this ID to retrieve details about the group.', 'type' => 'string', 'required' => true, 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v0.0.1', + 'description' => 'A list of up to 20 tags.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', + 'MachineGroupID' => ['description' => 'The ID of the machine group.', 'type' => 'string', 'example' => 'mgmioirqjgw6c5lg', 'title' => ''], + 'ResourceGroupID' => ['description' => 'The ID of the resource group. This ID is globally unique and can be used to retrieve information about the resource group.', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], + 'Status' => ['description' => 'The status of the machine group.'."\n" + .'Valid values:'."\n" + .'Creating: The machine group is being created.'."\n" + .'Ready: The machine group is running.'."\n" + .'Expiring: The machine group is about to expire.'."\n" + .'Expired: The machine group has expired.'."\n" + .'Stopping: The machine group is being stopped.'."\n" + .'Stopped: The machine group has been stopped.', 'type' => 'string', 'example' => 'Ready', 'title' => ''], + 'PaymentType' => ['description' => 'The payment type.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''], + 'PaymentDurationUnit' => ['description' => 'The unit of the billing cycle for the machine group.', 'type' => 'string', 'example' => 'Month', 'title' => ''], + 'PaymentDuration' => ['description' => 'The payment duration. When PaymentDurationUnit is set to Month, valid values are: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'EcsSpec' => ['description' => 'The ECS spec.', 'type' => 'string', 'example' => 'ecs.c6.large', 'title' => ''], + 'EcsCount' => ['description' => 'The number of ECS instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GmtCreatedTime' => ['description' => 'The creation time of the machine group.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modification time of the machine group.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z', 'title' => ''], + 'GmtStartedTime' => ['description' => 'The start time of the machine group.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z', 'title' => ''], + 'GmtExpiredTime' => ['description' => 'The expiration time of the machine group.', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E', 'title' => ''], + 'Cpu' => ['description' => 'The total number of CPU cores per machine in the machine group.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Gpu' => ['description' => 'The number of GPUs per machine in the machine group.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'GpuType' => ['description' => 'The GPU type per machine in the machine group.', 'type' => 'string', 'example' => 'A100', 'title' => ''], + 'Memory' => ['description' => 'The amount of memory per machine in the machine group.', 'type' => 'string', 'example' => '64', 'title' => ''], + 'SupportedDrivers' => [ + 'description' => 'The GPU driver versions supported by the machines in the machine group.', + 'type' => 'array', + 'items' => ['description' => 'A supported GPU driver version.', 'type' => 'string', 'example' => '535,550', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DefaultDriver' => ['description' => 'The default GPU driver version per machine in the machine group.', 'type' => 'string', 'example' => '535', 'title' => ''], + 'Name' => ['description' => 'The name of the machine group.', 'type' => 'string', 'example' => 'testMachineGroup', 'title' => ''], + 'Tags' => [ + 'description' => 'The list of tags attached to the machine group.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag object.', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey'], + 'TagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'AllocatableCpu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AllocatableMemory' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SystemReservedCpu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SystemReservedMemory' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'Get Machine Group Details', + 'changeSet' => [ + ['createdAt' => '2025-08-22T05:48:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-04T03:16:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-08-30T07:22:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-21T07:16:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]', - 'title' => 'DeleteAlgorithmVersion', - ], - 'GetAlgorithm' => [ - 'summary' => '获取一个算法信息', - 'path' => '/api/v1/algorithms/{AlgorithmId}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupMachineGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:GetResourceGroupMachineGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'MachineGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}/machinegroup/{#MachineGroupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"mgmioirqjgw6c5lg\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"Status\\": \\"Ready\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"PaymentDurationUnit\\": \\"Month\\",\\n \\"PaymentDuration\\": \\"1\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"EcsCount\\": 1,\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtStartedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtExpiredTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Cpu\\": \\"2\\",\\n \\"Gpu\\": \\"8\\",\\n \\"GpuType\\": \\"A100\\",\\n \\"Memory\\": \\"64\\",\\n \\"SupportedDrivers\\": [\\n \\"535,550\\"\\n ],\\n \\"DefaultDriver\\": \\"535\\",\\n \\"Name\\": \\"testMachineGroup\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"AllocatableCpu\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCpu\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetResourceGroupRequest' => [ + 'path' => '/api/v1/resources/data/request', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146159', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'], ], - 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AlgorithmId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'algo-xsldfvu1334', - ], + 'name' => 'ResourceGroupID', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID. Each resource group has a globally unique resource group ID. You can use the resource group ID to obtain information about the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], + ], + [ + 'name' => 'PodStatus', + 'in' => 'query', + 'schema' => ['description' => 'The container status. Valid values:'."\n" + ."\n" + .'- Waiting'."\n" + .'- Running'."\n" + .'- Terminated', 'type' => 'string', 'default' => 'Running', 'required' => false, 'example' => 'Running', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'AlgorithmDescription' => [ - 'description' => '', - 'type' => 'string', + 'requestCPU' => ['description' => 'The total number of allocated CPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'requestMemory' => ['description' => 'The total amount of allocated memory.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'requestGPU' => ['description' => 'The total number of allocated GPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'requestGPUInfos' => [ + 'description' => 'The allocated GPU resources counted separately by card type.', + 'type' => 'array', + 'items' => ['description' => 'The allocated GPU resources counted separately by card type.', '$ref' => '#/components/schemas/GPUInfo', 'title' => '', 'example' => ''], + 'title' => '', 'example' => '', ], - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-xsldfvu1334', - ], - 'AlgorithmName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm_training', - ], - 'AlgorithmProvider' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pai', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', - ], - 'DisplayName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm_training', - ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AlgorithmDescription\\": \\"大语言模型训练。\\",\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"TenantId\\": \\"123456789\\",\\n \\"DisplayName\\": \\"llm_training\\"\\n}","type":"json"}]', - 'title' => 'GetAlgorithm', - ], - 'GetAlgorithmVersion' => [ - 'summary' => '创建一个新的算法版本', - 'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}', - 'methods' => [ - 'get', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Obtain the resources that have been allocated to a resource group', + 'summary' => 'You can call the GetResourceGroupRequest operation to obtain the number of resources that have been allocated to a resource group.', + 'changeSet' => [ + ['createdAt' => '2022-07-21T07:16:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupRequest'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestCPU\\": 1,\\n \\"requestMemory\\": 2,\\n \\"requestGPU\\": 8,\\n \\"requestGPUInfos\\": [\\n {\\n \\"count\\": 1,\\n \\"type\\": \\"T4\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetResourceGroupTotal' => [ + 'path' => '/api/v1/resources/data/total', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '145960', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'], + ], 'parameters' => [ [ - 'name' => 'AlgorithmId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'algo-xsldfvu1334', - ], - ], - [ - 'name' => 'AlgorithmVersion', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v0.0.1', - ], + 'name' => 'ResourceGroupID', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Resource Group.', 'type' => 'string', 'required' => false, 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'AlgorithmSpec' => [ - 'description' => '', - '$ref' => '#/components/schemas/AlgorithmSpec', - ], - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-xsldfvu1334', - ], - 'AlgorithmName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm_training', - ], - 'AlgorithmProvider' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pai', - ], - 'AlgorithmVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'v0.0.1', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', + 'totalCPU' => ['description' => 'The total number of CPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'totalMemory' => ['description' => 'The total memory.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], + 'totalGPU' => ['description' => 'The total number of GPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => ''], + 'totalGPUInfos' => [ + 'description' => 'The resources counted by GPU card type.', + 'type' => 'array', + 'items' => ['description' => 'The resources of each card type counted separately by GPU card type.', '$ref' => '#/components/schemas/GPUInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmSpec\\": {\\n \\"OutputChannels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Name\\": \\"\\",\\n \\"SupportedChannelTypes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"HyperParameters\\": [\\n {\\n \\"DefaultValue\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"\\",\\n \\"Range\\": {\\n \\"Enum\\": [\\n \\"\\"\\n ],\\n \\"MinLength\\": 0,\\n \\"MaxLength\\": 0,\\n \\"Minimum\\": \\"\\",\\n \\"Maximum\\": \\"\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"ExclusiveMaximum\\": true,\\n \\"Pattern\\": \\"\\"\\n },\\n \\"DisplayName\\": \\"\\"\\n }\\n ],\\n \\"JobType\\": \\"\\",\\n \\"Command\\": [\\n \\"\\"\\n ],\\n \\"MetricDefinitions\\": [\\n {\\n \\"Description\\": \\"train dataset oob score\\",\\n \\"Regex\\": \\".*train:oob_score=([-+]?[0-9]*\\\\\\\\\\\\\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*\\",\\n \\"Name\\": \\"train:oob_score\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Name\\": \\"\\",\\n \\"SupportedChannelTypes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SupportsDistributedTraining\\": true,\\n \\"Image\\": \\"\\",\\n \\"SupportedInstanceTypes\\": [\\n \\"\\"\\n ],\\n \\"ComputeResource\\": {\\n \\"Policy\\": {\\n \\"Version\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n },\\n \\"CodeDir\\": {\\n \\"LocationType\\": \\"\\",\\n \\"LocationValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Customization\\": {\\n \\"CodeDir\\": true\\n },\\n \\"ResourceRequirements\\": [\\n {\\n \\"Key\\": \\"SupportedMachineTypes\\",\\n \\"Operator\\": \\"in\\",\\n \\"Values\\": [\\n \\"GPU\\"\\n ]\\n }\\n ],\\n \\"ProgressDefinitions\\": {\\n \\"OverallProgress\\": {\\n \\"Description\\": \\"\\",\\n \\"Regex\\": \\"\\"\\n },\\n \\"RemainingTime\\": {\\n \\"Description\\": \\"\\",\\n \\"Regex\\": \\"\\"\\n }\\n }\\n },\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"TenantId\\": \\"123456789\\"\\n}","type":"json"}]', - 'title' => 'GetAlgorithmVersion', - ], - 'ListAlgorithms' => [ - 'summary' => '获取算法列表', - 'path' => '/api/v1/algorithms', - 'methods' => [ - 'get', + 'title' => 'Get the total resources of a Resource Group', + 'summary' => 'You can call GetResourceGroupTotal to get the total resources of a Resource Group.', + 'changeSet' => [ + ['createdAt' => '2022-07-21T07:16:01.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupTotal'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCPU\\": 100,\\n \\"totalMemory\\": 300,\\n \\"totalGPU\\": 24,\\n \\"totalGPUInfos\\": [\\n {\\n \\"count\\": 1,\\n \\"type\\": \\"T4\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetSpotPriceHistory' => [ + 'path' => '/api/v1/spots/{InstanceType}/pricehistory', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '213678', + 'abilityTreeNodes' => ['FEATURElearnZO51AS'], + ], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'InstanceType', + 'in' => 'path', + 'schema' => ['description' => 'The instance type of the spot instance. Supports ECS and Lingjun instance types.', 'type' => 'string', 'required' => false, 'example' => 'ml.gu7xf.8xlarge-gu108', 'title' => ''], + ], + [ + 'name' => 'SpotDuration', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The retention period for the spot instance, in hours. Note that only ECS instance types support this parameter. Default value: 0. Valid values:'."\n" + ."\n" + .'- 1: Alibaba Cloud guarantees that the instance runs for at least one hour after creation. After one hour, the system compares your bid price with the current market price and checks resource inventory to decide whether to retain or revoke the instance.'."\n" + ."\n" + .'- 0: Alibaba Cloud does not guarantee one-hour runtime. The system compares your bid price with the current market price and checks resource inventory to decide whether to retain or revoke the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The start time for querying historical spot instance prices. This time must be no more than seven days before the end time. Specify the time in ISO 8601 format using UTC+0, as yyyy-MM-ddTHH:mm:ssZ. Default value: empty. An empty value means three days before the end time.', 'type' => 'string', 'required' => false, 'example' => '2024-12-26T09:36:46Z', 'title' => ''], ], [ - 'name' => 'AlgorithmName', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm_training', - ], + 'schema' => ['description' => 'The end time for querying historical spot instance prices. Specify the time in ISO 8601 format using UTC+0, as yyyy-MM-ddTHH:mm:ssZ. Default value: empty. An empty value means the current time.', 'type' => 'string', 'required' => false, 'example' => '2024-12-30T09:36:46Z', 'title' => ''], ], [ - 'name' => 'AlgorithmId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'algo-xsldfvu1334', - ], + 'schema' => ['description' => 'The page number of the current page. Default value: ***1***. This parameter applies only when you query historical prices for Lingjun instance types.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AlgorithmProvider', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: **10**. This parameter applies only when you query historical prices for Lingjun instance types.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The field to sort by. Default value: GmtCreatedTime. Valid values:'."\n" + ."\n" + .'- GmtCreatedTime'."\n" + ."\n" + .'This parameter applies only when you query historical prices for Lingjun instance types.', + 'enumValueTitles' => ['GmtCreatedTime' => 'GmtCreatedTime'], 'type' => 'string', 'required' => false, - 'example' => 'pai', + 'example' => 'GmtCreatedTime', + 'title' => '', ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The sort order. Default value: asc. Valid values:'."\n" + ."\n" + .'- desc: descending order.'."\n" + ."\n" + .'- asc: ascending order.'."\n" + ."\n" + .'This parameter applies only when you query historical prices for Lingjun instance types.', + 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'], 'type' => 'string', 'required' => false, - 'example' => '12345', + 'example' => 'asc', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Details about historical spot instance prices', + 'title' => '', 'type' => 'object', 'properties' => [ - 'Algorithms' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8BDA4440-DD3C-5F4B-BBDD-94A9CE1E75C7', 'title' => ''], + 'SpotPriceHistory' => [ + 'description' => 'A list of historical spot instance price details', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AlgorithmDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-sidjc8134hv', - ], - 'AlgorithmName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm_train', - ], - 'AlgorithmProvider' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pai', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-21T03:35:24Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-25T02:15:40Z', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', - ], - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'DisplayName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'LLM Train', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + 'items' => ['description' => 'Historical spot instance price details', '$ref' => '#/components/schemas/SpotPriceItem', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of historical spot instance prices', 'type' => 'integer', 'format' => 'int32', 'example' => '194', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Algorithms\\": [\\n {\\n \\"AlgorithmDescription\\": \\"大语言模型训练。\\",\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"GmtCreateTime\\": \\"2023-07-21T03:35:24Z\\",\\n \\"GmtModifiedTime\\": \\"2023-07-25T02:15:40Z\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"DisplayName\\": \\"LLM Train\\"\\n }\\n ],\\n \\"TotalCount\\": 4,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', - 'title' => 'ListAlgorithms', - ], - 'ListAlgorithmVersions' => [ - 'summary' => '获取算法的所有版本信息', - 'path' => '/api/v1/algorithms/{AlgorithmId}/versions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve spot instance historical prices ', + 'summary' => 'Retrieves the historical prices of spot instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BDA4440-DD3C-5F4B-BBDD-94A9CE1E75C7\\",\\n \\"SpotPriceHistory\\": [\\n {\\n \\"ZoneId\\": \\"cn-wulanchabu-a\\",\\n \\"InstanceType\\": \\"ml.gu8xf.8xlarge-gu108\\",\\n \\"SpotDiscount\\": 0.1,\\n \\"Timestamp\\": \\"2024-01-17T06:00:00Z\\"\\n }\\n ],\\n \\"TotalCount\\": 194\\n}","type":"json"}]', + ], + 'GetToken' => [ + 'summary' => 'Obtains a share token for a training task.', + 'path' => '/api/v1/tokens', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '189411', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'TrainingJobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'ID of the training task.', 'type' => 'string', 'required' => true, 'example' => 'traincclrt205dcs', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ExpireTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AlgorithmId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'algo-sidjc8134hv', - ], + 'schema' => ['description' => 'Time-to-live (TTL) of the share link in seconds. Default is 604800. Minimum is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Response schema', + 'title' => '', 'type' => 'object', 'properties' => [ - 'AlgorithmVersions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-sidjc8134hv', - ], - 'AlgorithmName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm_train', - ], - 'AlgorithmProvider' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pai', - ], - 'AlgorithmVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'v0.1.0', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-19T02:00:26Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-22T02:00:59Z', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], + 'RequestId' => ['title' => '', 'description' => 'ID of the request.', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'], + 'Token' => ['description' => 'Share token for the training task. Use this token as the Token parameter in the GetJob API to view details of the shared task.', 'type' => 'string', 'example' => 'ql4OU830nJaF17LP6KTry4a9DvnjIXHP', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmVersions\\": [\\n {\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.1.0\\",\\n \\"GmtCreateTime\\": \\"2024-01-19T02:00:26Z\\",\\n \\"GmtModifiedTime\\": \\"2024-01-22T02:00:59Z\\",\\n \\"TenantId\\": \\"123456789\\",\\n \\"UserId\\": \\"123456789\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', - 'title' => 'ListAlgorithmVersions', - ], - 'UpdateAlgorithm' => [ - 'summary' => '更新算法', - 'path' => '/api/v1/algorithms/{AlgorithmId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"Token\\": \\"ql4OU830nJaF17LP6KTry4a9DvnjIXHP\\"\\n}","type":"json"}]', + 'title' => 'Obtain a sharing token for a training job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'GetTrainingJob' => [ + 'summary' => 'Get training job details.', + 'path' => '/api/v1/trainingjobs/{TrainingJobId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132929', + 'abilityTreeNodes' => ['FEATURElearnVYA4L9'], + ], 'parameters' => [ [ - 'name' => 'AlgorithmDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'LLM Train', - ], - ], - [ - 'name' => 'AlgorithmId', + 'name' => 'TrainingJobId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'algo-sidjc8134hv', - ], + 'schema' => ['description' => 'The ID of the training job.', 'type' => 'string', 'required' => true, 'example' => 'train129f212o89d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F', + 'OutputChannels' => [ + 'description' => 'The configurations for the output data channels of the training job.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration for an output data channel.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the output data.', 'type' => 'string', 'example' => 'model', 'title' => ''], + 'OutputUri' => ['description' => 'The URI of the output data.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/model/', 'title' => ''], + 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 'd-8o0hh35po15ejcdq2p', 'title' => ''], + 'VersionName' => ['description' => 'The dataset version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-sidjc8134hv', + 'Status' => ['description' => 'The status of the training job.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'HyperParameters' => [ + 'description' => 'The hyperparameter settings for the training job.', + 'type' => 'array', + 'items' => [ + 'description' => 'A hyperparameter for the training job.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the hyperparameter.', 'type' => 'string', 'example' => 'learning_rate', 'title' => ''], + 'Value' => ['description' => 'The value of the hyperparameter.', 'type' => 'string', 'example' => '0.0001', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\"\\n}","type":"json"}]', - 'title' => 'UpdateAlgorithm', - ], - 'UpdateAlgorithmVersion' => [ - 'summary' => '更新算法', - 'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'AlgorithmId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'algo-sidjc8134hv', - ], - ], - [ - 'name' => 'AlgorithmVersion', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v0.0.1', - ], - ], - [ - 'name' => 'AlgorithmSpec', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/AlgorithmSpec', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-sidjc8134hv', - ], - 'AlgorithmVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'v0.1.0', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmVersion\\": \\"v0.1.0\\"\\n}","type":"json"}]', - 'title' => 'UpdateAlgorithmVersion', - ], - 'CreateTrainingJob' => [ - 'summary' => '创建TrainingJob', - 'path' => '/api/v1/trainingjobs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '132535', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AlgorithmName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ev_classification', - ], - 'AlgorithmProvider' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pai', - ], - 'AlgorithmVersion' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v1.0.0', + 'TrainingJobName' => ['description' => 'The training job name.', 'type' => 'string', 'example' => 'qwen_llm', 'title' => ''], + 'TrainingJobId' => ['description' => 'The training job ID.', 'type' => 'string', 'example' => 'traini6hhxiq69eo', 'title' => ''], + 'Scheduler' => [ + 'description' => 'The scheduling configuration for the training job.', + 'type' => 'object', + 'properties' => [ + 'MaxRunningTimeInSeconds' => ['description' => 'The maximum runtime of the training job, in seconds. If the value is 0, the runtime is not limited.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MaxRunningTimeInMinutes' => ['description' => 'The maximum runtime, in minutes.', 'type' => 'string', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'ReasonMessage' => ['description' => 'The reason for the training job failure.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '86995', 'title' => ''], 'ComputeResource' => [ - 'description' => '', + 'description' => 'The compute resource configuration.', 'type' => 'object', 'properties' => [ - 'EcsCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'EcsSpec' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.gn5-c8g1.2xlarge', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quotam670lixikcs', - ], - 'InstanceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'EcsCount' => ['description' => 'The number of ECS instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EcsSpec' => ['description' => 'The ECS instance type.', 'type' => 'string', 'example' => 'ecs.gn5-c8g1.2xlarge', 'title' => ''], + 'ResourceId' => ['description' => 'The resource quota ID.', 'type' => 'string', 'example' => 'quotam670lixikcl', 'title' => ''], + 'ResourceName' => ['description' => 'The resource quota name.', 'type' => 'string', 'example' => 'quota', 'title' => ''], + 'InstanceCount' => ['description' => 'The number of instances used from the resource quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'InstanceSpec' => [ - 'description' => '', + 'description' => 'The instance specification for the resource quota.', 'type' => 'object', 'properties' => [ - 'CPU' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8', - ], - 'Memory' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '32', - ], - 'SharedMemory' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '32', - ], - 'GPU' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'GPUType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'V100', - ], + 'CPU' => ['description' => 'The number of vCPUs for the instance.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'Memory' => ['description' => 'The memory size for the instance, in GiB.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'SharedMemory' => ['description' => 'The shared memory size for the instance, in GiB.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'GPU' => ['description' => 'The number of GPUs for the instance.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GPUType' => ['description' => 'The GPU type of the instance.', 'type' => 'string', 'example' => 'V100', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], + 'UseSpotInstance' => ['description' => 'Indicates whether to use spot instances.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SpotSpec' => [ - 'description' => '', + 'description' => 'The configuration for spot instances.', 'type' => 'object', 'properties' => [ - 'SpotStrategy' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SpotWithPriceLimit', - ], - 'SpotDiscountLimit' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '9', - ], + 'SpotStrategy' => ['description' => 'The bidding policy for the spot instance. Valid values:'."\n" + ."\n" + .'- `SpotWithPriceLimit`: Sets a maximum price for the spot instance.'."\n" + ."\n" + .'- `SpotAsPriceGo`: The system automatically places bids based on the real-time market price.', 'type' => 'string', 'example' => 'SpotWithPriceLimit', 'title' => ''], + 'SpotDiscountLimit' => ['description' => 'The maximum hourly price for the spot instance. This parameter applies only when `SpotStrategy` is set to `SpotWithPriceLimit`.', 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'title' => ''], ], - 'required' => false, - ], - 'UseSpotInstance' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'HyperParameters' => [ - 'description' => '', + 'Labels' => [ + 'description' => 'The labels for the training job.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A label for the training job.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'learning_rate', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.0001', - ], + 'Key' => ['description' => 'The label key.', 'type' => 'string', 'example' => 'CreatedBy', 'title' => ''], + 'Value' => ['description' => 'The label value.', 'type' => 'string', 'example' => 'QuickStart', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], + 'AlgorithmProvider' => ['description' => 'The algorithm provider.', 'type' => 'string', 'example' => 'pai', 'title' => ''], 'InputChannels' => [ - 'description' => '', + 'description' => 'The configurations for the input data channels of the training job.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The configuration for an input data channel.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'model', - ], - 'DatasetId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd-475megosidivjfgfq6', - ], - 'VersionName' => [ - 'type' => 'string', - ], - 'InputUri' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://pai-quickstart-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/modelscope/models/qwen2-0.5b/main/', - ], - 'Options' => [ - 'type' => 'string', - ], + 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 'd-475megosidivjfgfq6', 'title' => ''], + 'Name' => ['description' => 'The name of the input data.', 'type' => 'string', 'example' => 'model', 'title' => ''], + 'InputUri' => ['description' => 'The URI of the input data.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/model/', 'title' => ''], + 'Options' => ['description' => 'The file system parameters for the input data.', 'type' => 'string', 'example' => 'ossAppendable=true', 'title' => ''], + 'VersionName' => ['description' => 'The dataset version.', 'type' => 'string', 'example' => 'v1', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'Labels' => [ - 'description' => '', + 'AlgorithmName' => ['description' => 'The algorithm name.', 'type' => 'string', 'example' => 'llm_training', 'title' => ''], + 'ReasonCode' => ['description' => 'The reason code for the training job\'s status.', 'type' => 'string', 'example' => 'TrainingJobSucceed', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the training job status was last updated.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'StatusTransitions' => [ + 'description' => 'The status transitions for the training job.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A status transition of the training job.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CreatedBy', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'QuickStart', - ], + 'EndTime' => ['description' => 'The end time of the status.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'ReasonCode' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'TrainingJobSucceed', 'title' => ''], + 'ReasonMessage' => ['description' => 'The message for the status update.', 'type' => 'string', 'example' => 'KubeDL job runs successfully', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the status.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'OutputChannels' => [ - 'description' => '', + 'TrainingJobDescription' => ['description' => 'The training job description.', 'type' => 'string', 'example' => 'Qwen2 large language model training.', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'The algorithm version.', 'type' => 'string', 'example' => 'v0.0.1', 'title' => ''], + 'LatestMetrics' => [ + 'description' => 'The latest metrics for the training job.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A monitoring metric for the training job.', 'type' => 'object', 'properties' => [ - 'DatasetId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd-475megosidivjfgfq6', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'model', - ], - 'OutputUri' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://pai-quickstart-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/modelscope/models/qwen2-0.5b/main/', - ], - 'VersionName' => [ - 'type' => 'string', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Scheduler' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MaxRunningTimeInSeconds' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'MaxRunningTimeInMinutes' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - 'required' => false, - ], - 'TrainingJobDescription' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'qwen large language model training', - ], - 'TrainingJobName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qwen_llm', - ], - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - 'AlgorithmSpec' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/AlgorithmSpec', - ], - 'CodeDir' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Location', - ], - 'RoleArn' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::1157703270994901:role/aliyunserviceroleforpaiworkspace', - ], - 'UserVpc' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-dxiflssjx978sl', - ], - 'SwitchId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vs-icrc813vdsfol', - ], - 'SecurityGroupId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-qdfasd13sdasf', - ], - 'ExtendedCIDRs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.1/24', - ], - 'required' => false, - ], - 'DefaultRoute' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'eth0', + 'Name' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'loss', 'title' => ''], + 'Timestamp' => ['description' => 'The time when the metric was collected.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'Value' => ['description' => 'The value of the metric.', 'type' => 'number', 'format' => 'double', 'example' => '0.11', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'Settings' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'EnableErrorMonitoringInAIMaster' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'ErrorMonitoringArgs' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '--enable-log-hang-detection true', - ], - 'AIMasterType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.c6.large', + 'GmtCreateTime' => ['description' => 'The time when the training job was created.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], + 'Instances' => [ + 'description' => 'The instances for the training job.', + 'type' => 'array', + 'items' => [ + 'description' => 'A training job instance.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'train1oug3yehan4-master-0', 'title' => ''], + 'Role' => ['description' => 'The instance role.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, - '$ref' => '#/components/schemas/JobSettings', + 'title' => '', + 'example' => '', ], - 'ExperimentConfig' => [ - 'description' => '', + 'AlgorithmId' => ['description' => 'The training algorithm ID.', 'type' => 'string', 'example' => 'algo-xsldfvu1334', 'title' => ''], + 'TrainingJobUrl' => ['description' => 'The URL of the training job details page.', 'type' => 'string', 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=1234#/training/jobs/train1ouyadsl8n4', 'title' => ''], + 'RoleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role used for delegated authorization.', 'type' => 'string', 'example' => 'acs:ram::{accountID}:role/{roleName}', 'title' => ''], + 'AlgorithmSpec' => ['title' => '', 'description' => 'The definition of the temporary algorithm.', '$ref' => '#/components/schemas/AlgorithmSpec', 'example' => ''], + 'IsTempAlgo' => ['title' => '', 'description' => 'Indicates whether a temporary algorithm is used.', 'type' => 'boolean', 'example' => 'true'], + 'LatestProgress' => [ + 'description' => 'The latest progress of the training job.', 'type' => 'object', 'properties' => [ - 'ExperimentId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exp-ds9aefia90v', - ], - ], - 'required' => false, - ], - 'Environments' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'debug=true', - ], - ], - 'PythonRequirements' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'numpy', - ], - 'required' => false, - ], - 'Priority' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'AssignNodeSpec' => [ - '$ref' => '#/components/schemas/AssignNodeSpec', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'TrainingJobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'traineyfz0m2hsfv', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrainingJobId\\": \\"traineyfz0m2hsfv\\",\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]', - 'title' => 'CreateTrainingJob', - ], - 'CreateInstanceWebTerminal' => [ - 'summary' => '创建WebTerminal', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/webterminals', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '199679', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'train1nc6686x36b', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'train1nc6686x36b-master-0', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'WebTerminalId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WebTerminalId\\": \\"wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', - 'title' => 'CreateInstanceWebTerminal', - ], - 'CheckInstanceWebTerminal' => [ - 'summary' => '检查WebTerminal', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/webterminals/action/check', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '199680', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'traineyfz0m2hsfv', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'train1oxaqdiluad-master-0', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CheckInfo' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\"\\n}","type":"json"}]', - 'title' => 'CheckInstanceWebTerminal', - ], - 'DeleteTrainingJob' => [ - 'summary' => '删除一个TrainingJob', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '132982', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'train76rcaupa2cz', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4cc83062-9bcb-4ab3-979e-2e571a35834f', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4cc83062-9bcb-4ab3-979e-2e571a35834f\\"\\n}","type":"json"}]', - 'title' => 'DeleteTrainingJob', - ], - 'DeleteTrainingJobLabels' => [ - 'summary' => '删除TrainingJob的Labels', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/labels', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '132984', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'trainw52bqlfjbjc', - ], - ], - [ - 'name' => 'Keys', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'RootModelID', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', - 'title' => 'DeleteTrainingJobLabels', - ], - 'GetToken' => [ - 'summary' => '调用GetToken获取临时鉴权信息', - 'path' => '/api/v1/tokens', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '189411', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'traincclrt205dcs', - ], - ], - [ - 'name' => 'ExpireTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6', - ], - 'Token' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ql4OU830nJaF17LP6KTry4a9DvnjIXHP', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"Token\\": \\"ql4OU830nJaF17LP6KTry4a9DvnjIXHP\\"\\n}","type":"json"}]', - 'title' => 'GetToken', - ], - 'GetTrainingJob' => [ - 'summary' => '获取TrainingJob的详情', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '132929', - 'abilityTreeNodes' => [ - 'FEATURElearnVYA4L9', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'train129f212o89d', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'OutputChannels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model', - ], - 'OutputUri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/model/', - ], - 'DatasetId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd-8o0hh35po15ejcdq2p', - ], - 'VersionName' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'HyperParameters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'learning_rate', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.0001', - ], - ], - ], - ], - 'TrainingJobName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qwen_llm', - ], - 'TrainingJobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'traini6hhxiq69eo', - ], - 'Scheduler' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MaxRunningTimeInSeconds' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRunningTimeInMinutes' => [ - 'type' => 'string', - ], - ], - ], - 'ReasonMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '86995', - ], - 'ComputeResource' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EcsCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'EcsSpec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecs.gn5-c8g1.2xlarge', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'quotam670lixikcl', - ], - 'ResourceName' => [ - 'type' => 'string', - ], - 'InstanceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InstanceSpec' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CPU' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8', - ], - 'Memory' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32', - ], - 'SharedMemory' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32', - ], - 'GPU' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'GPUType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'V100', - ], - ], - ], - 'UseSpotInstance' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SpotSpec' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SpotStrategy' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SpotWithPriceLimit', - ], - 'SpotDiscountLimit' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.9', - ], - ], - ], - ], - ], - 'Labels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CreatedBy', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'QuickStart', - ], - ], - ], - ], - 'AlgorithmProvider' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pai', - ], - 'InputChannels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DatasetId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd-475megosidivjfgfq6', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model', - ], - 'InputUri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/model/', - ], - 'Options' => [ - 'type' => 'string', - ], - 'VersionName' => [ - 'type' => 'string', - ], - ], - ], - ], - 'AlgorithmName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm_training', - ], - 'ReasonCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TrainingJobSucceed', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'StatusTransitions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'ReasonCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TrainingJobSucceed', - ], - 'ReasonMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'KubeDL job runs successfully', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Creating', - ], - ], - ], - ], - 'TrainingJobDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', - ], - 'AlgorithmVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'v0.0.1', - ], - 'LatestMetrics' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'loss', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'Value' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.11', - ], - ], - ], - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Instances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'train1oug3yehan4-master-0', - ], - 'Role' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'master', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Succeeded', - ], - ], - ], - ], - 'AlgorithmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'algo-xsldfvu1334', - ], - 'TrainingJobUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=1234#/training/jobs/train1ouyadsl8n4', - ], - 'RoleArn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'acs:ram::{accountID}:role/{roleName}', - ], - 'AlgorithmSpec' => [ - 'title' => '临时算法定义。', - 'description' => '', - '$ref' => '#/components/schemas/AlgorithmSpec', - ], - 'IsTempAlgo' => [ - 'title' => '是否使用了临时算法。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LatestProgress' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OverallProgress' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-04T13:20:18Z', - ], - 'Value' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.75', - ], - ], - ], - 'RemainingTime' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-07-04T13:20:18Z', - ], - 'Value' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', - ], - ], - ], - ], - ], - 'UserVpc' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-abcdef****', - ], - 'SwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vs-abcdef****', - ], - 'SecurityGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sg-abcdef****', - ], - 'ExtendedCIDRs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '192.168.0.1/24', - ], - ], - ], - ], - 'OutputModel' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Uri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/model/output/', - ], - 'OutputChannelName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model', - ], - ], - ], - 'Settings' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EnableErrorMonitoringInAIMaster' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMonitoringArgs' => [ - 'description' => '', - 'type' => 'string', - 'example' => '--enable-log-hang-detection true', - ], - 'AIMasterType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecs.c6.large', - ], - ], - '$ref' => '#/components/schemas/JobSettings', - ], - 'ExperimentConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ExperimentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'exp-ds9aefia90v', - ], - 'ExperimentName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'large_language_model_train', - ], - ], - ], - 'Duration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7200', - ], - 'Environments' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'debug=true', - ], - ], - 'PythonRequirements' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'torch>=2.2.0', - ], - ], - 'Priority' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'AssignNodeSpec' => [ - '$ref' => '#/components/schemas/AssignNodeSpec', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutputChannels\\": [\\n {\\n \\"Name\\": \\"model\\",\\n \\"OutputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/model/\\",\\n \\"DatasetId\\": \\"d-8o0hh35po15ejcdq2p\\",\\n \\"VersionName\\": \\"v1\\"\\n }\\n ],\\n \\"Status\\": \\"Running\\",\\n \\"HyperParameters\\": [\\n {\\n \\"Name\\": \\"learning_rate\\",\\n \\"Value\\": \\"0.0001\\"\\n }\\n ],\\n \\"TrainingJobName\\": \\"qwen_llm\\",\\n \\"TrainingJobId\\": \\"traini6hhxiq69eo\\",\\n \\"Scheduler\\": {\\n \\"MaxRunningTimeInSeconds\\": \\"0\\",\\n \\"MaxRunningTimeInMinutes\\": \\"100\\"\\n },\\n \\"ReasonMessage\\": \\"None\\",\\n \\"WorkspaceId\\": \\"86995\\",\\n \\"ComputeResource\\": {\\n \\"EcsCount\\": 1,\\n \\"EcsSpec\\": \\"ecs.gn5-c8g1.2xlarge\\",\\n \\"ResourceId\\": \\"quotam670lixikcl\\",\\n \\"ResourceName\\": \\"quota\\",\\n \\"InstanceCount\\": 1,\\n \\"InstanceSpec\\": {\\n \\"CPU\\": \\"8\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"1\\",\\n \\"GPUType\\": \\"V100\\"\\n },\\n \\"UseSpotInstance\\": true,\\n \\"SpotSpec\\": {\\n \\"SpotStrategy\\": \\"SpotWithPriceLimit\\",\\n \\"SpotDiscountLimit\\": 0.9\\n }\\n },\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"CreatedBy\\",\\n \\"Value\\": \\"QuickStart\\"\\n }\\n ],\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"InputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-475megosidivjfgfq6\\",\\n \\"Name\\": \\"model\\",\\n \\"InputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/model/\\",\\n \\"Options\\": \\"ossAppendable=true\\",\\n \\"VersionName\\": \\"v1\\"\\n }\\n ],\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"StatusTransitions\\": [\\n {\\n \\"EndTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"KubeDL job runs successfully\\",\\n \\"StartTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ],\\n \\"TrainingJobDescription\\": \\"Qwen2大语言模型训练。\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"LatestMetrics\\": [\\n {\\n \\"Name\\": \\"loss\\",\\n \\"Timestamp\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Value\\": 0.11\\n }\\n ],\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Instances\\": [\\n {\\n \\"Name\\": \\"train1oug3yehan4-master-0\\",\\n \\"Role\\": \\"master\\",\\n \\"Status\\": \\"Succeeded\\"\\n }\\n ],\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"TrainingJobUrl\\": \\"https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=1234#/training/jobs/train1ouyadsl8n4\\",\\n \\"RoleArn\\": \\"acs:ram::{accountID}:role/{roleName}\\",\\n \\"AlgorithmSpec\\": {\\n \\"OutputChannels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Name\\": \\"\\",\\n \\"SupportedChannelTypes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"HyperParameters\\": [\\n {\\n \\"DefaultValue\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"\\",\\n \\"Range\\": {\\n \\"Enum\\": [\\n \\"\\"\\n ],\\n \\"MinLength\\": 0,\\n \\"MaxLength\\": 0,\\n \\"Minimum\\": \\"\\",\\n \\"Maximum\\": \\"\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"ExclusiveMaximum\\": true,\\n \\"Pattern\\": \\"\\"\\n },\\n \\"DisplayName\\": \\"\\"\\n }\\n ],\\n \\"JobType\\": \\"\\",\\n \\"Command\\": [\\n \\"\\"\\n ],\\n \\"MetricDefinitions\\": [\\n {\\n \\"Description\\": \\"train dataset oob score\\",\\n \\"Regex\\": \\".*train:oob_score=([-+]?[0-9]*\\\\\\\\\\\\\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*\\",\\n \\"Name\\": \\"train:oob_score\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Name\\": \\"\\",\\n \\"SupportedChannelTypes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SupportsDistributedTraining\\": true,\\n \\"Image\\": \\"\\",\\n \\"SupportedInstanceTypes\\": [\\n \\"\\"\\n ],\\n \\"ComputeResource\\": {\\n \\"Policy\\": {\\n \\"Version\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n },\\n \\"CodeDir\\": {\\n \\"LocationType\\": \\"\\",\\n \\"LocationValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Customization\\": {\\n \\"CodeDir\\": true\\n },\\n \\"ResourceRequirements\\": [\\n {\\n \\"Key\\": \\"SupportedMachineTypes\\",\\n \\"Operator\\": \\"in\\",\\n \\"Values\\": [\\n \\"GPU\\"\\n ]\\n }\\n ],\\n \\"ProgressDefinitions\\": {\\n \\"OverallProgress\\": {\\n \\"Description\\": \\"\\",\\n \\"Regex\\": \\"\\"\\n },\\n \\"RemainingTime\\": {\\n \\"Description\\": \\"\\",\\n \\"Regex\\": \\"\\"\\n }\\n }\\n },\\n \\"IsTempAlgo\\": true,\\n \\"LatestProgress\\": {\\n \\"OverallProgress\\": {\\n \\"Timestamp\\": \\"2023-07-04T13:20:18Z\\",\\n \\"Value\\": 0.75\\n },\\n \\"RemainingTime\\": {\\n \\"Timestamp\\": \\"2023-07-04T13:20:18Z\\",\\n \\"Value\\": 3600\\n }\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ]\\n },\\n \\"OutputModel\\": {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/model/output/\\",\\n \\"OutputChannelName\\": \\"model\\"\\n },\\n \\"Settings\\": {\\n \\"BusinessUserId\\": \\"166924\\",\\n \\"Caller\\": \\"SilkFlow\\",\\n \\"Tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PipelineId\\": \\"pid-123456\\",\\n \\"EnableTideResource\\": true,\\n \\"EnableErrorMonitoringInAIMaster\\": false,\\n \\"ErrorMonitoringArgs\\": \\"--enable-log-hang-detection true\\",\\n \\"EnableRDMA\\": true,\\n \\"EnableOssAppend\\": true,\\n \\"OversoldType\\": \\"AcceptQuotaOverSold\\",\\n \\"AdvancedSettings\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Driver\\": \\"535.54.03\\",\\n \\"EnableSanityCheck\\": true,\\n \\"SanityCheckArgs\\": \\"--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFai\\",\\n \\"JobReservedMinutes\\": 30,\\n \\"JobReservedPolicy\\": \\"Always\\"\\n },\\n \\"ExperimentConfig\\": {\\n \\"ExperimentId\\": \\"exp-ds9aefia90v\\",\\n \\"ExperimentName\\": \\"large_language_model_train\\"\\n },\\n \\"Duration\\": 7200,\\n \\"Environments\\": {\\n \\"key\\": \\"debug=true\\"\\n },\\n \\"PythonRequirements\\": [\\n \\"torch>=2.2.0\\"\\n ],\\n \\"Priority\\": 0,\\n \\"AssignNodeSpec\\": {\\n \\"EnableAssignNode\\": true,\\n \\"NodeNames\\": \\"\\",\\n \\"AntiAffinityNodeNames\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetTrainingJob', - ], - 'GetTrainingJobErrorInfo' => [ - 'summary' => '获取Training Job的算法错误信息', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/errorinfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '195103', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'traineyfz0m2hsfv', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'ErrorInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'AdditionalInfo' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'additional info', - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"ErrorInfo\\": {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"AdditionalInfo\\": \\"additional info\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetTrainingJobErrorInfo', - ], - 'GetTrainingJobLatestMetrics' => [ - 'summary' => '获取TrainingJob最近的Metrics', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/latestmetrics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '135852', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'train129f212o89d', - ], - ], - [ - 'name' => 'Names', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'loss', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E', - ], - 'Metrics' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2022-04-18T22:20:55Z', - ], - 'Value' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.97', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'loss', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"2022-04-18T22:20:55Z\\",\\n \\"Value\\": 0.97,\\n \\"Name\\": \\"loss\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetTrainingJobLatestMetrics', - ], - 'ListTrainingJobs' => [ - 'summary' => '获取TrainingJob的列表', - 'path' => '/api/v1/trainingjobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '132980', - 'abilityTreeNodes' => [ - 'FEATURElearnVYA4L9', - ], - ], - 'parameters' => [ - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtModifiedTime', - 'enum' => [ - 'GmtModifiedTime', - 'GmtCreateTime', - 'TrainingJobName', - 'AlgorithmName', - 'Status', - ], - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => 'ASC', - 'DESC' => 'DESC', - ], - 'example' => 'DESC', - 'enum' => [ - 'desc', - 'asc', - ], - ], - ], - [ - 'name' => 'TrainingJobName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'large_language_model_training', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], - ], - [ - 'name' => 'TrainingJobId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trains930928remn', - ], - ], - [ - 'name' => 'Labels', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{"project": "sd-s3"}', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-06-22T01:00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2023-12-27T02:10:00Z', - ], - ], - [ - 'name' => 'AlgorithmProvider', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pai', - ], - ], - [ - 'name' => 'AlgorithmName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm_train', - ], - ], - [ - 'name' => 'IsTempAlgo', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TrainingJobs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AlgorithmName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'llm_train', - ], - 'AlgorithmProvider' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pai', - ], - 'AlgorithmVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'v0.0.1', - ], - 'ComputeResource' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EcsCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'EcsSpec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecs.gn5-c8g1.2xlarge', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'quotam670lixikcl', - ], - 'ResourceName' => [ - 'type' => 'string', - ], - 'InstanceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InstanceSpec' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CPU' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8', - ], - 'Memory' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32', - ], - 'SharedMemory' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32', - ], - 'GPU' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'GPUType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'V100', - ], - ], - ], - ], - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'HyperParameters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'learning_rate', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.001', - ], - ], - ], - ], - 'InputChannels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DatasetId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd-475megosidivjfgfq6', - ], - 'InputUri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/channel/', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model', - ], - 'VersionName' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Labels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CreatedBy', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'QuickStart', - ], - ], - ], - ], - 'OutputChannels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DatasetId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd-8o0hh35po15ejcdq2p', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model', - ], - 'OutputUri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/channel/', - ], - 'VersionName' => [ - 'type' => 'string', - ], - ], - ], - ], - 'ReasonCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TrainingJobSucceed', - ], - 'ReasonMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Scheduler' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MaxRunningTimeInSeconds' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'StatusTransitions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'ReasonCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TrainingJobSucceed', - ], - 'ReasonMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'KubeDL job runs successfully', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-10T11:49:47Z', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Creating', - ], - ], - ], - ], - 'TrainingJobDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TrainingJobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'train1layo6js8ra', - ], - 'TrainingJobName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qwen2-7b', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456789', - ], - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1234', - ], - 'RoleArn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'acs:ram::{accountID}:role/{roleName}', - ], - 'IsTempAlgo' => [ - 'title' => '是否使用了临时算法。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserVpc' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-abcdef****', - ], - 'SwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vs-abcdef****', - ], - 'SecurityGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sg-abcdef****', - ], - 'ExtendedCIDRs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '192.168.0.1/24', - ], - ], - 'DefaultRoute' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eth1', - ], - ], - ], - 'ExperimentConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ExperimentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'exp-ds9aefia90v', - ], - 'ExperimentName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'large_language_model', - ], - ], - ], - 'Environments' => [ - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'debug=true', - ], - ], - 'PythonRequirements' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'torch>=2.2.0', - ], - ], - 'DlcJobId' => [ - 'type' => 'string', + 'OverallProgress' => [ + 'description' => 'The overall progress of the training job.', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => 'The timestamp of the progress update.', 'type' => 'string', 'example' => '2023-07-04T13:20:18Z', 'title' => ''], + 'Value' => ['description' => 'The progress value.', 'type' => 'number', 'format' => 'float', 'example' => '0.75', 'title' => ''], ], - 'AssignNodeSpec' => [ - '$ref' => '#/components/schemas/AssignNodeSpec', + 'title' => '', + 'example' => '', + ], + 'RemainingTime' => [ + 'description' => 'The estimated remaining time for the training job to complete, in seconds.', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => 'The timestamp of the progress update.', 'type' => 'string', 'example' => '2023-07-04T13:20:18Z', 'title' => ''], + 'Value' => ['description' => 'The remaining time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + 'UserVpc' => [ + 'description' => 'The user\'s VPC configuration.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-abcdef****', 'title' => ''], + 'SwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vs-abcdef****', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-abcdef****', 'title' => ''], + 'ExtendedCIDRs' => [ + 'description' => 'The configuration for the extended CIDR blocks.', + 'type' => 'array', + 'items' => ['description' => 'An extended CIDR block.', 'type' => 'string', 'example' => '192.168.0.1/24', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"TrainingJobs\\": [\\n {\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"ComputeResource\\": {\\n \\"EcsCount\\": 1,\\n \\"EcsSpec\\": \\"ecs.gn5-c8g1.2xlarge\\",\\n \\"ResourceId\\": \\"quotam670lixikcl\\",\\n \\"ResourceName\\": \\"quota\\",\\n \\"InstanceCount\\": 1,\\n \\"InstanceSpec\\": {\\n \\"CPU\\": \\"8\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"1\\",\\n \\"GPUType\\": \\"V100\\"\\n }\\n },\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"HyperParameters\\": [\\n {\\n \\"Name\\": \\"learning_rate\\",\\n \\"Value\\": \\"0.001\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-475megosidivjfgfq6\\",\\n \\"InputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/channel/\\",\\n \\"Name\\": \\"model\\",\\n \\"VersionName\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"CreatedBy\\",\\n \\"Value\\": \\"QuickStart\\"\\n }\\n ],\\n \\"OutputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-8o0hh35po15ejcdq2p\\",\\n \\"Name\\": \\"model\\",\\n \\"OutputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/channel/\\",\\n \\"VersionName\\": \\"\\"\\n }\\n ],\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"None\\",\\n \\"Scheduler\\": {\\n \\"MaxRunningTimeInSeconds\\": 0\\n },\\n \\"Status\\": \\"Running\\",\\n \\"StatusTransitions\\": [\\n {\\n \\"EndTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"KubeDL job runs successfully\\",\\n \\"StartTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ],\\n \\"TrainingJobDescription\\": \\"Qwen2大语言模型训练。\\",\\n \\"TrainingJobId\\": \\"train1layo6js8ra\\",\\n \\"TrainingJobName\\": \\"qwen2-7b\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"RoleArn\\": \\"acs:ram::{accountID}:role/{roleName}\\",\\n \\"IsTempAlgo\\": true,\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ],\\n \\"DefaultRoute\\": \\"eth1\\"\\n },\\n \\"ExperimentConfig\\": {\\n \\"ExperimentId\\": \\"exp-ds9aefia90v\\",\\n \\"ExperimentName\\": \\"large_language_model\\"\\n },\\n \\"Environments\\": {\\n \\"key\\": \\"debug=true\\"\\n },\\n \\"PythonRequirements\\": [\\n \\"torch>=2.2.0\\"\\n ],\\n \\"DlcJobId\\": \\"\\",\\n \\"AssignNodeSpec\\": {\\n \\"EnableAssignNode\\": true,\\n \\"NodeNames\\": \\"\\",\\n \\"AntiAffinityNodeNames\\": \\"\\"\\n }\\n }\\n ],\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', - 'title' => 'ListTrainingJobs', - ], - 'ListTrainingJobEvents' => [ - 'summary' => '获取指定TrainingJob的事件。', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/events', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '165613', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'traineyfz0m2hsfv', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '2000', - 'minimum' => '1', - 'example' => '100', - 'default' => '100', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '起始UTC时间，格式 iso8601，假如为空是任务开始时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '截止UTC时间，格式 iso8601，假如为空是当前时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + 'OutputModel' => [ + 'description' => 'The model generated by the training job.', + 'type' => 'object', + 'properties' => [ + 'Uri' => ['description' => 'The URI of the model.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/model/output/', 'title' => ''], + 'OutputChannelName' => ['description' => 'The name of the output channel for the model.', 'type' => 'string', 'example' => 'model', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'title' => '符合过滤条件的日志数量', - 'description' => '', - 'type' => 'string', - 'example' => '23', + 'Settings' => ['description' => 'The additional settings for the training job.', '$ref' => '#/components/schemas/JobSettings', 'title' => '', 'example' => ''], + 'ExperimentConfig' => [ + 'description' => 'The configuration of the experiment associated with the training job.', + 'type' => 'object', + 'properties' => [ + 'ExperimentId' => ['description' => 'The ID of the associated experiment.', 'type' => 'string', 'example' => 'exp-ds9aefia90v', 'title' => ''], + 'ExperimentName' => ['description' => 'The name of the associated experiment.', 'type' => 'string', 'example' => 'large_language_model_train', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Events' => [ - 'title' => '日志列表', - 'description' => '', + 'Duration' => ['description' => 'The duration of the training job, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '7200', 'title' => ''], + 'Environments' => [ + 'description' => 'The environment variables for the training job.', + 'additionalProperties' => ['description' => 'An environment variable for the training job.', 'type' => 'string', 'example' => 'debug=true', 'title' => ''], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'PythonRequirements' => [ + 'description' => 'The required Python packages for the training job.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'UserEvent', - ], + 'items' => ['description' => 'A required Python package for the training job.', 'type' => 'string', 'example' => 'torch>=2.2.0', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Priority' => ['description' => 'The priority of the training job.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'AssignNodeSpec' => ['$ref' => '#/components/schemas/AssignNodeSpec', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": \\"23\\",\\n \\"Events\\": [\\n \\"UserEvent\\"\\n ]\\n}","type":"json"}]', - 'title' => 'ListTrainingJobEvents', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutputChannels\\": [\\n {\\n \\"Name\\": \\"model\\",\\n \\"OutputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/model/\\",\\n \\"DatasetId\\": \\"d-8o0hh35po15ejcdq2p\\",\\n \\"VersionName\\": \\"v1\\"\\n }\\n ],\\n \\"Status\\": \\"Running\\",\\n \\"HyperParameters\\": [\\n {\\n \\"Name\\": \\"learning_rate\\",\\n \\"Value\\": \\"0.0001\\"\\n }\\n ],\\n \\"TrainingJobName\\": \\"qwen_llm\\",\\n \\"TrainingJobId\\": \\"traini6hhxiq69eo\\",\\n \\"Scheduler\\": {\\n \\"MaxRunningTimeInSeconds\\": \\"0\\",\\n \\"MaxRunningTimeInMinutes\\": \\"100\\"\\n },\\n \\"ReasonMessage\\": \\"None\\",\\n \\"WorkspaceId\\": \\"86995\\",\\n \\"ComputeResource\\": {\\n \\"EcsCount\\": 1,\\n \\"EcsSpec\\": \\"ecs.gn5-c8g1.2xlarge\\",\\n \\"ResourceId\\": \\"quotam670lixikcl\\",\\n \\"ResourceName\\": \\"quota\\",\\n \\"InstanceCount\\": 1,\\n \\"InstanceSpec\\": {\\n \\"CPU\\": \\"8\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"1\\",\\n \\"GPUType\\": \\"V100\\"\\n },\\n \\"UseSpotInstance\\": true,\\n \\"SpotSpec\\": {\\n \\"SpotStrategy\\": \\"SpotWithPriceLimit\\",\\n \\"SpotDiscountLimit\\": 0.9\\n }\\n },\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"CreatedBy\\",\\n \\"Value\\": \\"QuickStart\\"\\n }\\n ],\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"InputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-475megosidivjfgfq6\\",\\n \\"Name\\": \\"model\\",\\n \\"InputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/model/\\",\\n \\"Options\\": \\"ossAppendable=true\\",\\n \\"VersionName\\": \\"v1\\"\\n }\\n ],\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"StatusTransitions\\": [\\n {\\n \\"EndTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"KubeDL job runs successfully\\",\\n \\"StartTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ],\\n \\"TrainingJobDescription\\": \\"Qwen2 large language model training.\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"LatestMetrics\\": [\\n {\\n \\"Name\\": \\"loss\\",\\n \\"Timestamp\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Value\\": 0.11\\n }\\n ],\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Instances\\": [\\n {\\n \\"Name\\": \\"train1oug3yehan4-master-0\\",\\n \\"Role\\": \\"master\\",\\n \\"Status\\": \\"Succeeded\\"\\n }\\n ],\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"TrainingJobUrl\\": \\"https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=1234#/training/jobs/train1ouyadsl8n4\\",\\n \\"RoleArn\\": \\"acs:ram::{accountID}:role/{roleName}\\",\\n \\"AlgorithmSpec\\": {\\n \\"OutputChannels\\": [\\n {\\n \\"Description\\": \\"模型输出。\\",\\n \\"Required\\": true,\\n \\"Properties\\": {},\\n \\"Name\\": \\"Model\\",\\n \\"SupportedChannelTypes\\": [\\n \\"oss\\"\\n ]\\n }\\n ],\\n \\"HyperParameters\\": [\\n {\\n \\"DefaultValue\\": \\"0\\",\\n \\"Type\\": \\"Integer\\",\\n \\"Description\\": \\"参数定义了训练的batch_size。\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"batch_size\\",\\n \\"Range\\": {\\n \\"Enum\\": [\\n \\"0\\"\\n ],\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": \\"0\\",\\n \\"Maximum\\": \\"10\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"ExclusiveMaximum\\": true,\\n \\"Pattern\\": \\"^\\\\\\\\+?[1-9][0-9]*$\\"\\n },\\n \\"DisplayName\\": \\"Batch Size\\"\\n }\\n ],\\n \\"JobType\\": \\"TFJob\\",\\n \\"Command\\": [\\n \\"python train.py\\"\\n ],\\n \\"MetricDefinitions\\": [\\n {\\n \\"Description\\": \\"训练损失函数。\\",\\n \\"Regex\\": \\".*train:loss=([-+]?[0-9]*\\\\\\\\\\\\\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*\\",\\n \\"Name\\": \\"loss\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"Description\\": \\"模型输出。\\",\\n \\"Required\\": true,\\n \\"Properties\\": {},\\n \\"Name\\": \\"Model\\",\\n \\"SupportedChannelTypes\\": [\\n \\"oss\\"\\n ]\\n }\\n ],\\n \\"SupportsDistributedTraining\\": true,\\n \\"Image\\": \\"registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0\\",\\n \\"SupportedInstanceTypes\\": [\\n \\"ecs.g6.2xlarge\\"\\n ],\\n \\"ComputeResource\\": {\\n \\"Policy\\": {\\n \\"Version\\": \\"V1\\",\\n \\"Value\\": \\"[{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"MaxTotalCount\\\\\\\\\\\\\\":4,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":100}}},{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":5,\\\\\\\\\\\\\\"MaxTotalCount\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":20},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":80}}},{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":11,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":40},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":60}}}]\\"\\n }\\n },\\n \\"CodeDir\\": {\\n \\"LocationType\\": \\"OSS\\",\\n \\"LocationValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Customization\\": {\\n \\"CodeDir\\": true\\n },\\n \\"ResourceRequirements\\": [\\n {\\n \\"Key\\": \\"SupportedMachineTypes\\",\\n \\"Operator\\": \\"in\\",\\n \\"Values\\": [\\n \\"ecs.gn5-c4g1.xlarge\\"\\n ]\\n }\\n ],\\n \\"ProgressDefinitions\\": {\\n \\"OverallProgress\\": {\\n \\"Description\\": \\"training progress\\",\\n \\"Regex\\": \\"^[0-9]+([.][0-9]+){0,1}$\\"\\n },\\n \\"RemainingTime\\": {\\n \\"Description\\": \\"training remaining time\\",\\n \\"Regex\\": \\"^[0-9]+([.][0-9]+){0,1}$\\"\\n }\\n }\\n },\\n \\"IsTempAlgo\\": true,\\n \\"LatestProgress\\": {\\n \\"OverallProgress\\": {\\n \\"Timestamp\\": \\"2023-07-04T13:20:18Z\\",\\n \\"Value\\": 0.75\\n },\\n \\"RemainingTime\\": {\\n \\"Timestamp\\": \\"2023-07-04T13:20:18Z\\",\\n \\"Value\\": 3600\\n }\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ]\\n },\\n \\"OutputModel\\": {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/model/output/\\",\\n \\"OutputChannelName\\": \\"model\\"\\n },\\n \\"Settings\\": {\\n \\"BusinessUserId\\": \\"166924\\",\\n \\"Caller\\": \\"SilkFlow\\",\\n \\"Tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PipelineId\\": \\"pid-123456\\",\\n \\"EnableTideResource\\": true,\\n \\"EnableErrorMonitoringInAIMaster\\": false,\\n \\"ErrorMonitoringArgs\\": \\"--enable-log-hang-detection true\\",\\n \\"EnableRDMA\\": true,\\n \\"EnableOssAppend\\": true,\\n \\"OversoldType\\": \\"AcceptQuotaOverSold\\",\\n \\"AdvancedSettings\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Driver\\": \\"535.54.03\\",\\n \\"EnableSanityCheck\\": true,\\n \\"SanityCheckArgs\\": \\"--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFai\\",\\n \\"JobReservedMinutes\\": 30,\\n \\"JobReservedPolicy\\": \\"Always\\"\\n },\\n \\"ExperimentConfig\\": {\\n \\"ExperimentId\\": \\"exp-ds9aefia90v\\",\\n \\"ExperimentName\\": \\"large_language_model_train\\"\\n },\\n \\"Duration\\": 7200,\\n \\"Environments\\": {\\n \\"key\\": \\"debug=true\\"\\n },\\n \\"PythonRequirements\\": [\\n \\"torch>=2.2.0\\"\\n ],\\n \\"Priority\\": 0,\\n \\"AssignNodeSpec\\": {\\n \\"EnableAssignNode\\": true,\\n \\"NodeNames\\": \\"\\",\\n \\"AntiAffinityNodeNames\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'Get training job details', + 'changeSet' => [ + ['createdAt' => '2025-11-25T06:20:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-18T02:48:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-17T03:44:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-07T03:10:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-19T02:50:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-09T10:31:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-14T08:12:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-29T07:27:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-26T10:28:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-07T04:21:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-01T11:22:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-15T11:50:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-24T09:46:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-20T02:19:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-24T14:00:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-14T12:38:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-14T12:38:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-14T12:18:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-14T12:18:34.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJob'], + ], + ], + 'ramActions' => [], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'translator' => 'machine', ], - 'ListTrainingJobInstanceEvents' => [ - 'summary' => '获取指定Instance（TrainingJob的运行单元）的日志。', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/events', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTrainingJobErrorInfo' => [ + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/errorinfo', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '165612', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], + 'abilityTreeCode' => '195103', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ 'name' => 'TrainingJobId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'train76rcaupa2cz', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'train76rcaupa2cz-master-0', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '2000', - 'minimum' => '1', - 'example' => '100', - 'default' => '100', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '起始UTC时间，格式 iso8601，假如为空是任务开始时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '截止UTC时间，格式 iso8601，假如为空是当前时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], + 'schema' => ['description' => 'Training task ID.', 'type' => 'string', 'required' => true, 'example' => 'traineyfz0m2hsfv', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的日志数量', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Events' => [ - 'title' => '日志列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'You are using pip version 9.0.1, however version 20.2.4 is available.', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'ErrorInfo' => [ + 'description' => 'Error information.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'AdditionalInfo' => ['description' => 'Additional information.', 'type' => 'string', 'example' => 'additional info', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"Events\\": [\\n \\"You are using pip version 9.0.1, however version 20.2.4 is available.\\"\\n ]\\n}","type":"json"}]', - 'title' => 'ListTrainingJobInstanceEvents', - ], - 'ListTrainingJobInstanceMetrics' => [ - 'summary' => '获取Training Job实例的Metrics', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/instancemetrics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the error information of a training job', + 'summary' => 'Retrieve error information for a training task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"ErrorInfo\\": {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"AdditionalInfo\\": \\"additional info\\"\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetTrainingJobLatestMetrics' => [ + 'summary' => 'Retrieves the latest metrics for a training task.', + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/latestmetrics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '157749', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - ], - 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'title' => 'Training Job Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'trains930928remn', - ], - ], - [ - 'name' => 'MetricType', - 'in' => 'query', - 'schema' => [ - 'title' => '分页，从1开始，默认1', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'GpuCoreUsage', - ], - ], - [ - 'name' => 'TimeStep', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10s', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trains930928remn-master-0', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '起始UTC时间，格式 iso8601，假如为空是任务开始时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], + 'abilityTreeCode' => '135852', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ + [ + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the training task.', 'type' => 'string', 'required' => true, 'example' => 'train129f212o89d', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Names', 'in' => 'query', - 'schema' => [ - 'title' => '截止UTC时间，格式 iso8601，假如为空是当前时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], + 'schema' => ['description' => 'The name of the metric.', 'type' => 'string', 'required' => false, 'example' => 'loss', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', - ], - 'InstanceMetrics' => [ - 'title' => '符合过滤条件的Metrics数量', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'], + 'Metrics' => [ + 'description' => 'The metric information.', 'type' => 'array', 'items' => [ + 'description' => 'The metric information.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'type' => 'string', - ], - 'Metrics' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'number', - 'format' => 'double', - ], - ], - ], - ], - 'NodeName' => [ - 'type' => 'string', - ], + 'Timestamp' => ['description' => 'The timestamp when the metric was collected.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-04-18T22:20:55Z', 'title' => ''], + 'Value' => ['description' => 'The value of the metric.', 'type' => 'number', 'format' => 'double', 'example' => '0.97', 'title' => ''], + 'Name' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'loss', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"InstanceMetrics\\": [\\n {\\n \\"InstanceId\\": \\"trainkxen7qjyg6y-master-0\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": \\"2020-11-08T16:00:00Z\\",\\n \\"Value\\": 1\\n }\\n ],\\n \\"NodeName\\": \\"trains930928remn-master-0\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListTrainingJobInstanceMetrics', - ], - 'ListTrainingJobLogs' => [ - 'summary' => '获取Training Job的日志', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/logs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Retrieve the latest metrics of a training job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJobLatestMetrics'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"2022-04-18T22:20:55Z\\",\\n \\"Value\\": 0.97,\\n \\"Name\\": \\"loss\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetUserViewMetrics' => [ + 'summary' => 'Retrieves metric data at the user dimension.', + 'path' => '/api/v1/resources/{ResourceGroupID}/usermetrics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '152476', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'], + ], 'parameters' => [ [ - 'name' => 'TrainingJobId', + 'name' => 'ResourceGroupID', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'train129f212o89d', - ], + 'schema' => ['description' => 'The resource group ID. Each resource group has a globally unique resource group ID. You can use the resource group ID to retrieve information about the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], ], [ - 'name' => 'WorkerId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'train129f212o89d-master-0', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '86995', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '2000', - 'minimum' => '1', - 'example' => '100', - 'default' => '100', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'string', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'title' => '起始UTC时间，格式 iso8601，假如为空是任务开始时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], + 'schema' => ['description' => 'The sorting criterion.', 'type' => 'string', 'required' => false, 'example' => 'GmtModified', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'title' => '截止UTC时间，格式 iso8601，假如为空是当前时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + .'- asc: ascending order.'."\n" + .'- desc: descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'train129f212o89d-master-0', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'TimeStep', + 'in' => 'query', + 'schema' => ['description' => 'The time step. Default value: 5m. Valid values for the time unit:'."\n" + ."\n" + .'- h: hours.'."\n" + ."\n" + .'- m: minutes.'."\n" + ."\n" + .'- s: seconds.'."\n" + ."\n" + .'If no unit is specified, the default unit s (seconds) is used.', 'type' => 'string', 'required' => false, 'example' => '1h', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => 'CBF05F13-B24C-5129-9048-4FA684DCD579', - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的日志数量', - 'description' => '', - 'type' => 'string', - 'example' => '23', - ], - 'Logs' => [ - 'title' => '日志列表', - 'description' => '', + 'ResourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], + 'UserMetrics' => [ + 'description' => '按照用户维度统计的指标', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'loss: 0.0001', - ], + 'items' => ['description' => '按照用户维度统计的指标', '$ref' => '#/components/schemas/UserViewMetric', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'Summary' => ['description' => '用户监控数据。', '$ref' => '#/components/schemas/UserViewMetric', 'title' => '', 'example' => ''], + 'Total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF05F13-B24C-5129-9048-4FA684DCD579\\",\\n \\"TotalCount\\": \\"23\\",\\n \\"Logs\\": [\\n \\"loss: 0.0001\\"\\n ]\\n}","type":"json"}]', - 'title' => 'ListTrainingJobLogs', - ], - 'ListTrainingJobMetrics' => [ - 'summary' => '获取Training Job的Metrics', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/metrics', - 'methods' => [ - 'get', + 'staticInfo' => [ + 'substitutions' => ['PaiStudio::2022-01-12::GetQuotaUserViewMetrics'], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Retrieve user-dimension metrics', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserViewMetrics'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceGroupId\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"UserMetrics\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg17tmvwiokh****\\",\\n \\"TotalCPU\\": 1000,\\n \\"CPUUsageRate\\": \\"59\\",\\n \\"GPUUsageRate\\": \\"10\\",\\n \\"TotalMemory\\": 10240,\\n \\"TotalGPU\\": 1,\\n \\"MemoryUsageRate\\": \\"20\\",\\n \\"RequestCPU\\": 100,\\n \\"RequestGPU\\": 10,\\n \\"RequestMemory\\": 102400000,\\n \\"NetworkInputRate\\": \\"1\\",\\n \\"NetworkOutputRate\\": \\"1\\",\\n \\"DiskReadRate\\": \\"22\\",\\n \\"DiskWriteRate\\": \\"22\\",\\n \\"JobType\\": \\"PyTorch\\",\\n \\"UserId\\": \\"16111111****\\",\\n \\"CPUNodeNumber\\": 2,\\n \\"GPUNodeNumber\\": 1,\\n \\"CpuJobNames\\": [\\n \\"dlcxxxxx\\"\\n ],\\n \\"GpuJobNames\\": [\\n \\"dlcyyyyy\\"\\n ],\\n \\"NodeNames\\": [\\n \\"lrnxxxxxx\\"\\n ],\\n \\"CpuNodeNames\\": [\\n \\"ecixxxxxx\\"\\n ],\\n \\"GpuNodeNames\\": [\\n \\"lrnxxxxxxx\\"\\n ]\\n }\\n ],\\n \\"Summary\\": {\\n \\"ResourceGroupId\\": \\"rg17tmvwiokh****\\",\\n \\"TotalCPU\\": 1000,\\n \\"CPUUsageRate\\": \\"59\\",\\n \\"GPUUsageRate\\": \\"10\\",\\n \\"TotalMemory\\": 10240,\\n \\"TotalGPU\\": 1,\\n \\"MemoryUsageRate\\": \\"20\\",\\n \\"RequestCPU\\": 100,\\n \\"RequestGPU\\": 10,\\n \\"RequestMemory\\": 102400000,\\n \\"NetworkInputRate\\": \\"1\\",\\n \\"NetworkOutputRate\\": \\"1\\",\\n \\"DiskReadRate\\": \\"22\\",\\n \\"DiskWriteRate\\": \\"22\\",\\n \\"JobType\\": \\"PyTorch\\",\\n \\"UserId\\": \\"16111111****\\",\\n \\"CPUNodeNumber\\": 2,\\n \\"GPUNodeNumber\\": 1,\\n \\"CpuJobNames\\": [\\n \\"dlcxxxxx\\"\\n ],\\n \\"GpuJobNames\\": [\\n \\"dlcyyyyy\\"\\n ],\\n \\"NodeNames\\": [\\n \\"lrnxxxxxx\\"\\n ],\\n \\"CpuNodeNames\\": [\\n \\"ecixxxxxx\\"\\n ],\\n \\"GpuNodeNames\\": [\\n \\"lrnxxxxxxx\\"\\n ]\\n },\\n \\"Total\\": 2\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListAlgorithmVersions' => [ + 'summary' => 'Retrieve a list of algorithm version details.', + 'path' => '/api/v1/algorithms/{AlgorithmId}/versions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '132913', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ - [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'title' => 'Training Job Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'train76rcaupa2cz', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '分页，从1开始，默认1', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'accuracy', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '每页返回的日志数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页返回的日志数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '100', - 'default' => '100', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '起始UTC时间，格式 iso8601，假如为空是任务开始时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], + 'schema' => ['description' => 'The page size for paging.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '截止UTC时间，格式 iso8601，假如为空是当前时间', - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2020-11-08T16:00:00Z', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => 'Metrics的时间顺序，有ASC和DESC', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - 'default' => 'DESC', - ], + 'name' => 'AlgorithmId', + 'in' => 'path', + 'schema' => ['description' => 'The algorithm ID.', 'type' => 'string', 'required' => false, 'example' => 'algo-sidjc8134hv', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response to the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Metrics' => [ - 'title' => '符合过滤条件的Metrics数量', - 'description' => '', + 'AlgorithmVersions' => [ + 'description' => 'A list of algorithm version details.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Algorithm version details.', 'type' => 'object', 'properties' => [ - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2022-04-18T22:20:55Z', - ], - 'Value' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.97', - ], - 'Name' => [ - 'title' => 'Metrics名称', - 'description' => '', - 'type' => 'string', - 'example' => 'accuracy', - ], + 'AlgorithmId' => ['description' => 'The algorithm ID.', 'type' => 'string', 'example' => 'algo-sidjc8134hv', 'title' => ''], + 'AlgorithmName' => ['description' => 'The algorithm name.', 'type' => 'string', 'example' => 'llm_train', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'The algorithm provider.', 'type' => 'string', 'example' => 'pai', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'The algorithm version.', 'type' => 'string', 'example' => 'v0.1.0', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the algorithm was created.', 'type' => 'string', 'example' => '2024-01-19T02:00:26Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the algorithm was last updated.', 'type' => 'string', 'example' => '2024-01-22T02:00:59Z', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID that owns the algorithm.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'UserId' => ['description' => 'The user ID that owns the algorithm.', 'type' => 'string', 'example' => '123456789', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'TotalCount' => ['description' => 'The total number of algorithm versions.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"2022-04-18T22:20:55Z\\",\\n \\"Value\\": 0.97,\\n \\"Name\\": \\"accuracy\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n}","type":"json"}]', - 'title' => 'ListTrainingJobMetrics', - ], - 'ListTrainingJobOutputModels' => [ - 'summary' => '获取Training Job 产出的所有模型信息', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/outputmodels', - 'methods' => [ - 'get', + 'title' => 'Retrieve the list of algorithm version details', + 'changeSet' => [ + ['createdAt' => '2022-04-27T10:49:51.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithmVersions'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListAlgorithmVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmVersions\\": [\\n {\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.1.0\\",\\n \\"GmtCreateTime\\": \\"2024-01-19T02:00:26Z\\",\\n \\"GmtModifiedTime\\": \\"2024-01-22T02:00:59Z\\",\\n \\"TenantId\\": \\"123456789\\",\\n \\"UserId\\": \\"123456789\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListAlgorithms' => [ + 'summary' => 'Lists algorithm details.', + 'path' => '/api/v1/algorithms', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '200236', - 'abilityTreeNodes' => [ - 'FEATURElearn9XMQIJ', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'traineyfz0m2hsfv', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AlgorithmName', + 'in' => 'query', + 'schema' => ['description' => 'Algorithm name.', 'type' => 'string', 'required' => false, 'example' => 'llm_training', 'title' => ''], + ], + [ + 'name' => 'AlgorithmId', + 'in' => 'query', + 'schema' => ['description' => 'Algorithm ID.', 'type' => 'string', 'required' => false, 'example' => 'algo-xsldfvu1334', 'title' => ''], + ], + [ + 'name' => 'AlgorithmProvider', + 'in' => 'query', + 'schema' => ['description' => 'Algorithm provider.', 'type' => 'string', 'required' => false, 'example' => 'pai', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response.', 'type' => 'object', 'properties' => [ - 'OutputModels' => [ - 'description' => '', + 'Algorithms' => [ + 'description' => 'Algorithm list.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Algorithm details.', 'type' => 'object', 'properties' => [ - 'OutputChannelName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model', - ], - 'Uri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/path/to/output/channel/', - ], - 'Labels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'StableDiffusion', - ], - ], - ], - ], - 'Metrics' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{'."\n" - .' "lr": 0.000001,'."\n" - .' "train_loss": 2.6345'."\n" - .'}', - ], - 'TrainingSpec' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - ], - 'InferenceSpec' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - ], - 'EvaluationSpec' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - ], - 'SourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PAIFlow', - ], - 'SourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf', - ], - 'CompressionSpec' => [ - 'type' => 'object', - ], + 'AlgorithmDescription' => ['description' => 'Algorithm description.', 'type' => 'string', 'example' => 'Large language model training.', 'title' => ''], + 'AlgorithmId' => ['description' => 'Algorithm ID.', 'type' => 'string', 'example' => 'algo-sidjc8134hv', 'title' => ''], + 'AlgorithmName' => ['description' => 'Algorithm name.', 'type' => 'string', 'example' => 'llm_train', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'Algorithm provider.', 'type' => 'string', 'example' => 'pai', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Algorithm creation time.', 'type' => 'string', 'example' => '2023-07-21T03:35:24Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'Algorithm update time.', 'type' => 'string', 'example' => '2023-07-25T02:15:40Z', 'title' => ''], + 'UserId' => ['description' => 'Algorithm owner ID.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'WorkspaceId' => ['description' => 'Workspace ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'DisplayName' => ['description' => 'Algorithm display name.', 'type' => 'string', 'example' => 'LLM Train', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'Total algorithms.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Algorithms\\": [\\n {\\n \\"AlgorithmDescription\\": \\"Large language model training.\\",\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"GmtCreateTime\\": \\"2023-07-21T03:35:24Z\\",\\n \\"GmtModifiedTime\\": \\"2023-07-25T02:15:40Z\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"DisplayName\\": \\"LLM Train\\"\\n }\\n ],\\n \\"TotalCount\\": 4,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'Retrieve the algorithm details list', + 'changeSet' => [ + ['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-09T09:37:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-27T10:49:51.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutputModels\\": [\\n {\\n \\"OutputChannelName\\": \\"model\\",\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/path/to/output/channel/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"RootModelName\\",\\n \\"Value\\": \\"qwen2-0.5\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"Train\\": \\"oss://somebucket.oss-cn-hangzhou.aliyuncs.com/datasets/Chinese-medical-dialogue-data/chinese_medical_train_sampled.json\\"\\n },\\n \\"Metrics\\": {\\n \\"loss\\": 2.1276\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {},\\n \\"EvaluationSpec\\": {},\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf\\",\\n \\"CompressionSpec\\": {}\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListTrainingJobOutputModels', - ], - 'StopTrainingJob' => [ - 'summary' => '停止一个TrainingJob', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/stop', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithms'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListAlgorithms', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListNodeTypes' => [ + 'path' => '/api/v1/nodetypes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '191233', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'], + ], 'parameters' => [ [ - 'name' => 'TrainingJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'train76rcaupa2cz', - ], + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of resource group IDs. You must specify either this parameter or `QuotaId`. The `UserId` for the specified `ResourceGroupId` must match the `UserId` of the requesting user. All specified `resource group` instances must be of the same type and associated with the same Virtual Private Cloud (VPC).', 'type' => 'string', 'required' => false, 'example' => 'rg123,rg456', 'title' => ''], + ], + [ + 'name' => 'QuotaId', + 'in' => 'query', + 'schema' => ['description' => 'The quota ID. You must specify either this parameter or `ResourceGroupIds`.', 'type' => 'string', 'required' => false, 'example' => 'quota123', 'title' => ''], + ], + [ + 'name' => 'NodeTypes', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of node types. If omitted, all node types are returned.', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large,ecs.gn7i-c32g1.8xlarge', 'title' => ''], + ], + [ + 'name' => 'AcceleratorType', + 'in' => 'query', + 'schema' => ['description' => 'The accelerator type used to filter the results. Valid values: `CPU` and `GPU`.', 'type' => 'string', 'required' => false, 'example' => 'GPU', 'title' => ''], + ], + [ + 'name' => 'GPUType', + 'in' => 'query', + 'schema' => ['description' => 'The GPU type used to filter the results. Fuzzy matching is supported.', 'type' => 'string', 'required' => false, 'example' => 'A10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'NodeTypes' => [ + 'type' => 'array', + 'items' => ['description' => 'The details of a node type.', '$ref' => '#/components/schemas/NodeType', 'title' => '', 'example' => ''], + 'description' => 'A collection of node types.', + 'title' => '', + 'example' => '', + ], + 'Statistics' => [ + 'type' => 'array', + 'items' => ['description' => 'The statistics for a node type.', '$ref' => '#/components/schemas/NodeTypeStatistic', 'title' => '', 'example' => ''], + 'description' => 'Statistics for the node types that match the filter criteria.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', - 'title' => 'StopTrainingJob', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListNodeTypes', + 'summary' => 'Lists the available node types.', + 'description' => '## Description'."\n" + ."\n" + .'- Lists the node types that match the specified filter criteria.'."\n" + ."\n" + .'- You must specify either the `ResourceGroupIds` or `QuotaId` parameter. The specified resource group IDs or quota ID must belong to the requesting user.'."\n" + ."\n" + .'- You can filter the results by using parameters such as accelerator type and GPU type.'."\n" + ."\n" + .'- The response includes details and statistics for each node type, indicating the availability of your resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"NodeTypes\\": [\\n {\\n \\"NodeType\\": \\"ecs.g6.4xlarge\\",\\n \\"AcceleratorType\\": \\"CPU\\",\\n \\"CPU\\": \\"16\\",\\n \\"Memory\\": \\"64Gi\\",\\n \\"GPU\\": \\"0\\",\\n \\"GPUType\\": \\"\\",\\n \\"GPUMemory\\": \\"80G\\",\\n \\"AllocatableCPU\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCPU\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\"\\n }\\n ],\\n \\"Statistics\\": [\\n {\\n \\"NodeType\\": \\"ecs.g6.4xlarge\\",\\n \\"TotalCount\\": 10,\\n \\"CanBeBoundCount\\": 4\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdateTrainingJobLabels' => [ - 'summary' => '更新一个TrainingJob的Labels', - 'path' => '/api/v1/trainingjobs/{TrainingJobId}/labels', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListNodes' => [ + 'path' => '/api/v1/nodes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191226', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'], + ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of resource group IDs. You must specify either this parameter or `QuotaId`.'."\n" + .'Constraints:'."\n" + ."\n" + .'1. The user ID of the request must match the user ID associated with the specified resource groups.'."\n" + ."\n" + .'2. All specified resource groups must be of the same type.'."\n" + ."\n" + .'3. All specified resource groups must be in the same VPC.', 'type' => 'string', 'required' => false, 'example' => 'rg69rj0leslwdnbe', 'title' => ''], + ], + [ + 'name' => 'QuotaId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource quota that contains the nodes.', 'type' => 'string', 'required' => false, 'example' => 'quotamtl37ge7gkvdz', 'title' => ''], + ], + [ + 'name' => 'NodeTypes', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of node specifications. If this parameter is omitted, this operation returns nodes of all specifications.', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.xlarge', 'title' => ''], + ], + [ + 'name' => 'AcceleratorType', + 'in' => 'query', + 'schema' => ['description' => 'The accelerator type. Valid values:'."\n" + ."\n" + .'- CPU'."\n" + ."\n" + .'- GPU'."\n" + ."\n" + .'If omitted, this operation returns nodes of all accelerator types.', 'type' => 'string', 'required' => false, 'example' => 'CPU', 'title' => ''], + ], + [ + 'name' => 'GPUType', + 'in' => 'query', + 'schema' => ['description' => 'The GPU type. Fuzzy matching is supported.', 'type' => 'string', 'required' => false, 'example' => 'T4', 'title' => ''], + ], + [ + 'name' => 'NodeStatuses', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of node statuses. If this parameter is omitted, this operation returns nodes of all statuses.', 'type' => 'string', 'required' => false, 'example' => 'Ready', 'title' => ''], + ], + [ + 'name' => 'OrderStatuses', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of order statuses.', 'type' => 'string', 'required' => false, 'example' => 'Ready', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The first page is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field by which to sort the results.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- `desc`: Descending'."\n" + ."\n" + .'- `asc`: Ascending', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return resource usage information. This parameter applies only when `QuotaId` is specified.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'NodeNames', + 'in' => 'query', + 'schema' => ['description' => 'A comma-separated list of node names. Only nodes with names that match this list are returned.', 'type' => 'string', 'required' => false, 'example' => 'lingjxxxx', 'title' => ''], + ], + [ + 'name' => 'HyperNode', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CliqueID', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FilterByQuotaId', + 'in' => 'query', + 'schema' => ['description' => 'When used with `ResourceGroupIds`, this parameter further filters the results to include only nodes from the specified resource quota.', 'type' => 'string', 'required' => false, 'example' => 'quotamtl37ge7gkvdz', 'title' => ''], + ], + [ + 'name' => 'FilterByResourceGroupIds', + 'in' => 'query', + 'schema' => ['description' => 'When used with `QuotaId`, this parameter further filters the results to include only nodes from the specified resource groups.', 'type' => 'string', 'required' => false, 'example' => 'rg69rj0leslwdnbe', 'title' => ''], + ], + [ + 'name' => 'MachineGroupIds', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ReasonCodes', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'HyperZone', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AvailabilityZone', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PaymentType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'OrderInstanceIds', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'A comma-separated list of order IDs.', 'type' => 'string', 'example' => '260590501560397', 'required' => false], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'HealthRate', + 'in' => 'query', 'style' => 'json', 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'operation' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'HealthCount', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ 'type' => 'object', 'properties' => [ - 'Labels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'RootModelID', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'model-ad8cv770kl', - ], - ], - 'required' => false, - ], - 'required' => false, + 'operation' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'LayoutMode', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DiskPL', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'WorkloadNum', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PodNum', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response schema', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'Nodes' => [ + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => ['description' => 'The node information.', '$ref' => '#/components/schemas/Node', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The number of nodes that meet the filter conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], + ], + 'title' => 'Retrieve Node List', + 'summary' => 'Returns a list of resource nodes.', + 'description' => 'ListNodes retrieves resource nodes that match specified filter conditions.', + 'changeSet' => [ + ['createdAt' => '2025-11-04T03:55:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-13T08:27:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-06T06:21:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-18T03:04:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-16T09:52:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-13T10:38:20.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Nodes\\": [\\n {\\n \\"CreatorId\\": \\"281044699048527748\\",\\n \\"NodeName\\": \\"lingjxxxx\\",\\n \\"NodeType\\": \\"ecs.c8i.xlarge\\",\\n \\"AcceleratorType\\": \\"CPU\\",\\n \\"CPU\\": \\"4\\",\\n \\"Memory\\": \\"8\\",\\n \\"GPU\\": \\"0\\",\\n \\"GPUType\\": \\"\\\\\\"\\\\\\"\\",\\n \\"GPUMemory\\": \\"\\",\\n \\"NodeStatus\\": \\"Ready\\",\\n \\"ReasonCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ReasonMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"OrderStatus\\": \\"Ready\\",\\n \\"ResourceGroupId\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"MachineGroupId\\": \\"mg1234456\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtExpiredTime\\": \\"2025-06-22T00:00:00Z\\\\n\\",\\n \\"IsBound\\": false,\\n \\"BoundQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"RequestCPU\\": \\"4\\",\\n \\"RequestMemory\\": \\"8\\",\\n \\"RequestGPU\\": \\"0\\",\\n \\"LimitCPU\\": \\"4\\",\\n \\"LimitMemory\\": \\"8\\",\\n \\"LimitGPU\\": \\"0\\",\\n \\"PodNum\\": 2,\\n \\"WorkloadNum\\": 2,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"161222222222\\",\\n \\"UserName\\": \\"test\\"\\n }\\n ],\\n \\"HyperZone\\": \\"\\",\\n \\"AvailabilityZone\\": \\"\\",\\n \\"AllocatableCPU\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCPU\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\",\\n \\"AncestorQuotaWorkloadNum\\": 0,\\n \\"SelfQuotaWorkloadNum\\": 0,\\n \\"DescendantQuotaWorkloadNum\\": 0,\\n \\"DiskPL\\": \\"\\",\\n \\"DiskCapacity\\": 0,\\n \\"SubNodes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListQuotaActiveUserUsages' => [ + 'summary' => 'Lists users within a quota and their resource usage.', + 'path' => '/api/v1/quotas/{QuotaId}/activeuserusages', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TrainingJobId', + 'AK' => [], + ], + ], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '222847', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], + ], + 'parameters' => [ + [ + 'name' => 'QuotaId', 'in' => 'path', + 'schema' => ['description' => 'The quota ID.', 'type' => 'string', 'required' => true, 'example' => 'quotamtl37ge7gkvdz', 'title' => ''], + ], + [ + 'name' => 'SelfOnly', + 'in' => 'query', + 'schema' => ['description' => 'If true, retrieves resource usage from the current quota only.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '999', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. Valid values:'."\n" + ."\n" + .'- QuotaId'."\n" + ."\n" + .'- SubmittedCPU'."\n" + ."\n" + .'- SubmittedMemory'."\n" + ."\n" + .'- SubmittedGPU'."\n" + ."\n" + .'- UsedCPU'."\n" + ."\n" + .'- UsedMemory'."\n" + ."\n" + .'- UsedGPU'."\n" + ."\n" + .'- WorkloadCount', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- `desc`: descending order.'."\n" + ."\n" + .'- `asc`: ascending order.', 'type' => 'string', - 'required' => true, - 'example' => 'train76rcaupa2cz', + 'enum' => ['asc', 'desc'], + 'required' => false, + 'example' => 'desc', + 'title' => '', ], ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => 'Filters the results by user ID.', 'type' => 'string', 'required' => false, 'example' => '200xxxxxx', 'title' => ''], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => ['description' => 'Filters the results by username.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'WorkloadCount', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'], + 'QuotaUserUsages' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/QuotaUser', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'type' => 'string', - 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of entries that meet the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'QuotaUserUsage' => [ + 'type' => 'array', + 'items' => ['description' => 'The resource usage details for a user.', '$ref' => '#/components/schemas/QuotaUser', 'title' => '', 'example' => ''], + 'description' => 'A list of user resource usage details.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]', - 'title' => 'UpdateTrainingJobLabels', - ], - 'CreateQuota' => [ - 'summary' => '创建Quota', - 'path' => '/api/v1/quotas', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListQuotaActiveUserUsages', + 'description' => 'Retrieves the resource usage of users in a specified quota.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"QuotaUserUsages\\": [\\n {\\n \\"Username\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"WorkloadCount\\": 0,\\n \\"Resources\\": {\\n \\"Used\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"Submitted\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n }\\n }\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"QuotaUserUsage\\": [\\n {\\n \\"Username\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"WorkloadCount\\": 0,\\n \\"Resources\\": {\\n \\"Used\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListQuotaWorkloads' => [ + 'path' => '/api/v1/quotas/{QuotaId}/workloads', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '191129', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'abilityTreeCode' => '221848', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'QuotaId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID of the quota.', 'type' => 'string', 'required' => true, 'example' => 'quota1y9qarq****'], + ], + [ + 'name' => 'WorkspaceIds', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Filters workloads by workspace ID. You can specify multiple IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => '1866**'], + ], + [ + 'name' => 'WorkloadType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Filters workloads by the sub-product type of the instance.', 'type' => 'string', 'required' => false, 'example' => 'dlc'], + ], + [ + 'name' => 'WorkloadIds', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Filters workloads by workload ID. You can specify multiple IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'dlc123445**'], + ], + [ + 'name' => 'BeforeWorkloadId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Retrieves workloads that precede the specified workload ID in the queue.', 'type' => 'string', 'required' => false, 'example' => 'dsw654433**'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The maximum number of entries to return on a single page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The field to use for sorting the results.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreatedTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'QuotaName' => [ - 'title' => 'Quota名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-quota', - ], - 'ResourceType' => [ - 'title' => 'Quota资源类型（Lingjun/ECS），默认值ECS', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - 'ParentQuotaId' => [ - 'title' => '父QuotaId'."\n" - .'1. 如果父QuotaId为空，表示创建一个根Quota，从专属资源组中分配机器'."\n" - .'2. 如果父QuotaId不为空，表示创建一个子Quota，资源从根Quota中绑定的Nodes中分配资源', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quota1ci8g793pgm', - ], - 'ResourceGroupIds' => [ - 'title' => '专有资源组列表'."\n" - .'约束：'."\n" - .'1. 只有根Quota允许从（父QuotaId为空）资源组划分机器'."\n" - .'2. 指定的资源组列表中的vpc配置需要一致', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rgl593id9qqwkmbr', - ], - 'required' => false, - ], - 'AllocateStrategy' => [ - 'title' => 'Quota分配策略，目前仅支持ByNodeSpecs', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ByNodeSpecs', - ], - 'Min' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ResourceSpec', - ], - 'Description' => [ - 'title' => 'Quota描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test quota', - ], - 'Labels' => [ - 'title' => 'Quota标签', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - 'QuotaConfig' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/QuotaConfig', - ], - 'QueueStrategy' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PaiStrategyIntelligent', - ], - 'ClusterSpec' => [ - 'title' => '资源配额原生集群的规格', - '$ref' => '#/components/schemas/ClusterSpec', - ], - ], + 'title' => '', + 'description' => 'The sort order for the results. Valid values are `asc` for ascending and `desc` for descending.', + 'type' => 'string', + 'enum' => ['asc', 'desc'], 'required' => false, + 'example' => 'desc', ], ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads by their status in the queue.', 'type' => 'string', 'default' => 'Enqueued', 'required' => false, 'example' => 'Enqueued', 'title' => ''], + ], + [ + 'name' => 'ShowOwn', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only workloads that belong to the specified quota.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SubQuotaIds', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads by sub-quota ID. You can specify multiple IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'quota123446**,quota644322**', 'title' => ''], + ], + [ + 'name' => 'UserIds', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads by user ID. You can specify multiple IDs, separated by commas.', 'type' => 'string', 'required' => false, 'example' => '290438938**,238290930**', 'title' => ''], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads by node name.', 'type' => 'string', 'required' => false, 'example' => 'lrn482781276**', 'title' => ''], + ], + [ + 'name' => 'WorkloadCreatedTimeRange', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads based on their creation time range.', '$ref' => '#/components/schemas/TimeRangeFilter', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'WorkloadStatuses', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads by status. You can specify multiple statuses, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'Pending', 'title' => ''], + ], + [ + 'name' => 'GmtPositionModifiedTimeRange', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads by the time range of their last queue position change.', '$ref' => '#/components/schemas/TimeRangeFilter', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'GmtEnqueuedTimeRange', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads by their enqueue time range.', '$ref' => '#/components/schemas/TimeRangeFilter', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'GmtDequeuedTimeRange', + 'in' => 'query', + 'schema' => ['description' => 'Filters workloads by their dequeue time range.', '$ref' => '#/components/schemas/TimeRangeFilter', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'WithHistoricalData', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include historical data in the query results.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'WorkloadNames', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Position', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UseOversoldResource', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => 'CBF05F13-B24C-5129-9048-4FA684DCD579', - ], - 'QuotaId' => [ - 'title' => 'Quota Id', - 'description' => 'Quota Id', - 'type' => 'string', - 'example' => 'quotad2kd8ljpsno', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '42F23B58-3684-5443-848A-8DA81FF99712'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of workloads that match the filter criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], + 'Workloads' => [ + 'description' => 'A list of workloads.', + 'type' => 'array', + 'items' => ['description' => 'The details of a workload in the queue.', '$ref' => '#/components/schemas/QueueInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the job list on a resource quota', + 'summary' => 'Retrieves a list of workloads associated with a specific quota.', + 'changeSet' => [ + ['createdAt' => '2025-02-19T12:19:32.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF05F13-B24C-5129-9048-4FA684DCD579\\",\\n \\"QuotaId\\": \\"quotad2kd8ljpsno\\"\\n}","errorExample":""},{"type":"xml","example":"\\n quotad2kd8ljpsno\\n","errorExample":""}]', - 'title' => 'CreateQuota', + 'ramActions' => [], + 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\",\\n \\"TotalCount\\": 23,\\n \\"Workloads\\": [\\n {\\n \\"Status\\": \\"Enqueued\\",\\n \\"QuotaId\\": \\"“quotamtl37ge7gkvdz”\\",\\n \\"UserName\\": \\"\\",\\n \\"WorkloadId\\": \\"dlcxxxx\\",\\n \\"Position\\": 10,\\n \\"GmtEnqueuedTime\\": \\"“2023-06-22T00:00:00Z”\\",\\n \\"Priority\\": 2,\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"WorkloadType\\": \\"dlc\\",\\n \\"WorkspaceId\\": \\"“432524”\\",\\n \\"Resource\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"Code\\": \\"roleMaximumResource\\",\\n \\"Reason\\": \\"Current GPU Limit is 5, limited by Role PAI.AlgoDeveloper\\",\\n \\"UseOversoldResource\\": true,\\n \\"Name\\": \\"test-label-79f5498dd-9qrzs\\",\\n \\"WorkloadStatus\\": \\"PreAllocation\\",\\n \\"WorkloadName\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"GmtPositionModifiedTime\\": \\"\\\\\\"2023-06-22T00:00:00Z\\\\\\"\\",\\n \\"CodeType\\": \\"ConfigRule\\",\\n \\"GmtDequeuedTime\\": \\"\\\\\\"2023-06-22T00:00:00Z\\\\\\"\\",\\n \\"WorkspaceName\\": \\"\\",\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListQuotas' => [ - 'summary' => '获取Quota列表', - 'path' => '/api/v1/quotas/', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'path' => '/api/v1/quotas/', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -8561,2066 +5771,3150 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191173', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - 'FEATURElearn1N0SUT', - ], + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'], ], 'parameters' => [ [ 'name' => 'QuotaName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quotajradxh43rgb', - ], + 'schema' => ['description' => 'Filters the results by quota name. Fuzzy matching is supported.', 'type' => 'string', 'required' => false, 'example' => 'quotajradxh43rgb', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => 'The resource type. Valid values are Lingjun, ECS, and ACS. The default value is ECS.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], [ 'name' => 'LayoutMode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The layout mode. Valid values: Tree and List.', 'type' => 'string', 'required' => false, 'example' => 'Tree', 'title' => ''], ], [ 'name' => 'ParentQuotaId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quotajradxh43rgb', - ], + 'schema' => ['description' => 'Filters the results by parent quota ID:'."\n" + ."\n" + .'- If this parameter is not specified, all quotas within the tenant are returned, including both root and child quotas.'."\n" + ."\n" + .'- If this parameter is set to an empty string, all root quotas are returned.'."\n" + ."\n" + .'- If a specific parent quota ID is provided, all child quotas of that parent are returned.', 'type' => 'string', 'required' => false, 'example' => 'quotajradxh43rgb', 'title' => ''], ], [ 'name' => 'QuotaIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quota1ci8g793pgm,quotajradxh43rgb', - ], + 'schema' => ['description' => 'A comma-separated list of up to 100 quota IDs to filter the results. Only exact matching is supported.', 'type' => 'string', 'required' => false, 'example' => 'quota1ci8g793pgm,quotajradxh43rgb', 'title' => ''], ], [ 'name' => 'WorkspaceIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '21345,38727', - ], + 'schema' => ['description' => 'A comma-separated list of up to 10 workspace IDs to filter the results. Only exact matching is supported.', 'type' => 'string', 'required' => false, 'example' => '21345,38727', 'title' => ''], ], [ 'name' => 'Statuses', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Creating', - ], + 'schema' => ['description' => 'A comma-separated list of quota statuses to filter the results. Only exact matching is supported.', 'type' => 'string', 'required' => false, 'example' => 'Creating', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number of the results to return. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries to return on each page. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'status', - ], + 'schema' => ['description' => 'The field to sort the results by. Valid values:'."\n" + ."\n" + .'- QuotaName'."\n" + ."\n" + .'- Status'."\n" + ."\n" + .'- CPU'."\n" + ."\n" + .'- Memory'."\n" + ."\n" + .'- GPU'."\n" + ."\n" + .'- GmtCreatedTime'."\n" + ."\n" + .'- GmtModifiedTime', 'type' => 'string', 'required' => false, 'example' => 'status', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'The sort order. Valid values are desc and asc.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'official=true,gpu=false', - ], + 'schema' => ['description' => 'Filters the results by labels. Specify labels as key=value pairs, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'official=true,gpu=false', 'title' => ''], ], [ 'name' => 'Verbose', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to return detailed information. Valid values:'."\n" + ."\n" + .'- true: Returns detailed information.'."\n" + ."\n" + .'- false: Does not return detailed information.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'WorkspaceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the associated workspace.', 'type' => 'string', 'required' => false, 'example' => 'myshellprod', 'title' => ''], ], [ 'name' => 'HasResource', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'Versions', 'in' => 'query', - 'schema' => [ - 'title' => '按照版本信息搜索。', - 'type' => 'string', - 'example' => '1.0', - ], + 'schema' => ['title' => '', 'description' => 'Filters the results by version.', 'type' => 'string', 'example' => '1.0', 'required' => false], ], [ 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'title' => '集群类型', - 'type' => 'string', - 'example' => 'RayCluster', - ], + 'schema' => ['title' => '', 'description' => 'Filters the results by cluster type.', 'type' => 'string', 'example' => 'RayCluster', 'required' => false], + ], + [ + 'name' => 'GPUType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'], 'Quotas' => [ - 'description' => '', + 'description' => 'The list of quotas.', 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/Quota', - ], - ], - 'TotalCount' => [ - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['description' => 'The details of a quota.', '$ref' => '#/components/schemas/Quota', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of entries that match the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Resource Quota List', + 'summary' => 'Lists quotas.', + 'changeSet' => [ + ['createdAt' => '2025-11-06T13:03:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-19T03:30:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-25T06:06:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-04T13:22:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-09T02:33:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-19T09:17:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-24T08:33:18.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\",\\n \\"ResourceType\\": \\"\\",\\n \\"ParentQuotaId\\": \\"\\",\\n \\"ResourceGroupIds\\": [\\n \\"\\"\\n ],\\n \\"AllocateStrategy\\": \\"\\",\\n \\"Min\\": {\\n \\"NodeSpecs\\": [\\n {\\n \\"Type\\": \\"ecs.g6.4xlarge\\",\\n \\"Count\\": 10,\\n \\"BindingPolicy\\": {\\n \\"NodeSpecCount\\": 5,\\n \\"IncludeNodes\\": [\\n \\"lrnabc\\"\\n ],\\n \\"ExcludeNodes\\": [\\n \\"lrndef\\"\\n ]\\n },\\n \\"HyperType\\": \\"\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"CreatorId\\": \\"\\",\\n \\"LatestOperationId\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"ReasonCode\\": \\"\\",\\n \\"ReasonMessage\\": \\"\\",\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"QuotaDetails\\": {\\n \\"DesiredMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"ActualMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"RequestedQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n }\\n },\\n \\"QuotaConfig\\": {\\n \\"SupportRDMA\\": false,\\n \\"ClusterId\\": \\"ceeb37xxxx\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\"\\n ],\\n \\"RoleArn\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"\\",\\n \\"EipAllocationId\\": \\"\\"\\n }\\n },\\n \\"SupportGPUDrivers\\": [\\n \\"\\"\\n ],\\n \\"DefaultGPUDriver\\": \\"470.199.02\\",\\n \\"ACS\\": {\\n \\"ACSQuotaId\\": \\"\\",\\n \\"AssociatedProducts\\": [\\n \\"\\"\\n ]\\n },\\n \\"ResourceSpecs\\": [\\n {\\n \\"WorkspaceId\\": \\"\\",\\n \\"Product\\": \\"\\",\\n \\"Specs\\": [\\n {\\n \\"SpecName\\": \\"\\",\\n \\"IsGuaranteedValid\\": true,\\n \\"IsOverSoldValid\\": true,\\n \\"CodeType\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Reason\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"EnablePreemptSubquotaWorkloads\\": true,\\n \\"EnableSubQuotaPreemption\\": true,\\n \\"SubQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorityUpperBound\\": 9,\\n \\"PreemptedProducts\\": [\\n \\"dlc\\"\\n ]\\n },\\n \\"EnableGPUShare\\": true,\\n \\"OversoldUsageConfig\\": {\\n \\"DisabledBy\\": \\"\\",\\n \\"Disabled\\": true\\n },\\n \\"SelfQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorities\\": [\\n 0\\n ],\\n \\"PreemptedProducts\\": [\\n \\"\\"\\n ],\\n \\"PreemptorPriorities\\": [\\n 0\\n ]\\n },\\n \\"EniCacheConfig\\": {\\n \\"Enabled\\": true,\\n \\"CachePoolSize\\": 0\\n },\\n \\"SandboxCacheConfig\\": {\\n \\"Enabled\\": true\\n },\\n \\"UseCase\\": \\"\\",\\n \\"EnableSelfQuotaPreemption\\": true,\\n \\"ControlPlaneClusterId\\": \\"\\"\\n },\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"ws123456\\"\\n }\\n ],\\n \\"SubQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"QueueStrategy\\": \\"\\",\\n \\"Version\\": \\"\\",\\n \\"HyperZones\\": [\\n \\"\\"\\n ],\\n \\"QuotaCluster\\": {\\n \\"ClusterType\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"DataSourceId\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"Endpoints\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Status\\": \\"\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]', - 'title' => 'ListQuotas', - ], - 'GetQuota' => [ - 'summary' => '获取Quota', - 'path' => '/api/v1/quotas/{QuotaId}', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListQuotas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\",\\n \\"ResourceType\\": \\"ECS\\",\\n \\"ParentQuotaId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ResourceGroupIds\\": [\\n \\"rg69rj0leslw****\\"\\n ],\\n \\"AllocateStrategy\\": \\"ByNodeSpec\\",\\n \\"Min\\": {\\n \\"NodeSpecs\\": [\\n {\\n \\"Type\\": \\"ecs.g6.4xlarge\\",\\n \\"Count\\": 10,\\n \\"BindingPolicy\\": {\\n \\"NodeSpecCount\\": 5,\\n \\"IncludeNodes\\": [\\n \\"lrnabc\\"\\n ],\\n \\"ExcludeNodes\\": [\\n \\"lrndef\\"\\n ]\\n },\\n \\"HyperType\\": \\"\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"this is a test quota\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"testAccTag\\",\\n \\"Value\\": \\"nihao\\"\\n }\\n ],\\n \\"CreatorId\\": \\"1884692****\\",\\n \\"LatestOperationId\\": \\"operation****\\",\\n \\"Status\\": \\"Ready\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"QuotaDetails\\": {\\n \\"DesiredMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"ActualMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"RequestedQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"NodeStatistics\\": {\\n \\"ActualMinNodeNum\\": 0,\\n \\"ActualMinHyperNodeNum\\": 0,\\n \\"AllocatedNodeNum\\": 0,\\n \\"AllocatedHyperNodeNum\\": 0,\\n \\"EmptyNodeNum\\": 0,\\n \\"AllocatedHyperNodeDetails\\": [\\n {\\n \\"HyperNodeName\\": \\"\\",\\n \\"AllocatedNodeNum\\": 0,\\n \\"TotalNodeNum\\": 0,\\n \\"EmptyNodeNum\\": 0\\n }\\n ]\\n }\\n },\\n \\"QuotaConfig\\": {\\n \\"SupportRDMA\\": false,\\n \\"ClusterId\\": \\"ceeb3724255364***\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"192.168.0.1/24\\\\\\"\\"\\n ],\\n \\"RoleArn\\": \\"acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"nat-7j4mka9wguxj\\",\\n \\"EipAllocationId\\": \\"eip-h29r78ieufbih\\"\\n }\\n },\\n \\"SupportGPUDrivers\\": [\\n \\"470.199.02\\"\\n ],\\n \\"DefaultGPUDriver\\": \\"470.199.02\\",\\n \\"ACS\\": {\\n \\"ACSQuotaId\\": \\"rq-3kbt2gtimmyw7fgfgothocvh\\",\\n \\"AssociatedProducts\\": [\\n \\"PAI-DLC\\"\\n ]\\n },\\n \\"ResourceSpecs\\": [\\n {\\n \\"WorkspaceId\\": \\"122421\\",\\n \\"Product\\": \\"DLC\\",\\n \\"Specs\\": [\\n {\\n \\"SpecName\\": \\"spec_test\\",\\n \\"IsGuaranteedValid\\": true,\\n \\"IsOverSoldValid\\": true,\\n \\"CodeType\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Reason\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n }\\n ],\\n \\"EnablePreemptSubquotaWorkloads\\": false,\\n \\"EnableSubQuotaPreemption\\": false,\\n \\"SubQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorityUpperBound\\": 9,\\n \\"PreemptedProducts\\": [\\n \\"dlc\\"\\n ]\\n },\\n \\"EnableGPUShare\\": false,\\n \\"OversoldUsageConfig\\": {\\n \\"DisabledBy\\": \\"\\",\\n \\"Disabled\\": false\\n },\\n \\"SelfQuotaPreemptionConfig\\": {\\n \\"PreemptorPriorities\\": [\\n 0\\n ],\\n \\"PreemptedPriorities\\": [\\n 0\\n ],\\n \\"PreemptedProducts\\": [\\n \\"\\"\\n ]\\n },\\n \\"EniCacheConfig\\": {\\n \\"Enabled\\": true,\\n \\"CachePoolSize\\": 0\\n },\\n \\"SandboxCacheConfig\\": {\\n \\"Enabled\\": true\\n },\\n \\"UseCase\\": \\"\\",\\n \\"EnableSelfQuotaPreemption\\": false,\\n \\"ControlPlaneClusterId\\": \\"\\",\\n \\"IsEncryptedResource\\": false,\\n \\"WorkloadTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"ws123***\\",\\n \\"WorkspaceName\\": \\"\\"\\n }\\n ],\\n \\"SubQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\",\\n \\"Version\\": \\"\\",\\n \\"QuotaCluster\\": {\\n \\"ClusterType\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"DataSourceId\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"Endpoints\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Status\\": \\"\\"\\n },\\n \\"HyperZones\\": [\\n \\"\\"\\n ],\\n \\"GPUType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]', + ], + 'ListResourceGroupMachineGroups' => [ + 'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '191160', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'abilityTreeCode' => '125191', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'], ], 'parameters' => [ [ - 'name' => 'QuotaId', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'CreatorID', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who created the machine group.', 'type' => 'string', 'required' => false, 'example' => '1612285282502326', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupID', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quota1ci8g793pgm', - ], + 'schema' => ['description' => 'The globally unique ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], ], [ - 'name' => 'Verbose', + 'name' => 'PaymentType', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The payment type.', 'type' => 'string', 'required' => false, 'example' => 'PREPAY', 'title' => ''], ], [ - 'name' => 'WithNodeMeta', + 'name' => 'PaymentDurationUnit', 'in' => 'query', - 'schema' => [ - 'title' => '是否返回绑定到Quota的节点meta信息', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The billing duration unit of the machine group.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], + ], + [ + 'name' => 'PaymentDuration', + 'in' => 'query', + 'schema' => ['description' => 'The payment duration. If `PaymentDurationUnit` is set to `Month`, valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'EcsSpec', + 'in' => 'query', + 'schema' => ['description' => 'The ECS instance type.', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order.'."\n" + ."\n" + .'- `Asc`: Sorts the results in ascending order.'."\n" + ."\n" + .'- `Desc`: Sorts the results in descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort by.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreatedTime', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The instance status. `Creating`: The instance is being created. `Ready`: The instance is running. `Expiring`: The instance is expiring. `Expired`: The instance has expired. `Stopping`: The instance is being stopped. `Stopped`: The instance is stopped.', 'type' => 'string', 'required' => false, 'example' => 'Ready', 'title' => ''], + ], + [ + 'name' => 'OrderInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the purchase order.', 'type' => 'string', 'required' => false, 'example' => '236553689400333', 'title' => ''], + ], + [ + 'name' => 'MachineGroupIDs', + 'in' => 'query', + 'schema' => ['description' => 'The machine group IDs. Separate multiple IDs with a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'mg105ecqwfe49hwb', 'title' => ''], + ], + [ + 'name' => 'DiskPL', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E', - ], - 'QuotaId' => [ - 'title' => 'Quota Id', - 'description' => 'Quota Id', - 'type' => 'string', - 'example' => 'quotajradxh43rgb', - ], - 'QuotaName' => [ - 'title' => 'Quota名称', - 'description' => '', - 'type' => 'string', - 'example' => 'test-quota', - ], - 'ResourceType' => [ - 'title' => 'Quota资源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'ECS', - ], - 'ParentQuotaId' => [ - 'title' => '父Quota Id', - 'description' => '', - 'type' => 'string', - 'example' => 'quota1ci8g793pgm', - ], - 'ResourceGroupIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rg69rj0leslwdnbe', - ], - ], - 'AllocateStrategy' => [ - 'title' => '资源分配策略', - 'description' => '', - 'type' => 'string', - 'example' => 'ByNodeSpec', - ], - 'Min' => [ - 'description' => '', - '$ref' => '#/components/schemas/ResourceSpec', - ], - 'Description' => [ - 'title' => 'Quota描述', - 'description' => '', - 'type' => 'string', - 'example' => 'this is a test quota', - ], - 'Labels' => [ - 'title' => 'Quota标签', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/Label', - ], - ], - 'CreatorId' => [ - 'title' => 'Quota创建人Id', - 'description' => '', - 'type' => 'string', - 'example' => '18846926616', - ], - 'LatestOperationId' => [ - 'title' => 'Quota最近变更Id', - 'description' => '', - 'type' => 'string', - 'example' => 'operation1234', - ], - 'Status' => [ - 'title' => 'Quota状态', - 'description' => '', - 'type' => 'string', - 'example' => 'Ready', - ], - 'ReasonCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '“”', - ], - 'ReasonMessage' => [ - 'title' => '错误原因', - 'description' => '', - 'type' => 'string', - 'example' => '“”', - ], - 'GmtCreatedTime' => [ - 'title' => 'Quota创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - ], - 'GmtModifiedTime' => [ - 'title' => 'Quota修改时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-06-22T00:00:00Z', - ], - 'QuotaDetails' => [ - 'title' => 'Quota详情', - 'description' => '', - '$ref' => '#/components/schemas/QuotaDetails', - ], - 'QuotaConfig' => [ - 'description' => '', - '$ref' => '#/components/schemas/QuotaConfig', - ], - 'Workspaces' => [ - 'title' => 'Quota关联的工作空间', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/WorkspaceIdName', - ], - ], - 'SubQuotas' => [ - 'title' => 'Quota的子Quota列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/QuotaIdName', - ], - ], - 'QueueStrategy' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PaiStrategyIntelligent', - ], - 'Version' => [ - 'title' => '版本信息。当resource type为ECS时生效。', - 'type' => 'string', - 'example' => '1.0', - ], - 'HyperZones' => [ - 'title' => '高性能网络区列表', + 'MachineGroups' => [ + 'description' => 'A list of machine groups.', 'type' => 'array', - 'items' => [ - 'title' => '高性能网络区ID', - 'type' => 'string', - ], - ], - 'QuotaCluster' => [ - 'title' => '由配额内资源组成的集群规格与状态', - '$ref' => '#/components/schemas/QuotaCluster', + 'items' => ['description' => 'A machine group.', '$ref' => '#/components/schemas/MachineGroup', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of machine groups.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Obtain the list of machine groups', + 'summary' => 'Retrieves a list of machine groups in a specified resource group.', + 'changeSet' => [ + ['createdAt' => '2025-03-19T07:07:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-23T02:15:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"QuotaId\\": \\"quotajradxh4****\\",\\n \\"QuotaName\\": \\"test-quota\\",\\n \\"ResourceType\\": \\"ECS\\",\\n \\"ParentQuotaId\\": \\"quota1ci8g79****\\",\\n \\"ResourceGroupIds\\": [\\n \\"rg69rj0leslw****\\"\\n ],\\n \\"AllocateStrategy\\": \\"ByNodeSpec\\",\\n \\"Min\\": {\\n \\"NodeSpecs\\": [\\n {\\n \\"Type\\": \\"ecs.g6.4xlarge\\",\\n \\"Count\\": 10,\\n \\"BindingPolicy\\": {\\n \\"NodeSpecCount\\": 5,\\n \\"IncludeNodes\\": [\\n \\"lrnabc\\"\\n ],\\n \\"ExcludeNodes\\": [\\n \\"lrndef\\"\\n ]\\n },\\n \\"HyperType\\": \\"\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"this is a test quota\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"CreatorId\\": \\"1884692****\\",\\n \\"LatestOperationId\\": \\"operation****\\",\\n \\"Status\\": \\"Ready\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"QuotaDetails\\": {\\n \\"DesiredMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"ActualMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"RequestedQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n }\\n },\\n \\"QuotaConfig\\": {\\n \\"SupportRDMA\\": false,\\n \\"ClusterId\\": \\"ceeb37xxxx\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\"\\n ],\\n \\"RoleArn\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"\\",\\n \\"EipAllocationId\\": \\"\\"\\n }\\n },\\n \\"SupportGPUDrivers\\": [\\n \\"\\"\\n ],\\n \\"DefaultGPUDriver\\": \\"470.199.02\\",\\n \\"ACS\\": {\\n \\"ACSQuotaId\\": \\"\\",\\n \\"AssociatedProducts\\": [\\n \\"\\"\\n ]\\n },\\n \\"ResourceSpecs\\": [\\n {\\n \\"WorkspaceId\\": \\"\\",\\n \\"Product\\": \\"\\",\\n \\"Specs\\": [\\n {\\n \\"SpecName\\": \\"\\",\\n \\"IsGuaranteedValid\\": true,\\n \\"IsOverSoldValid\\": true,\\n \\"CodeType\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Reason\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"EnablePreemptSubquotaWorkloads\\": true,\\n \\"EnableSubQuotaPreemption\\": true,\\n \\"SubQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorityUpperBound\\": 9,\\n \\"PreemptedProducts\\": [\\n \\"dlc\\"\\n ]\\n },\\n \\"EnableGPUShare\\": true,\\n \\"OversoldUsageConfig\\": {\\n \\"DisabledBy\\": \\"\\",\\n \\"Disabled\\": true\\n },\\n \\"SelfQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorities\\": [\\n 0\\n ],\\n \\"PreemptedProducts\\": [\\n \\"\\"\\n ],\\n \\"PreemptorPriorities\\": [\\n 0\\n ]\\n },\\n \\"EniCacheConfig\\": {\\n \\"Enabled\\": true,\\n \\"CachePoolSize\\": 0\\n },\\n \\"SandboxCacheConfig\\": {\\n \\"Enabled\\": true\\n },\\n \\"UseCase\\": \\"\\",\\n \\"EnableSelfQuotaPreemption\\": true,\\n \\"ControlPlaneClusterId\\": \\"\\"\\n },\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"ws123456\\"\\n }\\n ],\\n \\"SubQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\",\\n \\"Version\\": \\"1.0\\",\\n \\"HyperZones\\": [\\n \\"A3\\"\\n ],\\n \\"QuotaCluster\\": {\\n \\"ClusterType\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"DataSourceId\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"Endpoints\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Status\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n quotajradxh43rgb\\n test-quota\\n ECS\\n quota1ci8g793pgm\\n rg69rj0leslwdnbe\\n ByNodeSpec\\n \\n \\n ecs.g6.4xlarge\\n 10\\n \\n \\n this is a test quota\\n \\n Ready\\n 2023-06-22T00:00:00Z\\n 2023-06-22T00:00:00Z\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n \\n false\\n ceeb37xxxx\\n \\n \\n 470.199.02\\n \\n \\n \\n \\n ws123456\\n \\n \\n quota12345\\n dlc-quota\\n \\n PaiStrategyIntelligent\\n","errorExample":""}]', - 'title' => 'GetQuota', - ], - 'UpdateQuota' => [ - 'summary' => '更新Quota', - 'path' => '/api/v1/quotas/{QuotaId}', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroupMachineGroups'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListResourceGroupMachineGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroups\\": [\\n {\\n \\"Status\\": \\"Success\\",\\n \\"EcsCount\\": 1,\\n \\"GmtStartedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"CreatorID\\": \\"1612285282502324\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"PaymentDurationUnit\\": \\"Monthly\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"SupportedDrivers\\": [\\n \\"470.199.02\\"\\n ],\\n \\"PaymentDuration\\": \\"2\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"DiskCapacity\\": 0,\\n \\"GmtExpiredTime\\": \\"2023-08-22T00:00:00Z\\\\n\\",\\n \\"OrderInstanceId\\": \\"“”\\",\\n \\"DefaultDriver\\": \\"470.199.02\\",\\n \\"MachineGroupID\\": \\"mg1\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"DiskPL\\": \\"\\",\\n \\"Cpu\\": 0,\\n \\"Gpu\\": 0,\\n \\"GpuMemory\\": 0,\\n \\"GpuType\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"ResourceType\\": \\"\\",\\n \\"AllocatableCpu\\": 0,\\n \\"AllocatableMemory\\": 0,\\n \\"SystemReservedCpu\\": 0,\\n \\"SystemReservedMemory\\": 0\\n }\\n ],\\n \\"TotalCount\\": \\"4\\",\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListResourceGroups' => [ + 'path' => '/api/v1/resources', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '191208', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124250', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'], ], 'parameters' => [ [ - 'name' => 'QuotaId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Quota ID', - 'type' => 'string', - 'required' => false, - 'example' => 'quota-20210126170216-mtl37ge7gkvdz', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2', 'required' => false], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test quota', - ], - 'Labels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - 'QueueStrategy' => [ - 'type' => 'string', - ], - 'QuotaConfig' => [ - '$ref' => '#/components/schemas/QuotaConfig', - ], - 'QuotaName' => [ - 'type' => 'string', - ], - ], - 'required' => false, - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'required' => false], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- `desc`: descending.'."\n" + ."\n" + .'- `asc`: ascending.', 'type' => 'string', 'example' => 'desc', 'required' => false], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The field to sort by. Valid values include: `DisplayName`, `GmtCreated`, `GmtModified`, `RegionID`, `Duration`, `PricingCycle`, and `PayType`.', 'type' => 'string', 'example' => 'DisplayName', 'required' => false], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The status of the resource group.', 'type' => 'string', 'example' => 'Creating', 'required' => false], + ], + [ + 'name' => 'ShowAll', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return all results.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ComputingResourceProvider', + 'in' => 'query', + 'schema' => ['description' => 'The provider of the compute resources.', 'type' => 'string', 'required' => false, 'example' => 'Ecs', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- `ECS`: ECS.'."\n" + ."\n" + .'- `Lingjun`: Lingjun intelligent computing resources.', 'type' => 'string', 'required' => false, 'example' => 'Lingjun', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupIDs', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'HasResource', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Versions', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The version to filter by.', 'type' => 'string', 'example' => '1.0', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => '96496E6E-00B4-5F55-80F6-1844FA9E92DC', - ], - 'QuotaId' => [ - 'title' => 'Quota Id', - 'description' => 'Quota Id', - 'type' => 'string', - 'example' => 'quota-20210126170216-mtl37ge7gkvdz', + 'ResourceGroups' => [ + 'description' => 'The list of resource groups.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'A resource group.', '$ref' => '#/components/schemas/ResourceGroup', 'title' => '', 'example' => ''], + 'example' => 'RG1', ], + 'TotalCount' => ['title' => '', 'description' => 'The total number of matching resource groups.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9CFA2665-1FFE-5929-8468-C14C25890486'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Obtain a List of Resource Groups', + 'summary' => 'Call this operation to list resource groups for ECS or Lingjun intelligent computing resources.', + 'description' => 'Currently, AI computing resource groups (including ECS and Lingjun intelligent computing resources) are available only in specific regions. For a list of supported regions, see [AI computing resource management](~~143986~~).', + 'changeSet' => [ + ['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-25T06:06:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-30T06:48:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-11T03:07:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-26T12:56:59.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96496E6E-00B4-5F55-80F6-1844FA9E92DC\\",\\n \\"QuotaId\\": \\"quota-20210126170216-mtl37ge7gkvdz\\"\\n}","type":"json"}]', - 'title' => 'UpdateQuota', - ], - 'ScaleQuota' => [ - 'summary' => '扩缩容Quota', - 'path' => '/api/v1/quotas/{QuotaId}/action/scale', - 'methods' => [ - 'put', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroups'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListResourceGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceGroups\\": [\\n {\\n \\"Name\\": \\"RG1\\",\\n \\"ResourceGroupID\\": \\"rg17tmvwiokh****\\",\\n \\"WorkspaceID\\": \\"23000\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"192.168.0.1/24\\\\\\"\\"\\n ],\\n \\"RoleArn\\": \\"acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"nat-7j4mka9wguxj\\",\\n \\"EipAllocationId\\": \\"eip-h29r78ieufbih\\"\\n }\\n },\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"CreatorID\\": \\"161228528250****\\",\\n \\"NodeCount\\": 3,\\n \\"Version\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"ResourceType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"9CFA2665-1FFE-5929-8468-C14C25890486\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListTagResources' => [ + 'path' => '/api/v1/tags', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '191196', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '205684', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'QuotaId', - 'in' => 'path', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Region ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', 'schema' => [ - 'description' => 'Quota ID', + 'title' => '', + 'description' => 'Resource type', + 'enumValueTitles' => ['MachineGroup' => 'MachineGroup', 'ResourceGroup' => 'ResourceGroup'], 'type' => 'string', + 'required' => true, + 'example' => 'ResourceGroup', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Resource IDs. Maximum: 50 items.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'Resource ID. You can specify up to 50 resource IDs per call.', 'type' => 'string', 'required' => false, 'example' => '[\\"rgrk6hhjpvio3wvj\\"]', 'title' => ''], 'required' => false, - 'example' => 'quotamtl37ge7gkvdz', + 'example' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'Tag', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceGroupIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2nxrabqavely', - ], - 'required' => false, - ], - 'Min' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ResourceSpec', + 'description' => 'Tags to filter by. Maximum: 20 items.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags that are used by the rule. You can set multiple tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Tag key', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['title' => '', 'description' => 'Tag value', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Pagination token for the next page of results', 'type' => 'string', 'required' => false, 'example' => 'ad31d453a1f3f23ce0b5e8707e68181f'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6', - ], - 'QuotaId' => [ - 'title' => 'Quota Id', - 'description' => 'Quota Id', - 'type' => 'string', - 'example' => 'quotamtl37ge7gkvdz', + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'CE22EE94-8AFE-53B5-9C2C-B36207B1CBF9'], + 'NextToken' => ['title' => '', 'description' => 'Pagination token for the next page of results', 'type' => 'string', 'example' => '3iEiu84Yk3TwHLzJV.usagf1Ain49xYKGoB6zffsDqPYZQQ5'], + 'TagResources' => [ + 'description' => 'The list of resources.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['title' => '', 'description' => 'Tag key', 'type' => 'string', 'example' => 'tagKey'], + 'TagValue' => ['title' => '', 'description' => 'Tag value', 'type' => 'string', 'example' => 'tagValue'], + 'ResourceId' => ['title' => '', 'description' => 'Resource ID', 'type' => 'string', 'example' => 'rgqssemfn6vjqqev'], + 'ResourceType' => ['title' => '', 'description' => 'Resource type', 'type' => 'string', 'example' => 'ResourceGroup'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Query tag list', + 'summary' => 'Tag query API.', + 'description' => 'Specify at least one of the following parameters to query for resources.'."\n" + ."\n" + .'- ResourceId.N'."\n" + ."\n" + .'- Tag.N (Tag.N.Key and Tag.N.Value)'."\n" + ."\n" + .'If you specify both parameters, the operation returns only resources that match both criteria.'."\n" + ."\n" + .'- Tag.N and ResourceId.N', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"QuotaId\\": \\"quotamtl37ge7gkvdz\\"\\n}","type":"json"}]', - 'title' => 'ScaleQuota', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE22EE94-8AFE-53B5-9C2C-B36207B1CBF9\\",\\n \\"NextToken\\": \\"3iEiu84Yk3TwHLzJV.usagf1Ain49xYKGoB6zffsDqPYZQQ5\\",\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"tagKey\\",\\n \\"TagValue\\": \\"tagValue\\",\\n \\"ResourceId\\": \\"rgqssemfn6vjqqev\\",\\n \\"ResourceType\\": \\"ResourceGroup\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'DeleteQuota' => [ - 'summary' => '删除Quota', - 'path' => '/api/v1/quotas/{QuotaId}', - 'methods' => [ - 'delete', + 'ListTrainingJobEvents' => [ + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/events', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '165613', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ + [ + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['description' => 'Training task ID.', 'type' => 'string', 'required' => true, 'example' => 'traineyfz0m2****', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'Page number (default is 1).', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size (default is 100).', 'type' => 'integer', 'format' => 'int64', 'maximum' => '2000', 'minimum' => '1', 'example' => '100', 'default' => '100', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Start UTC time (ISO8601 format). If empty, it is the task start time.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'End UTC time (ISO8601 format). If empty, it is the current time.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Returned result.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'TotalCount' => ['title' => '', 'description' => 'Total number of events.', 'type' => 'string', 'example' => '23'], + 'Events' => [ + 'description' => 'List of events.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'Event.', 'type' => 'string', 'title' => '', 'example' => 'UserEvent'], + 'example' => '', + ], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Retrieve Training Job Events', + 'summary' => 'Retrieve events for a specific training task to gain detailed insight into the training process.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobEvents'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": \\"23\\",\\n \\"Events\\": [\\n \\"UserEvent\\"\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListTrainingJobInstanceEvents' => [ + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/events', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '191219', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'abilityTreeCode' => '165612', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'QuotaId', + 'name' => 'TrainingJobId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quota1ci8g793pgm', - ], + 'schema' => ['description' => 'ID of the training job.', 'type' => 'string', 'required' => true, 'example' => 'train76rcaupa2cz', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'train76rcaupa2cz-master-0', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '2000', 'minimum' => '1', 'example' => '100', 'default' => '100', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Start time in UTC, in ISO 8601 format. If empty, defaults to the training job start time.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'End time in UTC, in ISO 8601 format. If empty, defaults to the current time.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'QuotaId' => [ - 'title' => 'Quota Id', - 'description' => 'Quota Id', - 'type' => 'string', - 'example' => 'quotamtl37ge7gkvdz', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'TotalCount' => ['title' => '', 'description' => 'Total number of events.', 'type' => 'string', 'example' => '1'], + 'Events' => [ + 'description' => 'List of events.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'Event message.', 'type' => 'string', 'title' => '', 'example' => 'You are using pip version 9.0.1, however version 20.2.4 is available.'], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Retrieve Management Events for a Training Job Instance', + 'summary' => 'Retrieve events for a training job instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobInstanceEvents'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"QuotaId\\": \\"quotamtl37ge7gkvdz\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n quotamtl37ge7gkvdz\\n","errorExample":""}]', - 'title' => 'DeleteQuota', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"Events\\": [\\n \\"You are using pip version 9.0.1, however version 20.2.4 is available.\\"\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ListQuotaWorkloads' => [ - 'summary' => '您可以通过此API获取Quota上的任务信息列表', - 'path' => '/api/v1/quotas/{QuotaId}/workloads', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTrainingJobInstanceMetrics' => [ + 'summary' => 'Retrieve monitoring metrics for training job instances.', + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/instancemetrics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '221848', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'abilityTreeCode' => '157749', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], ], 'parameters' => [ [ - 'name' => 'QuotaId', + 'name' => 'TrainingJobId', 'in' => 'path', - 'schema' => [ - 'title' => 'Quota ID', - 'description' => 'Quota ID', - 'type' => 'string', - 'required' => true, - 'example' => 'quota1y9qarqj2i7', - ], + 'schema' => ['title' => '', 'description' => 'Training job ID.', 'type' => 'string', 'required' => true, 'example' => 'trains930928remn'], ], [ - 'name' => 'WorkspaceIds', + 'name' => 'MetricType', 'in' => 'query', - 'schema' => [ - 'title' => '查询指定的Workspace下的workload的排队信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '186692', - ], + 'schema' => ['title' => '', 'description' => 'Metric type:'."\n" + ."\n" + .'- GpuCoreUsage: POD GPU usage'."\n" + ."\n" + .'- GpuMemoryUsage: POD GPU memory usage'."\n" + ."\n" + .'- CpuCoreUsage: POD CPU usage'."\n" + ."\n" + .'- MemoryUsage: POD memory usage'."\n" + ."\n" + .'- NetworkInputRate: POD network input rate (TCP/IP) (MB/s)'."\n" + ."\n" + .'- NetworkOutputRate: POD network output rate (TCP/IP) (MB/s)'."\n" + ."\n" + .'- DiskReadRate: POD disk read rate (MB/s)'."\n" + ."\n" + .'- DiskWriteRate: POD disk write rate (MB/s)', 'type' => 'string', 'required' => true, 'example' => 'GpuCoreUsage'], ], [ - 'name' => 'WorkloadType', + 'name' => 'TimeStep', 'in' => 'query', - 'schema' => [ - 'title' => '查询指定子产品的实例的排队信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dlc', - ], + 'schema' => ['description' => 'Time interval. Valid values: 1h, 30m, 5m, 10s.', 'type' => 'string', 'required' => false, 'example' => '10s', 'title' => ''], ], [ - 'name' => 'WorkloadIds', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '查询指定workload id的排队信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dlc12344556', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'trains930928remn-master-0', 'title' => ''], ], [ - 'name' => 'BeforeWorkloadId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询队列中指定workload Id之前的实例的排队信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dsw65443322', - ], + 'schema' => ['title' => '', 'description' => 'Start time in UTC, in ISO 8601 format. If empty, use the job start time.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], ], [ - 'name' => 'PageNumber', + 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'End time in UTC, in ISO 8601 format. If empty, use the current time.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '查询的页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'description' => 'Schema of Response', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'], + 'InstanceMetrics' => [ + 'description' => 'List of all monitoring metrics that match the filter condition.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'Monitoring metrics that match the filter condition.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'trainkxen7qjyg6y-master-0', 'title' => ''], + 'Metrics' => [ + 'description' => 'List of instance monitoring metrics.', + 'type' => 'array', + 'items' => [ + 'description' => 'Instance monitoring metric.', + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => 'UTC time in ISO 8601 format.', 'type' => 'string', 'example' => '2020-11-08T16:00:00Z', 'title' => ''], + 'Value' => ['description' => 'Metric value.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NodeName' => ['description' => 'Node name.', 'type' => 'string', 'example' => 'trains930928remn-master-0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'title' => 'Obtain monitoring metrics of a training job instance', + 'changeSet' => [ + ['createdAt' => '2024-08-06T02:04:36.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobInstanceMetrics'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"InstanceMetrics\\": [\\n {\\n \\"InstanceId\\": \\"trainkxen7qjyg6y-master-0\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": \\"2020-11-08T16:00:00Z\\",\\n \\"Value\\": 1\\n }\\n ],\\n \\"NodeName\\": \\"trains930928remn-master-0\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListTrainingJobLogs' => [ + 'summary' => 'Retrieves the logs for a training task.', + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/logs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页查询每页的大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'SortBy', + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the training task.', 'type' => 'string', 'required' => true, 'example' => 'train129f212o89d', 'title' => ''], + ], + [ + 'name' => 'WorkerId', 'in' => 'query', - 'schema' => [ - 'title' => '返回结果的排序字段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreatedTime', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The instance ID of the training task. This parameter is deprecated. Use InstanceId instead.', 'type' => 'string', 'required' => false, 'example' => 'train129f212o89d-master-0', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '排队顺序', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - 'enum' => [ - 'asc', - 'desc', - ], - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Enqueued', - 'default' => 'Enqueued', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '2000', 'minimum' => '1', 'example' => '100', 'default' => '100', 'required' => false, 'title' => ''], ], [ - 'name' => 'ShowOwn', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The start UTC time in ISO 8601 format. If empty, the task start time is used.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], ], [ - 'name' => 'SubQuotaIds', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quota12344666,quota64432233', - ], + 'schema' => ['title' => '', 'description' => 'The end UTC time in ISO 8601 format. If empty, the current time is used.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], ], [ - 'name' => 'UserIds', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'train129f212o89d-master-0', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '29043893812,23829093093', + 'description' => 'Schema of Response', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBF05F13-B24C-5129-9048-4FA684DCD579'], + 'TotalCount' => ['title' => '', 'description' => 'The number of logs that match the filter condition.', 'type' => 'string', 'example' => '23'], + 'Logs' => [ + 'description' => 'The list of logs.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The content of the log line.', 'type' => 'string', 'title' => '', 'example' => 'loss: 0.0001'], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'title' => 'Retrieve logs of a training job', + 'changeSet' => [ + ['createdAt' => '2023-10-13T09:11:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-05T12:21:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-27T10:49:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobLogs'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF05F13-B24C-5129-9048-4FA684DCD579\\",\\n \\"TotalCount\\": \\"23\\",\\n \\"Logs\\": [\\n \\"loss: 0.0001\\"\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListTrainingJobMetrics' => [ + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/metrics', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '132913', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ [ - 'name' => 'NodeName', + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID of the training task.', 'type' => 'string', 'required' => true, 'example' => 'train76rcaupa2cz'], + ], + [ + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lrn48278127617', - ], + 'schema' => ['title' => '', 'description' => 'The name of the metric.', 'type' => 'string', 'required' => false, 'example' => 'accuracy'], ], [ - 'name' => 'WorkloadCreatedTimeRange', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/TimeRangeFilter', - ], + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'example' => '1', 'default' => '1', 'required' => false], ], [ - 'name' => 'WorkloadStatuses', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Pending', - ], + 'schema' => ['title' => '', 'description' => 'The number of items per page.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'default' => '100', 'required' => false], ], [ - 'name' => 'GmtPositionModifiedTimeRange', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/TimeRangeFilter', - ], + 'schema' => ['title' => '', 'description' => 'The start time in UTC, in ISO 8601 format. If you omit this parameter, the task start time is used.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], ], [ - 'name' => 'GmtEnqueuedTimeRange', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/TimeRangeFilter', - ], + 'schema' => ['title' => '', 'description' => 'The end time in UTC, in ISO 8601 format. If you omit this parameter, the current time is used.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2020-11-08T16:00:00Z', 'required' => false], ], [ - 'name' => 'GmtDequeuedTimeRange', + 'name' => 'Order', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The sort order of returned metrics. Valid values: ASC or DESC.', 'type' => 'string', 'default' => 'DESC', 'required' => false, 'example' => 'DESC'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/TimeRangeFilter', + 'description' => 'Response schema', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'Metrics' => [ + 'description' => 'The list of metrics.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric information.', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => 'The timestamp when the metric was collected.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-04-18T22:20:55Z', 'title' => ''], + 'Value' => ['description' => 'The value of the metric.', 'type' => 'number', 'format' => 'double', 'example' => '0.97', 'title' => ''], + 'Name' => ['title' => '', 'description' => 'The name of the metric.', 'type' => 'string', 'example' => 'accuracy'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'title' => 'Obtain training job metrics ', + 'summary' => 'Retrieve monitoring data for a training task.', + 'changeSet' => [ + ['createdAt' => '2024-11-06T02:28:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-27T10:49:51.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobMetrics'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"2022-04-18T22:20:55Z\\",\\n \\"Value\\": 0.97,\\n \\"Name\\": \\"accuracy\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListTrainingJobOutputModels' => [ + 'summary' => 'Retrieves information about the output models of a training job.', + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/outputmodels', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'WithHistoricalData', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '200236', + 'abilityTreeNodes' => ['FEATURElearn9XMQIJ'], + ], + 'parameters' => [ + [ + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Training job ID.', 'type' => 'string', 'required' => true, 'example' => 'traineyfz0m2hsfv'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '42F23B58-3684-5443-848A-8DA81FF99712', - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的实例数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'Workloads' => [ - 'description' => '', + 'OutputModels' => [ + 'description' => 'List of models produced by training.', 'type' => 'array', 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/QueueInfo', + 'description' => 'Model produced by training.', + 'type' => 'object', + 'properties' => [ + 'OutputChannelName' => ['description' => 'Name of the training output data.', 'type' => 'string', 'example' => 'model', 'title' => ''], + 'Uri' => ['description' => 'Link to the training output data.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/path/to/output/channel/', 'title' => ''], + 'Labels' => [ + 'description' => 'List of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'RootModelName', 'title' => ''], + 'Value' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'qwen2-0.5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Metrics' => ['description' => 'Training job metrics.', 'type' => 'object', 'example' => '{'."\n" + .' "Results": ['."\n" + .' {'."\n" + .' "Dataset": {'."\n" + .' "Train": "oss://somebucket.oss-cn-hangzhou.aliyuncs.com/datasets/Chinese-medical-dialogue-data/chinese_medical_train_sampled.json"'."\n" + .' },'."\n" + .' "Metrics": {'."\n" + .' "loss": 2.1276'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + 'TrainingSpec' => ['description' => 'Model training configuration.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'InferenceSpec' => ['description' => 'Model inference configuration.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'EvaluationSpec' => ['description' => 'Model evaluation configuration.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'SourceType' => ['description' => 'Source (the type of job that produced the model). Default: Custom.', 'type' => 'string', 'example' => 'PAIFlow', 'title' => ''], + 'SourceId' => ['description' => 'Source ID (optional):'."\n" + ."\n" + .'- If the source is Custom, there are no format requirements.'."\n" + ."\n" + .'- If the source is PAIFlow, use the format: region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf.'."\n" + ."\n" + .'- If the source is TrainingService, use the format: region=cn-shanghai,workspaceId=1345,kind=TrainingJob,id=job-sakdbaskjdf.', 'type' => 'string', 'example' => 'region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf', 'title' => ''], + 'CompressionSpec' => ['description' => 'Model compression configuration.', 'type' => 'object', 'example' => '{}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\",\\n \\"TotalCount\\": 23,\\n \\"Workloads\\": [\\n {\\n \\"Status\\": \\"Enqueued\\",\\n \\"QuotaId\\": \\"“quotamtl37ge7gkvdz”\\",\\n \\"UserName\\": \\"\\",\\n \\"WorkloadId\\": \\"dlcxxxx\\",\\n \\"Position\\": 10,\\n \\"GmtEnqueuedTime\\": \\"“2023-06-22T00:00:00Z”\\",\\n \\"Priority\\": 2,\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"WorkloadType\\": \\"dlc\\",\\n \\"WorkspaceId\\": \\"“432524”\\",\\n \\"Resource\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"Code\\": \\"roleMaximumResource\\",\\n \\"Reason\\": \\"Current GPU Limit is 5, limited by Role PAI.AlgoDeveloper\\",\\n \\"UseOversoldResource\\": true,\\n \\"Name\\": \\"test-label-79f5498dd-9qrzs\\",\\n \\"WorkloadStatus\\": \\"PreAllocation\\",\\n \\"WorkloadName\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"GmtPositionModifiedTime\\": \\"\\\\\\"2023-06-22T00:00:00Z\\\\\\"\\",\\n \\"CodeType\\": \\"ConfigRule\\",\\n \\"GmtDequeuedTime\\": \\"\\\\\\"2023-06-22T00:00:00Z\\\\\\"\\",\\n \\"WorkspaceName\\": \\"\\",\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListQuotaWorkloads', - ], - 'ListTagResources' => [ - 'summary' => '查标签接口', - 'path' => '/api/v1/tags', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve models produced by a training job', + 'changeSet' => [ + ['createdAt' => '2024-07-11T04:11:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-11T03:58:46.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutputModels\\": [\\n {\\n \\"OutputChannelName\\": \\"model\\",\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/path/to/output/channel/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"RootModelName\\",\\n \\"Value\\": \\"qwen2-0.5\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"Train\\": \\"oss://somebucket.oss-cn-hangzhou.aliyuncs.com/datasets/Chinese-medical-dialogue-data/chinese_medical_train_sampled.json\\"\\n },\\n \\"Metrics\\": {\\n \\"loss\\": 2.1276\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {},\\n \\"EvaluationSpec\\": {},\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf\\",\\n \\"CompressionSpec\\": {}\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListTrainingJobs' => [ + 'summary' => 'List training jobs.', + 'path' => '/api/v1/trainingjobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '205684', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132980', + 'abilityTreeNodes' => ['FEATURElearnVYA4L9'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'MachineGroup' => 'MachineGroup', - 'ResourceGroup' => 'ResourceGroup', - ], - 'example' => 'ResourceGroup', - ], + 'schema' => ['description' => 'The page number of the results to return.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[\\"rgrk6hhjpvio3wvj\\"]', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'SortBy', 'in' => 'query', - 'style' => 'json', 'schema' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], + 'description' => 'The field to sort the results by.', + 'type' => 'string', 'required' => false, + 'enum' => ['GmtModifiedTime', 'GmtCreateTime', 'TrainingJobName', 'AlgorithmName', 'Status'], + 'example' => 'GmtModifiedTime', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => '', + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- `ASC`: Ascending order.'."\n" + ."\n" + .'- `DESC`: Descending order.', + 'enumValueTitles' => ['ASC' => '', 'DESC' => ''], 'type' => 'string', + 'enum' => ['desc', 'asc'], 'required' => false, - 'example' => 'ad31d453a1f3f23ce0b5e8707e68181f', + 'example' => 'DESC', + 'title' => '', ], ], + [ + 'name' => 'TrainingJobName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the training job.', 'type' => 'string', 'required' => false, 'example' => 'large_language_model_training', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the training job.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], + ], + [ + 'name' => 'TrainingJobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the training job.', 'type' => 'string', 'required' => false, 'example' => 'trains930928remn', 'title' => ''], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The labels of the training job, specified as key-value pairs.', 'type' => 'object', 'required' => false, 'example' => '{"project": "sd-s3"}', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to filter training jobs by creation time. The default is 7 days ago.', 'type' => 'string', 'required' => false, 'example' => '2024-06-22T01:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to filter training jobs by creation time. The default is the current time.', 'type' => 'string', 'required' => false, 'example' => '2023-12-27T02:10:00Z', 'title' => ''], + ], + [ + 'name' => 'AlgorithmProvider', + 'in' => 'query', + 'schema' => ['description' => 'The provider of the algorithm.', 'type' => 'string', 'required' => false, 'example' => 'pai', 'title' => ''], + ], + [ + 'name' => 'AlgorithmName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the algorithm.', 'type' => 'string', 'required' => false, 'example' => 'llm_train', 'title' => ''], + ], + [ + 'name' => 'IsTempAlgo', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether the algorithm is temporary.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'CE22EE94-8AFE-53B5-9C2C-B36207B1CBF9', - ], - 'NextToken' => [ - 'title' => '下一个查询开始Token', - 'description' => '', - 'type' => 'string', - 'example' => '3iEiu84Yk3TwHLzJV.usagf1Ain49xYKGoB6zffsDqPYZQQ5', - ], - 'TagResources' => [ - 'title' => '资源列表', - 'description' => '', + 'TotalCount' => ['description' => 'The total number of training jobs.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TrainingJobs' => [ + 'description' => 'A list of training jobs.', 'type' => 'array', 'items' => [ + 'description' => 'A training job.', 'type' => 'object', 'properties' => [ - 'TagKey' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'example' => 'tagKey', + 'AlgorithmName' => ['description' => 'The name of the algorithm.', 'type' => 'string', 'example' => 'llm_train', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'The provider of the algorithm.', 'type' => 'string', 'example' => 'pai', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'The version of the algorithm.', 'type' => 'string', 'example' => 'v0.0.1', 'title' => ''], + 'ComputeResource' => [ + 'description' => 'The compute resource configuration.', + 'type' => 'object', + 'properties' => [ + 'EcsCount' => ['description' => 'The number of ECS instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'EcsSpec' => ['description' => 'The ECS instance type.', 'type' => 'string', 'example' => 'ecs.gn5-c8g1.2xlarge', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the resource quota.', 'type' => 'string', 'example' => 'quotam670lixikcl', 'title' => ''], + 'ResourceName' => ['description' => 'The name of the resource quota.', 'type' => 'string', 'example' => 'quota', 'title' => ''], + 'InstanceCount' => ['description' => 'The number of instances for the resource quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'InstanceSpec' => [ + 'description' => 'The instance configuration for the resource quota.', + 'type' => 'object', + 'properties' => [ + 'CPU' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'Memory' => ['description' => 'The memory size, in GiB.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'SharedMemory' => ['description' => 'The shared memory size, in GiB.', 'type' => 'string', 'example' => '32', 'title' => ''], + 'GPU' => ['description' => 'The number of GPUs.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GPUType' => ['description' => 'The GPU type.', 'type' => 'string', 'example' => 'V100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'GmtCreateTime' => ['description' => 'The time the training job was created.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time the training job was last modified.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'HyperParameters' => [ + 'description' => 'The hyperparameter configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'A hyperparameter.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the hyperparameter.', 'type' => 'string', 'example' => 'learning_rate', 'title' => ''], + 'Value' => ['description' => 'The value of the hyperparameter.', 'type' => 'string', 'example' => '0.001', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'InputChannels' => [ + 'description' => 'The input data channels.', + 'type' => 'array', + 'items' => [ + 'description' => 'An input data channel.', + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['description' => 'The ID of the input dataset.', 'type' => 'string', 'example' => 'd-475megosidivjfgfq6', 'title' => ''], + 'InputUri' => ['description' => 'The URI of the input data.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/channel/', 'title' => ''], + 'Name' => ['description' => 'The name of the input channel.', 'type' => 'string', 'example' => 'model', 'title' => ''], + 'VersionName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'description' => 'The labels for the training job.', + 'type' => 'array', + 'items' => [ + 'description' => 'A label.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The label key.', 'type' => 'string', 'example' => 'CreatedBy', 'title' => ''], + 'Value' => ['description' => 'The label value.', 'type' => 'string', 'example' => 'QuickStart', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OutputChannels' => [ + 'description' => 'The output data channels.', + 'type' => 'array', + 'items' => [ + 'description' => 'An output data channel.', + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['description' => 'The ID of the output dataset.', 'type' => 'string', 'example' => 'd-8o0hh35po15ejcdq2p', 'title' => ''], + 'Name' => ['description' => 'The name of the output channel.', 'type' => 'string', 'example' => 'model', 'title' => ''], + 'OutputUri' => ['description' => 'The URI of the output data.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/channel/', 'title' => ''], + 'VersionName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ReasonCode' => ['description' => 'The reason code for the training job\'s status.', 'type' => 'string', 'example' => 'TrainingJobSucceed', 'title' => ''], + 'ReasonMessage' => ['description' => 'A message that provides details about the job\'s status.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Scheduler' => [ + 'description' => 'The scheduler configuration.', + 'type' => 'object', + 'properties' => [ + 'MaxRunningTimeInSeconds' => ['description' => 'The maximum runtime of the training job in seconds. A value of `0` indicates an unlimited runtime.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Status' => ['description' => 'The status of the training job.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'StatusTransitions' => [ + 'description' => 'A list of status transitions for the training job.', + 'type' => 'array', + 'items' => [ + 'description' => 'A status transition.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The time when the status ended.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'ReasonCode' => ['description' => 'The reason code for the status.', 'type' => 'string', 'example' => 'TrainingJobSucceed', 'title' => ''], + 'ReasonMessage' => ['description' => 'Details about the status transition.', 'type' => 'string', 'example' => 'KubeDL job runs successfully', 'title' => ''], + 'StartTime' => ['description' => 'The time when the status started.', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TrainingJobDescription' => ['description' => 'The description of the training job.', 'type' => 'string', 'example' => 'Qwen2 large language model training.', 'title' => ''], + 'TrainingJobId' => ['description' => 'The ID of the training job.', 'type' => 'string', 'example' => 'train1layo6js8ra', 'title' => ''], + 'TrainingJobName' => ['description' => 'The name of the training job.', 'type' => 'string', 'example' => 'qwen2-7b', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'WorkspaceId' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'RoleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role assumed for the training job.', 'type' => 'string', 'example' => 'acs:ram::{accountID}:role/{roleName}', 'title' => ''], + 'IsTempAlgo' => ['title' => '', 'description' => 'Indicates whether a temporary algorithm was used.', 'type' => 'boolean', 'example' => 'true'], + 'UserVpc' => [ + 'description' => 'The user\'s VPC configuration.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-abcdef****', 'title' => ''], + 'SwitchId' => ['description' => 'The switch ID.', 'type' => 'string', 'example' => 'vs-abcdef****', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-abcdef****', 'title' => ''], + 'ExtendedCIDRs' => [ + 'description' => 'The extended CIDR blocks.', + 'type' => 'array', + 'items' => ['description' => 'An extended CIDR block.', 'type' => 'string', 'example' => '192.168.0.1/24', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DefaultRoute' => ['description' => 'The default route.', 'type' => 'string', 'example' => 'eth1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'TagValue' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => 'tagValue', + 'ExperimentConfig' => [ + 'description' => 'The associated experiment configuration.', + 'type' => 'object', + 'properties' => [ + 'ExperimentId' => ['description' => 'The ID of the associated experiment.', 'type' => 'string', 'example' => 'exp-ds9aefia90v', 'title' => ''], + 'ExperimentName' => ['description' => 'The name of the associated experiment.', 'type' => 'string', 'example' => 'large_language_model', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ResourceId' => [ - 'title' => '资源ID', - 'description' => '', - 'type' => 'string', - 'example' => 'rgqssemfn6vjqqev', + 'Environments' => [ + 'description' => 'The environment variables.', + 'additionalProperties' => ['description' => 'An environment variable in key-value format.', 'type' => 'string', 'example' => 'debug=true', 'title' => ''], + 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'ResourceGroup', + 'PythonRequirements' => [ + 'description' => 'The required Python packages.', + 'type' => 'array', + 'items' => ['description' => 'A Python package requirement.', 'type' => 'string', 'example' => 'torch>=2.2.0', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'DlcJobId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AssignNodeSpec' => ['$ref' => '#/components/schemas/AssignNodeSpec', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE22EE94-8AFE-53B5-9C2C-B36207B1CBF9\\",\\n \\"NextToken\\": \\"3iEiu84Yk3TwHLzJV.usagf1Ain49xYKGoB6zffsDqPYZQQ5\\",\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"tagKey\\",\\n \\"TagValue\\": \\"tagValue\\",\\n \\"ResourceId\\": \\"rgqssemfn6vjqqev\\",\\n \\"ResourceType\\": \\"ResourceGroup\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'TagResources' => [ - 'summary' => '打标签接口', - 'path' => '/api/v1/tags', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"TrainingJobs\\": [\\n {\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"ComputeResource\\": {\\n \\"EcsCount\\": 1,\\n \\"EcsSpec\\": \\"ecs.gn5-c8g1.2xlarge\\",\\n \\"ResourceId\\": \\"quotam670lixikcl\\",\\n \\"ResourceName\\": \\"quota\\",\\n \\"InstanceCount\\": 1,\\n \\"InstanceSpec\\": {\\n \\"CPU\\": \\"8\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"1\\",\\n \\"GPUType\\": \\"V100\\"\\n }\\n },\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"HyperParameters\\": [\\n {\\n \\"Name\\": \\"learning_rate\\",\\n \\"Value\\": \\"0.001\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-475megosidivjfgfq6\\",\\n \\"InputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/channel/\\",\\n \\"Name\\": \\"model\\",\\n \\"VersionName\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"CreatedBy\\",\\n \\"Value\\": \\"QuickStart\\"\\n }\\n ],\\n \\"OutputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-8o0hh35po15ejcdq2p\\",\\n \\"Name\\": \\"model\\",\\n \\"OutputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/channel/\\",\\n \\"VersionName\\": \\"\\"\\n }\\n ],\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"None\\",\\n \\"Scheduler\\": {\\n \\"MaxRunningTimeInSeconds\\": 0\\n },\\n \\"Status\\": \\"Running\\",\\n \\"StatusTransitions\\": [\\n {\\n \\"EndTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"KubeDL job runs successfully\\",\\n \\"StartTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ],\\n \\"TrainingJobDescription\\": \\"Qwen2 large language model training.\\",\\n \\"TrainingJobId\\": \\"train1layo6js8ra\\",\\n \\"TrainingJobName\\": \\"qwen2-7b\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"RoleArn\\": \\"acs:ram::{accountID}:role/{roleName}\\",\\n \\"IsTempAlgo\\": true,\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ],\\n \\"DefaultRoute\\": \\"eth1\\"\\n },\\n \\"ExperimentConfig\\": {\\n \\"ExperimentId\\": \\"exp-ds9aefia90v\\",\\n \\"ExperimentName\\": \\"large_language_model\\"\\n },\\n \\"Environments\\": {\\n \\"key\\": \\"debug=true\\"\\n },\\n \\"PythonRequirements\\": [\\n \\"torch>=2.2.0\\"\\n ],\\n \\"DlcJobId\\": \\"\\",\\n \\"AssignNodeSpec\\": {\\n \\"EnableAssignNode\\": true,\\n \\"NodeNames\\": \\"\\",\\n \\"AntiAffinityNodeNames\\": \\"\\"\\n }\\n }\\n ],\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'Retrieve the training job list', + 'changeSet' => [ + ['createdAt' => '2025-11-25T06:20:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-18T02:48:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-07T03:10:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-29T07:27:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-15T03:13:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-09T06:51:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-01T11:22:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-20T02:19:53.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-26T11:54:38.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobs'], + ], ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'OperateNode' => [ + 'path' => '/api/v1/nodes/{NodeId}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '202685', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216521', + 'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'], ], 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'path', + 'schema' => ['description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'lingjunxxxx-mgxxx-xxxx', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ResourceGroup', - ], - 'RegionId' => [ - 'title' => '地域', - 'description' => '', + 'ResourceGroupId' => ['description' => 'The ID of the resource group that contains the node.', 'type' => 'string', 'required' => false, 'example' => 'rgaekzbrflewn6jjq', 'title' => ''], + 'Operation' => [ + 'description' => 'The operation to perform.'."\n" + ."\n" + .'- Cordon: Disables scheduling on the node.'."\n" + ."\n" + .'- Uncordon: Enables scheduling on the node.'."\n" + ."\n" + .'- Drain: Evicts pods from the node.', 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'ResourceId' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[\\"rgqssemfn6vjqqev\\"]', - ], - 'required' => false, - ], - 'Tag' => [ - 'title' => '对应新增标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, - ], - 'required' => false, + 'required' => true, + 'enum' => ['Cordon', 'Uncordon', 'Drain'], + 'example' => 'Cordon', + 'title' => '', ], + 'OperationParameters' => ['title' => '', 'description' => 'The parameter settings for the node operation.', '$ref' => '#/components/schemas/NodeOperationParameters', 'required' => false, 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '42F23B58-3684-5443-848A-8DA81FF99712', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '96496E6E-00B4-5F55-80F6-1844FA9E92DC'], + 'NodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'lingjunxxxx-mgxxx-xxxx', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Operate Edge Zone ', + 'summary' => 'Use OperateNode to manage nodes.', + 'description' => 'Use OperateNode to manage a specified resource node. Supported operations include disabling or enabling scheduling.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96496E6E-00B4-5F55-80F6-1844FA9E92DC\\",\\n \\"NodeId\\": \\"lingjunxxxx-mgxxx-xxxx\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'UntagResources' => [ - 'summary' => '删标签接口', - 'path' => '/api/v1/tags', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ScaleQuota' => [ + 'path' => '/api/v1/quotas/{QuotaId}/action/scale', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '205683', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', - ], + 'abilityTreeCode' => '191196', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'QuotaId', + 'in' => 'path', + 'schema' => ['description' => 'Quota ID.', 'type' => 'string', 'required' => false, 'example' => 'quotamtl37ge7gkvdz', 'title' => ''], ], [ - 'name' => 'ResourceType', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ResourceGroup', + 'description' => 'Request body.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIds' => [ + 'description' => 'Resource group IDs.', + 'type' => 'array', + 'items' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2nxrabqavely', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Min' => ['description' => 'Scaling Min Quota.'."\n" + .'>NodeSpecs specifies the post-scaling specifications and quantity. If the Count in NodeSpecs is less than the current Quota\'s Count, it indicates scale-in. Otherwise, it indicates scale-out.>', '$ref' => '#/components/schemas/ResourceSpec', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[\\"rga2yvifxyicn1rq\\"]', + 'description' => 'Schema of Response', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'], + 'QuotaId' => ['title' => '', 'description' => 'Quota ID.', 'type' => 'string', 'example' => 'quotamtl37ge7gkvdz'], ], - 'required' => true, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Scale Out or Scale In Resource Quota', + 'summary' => 'Use ScaleQuota to scale resource quotas.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'TagKey', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '对应标签键列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:ScaleQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"QuotaId\\": \\"quotamtl37ge7gkvdz\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'StopTrainingJob' => [ + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/stop', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'All', - 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对tags为空时有效。取值范围： true false True False 默认是 false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the training task.', 'type' => 'string', 'required' => false, 'example' => 'train76rcaupa2cz', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response', + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]', - ], - 'ListNodes' => [ - 'summary' => '获取资源节点列表', - 'path' => '/api/v1/nodes', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Stop Training Job', + 'summary' => 'Stops a training task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTrainingJob'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'TagResources' => [ + 'summary' => 'Attaches tags to resources.', + 'path' => '/api/v1/tags', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '191226', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - 'FEATURElearn1N0SUT', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '202685', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg69rj0leslwdnbe', - ], - ], - [ - 'name' => 'QuotaId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'ResourceGroup'], + 'RegionId' => ['title' => '', 'description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'ResourceId' => [ + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'example' => '[\\"rgqssemfn6vjqqev\\"]', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'Tag' => [ + 'description' => 'The tags to add. You can specify up to 20 tags.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag information.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'quotamtl37ge7gkvdz', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'NodeTypes', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.c6.xlarge', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '42F23B58-3684-5443-848A-8DA81FF99712'], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create and attach tags to a specified list of resources uniformly', + 'description' => 'Alibaba Cloud checks the number of existing tags on the resource before attaching a new tag. If the limit is exceeded, an error message is returned.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UntagResources' => [ + 'summary' => 'Detach tags from a list of specified resources. If a tag is no longer attached to any resource after detachment, Alibaba Cloud deletes it automatically.', + 'path' => '/api/v1/tags', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AcceleratorType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CPU', - ], + 'AK' => [], ], + ], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '205683', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], + ], + 'parameters' => [ [ - 'name' => 'GPUType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'T4', - ], + 'schema' => ['title' => '', 'description' => 'Region', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'NodeStatuses', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Ready', - ], + 'schema' => ['title' => '', 'description' => 'Resource type', 'type' => 'string', 'required' => true, 'example' => 'ResourceGroup'], ], [ - 'name' => 'OrderStatuses', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Ready', + 'description' => 'Resource IDs. Maximum: 50 items.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'List of resources.', 'type' => 'string', 'required' => false, 'example' => '[\\"rga2yvifxyicn1rq\\"]', 'title' => ''], + 'required' => true, + 'example' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'List of tag keys. Maximum: 20 items.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'Tag value for the resource. Valid values for N: 1 to 20. You can specify an empty string. Maximum length: 128 characters. Cannot start with `aliyun` or `acs:`. Cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'tagKey', 'title' => ''], 'required' => false, - 'example' => '2', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'All', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'Whether to detach all tags from the resource. Valid values:'."\n" + ."\n" + .'- **true**: Detach all tags from the resource.'."\n" + ."\n" + .'- **false**: Do not detach all tags from the resource.'."\n" + ."\n" + .'> * Default value: false.'."\n" + ."\n" + .'- If you specify both TagKey and this parameter, this parameter is ignored.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], - [ - 'name' => 'SortBy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Common parameter. Each request has a unique ID. Use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Detach tags from the specified resource list in a unified manner', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateAlgorithm' => [ + 'summary' => 'Updates an algorithm.', + 'path' => '/api/v1/algorithms/{AlgorithmId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'name' => 'AlgorithmDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The algorithm description.', 'type' => 'string', 'example' => 'Large language model training.', 'required' => false, 'title' => ''], ], [ - 'name' => 'NodeNames', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lingjxxxx', - ], + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the algorithm.', 'type' => 'string', 'required' => false, 'example' => 'LLM Train', 'title' => ''], ], [ - 'name' => 'HyperNode', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'AlgorithmId', + 'in' => 'path', + 'schema' => ['description' => 'The algorithm ID.', 'type' => 'string', 'required' => false, 'example' => 'algo-sidjc8134hv', 'title' => ''], ], - [ - 'name' => 'CliqueID', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'description' => 'Schema of Response', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'], + 'AlgorithmId' => ['description' => 'The algorithm ID.', 'type' => 'string', 'example' => 'algo-sidjc8134hv', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'FilterByQuotaId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'quotamtl37ge7gkvdz', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\"\\n}","type":"json"}]', + 'title' => 'Update algorithm', + 'changeSet' => [ + ['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAlgorithm'], ], + ], + 'ramActions' => [ [ - 'name' => 'FilterByResourceGroupIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg69rj0leslwdnbe', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pai:UpdateAlgorithm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'UpdateAlgorithmVersion' => [ + 'summary' => 'Updates an algorithm version.', + 'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MachineGroupIds', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + ], + 'parameters' => [ [ - 'name' => 'ReasonCodes', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'AlgorithmId', + 'in' => 'path', + 'schema' => ['description' => 'The algorithm ID.', 'type' => 'string', 'required' => false, 'example' => 'algo-sidjc8134hv', 'title' => ''], ], [ - 'name' => 'HyperZone', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'AlgorithmVersion', + 'in' => 'path', + 'schema' => ['description' => 'The algorithm version.', 'type' => 'string', 'required' => false, 'example' => 'v0.0.1', 'title' => ''], ], [ - 'name' => 'AvailabilityZone', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'AlgorithmSpec', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The details of the algorithm.', '$ref' => '#/components/schemas/AlgorithmSpec', 'required' => false, 'title' => '', 'example' => ''], ], - [ - 'name' => 'PaymentType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'description' => 'The response schema.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'AlgorithmId' => ['description' => 'The algorithm ID.', 'type' => 'string', 'example' => 'algo-sidjc8134hv', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'The algorithm version.', 'type' => 'string', 'example' => 'v0.1.0', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'OrderInstanceIds', - 'in' => 'query', - 'schema' => [ - 'title' => '订单Id信息', - 'type' => 'string', - 'example' => '260590501560397', - ], + ], + 'title' => 'Update Algorithm Version', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAlgorithmVersion'], ], + ], + 'ramActions' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pai:UpdateAlgorithmVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmVersion\\": \\"v0.1.0\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateQuota' => [ + 'path' => '/api/v1/quotas/{QuotaId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'HealthRate', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '节点的健康率（健康节点的占比）', - 'type' => 'object', - 'properties' => [ - 'operation' => [ - 'title' => '可选值ge, gte, eq, lte, lt', - 'type' => 'string', - ], - 'value' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191208', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], + ], + 'parameters' => [ + [ + 'name' => 'QuotaId', + 'in' => 'path', + 'schema' => ['description' => 'Quota ID。', 'type' => 'string', 'required' => false, 'example' => 'quota-20210126170216-mtl37ge7gkvdz', 'title' => ''], ], [ - 'name' => 'HealthCount', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '健康的节点数', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'operation' => [ - 'title' => '可选值ge, gte, eq, lte, lt', - 'type' => 'string', - ], - 'value' => [ - 'type' => 'integer', - 'format' => 'int32', + 'Description' => ['description' => 'The description of the resource quota.', 'type' => 'string', 'required' => false, 'example' => 'this is a test quota', 'title' => ''], + 'Labels' => [ + 'description' => 'The list of user-defined labels. This is a full update.', + 'type' => 'array', + 'items' => ['description' => 'The user-defined label.', '$ref' => '#/components/schemas/Label', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'QueueStrategy' => ['description' => 'The queuing strategy for jobs in the quota.', 'type' => 'string', 'required' => false, 'example' => 'PaiStrategyIntelligent', 'title' => ''], + 'QuotaConfig' => ['description' => 'The resource quota configuration.', '$ref' => '#/components/schemas/QuotaConfig', 'required' => false, 'title' => '', 'example' => ''], + 'QuotaName' => ['description' => 'The resource quota name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'PropagateDefaultGPUDriver' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - ], - ], - [ - 'name' => 'LayoutMode', - 'in' => 'query', - 'schema' => [ - 'title' => '布局模式', - 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Nodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/Node', - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '96496E6E-00B4-5F55-80F6-1844FA9E92DC'], + 'QuotaId' => ['title' => '', 'description' => 'Quota ID。', 'type' => 'string', 'example' => 'quota-20210126170216-mtl37ge7gkvdz'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Nodes\\": [\\n {\\n \\"CreatorId\\": \\"\\",\\n \\"NodeName\\": \\"\\",\\n \\"NodeType\\": \\"\\",\\n \\"AcceleratorType\\": \\"\\",\\n \\"CPU\\": \\"\\",\\n \\"Memory\\": \\"\\",\\n \\"GPU\\": \\"\\",\\n \\"GPUType\\": \\"\\",\\n \\"GPUMemory\\": \\"\\",\\n \\"NodeStatus\\": \\"\\",\\n \\"ReasonCode\\": \\"\\",\\n \\"ReasonMessage\\": \\"\\",\\n \\"OrderStatus\\": \\"\\",\\n \\"ResourceGroupId\\": \\"\\",\\n \\"ResourceGroupName\\": \\"\\",\\n \\"MachineGroupId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"GmtExpiredTime\\": \\"\\",\\n \\"IsBound\\": true,\\n \\"BoundQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"RequestCPU\\": \\"\\",\\n \\"RequestMemory\\": \\"\\",\\n \\"RequestGPU\\": \\"\\",\\n \\"LimitCPU\\": \\"\\",\\n \\"LimitMemory\\": \\"\\",\\n \\"LimitGPU\\": \\"\\",\\n \\"PodNum\\": 0,\\n \\"WorkloadNum\\": 0,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"\\",\\n \\"UserName\\": \\"\\"\\n }\\n ],\\n \\"HyperZone\\": \\"\\",\\n \\"AvailabilityZone\\": \\"\\",\\n \\"AllocatableCPU\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCPU\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\",\\n \\"AncestorQuotaWorkloadNum\\": 0,\\n \\"SelfQuotaWorkloadNum\\": 0,\\n \\"DescendantQuotaWorkloadNum\\": 0,\\n \\"DiskPL\\": \\"\\",\\n \\"DiskCapacity\\": 0,\\n \\"SubNodes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]', - 'title' => 'ListNodes', - ], - 'GetSpotPriceHistory' => [ - 'summary' => '获取抢占式实例历史价格', - 'path' => '/api/v1/spots/{InstanceType}/pricehistory', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update resource quota configuration', + 'summary' => 'Updates the information of a resource quota.', + 'changeSet' => [ + ['createdAt' => '2024-05-23T02:06:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-06T05:44:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-13T06:59:20.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96496E6E-00B4-5F55-80F6-1844FA9E92DC\\",\\n \\"QuotaId\\": \\"quota-20210126170216-mtl37ge7gkvdz\\"\\n}","type":"json"}]', + ], + 'UpdateResourceGroup' => [ + 'summary' => 'Use UpdateResourceGroup to update resource group information.', + 'path' => '/api/v1/resources/{ResourceGroupID}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '213678', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - ], + 'abilityTreeCode' => '143268', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'InstanceType', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'UserVpc' => ['description' => 'Information about the VPC connected to the resource group.', '$ref' => '#/components/schemas/UserVpc', 'required' => false, 'title' => '', 'example' => ''], + 'Unbind' => ['description' => 'Whether to detach the resource group from the currently connected VPC.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The name of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'prophet', 'title' => ''], + 'Description' => ['description' => 'The description of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'test_new_havpn_tf', 'title' => ''], + ], 'required' => false, - 'example' => 'ml.gu7xf.8xlarge-gu108', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SpotDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'ResourceGroupID', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], ], - [ - 'name' => 'StartTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-26T09:36:46Z', + 'description' => 'Schema of Response', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7'], + 'ResourceGroupID' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-12-30T09:36:46Z', - ], + ], + 'title' => 'Update Resource Group', + 'changeSet' => [ + ['createdAt' => '2024-01-04T03:16:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-29T07:14:57.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceGroup'], ], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:UpdateResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateTrainingJobLabels' => [ + 'path' => '/api/v1/trainingjobs/{TrainingJobId}/labels', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'SortBy', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'GmtCreatedTime' => 'GmtCreatedTime', + 'description' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'description' => 'The list of labels.', + 'type' => 'array', + 'items' => [ + 'description' => 'A label.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'RootModelID', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'model-ad8cv770kl', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - 'example' => 'GmtCreatedTime', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'TrainingJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the training task.', 'type' => 'string', 'required' => true, 'example' => 'train76rcaupa2cz', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => 'asc', - 'desc' => 'desc', + 'description' => 'Response schema', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD', 'title' => ''], ], - 'example' => 'asc', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8BDA4440-DD3C-5F4B-BBDD-94A9CE1E75C7', - ], - 'SpotPriceHistory' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/SpotPriceItem', - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '194', - ], - ], - ], - ], + 'title' => 'Update Training Job Labels', + 'summary' => 'Updates the labels of a training task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTrainingJobLabels'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + ], + 'endpoints' => [ + ['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' => '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-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-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-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' => '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-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' => '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' => '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' => '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' => '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' => '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' => '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' => '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' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], + ], + 'createdAt' => '2025-11-25T06:20:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetQuota'], + ], + 'createdAt' => '2025-11-12T09:21:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateQuota'], + ['description' => 'Response parameters changed', 'api' => 'GetQuota'], + ['description' => 'Request parameters changed', 'api' => 'ListQuotas'], + ], + 'createdAt' => '2025-11-06T13:03:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListNodes'], + ], + 'createdAt' => '2025-11-04T03:55:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListNodes'], + ], + 'createdAt' => '2025-04-16T09:53:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListResourceGroupMachineGroups'], + ], + 'createdAt' => '2025-03-19T07:07:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListNodes'], + ], + 'createdAt' => '2025-03-13T10:38:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListQuotaWorkloads'], + ], + 'createdAt' => '2025-02-19T12:19:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], + ], + 'createdAt' => '2024-11-18T02:49:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobMetrics'], + ], + 'createdAt' => '2024-11-06T02:28:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ], + 'createdAt' => '2024-10-17T03:44:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteAlgorithmVersion'], + ], + 'createdAt' => '2024-09-25T02:19:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ], + 'createdAt' => '2024-09-23T07:12:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], + ], + 'createdAt' => '2024-08-07T03:10:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobInstanceMetrics'], + ], + 'createdAt' => '2024-08-06T02:04:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ], + 'createdAt' => '2024-07-19T02:50:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobOutputModels'], + ], + 'createdAt' => '2024-07-11T04:11:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobOutputModels'], + ], + 'createdAt' => '2024-07-11T03:59:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListQuotas'], + ], + 'createdAt' => '2024-07-04T13:23:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ], + 'createdAt' => '2024-07-03T03:12:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMachineGroup'], + ['description' => 'Request parameters changed', 'api' => 'ListResourceGroupMachineGroups'], + ], + 'createdAt' => '2024-05-23T02:15:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateQuota'], + ], + 'createdAt' => '2024-05-23T02:06:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ], + 'createdAt' => '2024-05-09T10:31:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetQuota'], + ], + 'createdAt' => '2024-05-09T05:27:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListQuotas'], + ], + 'createdAt' => '2024-05-09T02:33:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateQuota'], + ], + 'createdAt' => '2024-05-06T05:44:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListQuotas'], + ], + 'createdAt' => '2024-03-19T09:18:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2024-03-14T08:13:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BDA4440-DD3C-5F4B-BBDD-94A9CE1E75C7\\",\\n \\"SpotPriceHistory\\": [\\n {\\n \\"ZoneId\\": \\"cn-wulanchabu-a\\",\\n \\"InstanceType\\": \\"ml.gu8xf.8xlarge-gu108\\",\\n \\"SpotDiscount\\": 0.1,\\n \\"Timestamp\\": \\"2024-01-17T06:00:00Z\\"\\n }\\n ],\\n \\"TotalCount\\": 194\\n}","type":"json"}]', + 'createdAt' => '2024-02-29T07:28:02.000Z', + 'description' => '', ], - 'OperateNode' => [ - 'summary' => '您可以通过OperateNode对节点进行操作', - 'path' => '/api/v1/nodes/{NodeId}', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListQuotas'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-01-24T08:33:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateResourceGroup'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetResourceGroup'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetResourceGroupMachineGroup'], + ['description' => 'Request parameters changed', 'api' => 'UpdateResourceGroup'], + ], + 'createdAt' => '2024-01-04T03:16:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-12-26T10:28:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], ], - 'consumes' => [ - 'application/json', + 'createdAt' => '2023-12-15T03:13:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateQuota'], ], - 'produces' => [ - 'application/json', + 'createdAt' => '2023-12-13T06:59:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '216521', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', - 'FEATURElearnCMM1R7', - ], + 'createdAt' => '2023-12-07T04:21:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTrainingJobLogs'], ], - 'parameters' => [ - [ - 'name' => 'NodeId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'lingjunxxxx-mgxxx-xxxx', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rgaekzbrflewn6jjq', - ], - 'Operation' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Cordon', - 'enum' => [ - 'Cordon', - 'Uncordon', - 'Drain', - ], - ], - 'OperationParameters' => [ - 'title' => '节点操作参数配置'."\n", - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/NodeOperationParameters', - ], - ], - 'required' => false, - ], - ], + 'createdAt' => '2023-10-13T09:11:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '96496E6E-00B4-5F55-80F6-1844FA9E92DC', - ], - 'NodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'lingjunxxxx-mgxxx-xxxx', - ], - ], - ], - ], + 'createdAt' => '2023-10-09T06:51:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96496E6E-00B4-5F55-80F6-1844FA9E92DC\\",\\n \\"NodeId\\": \\"lingjunxxxx-mgxxx-xxxx\\"\\n}","type":"json"}]', + 'createdAt' => '2023-09-12T03:19:09.000Z', + 'description' => '', ], - ], - 'endpoints' => [ [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'pai.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], + ], + 'createdAt' => '2023-09-01T11:22:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMachineGroup'], + ['description' => 'Response parameters changed', 'api' => 'GetResourceGroupMachineGroup'], + ], + 'createdAt' => '2023-08-30T07:23:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ], + 'createdAt' => '2023-08-22T03:17:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ], + 'createdAt' => '2023-08-15T11:50:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAlgorithm'], + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetAlgorithm'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'ListAlgorithms'], + ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], + ['description' => 'Request parameters changed', 'api' => 'UpdateAlgorithm'], + ], + 'createdAt' => '2023-05-24T09:46:53.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'pai.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateResourceGroup'], + ['description' => 'Response parameters changed', 'api' => 'GetResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'ListResourceGroups'], + ], + 'createdAt' => '2023-05-11T03:07:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListResourceGroups'], + ], + 'createdAt' => '2023-04-26T12:57:03.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'pai.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'ListTrainingJobs'], + ], + 'createdAt' => '2023-04-20T02:19:58.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'pai.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetResourceGroup'], + ], + 'createdAt' => '2023-04-10T09:57:42.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'pai.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetResourceGroup'], + ], + 'createdAt' => '2023-04-06T05:56:48.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'pai.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'GetResourceGroup'], + ], + 'createdAt' => '2023-04-04T06:45:10.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'pai.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], + ], + 'createdAt' => '2022-12-06T12:13:04.000Z', + 'description' => 'Support Temporary Algorithm.', ], [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'pai.ap-southeast-3.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTrainingJobLogs'], + ], + 'createdAt' => '2022-12-05T12:21:21.000Z', + 'description' => 'Modify ListTrainingJobLogs.', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'pai.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTrainingJobs'], + ], + 'createdAt' => '2022-09-26T11:55:02.000Z', + 'description' => '修改OpenApi可见性', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'pai.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ], + 'createdAt' => '2022-09-24T14:00:23.000Z', + 'description' => 'Add Training Job Url.', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'pai.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ], + 'createdAt' => '2022-09-14T12:39:10.000Z', + 'description' => '增加出参Instances（job实例）', ], [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'pai.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ['description' => 'Response parameters changed', 'api' => 'GetTrainingJob'], + ], + 'createdAt' => '2022-09-14T12:28:39.000Z', + 'description' => '添加算法id参数', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'pai.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAlgorithms'], + ], + 'createdAt' => '2022-09-09T09:37:46.000Z', + 'description' => 'fix error.', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'pai.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetNodeMetrics'], + ], + 'createdAt' => '2022-09-02T14:39:22.000Z', + 'description' => 'd', ], [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'pai.ap-northeast-2.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetResourceGroup'], + ], + 'createdAt' => '2022-08-03T03:11:58.000Z', + 'description' => '更新超时threshold', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'pai.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetResourceGroupMachineGroup'], + ['description' => 'OpenAPI offline', 'api' => 'GetResourceGroupRequest'], + ['description' => 'OpenAPI offline', 'api' => 'GetResourceGroupTotal'], + ], + 'createdAt' => '2022-07-21T07:16:25.000Z', + 'description' => 'dashboard相关的API发布上线', ], [ - 'regionId' => 'us-southeast-1', - 'endpoint' => 'pai.us-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateResourceGroup'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateResourceGroup'], + ], + 'createdAt' => '2022-07-01T08:14:21.000Z', + 'description' => 'UpdateResourceGroup', ], [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'pai.ap-southeast-7.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAlgorithm'], + ['description' => 'OpenAPI offline', 'api' => 'CreateAlgorithmVersion'], + ['description' => 'OpenAPI offline', 'api' => 'CreateTrainingJob'], + ['description' => 'OpenAPI offline', 'api' => 'GetAlgorithm'], + ['description' => 'OpenAPI offline', 'api' => 'GetAlgorithmVersion'], + ['description' => 'OpenAPI offline', 'api' => 'ListAlgorithms'], + ['description' => 'OpenAPI offline', 'api' => 'ListAlgorithmVersions'], + ['description' => 'OpenAPI offline', 'api' => 'ListTrainingJobLogs'], + ['description' => 'OpenAPI offline', 'api' => 'ListTrainingJobMetrics'], + ], + 'createdAt' => '2022-04-27T11:13:17.000Z', + 'description' => 'PAI基于云原生推出了全新的算法训练服务，基于此API支持用户直接调用PAI提供的内置算法，创建训练任务、查看任务的详情、运行日志、算法的Metrics等', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'pai.me-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateResourceGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteMachineGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteResourceGroup'], + ['description' => 'OpenAPI offline', 'api' => 'GetMachineGroup'], + ['description' => 'OpenAPI offline', 'api' => 'GetResourceGroup'], + ['description' => 'OpenAPI offline', 'api' => 'GetResourceGroupMachineGroup'], + ['description' => 'OpenAPI offline', 'api' => 'ListResourceGroupMachineGroups'], + ], + 'createdAt' => '2022-02-25T03:44:54.000Z', + 'description' => 'resource service openAPI第一次上线', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobInstanceMetrics'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMachineGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTrainingJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAlgorithmVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAlgorithm'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrainingJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResourceGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTrainingJobLabels'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupTotal'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupMachineGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeMetrics'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithms'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupRequest'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobInstanceEvents'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJobLatestMetrics'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlgorithm'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobLogs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJobLabels'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroupMachineGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceGroupMachineGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserViewMetrics'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobMetrics'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAlgorithm'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithmVersions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithm'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobEvents'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAlgorithmVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlgorithmVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMachineGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJob'], + ], + ], + 'ram' => [ + 'productCode' => 'PaiStudio', + 'productName' => 'Platform for AI', + 'ramCodes' => ['pai', 'paidesigner', 'paiartlab'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ListQuotas', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListQuotas', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetResourceGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:GetResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ], + ], + ], + [ + 'apiName' => 'CreateAlgorithm', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:CreateAlgorithm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateResourceGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:CreateResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListResourceGroupMachineGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListResourceGroupMachineGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAlgorithmVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:GetAlgorithmVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetQuota', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:GetQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetResourceGroupMachineGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:GetResourceGroupMachineGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'MachineGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}/machinegroup/{#MachineGroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListAlgorithms', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListAlgorithms', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteQuota', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:DeleteQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAlgorithm', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:GetAlgorithm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAlgorithmVersion', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pai:DeleteAlgorithmVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListResourceGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListResourceGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteResourceGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pai:DeleteResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateResourceGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:UpdateResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateAlgorithmVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pai:UpdateAlgorithmVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAlgorithm', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pai:DeleteAlgorithm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateQuota', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:CreateQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ScaleQuota', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pai:ScaleQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAlgorithm', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pai:UpdateAlgorithm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAlgorithmVersions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListAlgorithmVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAlgorithmVersion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:CreateAlgorithmVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'], + ['validationType' => 'always', 'resourceType' => 'Quota', 'arn' => 'acs:paiplugin:{#regionId}:{#accountId}:quota/{#QuotaId}'], + ['validationType' => 'always', 'resourceType' => 'MachineGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}/machinegroup/{#MachineGroupId}'], + ['validationType' => 'always', 'resourceType' => 'Quota', 'arn' => 'acs:pai:{#regionId}:{#accountId}:quota'], ], ], ]; -- cgit v1.2.3