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/zh_cn/aiworkspace/2021-02-04/api-docs.php | 27928 ++++++++++------------- 1 file changed, 11935 insertions(+), 15993 deletions(-) (limited to 'data/zh_cn/aiworkspace/2021-02-04') diff --git a/data/zh_cn/aiworkspace/2021-02-04/api-docs.php b/data/zh_cn/aiworkspace/2021-02-04/api-docs.php index 8708938..b85ac7c 100644 --- a/data/zh_cn/aiworkspace/2021-02-04/api-docs.php +++ b/data/zh_cn/aiworkspace/2021-02-04/api-docs.php @@ -1,232 +1,104 @@ '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'AIWorkSpace', - 'version' => '2021-02-04', - ], + 'info' => ['style' => 'ROA', 'product' => 'AIWorkSpace', 'version' => '2021-02-04'], 'directories' => [ [ - 'id' => 385742, - 'title' => '实验', + 'children' => ['ListExperiment', 'SetExperimentLabels', 'DeleteExperimentLabel', 'CreateRun', 'UpdateRun', 'DeleteRun', 'DeleteRunLabel', 'LogRunMetrics', 'ListRunMetrics'], 'type' => 'directory', - 'children' => [ - 'CreateExperiment', - 'UpdateExperiment', - 'GetExperiment', - 'ListExperiment', - 'DeleteExperiment', - 'SetExperimentLabels', - 'DeleteExperimentLabel', - 'CreateRun', - 'UpdateRun', - 'GetRun', - 'ListRuns', - 'DeleteRun', - 'DeleteRunLabel', - 'LogRunMetrics', - 'ListRunMetrics', - ], + 'title' => '实验', + 'id' => 151155, ], [ - 'id' => 385758, - 'title' => '镜像', + 'children' => ['AddImageLabels', 'ListImageLabels', 'RemoveImageLabels', 'CreateImageBuild'], 'type' => 'directory', - 'children' => [ - 'AddImage', - 'AddImageLabels', - 'GetImage', - 'ListImageLabels', - 'ListImages', - 'RemoveImage', - 'PublishImage', - 'RemoveImageLabels', - 'CreateImageBuild', - ], + 'title' => '镜像', + 'id' => 151047, ], [ - 'id' => 385768, - 'title' => '工作空间', - 'type' => 'directory', 'children' => [ [ - 'id' => 385769, - 'title' => '权限', - 'type' => 'directory', - 'children' => [ - 'ListPermissions', - 'GetPermission', - ], - ], - [ - 'id' => 385772, - 'title' => '资源', + 'children' => ['ListPermissions', 'GetPermission'], 'type' => 'directory', - 'children' => [ - 'DeleteWorkspaceResource', - 'UpdateWorkspaceResource', - 'ListResources', - 'CreateWorkspaceResource', - ], + 'title' => '权限', + 'id' => 151061, ], [ - 'id' => 385777, - 'title' => '成员', + 'children' => ['DeleteWorkspaceResource', 'UpdateWorkspaceResource', 'CreateWorkspaceResource'], 'type' => 'directory', - 'children' => [ - 'AddMemberRole', - 'RemoveMemberRole', - 'DeleteMembers', - 'GetMember', - 'ListMembers', - 'CreateMember', - ], + 'title' => '资源', + 'id' => 151064, ], [ - 'id' => 385784, - 'title' => '配置', + 'children' => ['AddMemberRole', 'RemoveMemberRole', 'DeleteMembers', 'GetMember', 'CreateMember'], 'type' => 'directory', - 'children' => [ - 'UpdateConfigs', - 'GetConfig', - 'ListConfigs', - 'DeleteConfig', - 'UpdateConfig', - ], + 'title' => '成员', + 'id' => 151069, ], [ - 'id' => 385790, - 'title' => '工作空间', + 'children' => ['UpdateConfigs', 'ListConfigs'], 'type' => 'directory', - 'children' => [ - 'ListWorkspaces', - 'CreateWorkspace', - 'GetWorkspace', - 'DeleteWorkspace', - 'UpdateWorkspace', - ], + 'title' => '配置', + 'id' => 151076, ], 'GetDefaultWorkspace', 'UpdateDefaultWorkspace', 'ListWorkspaceUsers', - 'ListQuotas', ], + 'type' => 'directory', + 'title' => '工作空间', + 'id' => 151056, ], [ - 'id' => 385800, - 'title' => '数据集', - 'type' => 'directory', 'children' => [ [ - 'id' => 385801, - 'title' => '多模态检索', + 'children' => ['GetDatasetFileMetasStatistics', 'StopDatasetJob', 'GetDatasetJob', 'CreateDatasetFileMetas', 'UpdateDatasetJob', 'ListDatasetJobs', 'DeleteDatasetJobConfig', 'DeleteDatasetJob', 'UpdateDatasetJobConfig', 'UpdateDatasetFileMetas', 'ListDatasetJobConfigs', 'ListDatasetFileMetas', 'GetDatasetJobConfig', 'GetDatasetFileMeta', 'DeleteDatasetFileMetas', 'CreateDatasetJobConfig', 'CreateDatasetJob'], 'type' => 'directory', - 'children' => [ - 'GetDatasetFileMetasStatistics', - 'StopDatasetJob', - 'GetDatasetJob', - 'CreateDatasetFileMetas', - 'UpdateDatasetJob', - 'ListDatasetJobs', - 'DeleteDatasetJobConfig', - 'DeleteDatasetJob', - 'UpdateDatasetJobConfig', - 'UpdateDatasetFileMetas', - 'ListDatasetJobConfigs', - 'ListDatasetFileMetas', - 'GetDatasetJobConfig', - 'GetDatasetFileMeta', - 'DeleteDatasetFileMetas', - 'CreateDatasetJobConfig', - 'CreateDatasetJob', - ], - ], - 'CreateDataset', - 'GetDataset', - 'UpdateDataset', + 'title' => '多模态检索', + 'id' => 151104, + ], 'PublishDataset', - 'ListDatasets', - 'DeleteDataset', 'CreateDatasetLabels', 'DeleteDatasetLabels', - 'CreateDatasetVersion', - 'GetDatasetVersion', - 'ListDatasetVersions', - 'UpdateDatasetVersion', - 'DeleteDatasetVersion', - 'DeleteDatasetVersionLabels', 'DeleteDatasetVersionLabels', 'CreateDatasetVersionLabels', ], + 'type' => 'directory', + 'title' => '数据集', + 'id' => 151088, ], [ - 'id' => 385834, - 'title' => '连接', + 'children' => ['ValidateConnection'], 'type' => 'directory', - 'children' => [ - 'CreateConnection', - 'GetConnection', - 'UpdateConnection', - 'ListConnections', - 'DeleteConnection', - 'ValidateConnection', - ], + 'title' => '连接', + 'id' => 151175, ], [ - 'id' => 385841, - 'title' => '代码配置', + 'children' => ['CreateCodeSource', 'DeleteCodeSource', 'PublishCodeSource', 'UpdateCodeSource', 'GetCodeSource', 'ListCodeSources'], 'type' => 'directory', - 'children' => [ - 'CreateCodeSource', - 'DeleteCodeSource', - 'PublishCodeSource', - 'UpdateCodeSource', - 'GetCodeSource', - 'ListCodeSources', - ], + 'title' => '代码配置', + 'id' => 151127, ], [ - 'id' => 385848, - 'title' => '模型', + 'children' => ['UpdateModel', 'GetModel', 'ListModels', 'CreateModelVersion', 'UpdateModelVersion', 'GetModelVersion', 'ListModelVersions', 'DeleteModelVersion', 'CreateModelLabels', 'DeleteModelLabels', 'CreateModelVersionLabels', 'DeleteModelVersionLabels'], 'type' => 'directory', - 'children' => [ - 'CreateModel', - 'UpdateModel', - 'GetModel', - 'ListModels', - 'DeleteModel', - 'CreateModelVersion', - 'UpdateModelVersion', - 'GetModelVersion', - 'ListModelVersions', - 'DeleteModelVersion', - 'CreateModelLabels', - 'DeleteModelLabels', - 'CreateModelVersionLabels', - 'DeleteModelVersionLabels', - ], + 'title' => '模型', + 'id' => 151134, ], [ - 'id' => 385863, - 'title' => '用户配置', + 'children' => ['SetUserConfigs', 'DeleteUserConfig', 'ListUserConfigs'], 'type' => 'directory', - 'children' => [ - 'SetUserConfigs', - 'DeleteUserConfig', - 'ListUserConfigs', - ], + 'title' => '用户配置', + 'id' => 151171, ], [ - 'id' => 385867, - 'title' => '其他', - 'type' => 'directory', 'children' => [ - 'ListProducts', - 'CreateProductOrders', - 'AcceptDataworksEvent', - 'ChangeResourceGroup', - 'ListFeatures', + 'CreateProductOrders', 'AcceptDataworksEvent', 'CreateWorkspaceRole', 'DeleteWorkspaceRoles', 'GetInstanceJob', 'GetWorkspaceRole', 'UpdateWorkspaceRole', 'AddImage', 'ChangeResourceGroup', 'CreateConnection', 'CreateDataset', 'CreateDatasetVersion', 'CreateExperiment', 'CreateModel', 'CreateWorkspace', 'DeleteConfig', 'DeleteConnection', 'DeleteDataset', 'DeleteDatasetVersion', 'DeleteExperiment', + 'DeleteModel', 'DeleteWorkspace', 'GetConfig', 'GetConnection', 'GetDataset', 'GetDatasetVersion', 'GetExperiment', 'GetImage', 'GetRun', 'GetWorkspace', 'ListConnections', 'ListDatasetVersions', 'ListDatasets', 'ListFeatures', 'ListImages', 'ListMembers', 'ListProducts', 'ListQuotas', 'ListResources', 'ListRuns', + 'ListWorkspaceRoles', 'ListWorkspaces', 'PublishImage', 'RemoveImage', 'UpdateConfig', 'UpdateConnection', 'UpdateDataset', 'UpdateDatasetVersion', 'UpdateExperiment', 'UpdateWorkspace', ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 151149, ], ], 'components' => [ @@ -236,95 +108,29 @@ 'description' => '代码配置的结构体。', 'type' => 'object', 'properties' => [ - 'CodeSourceId' => [ - 'title' => '代码源ID', - 'description' => '代码配置ID。', - 'type' => 'string', - 'example' => 'code-202**********', - ], - 'DisplayName' => [ - 'title' => '代码源配置的名字', - 'description' => '代码源配置的名字。', - 'type' => 'string', - 'example' => 'MyCodeSourceName1', - ], - 'Description' => [ - 'title' => '代码源详细描述', - 'description' => '详细描述。', - 'type' => 'string', - 'example' => 'code source of dlc examples', - ], - 'CodeRepo' => [ - 'title' => '代码仓库地址', - 'description' => '代码仓库地址。', - 'type' => 'string', - 'example' => 'https://code.aliyun.com/****', - ], - 'CodeBranch' => [ - 'title' => '代码分支', - 'description' => '代码分支。', - 'type' => 'string', - 'example' => 'master', - ], - 'CodeCommit' => [ - 'title' => '代码Commit ID', - 'description' => '代码CommitID。', - 'type' => 'string', - 'example' => '44da10**********', - ], - 'CodeRepoUserName' => [ - 'title' => '访问代码仓库的用户名', - 'description' => '访问代码仓库的用户名。', - 'type' => 'string', - 'example' => 'user', - ], - 'CodeRepoAccessToken' => [ - 'title' => '访问代码仓库所用的AccessToken', - 'description' => '访问代码仓库所用的Token。', - 'type' => 'string', - ], + 'CodeSourceId' => ['title' => '代码源ID', 'description' => '代码配置ID。', 'type' => 'string', 'example' => 'code-202**********'], + 'DisplayName' => ['title' => '代码源配置的名字', 'description' => '代码源配置的名字。', 'type' => 'string', 'example' => 'MyCodeSourceName1'], + 'Description' => ['title' => '代码源详细描述', 'description' => '详细描述。', 'type' => 'string', 'example' => 'code source of dlc examples'], + 'CodeRepo' => ['title' => '代码仓库地址', 'description' => '代码仓库地址。', 'type' => 'string', 'example' => 'https://code.aliyun.com/****'], + 'CodeBranch' => ['title' => '代码分支', 'description' => '代码分支。', 'type' => 'string', 'example' => 'master'], + 'CodeCommit' => ['title' => '代码Commit ID', 'description' => '代码CommitID。', 'type' => 'string', 'example' => '44da10**********'], + 'CodeRepoUserName' => ['title' => '访问代码仓库的用户名', 'description' => '访问代码仓库的用户名。', 'type' => 'string', 'example' => 'user'], + 'CodeRepoAccessToken' => ['title' => '访问代码仓库所用的AccessToken', 'description' => '访问代码仓库所用的Token。', 'type' => 'string'], 'Accessibility' => [ 'title' => '表示代码是否是工作空间下公开的,可选值PRIVATE,PUBLIC', - 'description' => '代码配置可见性，可能值：'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', + 'description' => '代码配置可见性。', 'type' => 'string', - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], + 'enumValueTitles' => ['PUBLIC' => '在此工作空间中，对所有人可见', 'PRIVATE' => '在此工作空间中，仅对您和管理员可见'], 'example' => 'PUBLIC', ], - 'UserId' => [ - 'title' => '代码源配置的用户ID', - 'description' => '创建者ID。', - 'type' => 'string', - 'example' => '1157290171663117', - ], - 'WorkspaceId' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '1234', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-01-18T12:52:15Z', - ], - 'GmtModifyTime' => [ - 'title' => '修改时间', - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2021-01-18T12:52:15Z', - ], - 'MountPath' => [ - 'title' => '代码Mount路径', - 'description' => '代码的本地挂载路径。', - 'type' => 'string', - 'example' => '/root/code/', - ], + 'UserId' => ['title' => '代码源配置的用户ID', 'description' => '创建者ID。', 'type' => 'string', 'example' => '1157290171663117'], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '1234'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-01-18T12:52:15Z'], + 'GmtModifyTime' => ['title' => '修改时间', 'description' => '修改时间。', 'type' => 'string', 'example' => '2021-01-18T12:52:15Z'], + 'MountPath' => ['title' => '代码Mount路径', 'description' => '代码的本地挂载路径。', 'type' => 'string', 'example' => '/root/code/'], + 'CloneType' => ['description' => '克隆模式。取值如下：'."\n" + .'- 0：新建子目录。'."\n" + .'- 1：平铺到当前目录。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], 'Collection' => [ @@ -332,36 +138,11 @@ 'description' => 'A short description of struct', 'type' => 'object', 'properties' => [ - 'CollectionName' => [ - 'title' => 'Collection名称，全局唯一', - 'description' => 'Collection名称，全局唯一', - 'type' => 'string', - 'example' => 'AI4D', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35Z', - ], - 'GmtModifiedTime' => [ - 'title' => '最后更新时间', - 'description' => '最后更新时间', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35Z', - ], - 'UserId' => [ - 'title' => '创建Collection的用户ID', - 'description' => '创建Collection的用户ID', - 'type' => 'string', - 'example' => '155770209******', - ], - 'OwnerId' => [ - 'title' => '云账号ID', - 'description' => '云账号ID', - 'type' => 'string', - 'example' => '155770209******', - ], + 'CollectionName' => ['title' => 'Collection名称，全局唯一', 'description' => 'Collection名称，全局唯一', 'type' => 'string', 'example' => 'AI4D'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z'], + 'GmtModifiedTime' => ['title' => '最后更新时间', 'description' => '最后更新时间', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z'], + 'UserId' => ['title' => '创建Collection的用户ID', 'description' => '创建Collection的用户ID', 'type' => 'string', 'example' => '155770209******'], + 'OwnerId' => ['title' => '云账号ID', 'description' => '云账号ID', 'type' => 'string', 'example' => '155770209******'], ], ], 'Connection' => [ @@ -369,107 +150,45 @@ 'description' => '连接信息', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => 'description', - 'description' => '连接的描述信息。', - 'type' => 'string', - 'example' => 'This is a description of a database connection.', - ], - 'ConnectionType' => [ - 'title' => 'connection Type', - 'description' => '连接的类型。可选值：'."\n" - .'- DashScopeConnection：百炼服务连接。'."\n" - .'- OpenLLMConnection：开源模型连接。'."\n" - .'- MilvusConnection：Milvus连接。'."\n" - .'- OpenSearchConnection：OpenSearch连接。'."\n" - .'- LindormConnection：Lindorm连接。'."\n" - .'- ElasticsearchConnection：Elasticsearch连接。'."\n" - .'- HologresConnection：Hologres连接。'."\n" - .'- RDSConnection：RDS连接。'."\n" - .'- CustomConnection：自定义连接。', - 'type' => 'string', - 'example' => 'ElasticsearchConnection', - ], - 'Accessibility' => [ - 'title' => 'accessibility', - 'description' => '工作空间可见度。取值：'."\n" - .'- PRIVATE（默认值）：表示工作空间内自己以及管理员可见。'."\n" - .'- PUBLIC：工作空间所有用户可见。', - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'Secrets' => [ - 'description' => '需要加密的Key-Value配置。如数据库登录密码，模型连接的Key等。', - 'type' => 'object', - 'additionalProperties' => [ - 'description' => '加密连接配置的value值。', - 'type' => 'string', - 'example' => 'Dsjk***hsl01'."\n", - ], - ], - 'WorkspaceId' => [ - 'title' => 'workspace Id', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '228**', - ], - 'Creator' => [ - 'title' => 'creator', - 'description' => '连接的创建者。', - 'type' => 'string', - 'example' => '20925961****557803', - ], + 'ConnectionType' => ['title' => 'connection Type', 'description' => '连接的类型。可选值：'."\n" + .'- DashScopeConnection：百炼服务连接。'."\n" + .'- OpenLLMConnection：开源模型连接。'."\n" + .'- MilvusConnection：Milvus连接。'."\n" + .'- OpenSearchConnection：OpenSearch连接。'."\n" + .'- LindormConnection：Lindorm连接。'."\n" + .'- ElasticsearchConnection：Elasticsearch连接。'."\n" + .'- HologresConnection：Hologres连接。'."\n" + .'- RDSConnection：RDS连接。'."\n" + .'- CustomConnection：自定义连接。', 'type' => 'string', 'example' => 'ElasticsearchConnection'], + 'Description' => ['title' => 'description', 'description' => '连接的描述信息。', 'type' => 'string', 'example' => 'This is a description of a database connection.'], + 'Accessibility' => ['title' => 'accessibility', 'description' => '工作空间可见度。取值：'."\n" + .'- PRIVATE（默认值）：表示工作空间内自己以及管理员可见。'."\n" + .'- PUBLIC：工作空间所有用户可见。', 'type' => 'string', 'example' => 'PRIVATE'], + 'WorkspaceId' => ['title' => 'workspace Id', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '228**'], + 'Creator' => ['title' => 'creator', 'description' => '连接的创建者。', 'type' => 'string', 'example' => '20925961****557803'], 'ResourceMeta' => [ 'title' => 'resource meta', 'description' => '连接的资源信息。一般适用于数据库类型的连接配置。', 'type' => 'object', 'properties' => [ - 'InstanceName' => [ - 'title' => 'instance name', - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'lindorm-xxxxxxx', - ], - 'Extra' => [ - 'title' => 'extra resource info', - 'description' => '额外配置信息。', - 'type' => 'string', - 'example' => '{"vpcId":"vpc-xxxx"}', - ], - 'InstanceId' => [ - 'title' => 'instanceId', - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ld-2vc1***v1zaqgzol', - ], + 'InstanceName' => ['title' => 'instance name', 'description' => '实例名称。', 'type' => 'string', 'example' => 'lindorm-xxxxxxx'], + 'InstanceId' => ['title' => 'instanceId', 'description' => '实例ID。', 'type' => 'string', 'example' => 'ld-2vc1***v1zaqgzol'], + 'Extra' => ['title' => 'extra resource info', 'description' => '额外配置信息。', 'type' => 'string', 'example' => '{"vpcId":"vpc-xxxx"}'], ], ], - 'GmtModifiedTime' => [ - 'title' => 'gmtModifiedTime', - 'description' => '修改连接的UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2025-03-07T07:54:56Z'."\n", - ], - 'ConnectionName' => [ - 'title' => 'connection name', - 'description' => '连接的名称。', - 'type' => 'string', - 'example' => 'lindorm-connection', - ], - 'ConnectionId' => [ - 'title' => 'connection Id', - 'description' => '连接ID。', - 'type' => 'string', - 'example' => 'conn-pai9m***mi47', + 'GmtModifiedTime' => ['title' => 'gmtModifiedTime', 'description' => '修改连接的UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2025-03-07T07:54:56Z'."\n"], + 'ConnectionName' => ['title' => 'connection name', 'description' => '连接的名称。', 'type' => 'string', 'example' => 'lindorm-connection'], + 'ConnectionId' => ['title' => 'connection Id', 'description' => '连接ID。', 'type' => 'string', 'example' => 'conn-pai9m***mi47'], + 'GmtCreateTime' => ['title' => 'gmtCreateTime', 'description' => '修改连接的UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2025-03-07T07:54:56Z'."\n"], + 'Secrets' => [ + 'description' => '需要加密的Key-Value配置。如数据库登录密码，模型连接的Key等。', + 'type' => 'object', + 'additionalProperties' => ['description' => '加密连接配置的value值。', 'type' => 'string', 'example' => 'Dsjk***hsl01'."\n"], ], 'Configs' => [ 'description' => '连接的配置信息。', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '连接配置的value值。', - 'type' => 'string', - 'example' => '12345', - ], + 'additionalProperties' => ['description' => '连接配置的value值。', 'type' => 'string', 'example' => '12345'], ], 'Models' => [ 'title' => 'model', @@ -479,44 +198,18 @@ 'description' => '模型。', 'type' => 'object', 'properties' => [ - 'ToolCall' => [ - 'title' => 'tool call', - 'description' => '是否支持ToolCall工具调用。可取值：'."\n" - .'- true：支持'."\n" - .'- false：不支持', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Model' => [ - 'title' => 'model', - 'description' => '模型标识符。', - 'type' => 'string', - 'example' => 'model_001', - ], - 'DisplayName' => [ - 'title' => 'display name', - 'description' => '模型的展示名称。', - 'type' => 'string', - 'example' => 'BGE model deploy.', - ], - 'ModelType' => [ - 'title' => 'model type', - 'description' => '模型类型，取值为：'."\n" - .'- LLM（大语言模型）'."\n" - .'- Embedding（Embedding模型）'."\n" - .'- ReRank（ReRank模型）', - 'type' => 'string', - 'example' => 'LLM', - ], + 'Model' => ['title' => 'model', 'description' => '模型标识符。', 'type' => 'string', 'example' => 'model_001'], + 'DisplayName' => ['title' => 'display name', 'description' => '模型的展示名称。', 'type' => 'string', 'example' => 'BGE model deploy.'], + 'ModelType' => ['title' => 'model type', 'description' => '模型类型，取值为：'."\n" + .'- LLM（大语言模型）'."\n" + .'- Embedding（Embedding模型）'."\n" + .'- ReRank（ReRank模型）', 'type' => 'string', 'example' => 'LLM'], + 'ToolCall' => ['title' => 'tool call', 'description' => '是否支持ToolCall工具调用。可取值：'."\n" + .'- true：支持'."\n" + .'- false：不支持', 'type' => 'boolean', 'example' => 'true'], ], ], ], - 'GmtCreateTime' => [ - 'title' => 'gmtCreateTime', - 'description' => '修改连接的UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2025-03-07T07:54:56Z'."\n", - ], ], ], 'Dataset' => [ @@ -524,72 +217,34 @@ 'description' => '数据集属性', 'type' => 'object', 'properties' => [ - 'DatasetId' => [ - 'title' => 'Dataset Id', - 'description' => '数据集ID。', - 'type' => 'string', - 'example' => 'd-c0h44g3****j8o4348', - ], - 'UserId' => [ - 'title' => 'User Id', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '2485765****023475', - ], - 'OwnerId' => [ - 'title' => 'Owner Id', - 'description' => '主账户ID。', - 'type' => 'string', - 'example' => '1631044****3440', - ], - 'Name' => [ - 'title' => 'Name', - 'description' => '数据集名称。', - 'type' => 'string', - 'example' => 'myName', - ], + 'DatasetId' => ['title' => 'Dataset Id', 'description' => '数据集ID。', 'type' => 'string', 'example' => 'd-c0h44g3****j8o4348'], + 'UserId' => ['title' => 'User Id', 'description' => '用户ID。', 'type' => 'string', 'example' => '2485765****023475'], + 'OwnerId' => ['title' => 'Owner Id', 'description' => '主账户ID。', 'type' => 'string', 'example' => '1631044****3440'], + 'Name' => ['title' => 'Name', 'description' => '数据集名称。', 'type' => 'string', 'example' => 'myName'], 'DataSourceType' => [ 'title' => 'DataSourceType', 'description' => '数据源类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'NAS' => 'NAS', - 'OSS' => 'OSS', - ], + 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], 'example' => 'NAS', ], - 'Uri' => [ - 'title' => 'Uri', - 'description' => 'Uri样例：'."\n" - ."\n" - .'- 数据源类型为OSS：'."\n" - .'`oss://bucket.endpoint/object`'."\n" - ."\n" - .'- 数据源类型为通用型NAS：'."\n" - .'`nas://.region/subpath/to/dir/`'."\n" - ."\n" - .'- 数据源类型为CPFS1.0：'."\n" - .'`nas://.region/subpath/to/dir/`'."\n" - ."\n" - .'- 数据源类型为CPFS2.0：'."\n" - .'`nas://.region//`'."\n" - ."\n" - .'> CPFS1.0和CPFS2.0根据fsid的格式来区分：CPFS1.0格式为cpfs-<8位ascii字符>，CPFS2.0格式为cpfs-<16为ascii字符>。', - 'type' => 'string', - 'example' => 'nas://09f****f2.cn-hangzhou/', - ], - 'GmtCreateTime' => [ - 'title' => 'GmtCreateTime', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'GmtModifiedTime' => [ - 'title' => 'GmtModifiedTime', - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], + 'Uri' => ['title' => 'Uri', 'description' => 'Uri样例：'."\n" + ."\n" + .'- 数据源类型为OSS：'."\n" + .'`oss://bucket.endpoint/object`'."\n" + ."\n" + .'- 数据源类型为通用型NAS：'."\n" + .'`nas://.region/subpath/to/dir/`'."\n" + ."\n" + .'- 数据源类型为CPFS1.0：'."\n" + .'`nas://.region/subpath/to/dir/`'."\n" + ."\n" + .'- 数据源类型为CPFS2.0：'."\n" + .'`nas://.region//`'."\n" + ."\n" + .'> CPFS1.0和CPFS2.0根据fsid的格式来区分：CPFS1.0格式为cpfs-<8位ascii字符>，CPFS2.0格式为cpfs-<16为ascii字符>。', 'type' => 'string', 'example' => 'nas://09f****f2.cn-hangzhou/'], + 'GmtCreateTime' => ['title' => 'GmtCreateTime', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'GmtModifiedTime' => ['title' => 'GmtModifiedTime', 'description' => '更新时间。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'DataType' => [ 'title' => 'DataType', 'description' => '数据集的数据类型。取值：'."\n" @@ -600,13 +255,7 @@ .'- VIDEO：视频。'."\n" .'- AUDIO：音频。', 'type' => 'string', - 'enumValueTitles' => [ - 'VIDEO' => 'VIDEO', - 'COMMON' => 'COMMON', - 'TEXT' => 'TEXT', - 'PIC' => 'PIC', - 'AUDIO' => 'AUDIO', - ], + 'enumValueTitles' => ['VIDEO' => 'VIDEO', 'COMMON' => 'COMMON', 'TEXT' => 'TEXT', 'PIC' => 'PIC', 'AUDIO' => 'AUDIO'], 'example' => 'COMMON', ], 'Property' => [ @@ -616,177 +265,83 @@ .'- FILE：文件。'."\n" .'- DIRECTORY：文件夹。', 'type' => 'string', - 'enumValueTitles' => [ - 'DIRECTORY' => 'DIRECTORY', - 'FILE' => 'FILE', - ], + 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], 'example' => 'DIRECTORY', ], 'SourceType' => [ 'title' => 'SourceType', 'description' => '来源类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', - 'ITAG' => 'ITAG', - 'USER' => 'USER', - ], + 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], 'example' => 'USER', ], - 'SourceId' => [ - 'title' => 'SourceId', - 'description' => '来源ID。', - 'type' => 'string', - 'example' => 'jdnhf***fnrimv', - ], - 'Description' => [ - 'title' => 'Description', - 'description' => '数据集的描述。', - 'type' => 'string', - 'example' => 'This is a description of a dataset.', - ], - 'WorkspaceId' => [ - 'title' => 'WorkspaceId', - 'description' => '数据集所在工作空间ID。', - 'type' => 'string', - 'example' => '478**', - ], - 'Options' => [ - 'title' => 'Options', - 'description' => '扩展字段（选项），JsonString类型。'."\n" - .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', - 'type' => 'string', - 'example' => '{'."\n" - .' "mountPath": "/mnt/data/"'."\n" - .'}', - ], + 'SourceId' => ['title' => 'SourceId', 'description' => '来源ID。', 'type' => 'string', 'example' => 'jdnhf***fnrimv'], + 'Description' => ['title' => 'Description', 'description' => '数据集的描述。', 'type' => 'string', 'example' => 'This is a description of a dataset.'], + 'WorkspaceId' => ['title' => 'WorkspaceId', 'description' => '数据集所在工作空间ID。', 'type' => 'string', 'example' => '478**'], + 'Options' => ['title' => 'Options', 'description' => '扩展字段（选项），JsonString类型。'."\n" + .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', 'type' => 'string', 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}'], 'Accessibility' => [ 'title' => 'Accessibility', 'description' => '工作空间可见度。取值：'."\n" - .'- PRIVATE（默认值）：表示工作空间内自己以及管理员可见。'."\n" - .'- PUBLIC：工作空间所有用户可见。', + .'- PRIVATE：仅数据集所有者及管理员可见'."\n" + .'- PUBLIC：工作空间全体成员可见'."\n" + .'- ROLE_PUBLIC: 指定工作空间角色可见，角色列表参考：AccessibleRoleIdList。该条件下数据集所有者及管理员始终具备可见性。', 'type' => 'string', - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'example' => 'PRIVATE', ], - 'ProviderType' => [ - 'title' => 'ProviderType', - 'description' => '数据集的数据源来源类型。取值：'."\n" - .'- Ecs（默认值）'."\n" - .'- Lingjun', - 'type' => 'string', - 'example' => 'Ecs', - ], - 'SourceDatasetId' => [ - 'title' => 'SourceDatasetId', - 'description' => '标注数据集的来源数据集ID。', - 'type' => 'string', - 'example' => 'd-bvfasdfxxxxj8o411', - ], - 'SourceDatasetVersion' => [ - 'title' => 'SourceDatasetVersion', - 'description' => '标注数据集的来源数据集版本。', - 'type' => 'string', - 'example' => 'v2', - ], - 'TagTemplateType' => [ - 'title' => 'TagTemplateType', - 'description' => 'iTAG标注数据集的标注模板。', - 'type' => 'string', - 'example' => 'text-classification', - ], - 'LatestVersion' => [ - 'title' => 'LatestVersion', - 'description' => '数据集的最新版本信息。', - '$ref' => '#/components/schemas/DatasetVersion', - ], - 'MountAccess' => [ - 'title' => 'MountAccess', - 'description' => 'MountAccess', - 'type' => 'string', - 'example' => 'RO RW', - ], - 'ImportInfo' => [ - 'title' => 'ImportInfo', - 'description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" - ."\n" - .'
'."\n" - .'OSS'."\n" - .'{'."\n" - .'"region": "${region}",//地域ID'."\n" - .'"bucket": "${bucket}",//bucket名称'."\n" - .'"path": "${path}" //文件路径'."\n" - .'}'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'NAS'."\n" - ."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'CPFS'."\n" - .'区块内容'."\n" - .'
'."\n" - ."\n\n" - .'
'."\n" - .'智算CPFS'."\n" - .'区块内容'."\n" - .'
', - 'type' => 'string', - 'example' => '{'."\n" - .' "region": "cn-wulanchabu",'."\n" - .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" - .' "path": "/mnt",'."\n" - .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" - .' "isVpcMount": true'."\n" - .'}', - ], - 'Edition' => [ - 'title' => 'Edition', - 'description' => '数据集类型。枚举值：'."\n" - ."\n" - .'BASIC：基础型。不支持数据集文件元数据管理。'."\n" - .'ADVANCED：高级型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。', - 'type' => 'string', - 'example' => 'BASIC', - ], - 'Labels' => [ - 'title' => 'Labels', - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'example' => '{"Key": "env", "Value": "test"}', - '$ref' => '#/components/schemas/Label', - ], - ], - 'MountAccessReadWriteRoleIdList' => [ - 'title' => 'MountAccessReadWriteRoleIdList', - 'description' => '具有该数据集读写权限的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。', - 'type' => 'array', - 'items' => [ - 'description' => '工作空间角色ID。', - 'type' => 'string', - 'example' => 'PAI.AlgoOperator', - ], - ], + 'ProviderType' => ['title' => 'ProviderType', 'description' => '数据集的数据源来源类型。取值：'."\n" + .'- Ecs（默认值）'."\n" + .'- Lingjun', 'type' => 'string', 'example' => 'Ecs'], + 'SourceDatasetId' => ['title' => 'SourceDatasetId', 'description' => '标注数据集的来源数据集ID。', 'type' => 'string', 'example' => 'd-bvfasdfxxxxj8o411'], + 'SourceDatasetVersion' => ['title' => 'SourceDatasetVersion', 'description' => '标注数据集的来源数据集版本。', 'type' => 'string', 'example' => 'v2'], + 'TagTemplateType' => ['title' => 'TagTemplateType', 'description' => 'iTAG标注数据集的标注模板。', 'type' => 'string', 'example' => 'text-classification'], + 'LatestVersion' => ['title' => 'LatestVersion', 'description' => '数据集的最新版本信息。', '$ref' => '#/components/schemas/DatasetVersion'], + 'MountAccess' => ['title' => 'MountAccess', 'description' => 'MountAccess', 'type' => 'string', 'example' => 'RO RW'], + 'ImportInfo' => ['title' => 'ImportInfo', 'description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" + ."\n" + .'
'."\n" + .'OSS'."\n" + .'{'."\n" + .'"region": "${region}",//地域ID'."\n" + .'"bucket": "${bucket}",//bucket名称'."\n" + .'"path": "${path}" //文件路径'."\n" + .'}'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'NAS'."\n" + ."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'CPFS'."\n" + .'区块内容'."\n" + .'
'."\n" + ."\n\n" + .'
'."\n" + .'智算CPFS'."\n" + .'区块内容'."\n" + .'
', 'type' => 'string', 'example' => '{'."\n" + .' "region": "cn-wulanchabu",'."\n" + .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" + .' "path": "/mnt",'."\n" + .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" + .' "isVpcMount": true'."\n" + .'}'], + 'Edition' => ['title' => 'Edition', 'description' => '数据集类型。枚举值：'."\n" + ."\n" + .'BASIC：基础型。不支持数据集文件元数据管理。'."\n" + .'ADVANCED：高级型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。', 'type' => 'string', 'example' => 'BASIC'], 'IsShared' => [ 'description' => '是否为共享数据集。', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'false', ], - 'SharedFrom' => [ - 'description' => '描述该分享数据集的来源关系。仅IsShared为true时有效。', - '$ref' => '#/components/schemas/DatasetShareRelationship', - ], + 'SharedFrom' => ['description' => '描述该分享数据集的来源关系。仅IsShared为true时有效。', '$ref' => '#/components/schemas/DatasetShareRelationship'], 'SharingConfig' => [ 'description' => '当前数据集的分享配置信息。', 'type' => 'object', @@ -794,13 +349,27 @@ 'SharedTo' => [ 'description' => '多条分享配置关系。', 'type' => 'array', - 'items' => [ - 'description' => '该数据集被分享的分享配置关系。', - '$ref' => '#/components/schemas/DatasetShareRelationship', - ], + 'items' => ['description' => '该数据集被分享的分享配置关系。', '$ref' => '#/components/schemas/DatasetShareRelationship'], ], ], ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。', 'example' => '{"Key": "env", "Value": "test"}', '$ref' => '#/components/schemas/Label'], + ], + 'MountAccessReadWriteRoleIdList' => [ + 'title' => 'MountAccessReadWriteRoleIdList', + 'description' => '具有该数据集读写权限的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。', + 'type' => 'array', + 'items' => ['description' => '工作空间角色ID。', 'type' => 'string', 'example' => 'PAI.AlgoOperator'], + ], + 'AccessibleRoleIdList' => [ + 'description' => '在Accessibility为ROLE_PUBLIC时生效。该数据集可见的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。', + 'type' => 'array', + 'items' => ['description' => '工作空间角色ID。', 'type' => 'string', 'example' => 'PAI.AlgoOperator'], + ], ], ], 'DatasetFileMeta' => [ @@ -808,153 +377,62 @@ 'description' => '数据集文件元数据详情。', 'type' => 'object', 'properties' => [ - 'DatasetFileMetaId' => [ - 'title' => 'Dataset FileMeta Id', - 'description' => '数据集文件元数据ID。', - 'type' => 'string', - 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6', - ], - 'Uri' => [ - 'title' => 'Uri', - 'description' => '文件唯一URI。用于记录文件唯一路径。支持OSS、NAS下的文件路径。'."\n" - .'
'."\n" - .'OSS'."\n" - .'oss://${bucket}/${path}'."\n" - .'
'."\n" - .'
'."\n" - .'NAS'."\n" - .'nas://${fileSystemId}/${path}'."\n" - .'
', - 'type' => 'string', - 'example' => 'oss://test-bucket/dataset/cat.png', - ], - 'FileName' => [ - 'title' => 'File Name', - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'cat.png', - ], - 'DownloadUrl' => [ - 'title' => 'Download Url', - 'description' => '文件的下载地址。', - 'type' => 'string', - 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D', - ], - 'Score' => [ - 'title' => 'Score', - 'description' => '相似度得分。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6', - ], - 'DataSize' => [ - 'title' => 'Size', - 'description' => '文件大小，字节。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120000', - ], - 'FileFingerPrint' => [ - 'title' => 'FileFingerPrint', - 'description' => '文件指纹值。用于确定文件内容的唯一性，文件内容修改后该值会发生变化。OSS文件使用ETag，NAS文件使用MD5值。', - 'type' => 'string', - 'example' => 'D41D8CD98F*****E9800998ECF8'."\n", - ], - 'FileUpdateTime' => [ - 'title' => '文件修改时间，格式：ISO8601格式', - 'description' => '文件最后修改时间。ISO8601格式UTC时间戳。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-01-12T14:36:01Z', - ], - 'Tags' => [ - 'title' => '标签组(json格式)', - 'description' => '该元数据的标签合集，JSON String格式。包括：'."\n" - .'- 算法标签组：'."\n" - .' - ai: 对单个元数据，全部的算法打标任务汇总后的标签名列表。'."\n" - .'- 用户自定义标签组：'."\n" - .' - user: 对单个元数据，用户自行添加的标签名列表。'."\n" - .' - user-delete-ai-tags: 对单个元数据，算法标签组中用户需要删除的标签名列表。', - 'type' => 'string', - 'example' => '{'."\n" - .' "ai":'."\n" - .' ['."\n" - .' "Lane line",'."\n" - .' "Water horse",'."\n" - .' "Sunny day"'."\n" - .' ],'."\n" - .' "user":'."\n" - .' ['."\n" - .' "Everett",'."\n" - .' "Intelligent driving Dataset 1",'."\n" - .' "Cloudy day"'."\n" - .' ],'."\n" - .' "user-delete-ai-tags":'."\n" - .' ['."\n" - .' "Sunny day"'."\n" - .' ]'."\n" - .'}', - ], - 'ThumbnailUrl' => [ - 'title' => 'Thumbnail Url', - 'description' => '缩略图地址。', - 'type' => 'string', - 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D', - ], - 'MetaAttributes' => [ - 'title' => '基础元数据属性，格式为json string', - 'description' => '文件的特定元数据。例如图片宽高信息，视频文件的码率分辨率信息等。暂不具备检索能力。JSON String格式。', - 'type' => 'string', - 'example' => '{ "ImageHeight": 400, "ImageWidth": 800 }', - ], - 'SemanticIndexJobId' => [ - 'title' => '语义索引构建的任务ID', - 'description' => '语义索引最后一次构建的任务ID。', - 'type' => 'string', - 'example' => 'dsjob-klfwtjto****scvt3', - ], - 'SemanticIndexUpdateTime' => [ - 'title' => '语义索引构建的时间', - 'description' => '语义索引最后更新时间。ISO8601格式UTC时间戳。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2021-01-12T14:36:01.000Z', - ], - 'FileCreateTime' => [ - 'title' => '文件创建时间，格式：ISO8601格式', - 'description' => '文件创建时间。ISO8601格式UTC时间戳。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2021-01-12T14:36:01.000Z', - ], + 'DatasetFileMetaId' => ['title' => 'Dataset FileMeta Id', 'description' => '数据集文件元数据ID。', 'type' => 'string', 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'], + 'Uri' => ['title' => 'Uri', 'description' => '文件唯一URI。用于记录文件唯一路径。支持OSS、NAS下的文件路径。'."\n" + .'
'."\n" + .'OSS'."\n" + .'oss://${bucket}/${path}'."\n" + .'
'."\n" + .'
'."\n" + .'NAS'."\n" + .'nas://${fileSystemId}/${path}'."\n" + .'
', 'type' => 'string', 'example' => 'oss://test-bucket/dataset/cat.png'], + 'FileName' => ['title' => 'File Name', 'description' => '文件名。', 'type' => 'string', 'example' => 'cat.png'], + 'DownloadUrl' => ['title' => 'Download Url', 'description' => '文件的下载地址。', 'type' => 'string', 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D'], + 'Score' => ['title' => 'Score', 'description' => '相似度得分。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'], + 'DataSize' => ['title' => 'Size', 'description' => '文件大小，字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '120000'], + 'FileFingerPrint' => ['title' => 'FileFingerPrint', 'description' => '文件指纹值。用于确定文件内容的唯一性，文件内容修改后该值会发生变化。OSS文件使用ETag，NAS文件使用MD5值。', 'type' => 'string', 'example' => 'D41D8CD98F*****E9800998ECF8'."\n"], + 'FileUpdateTime' => ['title' => '文件修改时间，格式：ISO8601格式', 'description' => '文件最后修改时间。ISO8601格式UTC时间戳。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01Z'], + 'Tags' => ['title' => '标签组(json格式)', 'description' => '该元数据的标签合集，JSON String格式。包括：'."\n" + .'- 算法标签组：'."\n" + .' - ai: 对单个元数据，全部的算法打标任务汇总后的标签名列表。'."\n" + .'- 用户自定义标签组：'."\n" + .' - user: 对单个元数据，用户自行添加的标签名列表。'."\n" + .' - user-delete-ai-tags: 对单个元数据，算法标签组中用户需要删除的标签名列表。', 'type' => 'string', 'example' => '{'."\n" + .' "ai":'."\n" + .' ['."\n" + .' "Lane line",'."\n" + .' "Water horse",'."\n" + .' "Sunny day"'."\n" + .' ],'."\n" + .' "user":'."\n" + .' ['."\n" + .' "Everett",'."\n" + .' "Intelligent driving Dataset 1",'."\n" + .' "Cloudy day"'."\n" + .' ],'."\n" + .' "user-delete-ai-tags":'."\n" + .' ['."\n" + .' "Sunny day"'."\n" + .' ]'."\n" + .'}'], + 'ThumbnailUrl' => ['title' => 'Thumbnail Url', 'description' => '缩略图地址。', 'type' => 'string', 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D'], + 'MetaAttributes' => ['title' => '基础元数据属性，格式为json string', 'description' => '文件的特定元数据。例如图片宽高信息，视频文件的码率分辨率信息等。暂不具备检索能力。JSON String格式。', 'type' => 'string', 'example' => '{ "ImageHeight": 400, "ImageWidth": 800 }'], + 'SemanticIndexJobId' => ['title' => '语义索引构建的任务ID', 'description' => '语义索引最后一次构建的任务ID。', 'type' => 'string', 'example' => 'dsjob-klfwtjto****scvt3'], + 'SemanticIndexUpdateTime' => ['title' => '语义索引构建的时间', 'description' => '语义索引最后更新时间。ISO8601格式UTC时间戳。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z'], + 'FileCreateTime' => ['title' => '文件创建时间，格式：ISO8601格式', 'description' => '文件创建时间。ISO8601格式UTC时间戳。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z'], 'FileType' => [ 'title' => '文件类型', 'description' => '文件类型。与 MIME Type 相同。', 'type' => 'string', - 'enumValueTitles' => [ - 'image' => 'image', - 'application' => 'application', - 'video' => 'video', - 'audio' => 'audio', - 'text' => 'text', - ], + 'enumValueTitles' => ['image' => 'image', 'application' => 'application', 'video' => 'video', 'audio' => 'audio', 'text' => 'text'], 'example' => 'image', ], 'ContentType' => [ 'title' => '文件的MIME Type', 'description' => '文件的 MIME 类型。包含 Type 和 SubType。', 'type' => 'string', - 'enumValueTitles' => [ - 'image/png' => 'image/png', - 'image/jpeg' => 'image/jpeg', - 'image/tiff' => 'image/tiff', - 'image/bmp' => 'image/bmp', - 'image/gif' => 'image/gif', - 'image/x-icon' => 'image/x-icon', - 'image/svg+xml' => 'image/svg+xml', - 'image/webp' => 'image/webp', - 'image/heic ' => 'image/heic ', - ], + 'enumValueTitles' => ['image/png' => 'image/png', 'image/jpeg' => 'image/jpeg', 'image/tiff' => 'image/tiff', 'image/bmp' => 'image/bmp', 'image/gif' => 'image/gif', 'image/x-icon' => 'image/x-icon', 'image/svg+xml' => 'image/svg+xml', 'image/webp' => 'image/webp', 'image/heic ' => 'image/heic '], 'example' => 'image/jpeg', ], 'Status' => [ @@ -963,10 +441,7 @@ .'* DELETED：已被删除', 'type' => 'string', 'example' => 'ACTIVE', - 'enum' => [ - 'ACTIVE', - 'DELETED', - ], + 'enum' => ['ACTIVE', 'DELETED'], ], ], ], @@ -975,53 +450,17 @@ 'description' => '待更新的文件元数据详情。', 'type' => 'object', 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => '文件名。', - 'type' => 'string', - 'required' => false, - 'example' => '00001.jpeg'."\n", - ], - 'Comment' => [ - 'title' => '注释', - 'description' => '文件注释。', - 'type' => 'string', - 'example' => 'The first image file in the dataset.', - ], - 'FileCreateTime' => [ - 'title' => '创建时间，格式：ISO8601格式', - 'description' => '文件创建时间，格式：ISO8601格式。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-01-12T14:36:01.001Z'."\n", - ], - 'FileUpdateTime' => [ - 'title' => '修改时间，格式：ISO8601格式', - 'description' => '文件最后修改时间，格式：ISO8601格式。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-01-12T14:36:01.001Z'."\n", - ], - 'DataSize' => [ - 'title' => '文件大小，字节', - 'description' => '文件大小，字节。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], + 'FileName' => ['title' => '文件名', 'description' => '文件名。', 'type' => 'string', 'required' => false, 'example' => '00001.jpeg'."\n"], + 'Comment' => ['title' => '注释', 'description' => '文件注释。', 'type' => 'string', 'example' => 'The first image file in the dataset.'], + 'FileCreateTime' => ['title' => '创建时间，格式：ISO8601格式', 'description' => '文件创建时间，格式：ISO8601格式。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01.001Z'."\n"], + 'FileUpdateTime' => ['title' => '修改时间，格式：ISO8601格式', 'description' => '文件最后修改时间，格式：ISO8601格式。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01.001Z'."\n"], + 'DataSize' => ['title' => '文件大小，字节', 'description' => '文件大小，字节。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'], 'FileType' => [ 'title' => '文件类型 image/audio/video/text', 'description' => '文件类型。与MIME Type相同。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'image' => 'image', - 'application' => 'application', - 'audio' => 'audio', - 'video' => 'video', - 'text' => 'text', - ], + 'enumValueTitles' => ['image' => 'image', 'application' => 'application', 'audio' => 'audio', 'video' => 'video', 'text' => 'text'], 'example' => 'image', ], 'ContentType' => [ @@ -1029,97 +468,55 @@ 'description' => '文件的MIME类型。包含Type和SubType。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'image/png' => 'PNG', - ' image/svg+xml' => 'SVG', - 'image/jpeg' => 'JPEG', - 'image/tiff' => 'TIFF', - ' image/gif' => 'GIF', - 'image/bmp' => 'BMP', - 'image/x-icon' => 'ICON', - 'image/heic' => 'HEIC', - 'image/webp' => 'WEBP', - ], + 'enumValueTitles' => ['image/png' => 'PNG', ' image/svg+xml' => 'SVG', 'image/jpeg' => 'JPEG', 'image/tiff' => 'TIFF', ' image/gif' => 'GIF', 'image/bmp' => 'BMP', 'image/x-icon' => 'ICON', 'image/heic' => 'HEIC', 'image/webp' => 'WEBP'], 'example' => 'image/jpeg'."\n", ], - 'MetaAttributes' => [ - 'title' => 'JSON String，存储文件的基础元数据，暂不具备检索能力', - 'description' => '文件的特定元数据。例如图片宽高信息，视频文件的码率分辨率信息等。暂不具备检索能力。JSON String格式。', - 'type' => 'string', - 'example' => '{'."\n" - .' "Image":'."\n" - .' {'."\n" - .' "Width": 1920,'."\n" - .' "Height": 1080,'."\n" - .' "Channel": 3'."\n" - .' }'."\n" - .'}', - ], - 'Tags' => [ - 'title' => '待更新的标签组(json string), user标签组直接更新，ai标签组需要配合TagJobId字段更新', - 'description' => '待更新的标签组。'."\n" - ."\n" - .'- 执行算法打标更新（必须设置有效的TagJobId）'."\n" - .'```'."\n" - .'{'."\n" - .' "ai":["车道线", "水马", "晴天"]'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- 用户手动打标：(add/remove表示对标签组内的标签进行增加/删除操作)'."\n" - .'用户可操作的标签组为：'."\n" - .' - user: 对单个元数据，用户自行添加/删除的标签名列表。'."\n" - .' - user-delete-ai-tags: 对单个元数据，算法标签组中用户需要删除的标签名列表。'."\n" - .'```'."\n" - .'{'."\n" - .' "user":{'."\n" - .' "add":["车道线","晴天"],'."\n" - .' "remove":["水马"]'."\n" - .' },'."\n" - .' "user-delete-ai-tags":{'."\n" - .' "add": ["地面阴影"],'."\n" - .' "remove": []'."\n" - .' }'."\n" - .'}'."\n" - .'```', - 'type' => 'string', - 'example' => '{'."\n" - .' "user":{'."\n" - .' "add":["Lane line","Sunny day"],'."\n" - .' "remove":["Water horse"]'."\n" - .' },'."\n" - .' "user-delete-ai-tags":{'."\n" - .' "add": ["Ground shadow"],'."\n" - .' "remove": []'."\n" - .' }'."\n" - .'}', - ], - 'DatasetFileMetaId' => [ - 'title' => 'uuid', - 'description' => '数据集文件元数据ID。', - 'type' => 'string', - 'required' => true, - 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n", - ], - 'SemanticIndexJobId' => [ - 'title' => '语义索引构建的任务ID', - 'description' => '语义索引构建的任务ID。', - 'type' => 'string', - 'example' => 'dsjob-klfwt*****l0escvt3', - ], - 'SemanticIndexUpdateTime' => [ - 'title' => '语义索引构建的时间', - 'description' => '语义索引构建的时间。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2021-01-12T14:36:01.000Z', - ], - 'FileFingerPrint' => [ - 'title' => '文件指纹', - 'description' => '文件指纹信息。', - 'type' => 'string', - 'example' => '124FB71******7BE45608CDEA4DE54B3', - ], + 'MetaAttributes' => ['title' => 'JSON String，存储文件的基础元数据，暂不具备检索能力', 'description' => '文件的特定元数据。例如图片宽高信息，视频文件的码率分辨率信息等。暂不具备检索能力。JSON String格式。', 'type' => 'string', 'example' => '{'."\n" + .' "Image":'."\n" + .' {'."\n" + .' "Width": 1920,'."\n" + .' "Height": 1080,'."\n" + .' "Channel": 3'."\n" + .' }'."\n" + .'}'], + 'Tags' => ['title' => '待更新的标签组(json string), user标签组直接更新，ai标签组需要配合TagJobId字段更新', 'description' => '待更新的标签组。'."\n" + ."\n" + .'- 执行算法打标更新（必须设置有效的TagJobId）'."\n" + .'```'."\n" + .'{'."\n" + .' "ai":["车道线", "水马", "晴天"]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- 用户手动打标：(add/remove表示对标签组内的标签进行增加/删除操作)'."\n" + .'用户可操作的标签组为：'."\n" + .' - user: 对单个元数据，用户自行添加/删除的标签名列表。'."\n" + .' - user-delete-ai-tags: 对单个元数据，算法标签组中用户需要删除的标签名列表。'."\n" + .'```'."\n" + .'{'."\n" + .' "user":{'."\n" + .' "add":["车道线","晴天"],'."\n" + .' "remove":["水马"]'."\n" + .' },'."\n" + .' "user-delete-ai-tags":{'."\n" + .' "add": ["地面阴影"],'."\n" + .' "remove": []'."\n" + .' }'."\n" + .'}'."\n" + .'```', 'type' => 'string', 'example' => '{'."\n" + .' "user":{'."\n" + .' "add":["Lane line","Sunny day"],'."\n" + .' "remove":["Water horse"]'."\n" + .' },'."\n" + .' "user-delete-ai-tags":{'."\n" + .' "add": ["Ground shadow"],'."\n" + .' "remove": []'."\n" + .' }'."\n" + .'}'], + 'DatasetFileMetaId' => ['title' => 'uuid', 'description' => '数据集文件元数据ID。', 'type' => 'string', 'required' => true, 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n"], + 'SemanticIndexJobId' => ['title' => '语义索引构建的任务ID', 'description' => '语义索引构建的任务ID。', 'type' => 'string', 'example' => 'dsjob-klfwt*****l0escvt3'], + 'SemanticIndexUpdateTime' => ['title' => '语义索引构建的时间', 'description' => '语义索引构建的时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z'], + 'FileFingerPrint' => ['title' => '文件指纹', 'description' => '文件指纹信息。', 'type' => 'string', 'example' => '124FB71******7BE45608CDEA4DE54B3'], ], ], 'DatasetFileMetaContentCreate' => [ @@ -1127,77 +524,28 @@ 'description' => '文件元数据内容详情。', 'type' => 'object', 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => '文件名。', - 'type' => 'string', - 'required' => false, - 'example' => '00001.jpeg', - ], - 'Uri' => [ - 'title' => 'oss/nas/cpfs uri', - 'description' => '文件唯一URI。用于记录文件唯一路径。支持OSS、NAS下的文件路径。'."\n" - .'
'."\n" - .'OSS'."\n" - .'oss://${bucket}/${path}'."\n" - .'
'."\n" - .'
'."\n" - .'NAS'."\n" - .'nas://${fileSystemId}/${path}'."\n" - .'
', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://*****-test/dataset/1653421.jpg'."\n" - .'nas://0e25d***dff/dataset/1653421.jpg', - ], - 'Comment' => [ - 'title' => '注释', - 'description' => '文件注释。', - 'type' => 'string', - 'example' => 'The first image file in the dataset.', - ], - 'FileCreateTime' => [ - 'title' => '创建时间，格式：ISO8601格式', - 'description' => '文件创建时间，格式：ISO8601格式。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-01-12T14:36:01Z', - ], - 'FileUpdateTime' => [ - 'title' => '修改时间，格式：ISO8601格式', - 'description' => '文件最后修改时间，格式：ISO8601格式。', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => true, - 'example' => '2025-01-12T14:36:01Z', - ], - 'FileFingerPrint' => [ - 'title' => 'md5/oss etag', - 'description' => '文件指纹值。用于确定文件内容的唯一性，文件内容修改后该值会发生变化。OSS文件使用ETag，NAS文件使用MD5值。', - 'type' => 'string', - 'required' => true, - 'example' => 'D41D8CD98F*****E9800998ECF8', - ], - 'DataSize' => [ - 'title' => '文件大小，字节', - 'description' => '文件大小，字节。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], + 'FileName' => ['title' => '文件名', 'description' => '文件名。', 'type' => 'string', 'required' => false, 'example' => '00001.jpeg'], + 'Uri' => ['title' => 'oss/nas/cpfs uri', 'description' => '文件唯一URI。用于记录文件唯一路径。支持OSS、NAS下的文件路径。'."\n" + .'
'."\n" + .'OSS'."\n" + .'oss://${bucket}/${path}'."\n" + .'
'."\n" + .'
'."\n" + .'NAS'."\n" + .'nas://${fileSystemId}/${path}'."\n" + .'
', 'type' => 'string', 'required' => true, 'example' => 'oss://*****-test/dataset/1653421.jpg'."\n" + .'nas://0e25d***dff/dataset/1653421.jpg'], + 'Comment' => ['title' => '注释', 'description' => '文件注释。', 'type' => 'string', 'example' => 'The first image file in the dataset.'], + 'FileCreateTime' => ['title' => '创建时间，格式：ISO8601格式', 'description' => '文件创建时间，格式：ISO8601格式。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01Z'], + 'FileUpdateTime' => ['title' => '修改时间，格式：ISO8601格式', 'description' => '文件最后修改时间，格式：ISO8601格式。', 'type' => 'string', 'format' => 'iso8601', 'required' => true, 'example' => '2025-01-12T14:36:01Z'], + 'FileFingerPrint' => ['title' => 'md5/oss etag', 'description' => '文件指纹值。用于确定文件内容的唯一性，文件内容修改后该值会发生变化。OSS文件使用ETag，NAS文件使用MD5值。', 'type' => 'string', 'required' => true, 'example' => 'D41D8CD98F*****E9800998ECF8'], + 'DataSize' => ['title' => '文件大小，字节', 'description' => '文件大小，字节。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'], 'FileType' => [ 'title' => '文件类型 image/audio/video/text', 'description' => '文件类型。与MIME Type相同。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'image' => 'image', - 'application' => 'application', - 'audio' => 'audio', - 'video' => 'video', - 'text' => 'text', - ], + 'enumValueTitles' => ['image' => 'image', 'application' => 'application', 'audio' => 'audio', 'video' => 'video', 'text' => 'text'], 'example' => 'image', ], 'ContentType' => [ @@ -1205,49 +553,28 @@ 'description' => '文件的MIME类型。包含Type和SubType。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'image/png' => 'PNG', - 'image/jpeg' => 'JPEG', - 'image/tiff' => 'TIFF', - 'image/bmp' => 'BMP', - 'image/gif' => 'GIF', - 'image/x-icon' => 'ICON', - 'image/svg+xml' => 'SVG', - 'image/webp' => 'WEBP', - 'image/heic ' => 'HEIC', - ], + 'enumValueTitles' => ['image/png' => 'PNG', 'image/jpeg' => 'JPEG', 'image/tiff' => 'TIFF', 'image/bmp' => 'BMP', 'image/gif' => 'GIF', 'image/x-icon' => 'ICON', 'image/svg+xml' => 'SVG', 'image/webp' => 'WEBP', 'image/heic ' => 'HEIC'], 'example' => 'image/jpeg', ], - 'MetaAttributes' => [ - 'title' => 'JSON String，存储文件的基础元数据，暂不具备检索能力', - 'description' => '文件的特定元数据，暂不具备检索能力。JSON String格式。', - 'type' => 'string', - 'example' => '{'."\n" - .' "ImageHeight": 1080,'."\n" - .' "ImageWidth": 1920'."\n" - .'}', - ], - 'Tags' => [ - 'title' => '标签组(json string)，仅更新user标签组', - 'description' => '用户手动打标：（add表示对标签组内的标签进行增加操作）。JSON String格式。'."\n" - .'可操作的标签组为：'."\n" - .'- user: 对单个元数据，用户自行添加的标签名列表。'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "user":{'."\n" - .' "add":["车道线","晴天"]'."\n" - .' }'."\n" - .'}'."\n" - .'```', - 'type' => 'string', - 'deprecated' => false, - 'example' => '{'."\n" - .' "user":{'."\n" - .' "add":["Lane line","Sunny day"]'."\n" - .' }'."\n" - .'}', - ], + 'MetaAttributes' => ['title' => 'JSON String，存储文件的基础元数据，暂不具备检索能力', 'description' => '文件的特定元数据，暂不具备检索能力。JSON String格式。', 'type' => 'string', 'example' => '{'."\n" + .' "ImageHeight": 1080,'."\n" + .' "ImageWidth": 1920'."\n" + .'}'], + 'Tags' => ['title' => '标签组(json string)，仅更新user标签组', 'description' => '用户手动打标：（add表示对标签组内的标签进行增加操作）。JSON String格式。'."\n" + .'可操作的标签组为：'."\n" + .'- user: 对单个元数据，用户自行添加的标签名列表。'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "user":{'."\n" + .' "add":["车道线","晴天"]'."\n" + .' }'."\n" + .'}'."\n" + .'```', 'type' => 'string', 'deprecated' => false, 'example' => '{'."\n" + .' "user":{'."\n" + .' "add":["Lane line","Sunny day"]'."\n" + .' }'."\n" + .'}'], ], ], 'DatasetFileMetaContentGet' => [ @@ -1255,77 +582,28 @@ 'description' => '获取的数据集文件元数据详情', 'type' => 'object', 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => '文件名。', - 'type' => 'string', - 'required' => false, - 'example' => '00001.jpeg', - ], - 'Uri' => [ - 'title' => 'oss/nas/cpfs uri', - 'description' => '文件唯一URI。用于记录文件唯一路径。支持OSS、NAS下的文件路径。'."\n" - .'
'."\n" - .'OSS'."\n" - .'oss://${bucket}/${path}'."\n" - .'
'."\n" - .'
'."\n" - .'NAS'."\n" - .'nas://${fileSystemId}/${path}'."\n" - .'
', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://*****-test/dataset/1653421.jpg'."\n" - .'nas://0e25d***dff/dataset/1653421.jpg'."\n", - ], - 'Comment' => [ - 'title' => '注释', - 'description' => '文件注释。', - 'type' => 'string', - 'example' => 'The first image file in the dataset.', - ], - 'FileCreateTime' => [ - 'title' => '创建时间，格式：ISO8601格式', - 'description' => '文件的创建时间，格式：ISO8601格式。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2025-01-12T14:36:01Z', - ], - 'FileUpdateTime' => [ - 'title' => '修改时间，格式：ISO8601格式', - 'description' => '文件的最后修改时间，格式：ISO8601格式。', - 'type' => 'string', - 'format' => 'iso8601', - 'required' => false, - 'example' => '2025-01-12T14:36:01Z', - ], - 'FileFingerPrint' => [ - 'title' => 'md5/oss etag', - 'description' => '文件指纹值。用于确定文件内容的唯一性，文件内容修改后该值会发生变化。OSS文件使用ETag，NAS文件使用MD5值。', - 'type' => 'string', - 'required' => false, - 'example' => 'D41D8CD98F*****E9800998ECF8'."\n", - ], - 'DataSize' => [ - 'title' => '文件大小，字节', - 'description' => '文件大小，字节。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], + 'FileName' => ['title' => '文件名', 'description' => '文件名。', 'type' => 'string', 'required' => false, 'example' => '00001.jpeg'], + 'Uri' => ['title' => 'oss/nas/cpfs uri', 'description' => '文件唯一URI。用于记录文件唯一路径。支持OSS、NAS下的文件路径。'."\n" + .'
'."\n" + .'OSS'."\n" + .'oss://${bucket}/${path}'."\n" + .'
'."\n" + .'
'."\n" + .'NAS'."\n" + .'nas://${fileSystemId}/${path}'."\n" + .'
', 'type' => 'string', 'required' => false, 'example' => 'oss://*****-test/dataset/1653421.jpg'."\n" + .'nas://0e25d***dff/dataset/1653421.jpg'."\n"], + 'Comment' => ['title' => '注释', 'description' => '文件注释。', 'type' => 'string', 'example' => 'The first image file in the dataset.'], + 'FileCreateTime' => ['title' => '创建时间，格式：ISO8601格式', 'description' => '文件的创建时间，格式：ISO8601格式。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01Z'], + 'FileUpdateTime' => ['title' => '修改时间，格式：ISO8601格式', 'description' => '文件的最后修改时间，格式：ISO8601格式。', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2025-01-12T14:36:01Z'], + 'FileFingerPrint' => ['title' => 'md5/oss etag', 'description' => '文件指纹值。用于确定文件内容的唯一性，文件内容修改后该值会发生变化。OSS文件使用ETag，NAS文件使用MD5值。', 'type' => 'string', 'required' => false, 'example' => 'D41D8CD98F*****E9800998ECF8'."\n"], + 'DataSize' => ['title' => '文件大小，字节', 'description' => '文件大小，字节。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'], 'FileType' => [ 'title' => '文件类型 image/audio/video/text', 'description' => '文件类型。与 MIME Type 相同。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'image' => 'image', - 'application' => 'application', - 'audio' => 'audio', - 'video' => 'video', - 'text' => 'text', - ], + 'enumValueTitles' => ['image' => 'image', 'application' => 'application', 'audio' => 'audio', 'video' => 'video', 'text' => 'text'], 'example' => 'image', ], 'ContentType' => [ @@ -1333,94 +611,44 @@ 'description' => '文件的 MIME 类型。包含 Type 和 SubType。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'image/png' => 'PNG', - 'image/jpeg' => 'JPEG', - 'image/tiff' => 'TIFF', - 'image/bmp' => 'BMP', - 'image/gif' => 'GIF', - 'image/x-icon' => 'ICON', - 'image/svg+xml' => 'SVG', - 'image/heic' => 'HEIC', - 'image/webp' => 'WEBP', - ], + 'enumValueTitles' => ['image/png' => 'PNG', 'image/jpeg' => 'JPEG', 'image/tiff' => 'TIFF', 'image/bmp' => 'BMP', 'image/gif' => 'GIF', 'image/x-icon' => 'ICON', 'image/svg+xml' => 'SVG', 'image/heic' => 'HEIC', 'image/webp' => 'WEBP'], 'example' => 'image/png', ], - 'MetaAttributes' => [ - 'title' => 'JSON String，存储文件的基础元数据，暂不具备检索能力', - 'description' => '文件的特定元数据，暂不具备检索能力。JSON String格式。', - 'type' => 'string', - 'example' => '{'."\n" - .' "ImageHeight": 1080,'."\n" - .' "ImageWidth": 1920'."\n" - .'}', - ], - 'Tags' => [ - 'title' => '标签组(json格式)', - 'description' => '该元数据的标签合集，包括：'."\n" - .'- 算法标签组：'."\n" - .' - ai: 对单个元数据，全部的算法打标任务汇总后的标签名列表。'."\n" - .'- 用户自定义标签组：'."\n" - .' - user: 对单个元数据，用户自行添加的标签名列表。'."\n" - .' - user-delete-ai-tags: 对单个元数据，算法标签组中用户需要删除的标签名列表。', - 'type' => 'string', - 'example' => '{'."\n" - .' "ai":'."\n" - .' ['."\n" - .' "Lane line",'."\n" - .' "Water horse",'."\n" - .' "Sunny day"'."\n" - .' ],'."\n" - .' "user":'."\n" - .' ['."\n" - .' "Everett",'."\n" - .' "Intelligent driving Dataset 1",'."\n" - .' "Cloudy day"'."\n" - .' ],'."\n" - .' "user-delete-ai-tags":'."\n" - .' ['."\n" - .' "Sunny day"'."\n" - .' ]'."\n" - .'}', - ], - 'DatasetFileMetaId' => [ - 'title' => 'uuid', - 'description' => '数据集文件元数据ID。', - 'type' => 'string', - 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n", - ], - 'FileDir' => [ - 'title' => 'oss/nas/cpfs文件所在目录的路径', - 'description' => 'oss/nas/cpfs文件所在目录的路径。', - 'type' => 'string', - 'example' => 'icp_certificate_card/icp/1577179298694813/1716429710367', - ], - 'TagUpdateTime' => [ - 'title' => '标签最后修改时间，格式iso8601', - 'description' => '标签最后修改时间，格式iso8601。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2021-01-12T14:36:01.000Z', - ], - 'SemanticIndexJobId' => [ - 'title' => '语义索引构建的任务ID', - 'description' => '语义索引构建的任务ID。', - 'type' => 'string', - 'example' => 'dsjob-klfwtjtov*****scvt3', - ], - 'SemanticIndexUpdateTime' => [ - 'title' => '语义索引构建的时间', - 'description' => '语义索引构建的时间。', - 'type' => 'string', - 'format' => 'iso8601', - 'example' => '2021-01-12T14:36:01.000Z', - ], + 'MetaAttributes' => ['title' => 'JSON String，存储文件的基础元数据，暂不具备检索能力', 'description' => '文件的特定元数据，暂不具备检索能力。JSON String格式。', 'type' => 'string', 'example' => '{'."\n" + .' "ImageHeight": 1080,'."\n" + .' "ImageWidth": 1920'."\n" + .'}'], + 'Tags' => ['title' => '标签组(json格式)', 'description' => '该元数据的标签合集，包括：'."\n" + .'- 算法标签组：'."\n" + .' - ai: 对单个元数据，全部的算法打标任务汇总后的标签名列表。'."\n" + .'- 用户自定义标签组：'."\n" + .' - user: 对单个元数据，用户自行添加的标签名列表。'."\n" + .' - user-delete-ai-tags: 对单个元数据，算法标签组中用户需要删除的标签名列表。', 'type' => 'string', 'example' => '{'."\n" + .' "ai":'."\n" + .' ['."\n" + .' "Lane line",'."\n" + .' "Water horse",'."\n" + .' "Sunny day"'."\n" + .' ],'."\n" + .' "user":'."\n" + .' ['."\n" + .' "Everett",'."\n" + .' "Intelligent driving Dataset 1",'."\n" + .' "Cloudy day"'."\n" + .' ],'."\n" + .' "user-delete-ai-tags":'."\n" + .' ['."\n" + .' "Sunny day"'."\n" + .' ]'."\n" + .'}'], + 'DatasetFileMetaId' => ['title' => 'uuid', 'description' => '数据集文件元数据ID。', 'type' => 'string', 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n"], + 'FileDir' => ['title' => 'oss/nas/cpfs文件所在目录的路径', 'description' => 'oss/nas/cpfs文件所在目录的路径。', 'type' => 'string', 'example' => 'icp_certificate_card/icp/1577179298694813/1716429710367'], + 'TagUpdateTime' => ['title' => '标签最后修改时间，格式iso8601', 'description' => '标签最后修改时间，格式iso8601。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z'], + 'SemanticIndexJobId' => ['title' => '语义索引构建的任务ID', 'description' => '语义索引构建的任务ID。', 'type' => 'string', 'example' => 'dsjob-klfwtjtov*****scvt3'], + 'SemanticIndexUpdateTime' => ['title' => '语义索引构建的时间', 'description' => '语义索引构建的时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z'], 'Status' => [ 'type' => 'string', - 'enum' => [ - 'ACTIVE', - 'DELETED', - ], + 'enum' => ['ACTIVE', 'DELETED'], ], ], ], @@ -1429,44 +657,17 @@ 'description' => '单个文件元数据操的作返回结果。', 'type' => 'object', 'properties' => [ - 'DatasetFileMetaId' => [ - 'title' => '文件元数据ID', - 'description' => '文件元数据ID。', - 'type' => 'string', - 'required' => true, - 'example' => '07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6', - ], - 'Result' => [ - 'title' => 'Not Found/Failed ...', - 'description' => '文件元数据操作失败原因描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'Not Found', - ], - 'Uri' => [ - 'title' => 'oss/nas/cpfs uri', - 'description' => '文件的URI。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://l*****-test/dataset/1653421.jpg', - ], + 'DatasetFileMetaId' => ['title' => '文件元数据ID', 'description' => '文件元数据ID。', 'type' => 'string', 'required' => true, 'example' => '07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6'], + 'Result' => ['title' => 'Not Found/Failed ...', 'description' => '文件元数据操作失败原因描述。', 'type' => 'string', 'required' => true, 'example' => 'Not Found'], + 'Uri' => ['title' => 'oss/nas/cpfs uri', 'description' => '文件的URI。', 'type' => 'string', 'required' => false, 'example' => 'oss://l*****-test/dataset/1653421.jpg'], ], ], 'DatasetFileMetasStat' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '元数据属性内容。', - 'type' => 'string', - 'example' => 'cat', - ], - 'Count' => [ - 'title' => '聚合后的数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'Key' => ['title' => '元数据属性内容。', 'type' => 'string', 'example' => 'cat'], + 'Count' => ['title' => '聚合后的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], 'DatasetJob' => [ @@ -1474,100 +675,31 @@ 'description' => '数据集任务', 'type' => 'object', 'properties' => [ - 'DatasetJobId' => [ - 'title' => '任务ID', - 'description' => '任务ID。', - 'type' => 'string', - 'example' => 'dsjob-9jx1*****uj9e', - ], - 'JobAction' => [ - 'title' => '任务操作', - 'description' => '任务操作。', - 'type' => 'string', - 'example' => 'SemanticIndex', - ], - 'CreateTime' => [ - 'title' => '任务创建时间（UTC）', - 'description' => '任务创建时间（UTC）', - 'type' => 'string', - 'example' => '2023-06-20T04:05:59Z', - ], - 'FinishTime' => [ - 'title' => '任务结束时间（UTC）', - 'description' => '任务结束时间（UTC）', - 'type' => 'string', - 'example' => '2023-06-20T06:03:48Z', - ], - 'Status' => [ - 'title' => '任务状态', - 'description' => '任务状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'Description' => [ - 'title' => '任务描述', - 'description' => '任务描述。', - 'type' => 'string', - 'example' => 'This is a job description of a dataset.', - ], + 'DatasetJobId' => ['title' => '任务ID', 'description' => '任务ID。', 'type' => 'string', 'example' => 'dsjob-9jx1*****uj9e'], + 'JobAction' => ['title' => '任务操作', 'description' => '任务操作。', 'type' => 'string', 'example' => 'SemanticIndex'], + 'CreateTime' => ['title' => '任务创建时间（UTC）', 'description' => '任务创建时间（UTC）', 'type' => 'string', 'example' => '2023-06-20T04:05:59Z'], + 'FinishTime' => ['title' => '任务结束时间（UTC）', 'description' => '任务结束时间（UTC）', 'type' => 'string', 'example' => '2023-06-20T06:03:48Z'], + 'Status' => ['title' => '任务状态', 'description' => '任务状态。', 'type' => 'string', 'example' => 'Running'], + 'Description' => ['title' => '任务描述', 'description' => '任务描述。', 'type' => 'string', 'example' => 'This is a job description of a dataset.'], 'JobMode' => [ 'title' => '索引类型', 'description' => '任务模式。', 'type' => 'string', - 'enumValueTitles' => [ - 'Full' => 'Full', - ], + 'enumValueTitles' => ['Full' => 'Full'], 'example' => 'Full', ], - 'JobSpec' => [ - 'title' => '任务明细', - 'description' => '任务明细。', - 'type' => 'string', - 'example' => '{\\"modelId\\":\\"xxx\\"}', - ], + 'JobSpec' => ['title' => '任务明细', 'description' => '任务明细。', 'type' => 'string', 'example' => '{\\"modelId\\":\\"xxx\\"}'], 'Logs' => [ 'title' => '任务结果信息', 'description' => '任务日志列表。', 'type' => 'array', - 'items' => [ - 'description' => '日志行内容', - 'type' => 'string', - 'example' => '2025-02-17 09:58:10.143 INFO: Job completed successfully.', - ], - ], - 'TotalFileCount' => [ - 'title' => '任务文件总量', - 'description' => '任务文件总量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'CompletedFileCount' => [ - 'title' => '已完成文件总量', - 'description' => '已完成文件总量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '990', - ], - 'FailedFileCount' => [ - 'title' => '失败文件总量', - 'description' => '失败文件总量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'DatasetVersion' => [ - 'title' => '数据集版本', - 'description' => '数据集版本', - 'type' => 'string', - 'example' => 'v1', - ], - 'WorkspaceId' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID', - 'type' => 'string', - 'example' => '145883', + 'items' => ['description' => '日志行内容', 'type' => 'string', 'example' => '2025-02-17 09:58:10.143 INFO: Job completed successfully.'], ], + 'TotalFileCount' => ['title' => '任务文件总量', 'description' => '任务文件总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'CompletedFileCount' => ['title' => '已完成文件总量', 'description' => '已完成文件总量', 'type' => 'integer', 'format' => 'int64', 'example' => '990'], + 'FailedFileCount' => ['title' => '失败文件总量', 'description' => '失败文件总量', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'DatasetVersion' => ['title' => '数据集版本', 'description' => '数据集版本', 'type' => 'string', 'example' => 'v1'], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'string', 'example' => '145883'], ], ], 'DatasetJobConfig' => [ @@ -1575,62 +707,23 @@ 'description' => '数据集任务配置', 'type' => 'object', 'properties' => [ - 'DatasetJobConfigId' => [ - 'title' => 'DatasetJobConfigId', - 'description' => '数据集任务配置ID', - 'type' => 'string', - 'example' => 'dscfg-xxxxxxxxxxxx', - ], - 'CreateTime' => [ - 'title' => 'CreateTime', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-01-14T01:37:37Z', - ], - 'ModifyTime' => [ - 'title' => 'ModifyTime', - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2024-10-11T02:18:54Z', - ], - 'ConfigType' => [ - 'title' => 'ConfigType', - 'description' => '数据集任务配置类型', - 'type' => 'string', - 'example' => 'MultimodalIntelligentTag', - ], - 'Config' => [ - 'title' => 'Config', - 'description' => '数据集任务配置内容，json格式。', - 'type' => 'string', - 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', - ], - 'WorkspaceId' => [ - 'title' => 'WorkspaceId', - 'description' => '工作空间ID', - 'type' => 'string', - 'example' => '234*34', - ], - 'DatasetVersion' => [ - 'type' => 'string', - ], + 'DatasetJobConfigId' => ['title' => 'DatasetJobConfigId', 'description' => '数据集任务配置ID', 'type' => 'string', 'example' => 'dscfg-xxxxxxxxxxxx'], + 'CreateTime' => ['title' => 'CreateTime', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-01-14T01:37:37Z'], + 'ModifyTime' => ['title' => 'ModifyTime', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-10-11T02:18:54Z'], + 'ConfigType' => ['title' => 'ConfigType', 'description' => '数据集任务配置类型', 'type' => 'string', 'example' => 'MultimodalIntelligentTag'], + 'Config' => ['title' => 'Config', 'description' => '数据集任务配置内容，json格式。', 'type' => 'string', 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'], + 'WorkspaceId' => ['title' => 'WorkspaceId', 'description' => '工作空间ID', 'type' => 'string', 'example' => '234*34'], + 'DatasetVersion' => ['type' => 'string', 'description' => ''], ], ], 'DatasetLabel' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => 'Key', - 'description' => 'Key', - 'type' => 'string', - ], - 'Value' => [ - 'title' => 'Value', - 'description' => 'Value', - 'type' => 'string', - ], + 'Key' => ['title' => 'Key', 'description' => 'Key', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'Key'], + 'Value' => ['title' => 'Value', 'description' => 'Value', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'Value'], ], ], 'DatasetShareRelationship' => [ @@ -1649,68 +742,28 @@ .'* REVOKED: 分享被主动取消(分享者手动撤销分享)'."\n" .'* INVALID：分享因系统原因自动失效(如源数据集被删除)', 'type' => 'string', - 'enumValueTitles' => [ - 'REVOKED' => 'REVOKED', - 'ACTIVE' => 'ACTIVE', - 'EXPIRED' => 'EXPIRED', - 'INVALID' => 'INVALID', - ], + 'enumValueTitles' => ['REVOKED' => 'REVOKED', 'ACTIVE' => 'ACTIVE', 'EXPIRED' => 'EXPIRED', 'INVALID' => 'INVALID'], 'example' => 'ACTIVE', ], - 'SourceTenantId' => [ - 'title' => '源数据集租户ID', - 'description' => '源数据集租户ID。分享者需为该工作空间管理员或者主账号身份。', - 'type' => 'string', - 'example' => '148***************115', - ], - 'SourceWorkspaceId' => [ - 'title' => '源数据集工作空间ID', - 'description' => '源数据集工作空间ID。', - 'type' => 'string', - 'example' => '33**19', - ], - 'TenantId' => [ - 'title' => '目标租户ID', - 'description' => '目标租户ID，必须为主账号ID。'."\n" - .'> 设置分享关系时必填。', - 'type' => 'string', - 'required' => false, - 'example' => '153***************249', - ], - 'WorkspaceId' => [ - 'title' => '目标工作空间ID', - 'description' => '目标工作空间ID。需与源数据集工作空间ID不同。'."\n" - ."\n" - .'> 设置分享关系时必填。', - 'type' => 'string', - 'required' => false, - 'example' => '42**2', - ], + 'SourceTenantId' => ['title' => '源数据集租户ID', 'description' => '源数据集租户ID。分享者需为该工作空间管理员或者主账号身份。', 'type' => 'string', 'example' => '148***************115'], + 'SourceWorkspaceId' => ['title' => '源数据集工作空间ID', 'description' => '源数据集工作空间ID。', 'type' => 'string', 'example' => '33**19'], + 'TenantId' => ['title' => '目标租户ID', 'description' => '目标租户ID，必须为主账号ID。'."\n" + .'> 设置分享关系时必填。', 'type' => 'string', 'required' => false, 'example' => '153***************249'], + 'WorkspaceId' => ['title' => '目标工作空间ID', 'description' => '目标工作空间ID。需与源数据集工作空间ID不同。'."\n" + ."\n" + .'> 设置分享关系时必填。', 'type' => 'string', 'required' => false, 'example' => '42**2'], 'IsSecureMode' => [ 'title' => '是否需要安全防护', 'description' => '是否需要对分享的数据集开启安全防护。', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', ], - 'SharedAt' => [ - 'title' => '分享时间，ISO 8601格式', - 'description' => '分享时间，ISO 8601格式。', - 'type' => 'string', - 'example' => '2025-08-27T12:23:58Z', - ], - 'ExpiresAt' => [ - 'title' => '过期时间，ISO 8601格式', - 'description' => '过期时间，ISO 8601格式。'."\n" - ."\n" - .'> 如不填写则表示永不过期。', - 'type' => 'string', - 'example' => '2026-08-27T12:23:58Z', - ], + 'SharedAt' => ['title' => '分享时间，ISO 8601格式', 'description' => '分享时间，ISO 8601格式。', 'type' => 'string', 'example' => '2025-08-27T12:23:58Z'], + 'ExpiresAt' => ['title' => '过期时间，ISO 8601格式', 'description' => '过期时间，ISO 8601格式。'."\n" + ."\n" + .'> 如不填写则表示永不过期。', 'type' => 'string', 'example' => '2026-08-27T12:23:58Z'], 'AllowedMountAccessLevels' => [ 'title' => '分享时指定允许的权限范围，使用被分享的数据集时权限需在此列表范围内'."\n" .'● RO: 只读权限，被分享方只能读取数据集内容'."\n" @@ -1722,22 +775,15 @@ 'items' => [ 'description' => '数据集权限。', 'type' => 'string', - 'enumValueTitles' => [ - 'RW' => 'RW', - 'RO' => 'RO', - ], + 'enumValueTitles' => ['RW' => 'RW', 'RO' => 'RO'], 'example' => 'RO', ], 'required' => false, ], - 'Extra' => [ - 'description' => '分享补充配置。json string格式。'."\n" - .'* AllowExportModel：是否允许训练后的模型导出'."\n" - .'* AllowAccessDLCWebTerminal：打开/关闭DLC任务中的登录容器的权限'."\n" - .'* AllowAccessDLCFullLog：打开/关闭全量展示任务日志的权限', - 'type' => 'string', - 'example' => '{"AllowExportModel":false,"AllowAccessDLCWebTerminal":false,"AllowAccessDLCFullLog":false}', - ], + 'Extra' => ['description' => '分享补充配置。json string格式。'."\n" + .'* AllowExportModel：是否允许训练后的模型导出'."\n" + .'* AllowAccessDLCWebTerminal：打开/关闭DLC任务中的登录容器的权限'."\n" + .'* AllowAccessDLCFullLog：打开/关闭全量展示任务日志的权限', 'type' => 'string', 'example' => '{"AllowExportModel":false,"AllowAccessDLCWebTerminal":false,"AllowAccessDLCFullLog":false}'], ], ], 'DatasetVersion' => [ @@ -1745,108 +791,34 @@ 'description' => 'Dataset Version struct', 'type' => 'object', 'properties' => [ - 'VersionName' => [ - 'title' => 'version name', - 'description' => 'version name', - 'type' => 'string', - 'example' => 'v1', - ], - 'GmtCreateTime' => [ - 'title' => 'create time', - 'description' => 'create time', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'GmtModifiedTime' => [ - 'title' => 'modify time', - 'description' => 'modify time', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'Property' => [ - 'title' => 'property', - 'description' => 'property', - 'type' => 'string', - 'example' => 'FILE', - ], - 'DataSourceType' => [ - 'title' => 'DataSourceType', - 'description' => 'DataSourceType', - 'type' => 'string', - 'example' => 'OSS', - ], - 'Uri' => [ - 'title' => 'Uri', - 'description' => 'Uri', - 'type' => 'string', - 'example' => 'OSS://xxx', - ], + 'VersionName' => ['title' => 'version name', 'description' => 'version name', 'type' => 'string', 'example' => 'v1'], + 'GmtCreateTime' => ['title' => 'create time', 'description' => 'create time', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'GmtModifiedTime' => ['title' => 'modify time', 'description' => 'modify time', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'Property' => ['title' => 'property', 'description' => 'property', 'type' => 'string', 'example' => 'FILE'], + 'DataSourceType' => ['title' => 'DataSourceType', 'description' => 'DataSourceType', 'type' => 'string', 'example' => 'OSS'], + 'Uri' => ['title' => 'Uri', 'description' => 'Uri', 'type' => 'string', 'example' => 'OSS://xxx'], 'Labels' => [ 'title' => 'Labels', 'description' => 'Labels', 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/Label', - ], - ], - 'Options' => [ - 'title' => 'Options', - 'description' => 'Options', - 'type' => 'string', - 'example' => '{'."\n" - .' "mountPath": "/mnt/data/"'."\n" - .'}', - ], - 'SourceType' => [ - 'title' => 'SourceType', - 'description' => 'SourceType', - 'type' => 'string', - 'example' => 'USER', - ], - 'Description' => [ - 'title' => 'Description', - 'description' => 'Description', - 'type' => 'string', - 'example' => 'base model v1', - ], - 'SourceId' => [ - 'title' => 'SourceId', - 'description' => 'SourceId', - 'type' => 'string', - 'example' => 'd-65mrsr5fub4u74lej3', - ], - 'DataCount' => [ - 'title' => 'DataCount', - 'description' => 'DataCount', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'DataSize' => [ - 'title' => 'DataSize', - 'description' => 'DataSize', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'MountAccess' => [ - 'title' => 'MountAccess', - 'description' => 'MountAccess', - 'type' => 'string', - 'example' => 'RO', - ], - 'ImportInfo' => [ - 'title' => 'ImportInfo', - 'description' => 'ImportInfo', - 'type' => 'string', - 'example' => '{'."\n" - .' "region": "cn-wulanchabu",'."\n" - .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" - .' "path": "/mnt",'."\n" - .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" - .' "isVpcMount": true'."\n" - .'}', - ], + 'items' => ['$ref' => '#/components/schemas/Label', 'description' => ''], + ], + 'Options' => ['title' => 'Options', 'description' => 'Options', 'type' => 'string', 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}'], + 'SourceType' => ['title' => 'SourceType', 'description' => 'SourceType', 'type' => 'string', 'example' => 'USER'], + 'Description' => ['title' => 'Description', 'description' => 'Description', 'type' => 'string', 'example' => 'base model v1'], + 'SourceId' => ['title' => 'SourceId', 'description' => 'SourceId', 'type' => 'string', 'example' => 'd-65mrsr5fub4u74lej3'], + 'DataCount' => ['title' => 'DataCount', 'description' => 'DataCount', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'DataSize' => ['title' => 'DataSize', 'description' => 'DataSize', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'MountAccess' => ['title' => 'MountAccess', 'description' => 'MountAccess', 'type' => 'string', 'example' => 'RO'], + 'ImportInfo' => ['title' => 'ImportInfo', 'description' => 'ImportInfo', 'type' => 'string', 'example' => '{'."\n" + .' "region": "cn-wulanchabu",'."\n" + .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" + .' "path": "/mnt",'."\n" + .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" + .' "isVpcMount": true'."\n" + .'}'], ], ], 'Experiment' => [ @@ -1854,74 +826,24 @@ 'description' => '实验', 'type' => 'object', 'properties' => [ - 'ExperimentId' => [ - 'title' => 'ExperimentId', - 'description' => 'ExperimentId', - 'type' => 'string', - ], - 'Name' => [ - 'title' => 'Name', - 'description' => 'Name', - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'title' => 'WorkspaceId', - 'description' => 'WorkspaceId', - 'type' => 'string', - ], - 'ArtifactUri' => [ - 'title' => 'ArtifactUri', - 'description' => 'ArtifactUri', - 'type' => 'string', - ], - 'TensorboardLogUri' => [ - 'title' => 'TensorboardLogUri', - 'description' => 'TensorboardLogUri', - 'type' => 'string', - ], + 'ExperimentId' => ['title' => 'ExperimentId', 'description' => 'ExperimentId', 'type' => 'string'], + 'Name' => ['title' => 'Name', 'description' => 'Name', 'type' => 'string'], + 'WorkspaceId' => ['title' => 'WorkspaceId', 'description' => 'WorkspaceId', 'type' => 'string'], + 'ArtifactUri' => ['title' => 'ArtifactUri', 'description' => 'ArtifactUri', 'type' => 'string'], + 'TensorboardLogUri' => ['title' => 'TensorboardLogUri', 'description' => 'TensorboardLogUri', 'type' => 'string'], 'Labels' => [ 'title' => 'Labels', 'description' => 'Labels', 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/ExperimentLabel', - ], - ], - 'UserId' => [ - 'title' => 'UserId', - 'description' => 'UserId', - 'type' => 'string', - ], - 'OwnerId' => [ - 'title' => 'OwnerId', - 'description' => 'OwnerId', - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'title' => 'GmtCreatedTime', - 'description' => 'GmtCreatedTime', - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'title' => 'GmtModifiedTime', - 'description' => 'GmtModifiedTime', - 'type' => 'string', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId', - 'type' => 'string', - ], - 'Accessibility' => [ - 'title' => 'Accessibility', - 'description' => 'Accessibility', - 'type' => 'string', - ], - 'LatestRun' => [ - 'title' => 'LatestRun', - 'description' => 'LatestRun', - '$ref' => '#/components/schemas/Run', + 'items' => ['$ref' => '#/components/schemas/ExperimentLabel', 'description' => ''], ], + 'UserId' => ['title' => 'UserId', 'description' => 'UserId', 'type' => 'string'], + 'OwnerId' => ['title' => 'OwnerId', 'description' => 'OwnerId', 'type' => 'string'], + 'GmtCreateTime' => ['title' => 'GmtCreatedTime', 'description' => 'GmtCreatedTime', 'type' => 'string'], + 'GmtModifiedTime' => ['title' => 'GmtModifiedTime', 'description' => 'GmtModifiedTime', 'type' => 'string'], + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string'], + 'Accessibility' => ['title' => 'Accessibility', 'description' => 'Accessibility', 'type' => 'string'], + 'LatestRun' => ['title' => 'LatestRun', 'description' => 'LatestRun', '$ref' => '#/components/schemas/Run'], ], ], 'ExperimentLabel' => [ @@ -1929,36 +851,11 @@ 'description' => '实验标签', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => 'Key of Experiment Label', - 'description' => 'Key of Experiment Label', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => 'Value of Experiment Label', - 'description' => 'Value of Experiment Label', - 'type' => 'string', - 'example' => 'value', - ], - 'GmtCreateTime' => [ - 'title' => 'Create time', - 'description' => 'Create time', - 'type' => 'string', - 'example' => '2023-12-27T03:30:04Z', - ], - 'GmtModifiedTime' => [ - 'title' => 'Modified time', - 'description' => 'Modified time', - 'type' => 'string', - 'example' => '2023-12-27T03:30:04Z', - ], - 'ExperimentId' => [ - 'title' => 'ExperimentId', - 'description' => 'ExperimentId', - 'type' => 'string', - 'example' => 'exp-890waerw09a0f', - ], + 'Key' => ['title' => 'Key of Experiment Label', 'description' => 'Key of Experiment Label', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => 'Value of Experiment Label', 'description' => 'Value of Experiment Label', 'type' => 'string', 'example' => 'value'], + 'GmtCreateTime' => ['title' => 'Create time', 'description' => 'Create time', 'type' => 'string', 'example' => '2023-12-27T03:30:04Z'], + 'GmtModifiedTime' => ['title' => 'Modified time', 'description' => 'Modified time', 'type' => 'string', 'example' => '2023-12-27T03:30:04Z'], + 'ExperimentId' => ['title' => 'ExperimentId', 'description' => 'ExperimentId', 'type' => 'string', 'example' => 'exp-890waerw09a0f'], ], ], 'Label' => [ @@ -1966,18 +863,8 @@ 'description' => '标签结构。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '标签的key', - 'description' => '标签的key。最长128 字节，不支持等于号（=）与半角逗号（,）。', - 'type' => 'string', - 'example' => 'env', - ], - 'Value' => [ - 'title' => '标签的value', - 'description' => '标签的value。最长128 字节，不支持等于号（=）与半角逗号（,）。', - 'type' => 'string', - 'example' => 'test', - ], + 'Key' => ['title' => '标签的key', 'description' => '标签的key。最长128 字节，不支持等于号（=）与半角逗号（,）。', 'type' => 'string', 'example' => 'env'], + 'Value' => ['title' => '标签的value', 'description' => '标签的value。最长128 字节，不支持等于号（=）与半角逗号（,）。', 'type' => 'string', 'example' => 'test'], ], ], 'LabelInfo' => [ @@ -1985,18 +872,8 @@ 'description' => 'TrialLabelInfo', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => 'Key of Label', - 'description' => 'Key of Label', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => 'Value of Label', - 'description' => 'Value of Label', - 'type' => 'string', - 'example' => 'value', - ], + 'Key' => ['title' => 'Key of Label', 'description' => 'Key of Label', 'type' => 'string', 'example' => 'key'], + 'Value' => ['title' => 'Value of Label', 'description' => 'Value of Label', 'type' => 'string', 'example' => 'value'], ], ], 'LineageEntity' => [ @@ -2004,26 +881,10 @@ 'description' => '血缘实体', 'type' => 'object', 'properties' => [ - 'Attributes' => [ - 'title' => 'Attributes', - 'description' => 'Attributes', - 'type' => 'object', - ], - 'EntityType' => [ - 'title' => 'EntityType', - 'description' => 'EntityType', - 'type' => 'string', - ], - 'Name' => [ - 'title' => 'Name', - 'description' => 'Name', - 'type' => 'string', - ], - 'QualifiedName' => [ - 'title' => 'QualifiedName', - 'description' => 'QualifiedName', - 'type' => 'string', - ], + 'Attributes' => ['title' => 'Attributes', 'description' => 'Attributes', 'type' => 'object'], + 'EntityType' => ['title' => 'EntityType', 'description' => 'EntityType', 'type' => 'string'], + 'Name' => ['title' => 'Name', 'description' => 'Name', 'type' => 'string'], + 'QualifiedName' => ['title' => 'QualifiedName', 'description' => 'QualifiedName', 'type' => 'string'], ], ], 'LineageRelation' => [ @@ -2031,21 +892,9 @@ 'description' => 'LineageRelation', 'type' => 'object', 'properties' => [ - 'DestEntityQualifiedName' => [ - 'title' => 'DestEntityQualifiedName', - 'description' => 'DestEntityQualifiedName', - 'type' => 'string', - ], - 'RelationshipGuid' => [ - 'title' => 'RelationshipGuid', - 'description' => 'RelationshipGuid', - 'type' => 'string', - ], - 'SrcEntityQualifiedName' => [ - 'title' => 'SrcEntityQualifiedName', - 'description' => 'SrcEntityQualifiedName', - 'type' => 'string', - ], + 'DestEntityQualifiedName' => ['title' => 'DestEntityQualifiedName', 'description' => 'DestEntityQualifiedName', 'type' => 'string'], + 'RelationshipGuid' => ['title' => 'RelationshipGuid', 'description' => 'RelationshipGuid', 'type' => 'string'], + 'SrcEntityQualifiedName' => ['title' => 'SrcEntityQualifiedName', 'description' => 'SrcEntityQualifiedName', 'type' => 'string'], ], ], 'Model' => [ @@ -2053,156 +902,54 @@ 'description' => '模型。', 'type' => 'object', 'properties' => [ - 'ModelId' => [ - 'title' => '模型ID', - 'description' => '模型ID。', - 'type' => 'string', - 'example' => 'model-1123*****', - ], - 'ModelName' => [ - 'title' => '模型名字', - 'description' => '模型名称。', - 'type' => 'string', - 'example' => '情感分析', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建模型UTC时间，格式为ISO 8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35Z', - ], - 'GmtModifiedTime' => [ - 'title' => '最后更新时间', - 'description' => '最后更新模型UTC时间，格式为ISO 8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35Z', - ], - 'WorkspaceId' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '234**', - ], - 'UserId' => [ - 'title' => '创建模型的用户ID', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1557702098******', - ], - 'OwnerId' => [ - 'title' => '云账号ID', - 'description' => '主账号ID', - 'type' => 'string', - 'example' => '1557702098******', - ], - 'ModelDescription' => [ - 'title' => '模型的描述', - 'description' => '模型描述。', - 'type' => 'string', - 'example' => '情感分析。', - ], + 'ModelId' => ['title' => '模型ID', 'description' => '模型ID。', 'type' => 'string', 'example' => 'model-1123*****'], + 'ModelName' => ['title' => '模型名字', 'description' => '模型名称。', 'type' => 'string', 'example' => '情感分析'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建模型UTC时间，格式为ISO 8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z'], + 'GmtModifiedTime' => ['title' => '最后更新时间', 'description' => '最后更新模型UTC时间，格式为ISO 8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z'], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '234**'], + 'UserId' => ['title' => '创建模型的用户ID', 'description' => '用户ID。', 'type' => 'string', 'example' => '1557702098******'], + 'OwnerId' => ['title' => '云账号ID', 'description' => '主账号ID', 'type' => 'string', 'example' => '1557702098******'], + 'ModelDescription' => ['title' => '模型的描述', 'description' => '模型描述。', 'type' => 'string', 'example' => '情感分析。'], 'Accessibility' => [ 'title' => '可见性', 'description' => '工作空间可见度。取值：'."\n" .'- PRIVATE（默认值）：表示工作空间内自己以及管理员可见。'."\n" .'- PUBLIC：为工作空间所有用户可见。', 'type' => 'string', - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'example' => 'PUBLIC', ], - 'LatestVersion' => [ - 'title' => '最新版本', - 'description' => '模型最新版本。', - '$ref' => '#/components/schemas/ModelVersion', - ], - 'OrderNumber' => [ - 'title' => '模型序号', - 'description' => '模型序号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101', - ], - 'Origin' => [ - 'title' => '模型源', - 'description' => '模型源。描述源模型所属社区或组织，如ModelScope、HuggingFace等。', - 'type' => 'string', - 'example' => 'ModelScope', - ], - 'Domain' => [ - 'title' => '领域', - 'description' => '领域。描述模型解决问题所属领域，如nlp（自然语言处理），cv（计算机视觉）等。', - 'type' => 'string', - 'example' => 'nlp', - ], - 'Task' => [ - 'title' => '任务', - 'description' => '任务。描述模型解决的具体问题，如text-classification（文本分类）等。', - 'type' => 'string', - 'example' => 'text-classifiaction', - ], - 'ModelDoc' => [ - 'title' => '模型介绍文档', - 'description' => '模型介绍文档。', - 'type' => 'string', - 'example' => 'https://***.md', - ], - 'Provider' => [ - 'title' => '模型提供者', - 'description' => '模型提供者。', - 'type' => 'string', - 'example' => 'pai', - ], - 'ModelType' => [ - 'title' => '模型类型', - 'description' => '模型类型。如Checkpoint，LoRA等。', - 'type' => 'string', - 'example' => 'Checkpoint', - ], + 'LatestVersion' => ['title' => '最新版本', 'description' => '模型最新版本。', '$ref' => '#/components/schemas/ModelVersion'], + 'OrderNumber' => ['title' => '模型序号', 'description' => '模型序号', 'type' => 'integer', 'format' => 'int64', 'example' => '101'], + 'Origin' => ['title' => '模型源', 'description' => '模型源。描述源模型所属社区或组织，如ModelScope、HuggingFace等。', 'type' => 'string', 'example' => 'ModelScope'], + 'Domain' => ['title' => '领域', 'description' => '领域。描述模型解决问题所属领域，如nlp（自然语言处理），cv（计算机视觉）等。', 'type' => 'string', 'example' => 'nlp'], + 'Task' => ['title' => '任务', 'description' => '任务。描述模型解决的具体问题，如text-classification（文本分类）等。', 'type' => 'string', 'example' => 'text-classifiaction'], + 'ModelDoc' => ['title' => '模型介绍文档', 'description' => '模型介绍文档。', 'type' => 'string', 'example' => 'https://***.md'], + 'Provider' => ['title' => '模型提供者', 'description' => '模型提供者。', 'type' => 'string', 'example' => 'pai'], + 'ModelType' => ['title' => '模型类型', 'description' => '模型类型。如Checkpoint，LoRA等。', 'type' => 'string', 'example' => 'Checkpoint'], 'Labels' => [ 'title' => '标签列表', 'description' => '标签列表。将废弃，由Tag取代。', 'type' => 'array', - 'items' => [ - 'description' => '标签。', - '$ref' => '#/components/schemas/Label', - ], + 'items' => ['description' => '标签。', '$ref' => '#/components/schemas/Label'], ], 'Tags' => [ 'title' => '标签列表', 'description' => '标签列表', 'type' => 'array', - 'items' => [ - 'description' => '标签。', - '$ref' => '#/components/schemas/Label', - ], - ], - 'ExtraInfo' => [ - 'description' => '其它信息。', - 'type' => 'object', - 'example' => '{'."\n" - .' "RatingCount": 2866,'."\n" - .' "Rating": 4.94,'."\n" - .' "FavoriteCount": 34992,'."\n" - .' "CommentCount": 754,'."\n" - .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" - .' "TippedAmountCount": 32,'."\n" - .' "DownloadCount": 606056'."\n" - .'}', - ], - 'ParameterSize' => [ - 'description' => '参数量，单位M。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'GmtLatestVersionModifiedTime' => [ - 'description' => '最后版本更新时间。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35Z', + 'items' => ['description' => '标签。', '$ref' => '#/components/schemas/Label'], ], + 'ExtraInfo' => ['description' => '其它信息。', 'type' => 'object', 'example' => '{'."\n" + .' "RatingCount": 2866,'."\n" + .' "Rating": 4.94,'."\n" + .' "FavoriteCount": 34992,'."\n" + .' "CommentCount": 754,'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" + .' "TippedAmountCount": 32,'."\n" + .' "DownloadCount": 606056'."\n" + .'}'], + 'ParameterSize' => ['description' => '参数量，单位M。', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], + 'GmtLatestVersionModifiedTime' => ['description' => '最后版本更新时间。', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z'], ], ], 'ModelVersion' => [ @@ -2210,52 +957,17 @@ 'description' => '模型版本。', 'type' => 'object', 'properties' => [ - 'VersionName' => [ - 'title' => '版本名，模型下唯一', - 'description' => '模型版本，模型下唯一。若不填，则默认`0.1.0`为第一个版本，之后子版本号加1，如第二个版本将默认为`0.2.0`。'."\n" - ."\n" - .'版本号由主版本号，子版本号，阶段版本号组成，由`.`分割，其中主版本号，子版本号为数字，阶段版本号以数字开头，接`_`加字母组成。如：1.1.0 或 2.3.4_beta。'."\n" - ."\n" - .'正则表达参考：`"^\\\\d+\\\\.\\\\d+\\\\.\\\\d+(_\\\\w+)?$"`', - 'type' => 'string', - 'example' => '0.1.0', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建模型UTC时间，格式为ISO 8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35Z', - ], - 'GmtModifiedTime' => [ - 'title' => '最后更新时间', - 'description' => '最后更新模型UTC时间，格式为ISO 8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35Z', - ], - 'UserId' => [ - 'title' => '创建模型版本的用户ID', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '155770209******', - ], - 'OwnerId' => [ - 'title' => '云账号ID', - 'description' => '主账号ID。', - 'type' => 'string', - 'example' => '155770209******', - ], - 'Uri' => [ - 'title' => '版本的URI', - 'description' => '模型版本URI，即模型存储位置。可以为模型的HTTP(S)地址，如：`https://myweb.com/mymodel.tar.gz`；若模型在OSS中，格式为`oss://./object`，endpoint可以在OSS控制台查询，样例：`oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`。', - 'type' => 'string', - 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/', - ], - 'VersionDescription' => [ - 'title' => '版本的描述', - 'description' => '模型版本描述。', - 'type' => 'string', - 'example' => '情感分析。', - ], + 'VersionName' => ['title' => '版本名，模型下唯一', 'description' => '模型版本，模型下唯一。若不填，则默认`0.1.0`为第一个版本，之后子版本号加1，如第二个版本将默认为`0.2.0`。'."\n" + ."\n" + .'版本号由主版本号，子版本号，阶段版本号组成，由`.`分割，其中主版本号，子版本号为数字，阶段版本号以数字开头，接`_`加字母组成。如：1.1.0 或 2.3.4_beta。'."\n" + ."\n" + .'正则表达参考：`"^\\\\d+\\\\.\\\\d+\\\\.\\\\d+(_\\\\w+)?$"`', 'type' => 'string', 'example' => '0.1.0'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建模型UTC时间，格式为ISO 8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z'], + 'GmtModifiedTime' => ['title' => '最后更新时间', 'description' => '最后更新模型UTC时间，格式为ISO 8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z'], + 'UserId' => ['title' => '创建模型版本的用户ID', 'description' => '用户ID。', 'type' => 'string', 'example' => '155770209******'], + 'OwnerId' => ['title' => '云账号ID', 'description' => '主账号ID。', 'type' => 'string', 'example' => '155770209******'], + 'Uri' => ['title' => '版本的URI', 'description' => '模型版本URI，即模型存储位置。可以为模型的HTTP(S)地址，如：`https://myweb.com/mymodel.tar.gz`；若模型在OSS中，格式为`oss://./object`，endpoint可以在OSS控制台查询，样例：`oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/'], + 'VersionDescription' => ['title' => '版本的描述', 'description' => '模型版本描述。', 'type' => 'string', 'example' => '情感分析。'], 'FormatType' => [ 'title' => '模型格式', 'description' => '模型格式。'."\n" @@ -2270,18 +982,7 @@ .'- AlinkModel'."\n" .'- ONNX', 'type' => 'string', - 'enumValueTitles' => [ - 'OfflineModel' => 'OfflineModel', - 'SavedModel' => 'SavedModel', - 'Keras H5' => 'Keras H5', - 'Frozen Pb' => 'Frozen Pb', - 'Caffe Prototxt' => 'Caffe Prototxt', - 'TorchScript' => 'TorchScript', - 'XGBoost' => 'XGBoost', - 'PMML' => 'PMML', - 'AlinkModel' => 'AlinkModel', - 'ONNX' => 'ONNX', - ], + 'enumValueTitles' => ['OfflineModel' => 'OfflineModel', 'SavedModel' => 'SavedModel', 'Keras H5' => 'Keras H5', 'Frozen Pb' => 'Frozen Pb', 'Caffe Prototxt' => 'Caffe Prototxt', 'TorchScript' => 'TorchScript', 'XGBoost' => 'XGBoost', 'PMML' => 'PMML', 'AlinkModel' => 'AlinkModel', 'ONNX' => 'ONNX'], 'example' => 'SavedModel', ], 'FrameworkType' => [ @@ -2295,23 +996,10 @@ .'- Xflow'."\n" .'- TensorFlow', 'type' => 'string', - 'enumValueTitles' => [ - 'Pytorch' => 'Pytorch', - 'XGBoost' => 'XGBoost', - 'Keras' => 'Keras', - 'Caffe' => 'Caffe', - 'Alink' => 'Alink', - 'Xflow' => 'Xflow', - 'TensorFlow' => 'TensorFlow', - ], + 'enumValueTitles' => ['Pytorch' => 'Pytorch', 'XGBoost' => 'XGBoost', 'Keras' => 'Keras', 'Caffe' => 'Caffe', 'Alink' => 'Alink', 'Xflow' => 'Xflow', 'TensorFlow' => 'TensorFlow'], 'example' => 'TensorFlow', ], - 'Options' => [ - 'title' => '扩展字段', - 'description' => '扩展字段。JsonString类型。', - 'type' => 'string', - 'example' => '{}', - ], + 'Options' => ['title' => '扩展字段', 'description' => '扩展字段。JsonString类型。', 'type' => 'string', 'example' => '{}'], 'SourceType' => [ 'title' => '来源类型', 'description' => '模型来源类型，默认为Custom。'."\n" @@ -2320,36 +1008,22 @@ .'- PAIFlow：PAI工作流。'."\n" .'- TrainingService：PAI训练服务。', 'type' => 'string', - 'enumValueTitles' => [ - 'PAIFlow' => 'PAIFlow', - 'Custom' => 'Custom', - 'TrainingService' => 'TrainingService', - ], + 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], 'example' => 'PAIFlow', ], - 'SourceId' => [ - 'title' => '来源ID', - 'description' => '来源ID。'."\n" - ."\n" - .'* 来源类型为Custom时，该字段不做限制。'."\n" - ."\n" - .'* 来源为PAIFlow，TrainingService时，格式为 '."\n" - .'```'."\n" - .'region=,workspaceId=,kind=,id='."\n" - .'```'."\n" - .'region 为阿里云区域ID；workspacceId 为工作空间ID；kind为类型，取值：PipelineRun（PAIFlow工作流），ServiceJob（训练服务）；id 为唯一标识。', - 'type' => 'string', - 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf', - ], - 'ApprovalStatus' => [ - 'title' => '准入状态', - 'description' => '准入状态，取值如下：'."\n" - .'- Pending：待定。'."\n" - .'- Approved：允许上线。'."\n" - .'- Rejected：不允许上线。', - 'type' => 'string', - 'example' => 'Approved', - ], + 'SourceId' => ['title' => '来源ID', 'description' => '来源ID。'."\n" + ."\n" + .'* 来源类型为Custom时，该字段不做限制。'."\n" + ."\n" + .'* 来源为PAIFlow，TrainingService时，格式为 '."\n" + .'```'."\n" + .'region=,workspaceId=,kind=,id='."\n" + .'```'."\n" + .'region 为阿里云区域ID；workspacceId 为工作空间ID；kind为类型，取值：PipelineRun（PAIFlow工作流），ServiceJob（训练服务）；id 为唯一标识。', 'type' => 'string', 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], + 'ApprovalStatus' => ['title' => '准入状态', 'description' => '准入状态，取值如下：'."\n" + .'- Pending：待定。'."\n" + .'- Approved：允许上线。'."\n" + .'- Rejected：不允许上线。', 'type' => 'string', 'example' => 'Approved'], 'Labels' => [ 'title' => '标签列表', 'description' => '标签列表。', @@ -2358,131 +1032,101 @@ 'description' => '标签。', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '标签的value', - 'description' => '标签的value', - 'type' => 'string', - 'example' => 'v1', - ], - 'Key' => [ - 'title' => '标签的key', - 'description' => '标签的key', - 'type' => 'string', - 'example' => 'k1', - ], - ], - ], - ], - 'Metrics' => [ - 'description' => '模型指标。', - 'type' => 'object', - 'example' => '{'."\n" - .' "Results": [{'."\n" - .' "Dataset": {'."\n" - .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" - .' },'."\n" - .' "Metrics": {'."\n" - .' "cer": 0.175'."\n" - .' }'."\n" - .' }, {'."\n" - .' "Dataset": {'."\n" - .' "Uri": "oss://xxxx/"'."\n" - .' },'."\n" - .' "Metrics": {'."\n" - .' "cer": 0.172'."\n" - .' }'."\n" - .' }]'."\n" - .'}', - ], - 'TrainingSpec' => [ - 'description' => '训练配置。用于微调、增量训练的配置。', - 'type' => 'object', - 'example' => '{}', - ], - 'InferenceSpec' => [ - 'description' => '描述如何应用于下游的推理应用：如描述EAS的processor/container等，如：'."\n" - .'`{'."\n" - .' "processor": "tensorflow_gpu_1.12"'."\n" - .'}`', - 'type' => 'object', - 'example' => '{'."\n" - .' "processor": "tensorflow_gpu_1.12"'."\n" - .'}', - ], - 'EvaluationSpec' => [ - 'description' => '评测配置。', - 'type' => 'object', - 'example' => '{}', - ], - 'CompressionSpec' => [ - 'description' => '压缩配置。', - 'type' => 'object', - 'example' => '{}', - ], - 'ExtraInfo' => [ - 'description' => '其它信息。', - 'type' => 'object', - 'example' => '{'."\n" - .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" - .' "TrainedWords": ["albedo_overlord"]'."\n" - .'}', - ], - 'DistillationSpec' => [ - 'description' => '蒸馏配置。', - 'type' => 'object', - 'example' => '{}', - ], + 'Key' => ['title' => '标签的key', 'description' => '标签的key', 'type' => 'string', 'example' => 'k1'], + 'Value' => ['title' => '标签的value', 'description' => '标签的value', 'type' => 'string', 'example' => 'v1'], + ], + ], + ], + 'Metrics' => ['description' => '模型指标。', 'type' => 'object', 'example' => '{'."\n" + .' "Results": [{'."\n" + .' "Dataset": {'."\n" + .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" + .' },'."\n" + .' "Metrics": {'."\n" + .' "cer": 0.175'."\n" + .' }'."\n" + .' }, {'."\n" + .' "Dataset": {'."\n" + .' "Uri": "oss://xxxx/"'."\n" + .' },'."\n" + .' "Metrics": {'."\n" + .' "cer": 0.172'."\n" + .' }'."\n" + .' }]'."\n" + .'}'], + 'TrainingSpec' => ['description' => '训练配置。用于微调、增量训练的配置。', 'type' => 'object', 'example' => '{}'], + 'InferenceSpec' => ['description' => '描述如何应用于下游的推理应用：如描述EAS的processor/container等，如：'."\n" + .'`{'."\n" + .' "processor": "tensorflow_gpu_1.12"'."\n" + .'}`', 'type' => 'object', 'example' => '{'."\n" + .' "processor": "tensorflow_gpu_1.12"'."\n" + .'}'], + 'EvaluationSpec' => ['description' => '评测配置。', 'type' => 'object', 'example' => '{}'], + 'CompressionSpec' => ['description' => '压缩配置。', 'type' => 'object', 'example' => '{}'], + 'ExtraInfo' => ['description' => '其它信息。', 'type' => 'object', 'example' => '{'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" + .' "TrainedWords": ["albedo_overlord"]'."\n" + .'}'], + 'DistillationSpec' => ['description' => '蒸馏配置。', 'type' => 'object', 'example' => '{}'], ], ], 'ModulePermissions' => [ 'title' => 'A short description of struct', - 'description' => 'A short description of struct', + 'description' => '模块权限配置列表', 'type' => 'array', 'items' => [ + 'description' => '权限结构体。', 'type' => 'object', 'properties' => [ - 'ModuleName' => [ - 'title' => 'ModuleName', - 'description' => 'ModuleName', - 'type' => 'string', - ], - 'PermissionType' => [ - 'title' => 'PermissionType', - 'description' => 'PermissionType', - 'type' => 'string', - ], + 'ModuleName' => ['title' => 'ModuleName', 'description' => '模块名。可取值：'."\n" + .'- PaiDesigner：可视化建模（Designer）'."\n" + .'- Paiflow：工作流'."\n" + .'- DSW：交互式建模（DSW）'."\n" + .'- DLC：分布式训练（DLC）'."\n" + .'- Dataset：数据集'."\n" + .'- Model：模型'."\n" + .'- Image：镜像'."\n" + .'- CodeSource：代码配置'."\n" + .'- PaiWorkspace@@Workspace：工作空间基本信息'."\n" + .'- PaiWorkspace@@MemberRole：工作空间成员管理'."\n" + .'- PaiWorkspace@@Resource：工作空间计算资源管理'."\n" + .'- PaiWorkspace@@Config：工作空间配置中心'."\n" + .'- ArtLab：ArtLab', 'type' => 'string', 'example' => 'PaiDesigner'], + 'PermissionType' => ['title' => 'PermissionType', 'description' => '权限类型。取值如下：'."\n" + .'- ReadOnly：只读'."\n" + .'- ReadWrite：可编辑/运行'."\n" + .'- FullAccess：完全控制'."\n" + .'- NoPrivilege：无权限'."\n" + .'- CustomPermissions: 自定义权限', 'type' => 'string', 'example' => 'ReadOnly'], 'Permissions' => [ 'title' => 'Permissions', - 'description' => 'Permissions', + 'description' => '权限列表。仅PermissionType为CustomPermissions时才有效，且必填。', 'type' => 'array', 'items' => [ + 'description' => '权限对象', 'type' => 'object', 'properties' => [ 'PermissionCodes' => [ 'title' => 'PermissionCodes', - 'description' => 'PermissionCodes', + 'description' => '权限点列表。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['description' => '权限点的名字，同地域内唯一。权限点介绍，请参见[附录：角色及权限列表](~~2840449~~)。', 'type' => 'string', 'example' => 'PaiDLC:GetTensorboard'], ], 'PermissionRules' => [ 'title' => 'PermissionRules', - 'description' => 'PermissionRules', + 'description' => '权限规则列表。', 'type' => 'array', 'items' => [ + 'description' => '权限规则。', 'type' => 'object', 'properties' => [ - 'Accessibility' => [ - 'title' => 'Accessibility', - 'description' => 'Accessibility', - 'type' => 'string', - ], - 'EntityAccessType' => [ - 'title' => 'EntityAccessType', - 'description' => 'EntityAccessType', - 'type' => 'string', - ], + 'Accessibility' => ['title' => 'Accessibility', 'description' => '访问类型，可能值：'."\n" + .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" + .'- PRIVATE：只有创建者可以操作。'."\n" + .'- ANY：创建者和非创建者都可以操作。', 'type' => 'string', 'example' => 'PRIVATE'], + 'EntityAccessType' => ['title' => 'EntityAccessType', 'description' => '存取类型。 当 Accessibility 为 PUBLIC，所有用户都能操作，此值无效； 当 Accessibility 为 PRIVATE 时，根据 EntityAccessType 的值决定权限，EntityAccessType 支持如下值：'."\n" + .'- CREATOR：只有创建者可以操作。'."\n" + .'- ANY：创建者和非创建者都可以操作。', 'type' => 'string', 'example' => 'CREATOR'], ], ], ], @@ -2497,38 +1141,14 @@ 'description' => '提示词数据结构', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'title' => '创建时间', - 'type' => 'string', - ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'type' => 'string', - ], - 'PromptName' => [ - 'title' => '提示词名称', - 'type' => 'string', - ], - 'FrameworkType' => [ - 'title' => '提示词框架类型', - 'type' => 'string', - ], - 'FrameworkContent' => [ - 'title' => '提示词框架内容', - 'type' => 'string', - ], - 'PromptId' => [ - 'title' => '提示词id', - 'type' => 'string', - ], - 'Description' => [ - 'title' => '提示词描述信息', - 'type' => 'string', - ], - 'Accessibility' => [ - 'title' => '工作空间可见性', - 'type' => 'string', - ], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string'], + 'ModifyTime' => ['title' => '修改时间', 'type' => 'string'], + 'PromptName' => ['title' => '提示词名称', 'type' => 'string'], + 'FrameworkType' => ['title' => '提示词框架类型', 'type' => 'string'], + 'FrameworkContent' => ['title' => '提示词框架内容', 'type' => 'string'], + 'PromptId' => ['title' => '提示词id', 'type' => 'string'], + 'Description' => ['title' => '提示词描述信息', 'type' => 'string'], + 'Accessibility' => ['title' => '工作空间可见性', 'type' => 'string'], ], ], 'Relation' => [ @@ -2536,21 +1156,9 @@ 'description' => 'Relation', 'type' => 'object', 'properties' => [ - 'ErrMsg' => [ - 'title' => 'ErrMsg', - 'description' => 'ErrMsg', - 'type' => 'string', - ], - 'LineageRelation' => [ - 'title' => 'LineageRelation', - 'description' => 'LineageRelation', - '$ref' => '#/components/schemas/LineageRelation', - ], - 'Result' => [ - 'title' => 'Result', - 'description' => 'Result', - 'type' => 'boolean', - ], + 'ErrMsg' => ['title' => 'ErrMsg', 'description' => 'ErrMsg', 'type' => 'string'], + 'LineageRelation' => ['title' => 'LineageRelation', 'description' => 'LineageRelation', '$ref' => '#/components/schemas/LineageRelation'], + 'Result' => ['title' => 'Result', 'description' => 'Result', 'type' => 'boolean'], ], ], 'Relationship' => [ @@ -2558,26 +1166,10 @@ 'description' => 'Relationship', 'type' => 'object', 'properties' => [ - 'Attributes' => [ - 'title' => 'Attributes', - 'description' => 'Attributes', - 'type' => 'object', - ], - 'DataChannel' => [ - 'title' => 'DataChannel', - 'description' => 'DataChannel', - 'type' => 'string', - ], - 'RelationshipGuid' => [ - 'title' => 'RelationshipGuid', - 'description' => 'RelationshipGuid', - 'type' => 'string', - ], - 'RelationshipType' => [ - 'title' => 'RelationshipType', - 'description' => 'RelationshipType', - 'type' => 'string', - ], + 'Attributes' => ['title' => 'Attributes', 'description' => 'Attributes', 'type' => 'object'], + 'DataChannel' => ['title' => 'DataChannel', 'description' => 'DataChannel', 'type' => 'string'], + 'RelationshipGuid' => ['title' => 'RelationshipGuid', 'description' => 'RelationshipGuid', 'type' => 'string'], + 'RelationshipType' => ['title' => 'RelationshipType', 'description' => 'RelationshipType', 'type' => 'string'], ], ], 'Run' => [ @@ -2589,104 +1181,38 @@ 'title' => '可见性', 'description' => '可见性', 'type' => 'string', - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'example' => 'PRIVATE', ], - 'SourceId' => [ - 'title' => '来源的PAI Workload的ID', - 'description' => '来源的PAI Workload的ID', - 'type' => 'string', - 'example' => 'train9s0afvjkf', - ], - 'SourceType' => [ - 'title' => '来源的PAI Workload类型', - 'description' => '来源的PAI Workload类型', - 'type' => 'string', - 'example' => 'TrainingService', - ], - 'WorkspaceId' => [ - 'title' => 'Run所属工作空间的ID', - 'description' => 'Run所属工作空间的ID', - 'type' => 'string', - 'example' => '145883', - ], + 'SourceId' => ['title' => '来源的PAI Workload的ID', 'description' => '来源的PAI Workload的ID', 'type' => 'string', 'example' => 'train9s0afvjkf'], + 'SourceType' => ['title' => '来源的PAI Workload类型', 'description' => '来源的PAI Workload类型', 'type' => 'string', 'example' => 'TrainingService'], + 'WorkspaceId' => ['title' => 'Run所属工作空间的ID', 'description' => 'Run所属工作空间的ID', 'type' => 'string', 'example' => '145883'], 'Params' => [ 'title' => 'Run的超参数列表', 'description' => 'Run的超参数列表', 'type' => 'array', - 'items' => [ - 'description' => '超参数', - '$ref' => '#/components/schemas/RunParam', - ], + 'items' => ['description' => '超参数', '$ref' => '#/components/schemas/RunParam'], ], 'Labels' => [ 'title' => 'Run的标签列表', 'description' => 'Run的标签列表', 'type' => 'array', - 'items' => [ - 'description' => '标签', - '$ref' => '#/components/schemas/RunLabel', - ], - ], - 'GmtModifiedTime' => [ - 'title' => '编辑时间', - 'description' => '编辑时间', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'Name' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'example' => 'testrun', + 'items' => ['description' => '标签', '$ref' => '#/components/schemas/RunLabel'], ], + 'GmtModifiedTime' => ['title' => '编辑时间', 'description' => '编辑时间', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'example' => 'testrun'], 'Metrics' => [ 'title' => 'Run的metric列表', 'description' => 'Run的metric列表', 'type' => 'array', - 'items' => [ - 'description' => '指标', - '$ref' => '#/components/schemas/RunMetric', - ], - ], - 'OwnerId' => [ - 'title' => '所有者主账号ID', - 'description' => '所有者主账号ID', - 'type' => 'string', - 'example' => '1631044****3440', - ], - 'ExperimentId' => [ - 'title' => 'Run关联的实验ID', - 'description' => 'Run关联的实验ID', - 'type' => 'string', - 'example' => 'exp-1zpfthdx******', - ], - 'UserId' => [ - 'title' => '所有者ID', - 'description' => '所有者ID', - 'type' => 'string', - ], - 'RunId' => [ - 'title' => 'Run唯一ID', - 'description' => 'Run唯一ID', - 'type' => 'string', - 'example' => 'run-1qJhzJ2YXgX****', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', + 'items' => ['description' => '指标', '$ref' => '#/components/schemas/RunMetric'], ], + 'OwnerId' => ['title' => '所有者主账号ID', 'description' => '所有者主账号ID', 'type' => 'string', 'example' => '163104*****3440'], + 'ExperimentId' => ['title' => 'Run关联的实验ID', 'description' => 'Run关联的实验ID', 'type' => 'string', 'example' => 'exp-1zpfthdx******'], + 'UserId' => ['title' => '所有者ID', 'description' => '所有者ID', 'type' => 'string'], + 'RunId' => ['title' => 'Run唯一ID', 'description' => 'Run唯一ID', 'type' => 'string', 'example' => 'run-1qJhzJ2YXgX****'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], 'RunLabel' => [ @@ -2694,33 +1220,11 @@ 'description' => 'Run标签详情', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '标签的值', - 'description' => '标签的值', - 'type' => 'string', - 'required' => true, - ], - 'RunId' => [ - 'title' => '所属RunID', - 'description' => '所属RunID', - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'title' => '编辑时间', - 'description' => '编辑时间', - 'type' => 'string', - ], - 'Key' => [ - 'title' => '标签的Key', - 'description' => '标签的Key', - 'type' => 'string', - 'required' => true, - ], + 'Value' => ['title' => '标签的值', 'description' => '标签的值', 'type' => 'string', 'required' => true], + 'RunId' => ['title' => '所属RunID', 'description' => '所属RunID', 'type' => 'string'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string'], + 'GmtModifiedTime' => ['title' => '编辑时间', 'description' => '编辑时间', 'type' => 'string'], + 'Key' => ['title' => '标签的Key', 'description' => '标签的Key', 'type' => 'string', 'required' => true], ], ], 'RunMetric' => [ @@ -2728,31 +1232,10 @@ 'description' => '任务指标', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '指标值', - 'description' => '指标值', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - ], - 'Step' => [ - 'title' => '指标产生的步数', - 'description' => '指标产生的步数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Timestamp' => [ - 'title' => '指标产生的时间戳', - 'description' => '指标产生的时间戳', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Key' => [ - 'title' => '指标名称', - 'description' => '指标名称', - 'type' => 'string', - 'required' => true, - ], + 'Value' => ['title' => '指标值', 'description' => '指标值', 'type' => 'number', 'format' => 'float', 'required' => true], + 'Step' => ['title' => '指标产生的步数', 'description' => '指标产生的步数', 'type' => 'integer', 'format' => 'int64'], + 'Timestamp' => ['title' => '指标产生的时间戳', 'description' => '指标产生的时间戳', 'type' => 'integer', 'format' => 'int64'], + 'Key' => ['title' => '指标名称', 'description' => '指标名称', 'type' => 'string', 'required' => true], ], ], 'RunParam' => [ @@ -2760,153 +1243,99 @@ 'description' => '任务参数', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '参数值', - 'description' => '参数值', - 'type' => 'string', - 'required' => true, - ], - 'Key' => [ - 'title' => '参数名', - 'description' => '参数名', - 'type' => 'string', - 'required' => true, + 'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => true], + 'Key' => ['title' => '参数名', 'description' => '参数名', 'type' => 'string', 'required' => true], + ], + ], + 'ServiceTemplate' => [ + 'title' => 'A short description of struct', + 'description' => '服务模版。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ServiceTemplateId' => ['title' => '服务模版ID', 'description' => '服务模版ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'st-asdkjf**skdhh', 'backendName' => 'ServiceTemplateId'], + 'ServiceTemplateName' => ['title' => '服务模版名称', 'description' => '服务模版名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'foo', 'backendName' => 'ServiceTemplateName'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'backendName' => 'GmtCreateTime'], + 'GmtModifiedTime' => ['title' => '更新时间', 'description' => '更新时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'backendName' => 'GmtModifiedTime'], + 'UserId' => ['title' => '创建者ID', 'description' => '创建者ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => '155770209****904', 'backendName' => 'UserId'], + 'OwnerId' => ['title' => '主账号ID', 'description' => '主账号ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => '155770209****904', 'backendName' => 'OwnerId'], + 'OrderNumber' => ['title' => '序号', 'description' => '序号。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'OrderNumber'], + 'Provider' => ['title' => '提供者', 'description' => '提供者。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'pai', 'backendName' => 'Provider'], + 'ServiceTemplateDoc' => ['title' => '服务模版文档', 'description' => '服务模版文档。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://***.md', 'backendName' => 'ServiceTemplateDoc'], + 'ServiceTemplateDescription' => ['title' => '描述', 'description' => '描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => '这里是一个描述。', 'backendName' => 'ServiceTemplateDescription'], + 'InferenceSpec' => ['title' => '模版配置', 'description' => '模版配置。', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "processor": "tensorflow_gpu_1.12" }', 'backendName' => 'InferenceSpec'], + 'Labels' => [ + 'title' => '标签列表', + 'description' => '标签列表。', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => ['description' => '标签。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/Label'], + 'backendName' => 'Labels', ], ], ], 'Trial' => [ 'title' => 'A short description of struct', 'description' => 'Trial', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'Name', - 'description' => 'Name', - 'type' => 'string', - ], - 'TrialId' => [ - 'title' => 'TrialId', - 'description' => 'TrialId', - 'type' => 'string', - ], - 'SourceType' => [ - 'title' => 'SourceType', - 'description' => 'SourceType', - 'type' => 'string', - ], - 'SourceId' => [ - 'title' => 'SourceId', - 'description' => 'SourceId', - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'title' => 'WorkspaceId', - 'description' => 'WorkspaceId', - 'type' => 'string', - ], - 'ExperimentId' => [ - 'title' => 'ExperimentId', - 'description' => 'ExperimentId', - 'type' => 'string', - ], + 'Name' => ['title' => 'Name', 'description' => 'Name', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'Name'], + 'TrialId' => ['title' => 'TrialId', 'description' => 'TrialId', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'TrialId'], + 'SourceType' => ['title' => 'SourceType', 'description' => 'SourceType', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'SourceType'], + 'SourceId' => ['title' => 'SourceId', 'description' => 'SourceId', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'SourceId'], + 'WorkspaceId' => ['title' => 'WorkspaceId', 'description' => 'WorkspaceId', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'WorkspaceId'], + 'ExperimentId' => ['title' => 'ExperimentId', 'description' => 'ExperimentId', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'ExperimentId'], 'Labels' => [ 'title' => 'Labels', 'description' => 'Labels', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'type' => 'object', - ], - ], - 'UserId' => [ - 'title' => 'UserId', - 'description' => 'UserId', - 'type' => 'string', - ], - 'OwnerId' => [ - 'title' => 'OwnerId', - 'description' => 'OwnerId', - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'title' => 'GmtCreateTime', - 'description' => 'GmtCreateTime', - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'title' => 'GmtModifiedTime', - 'description' => 'GmtModifiedTime', - 'type' => 'string', - ], - 'Accessibility' => [ - 'title' => 'Accessibility', - 'description' => 'Accessibility', - 'type' => 'string', + 'items' => ['visibility' => 'Public', 'type' => 'object', 'extendType' => 'true'], + 'backendName' => 'Labels', ], + 'UserId' => ['title' => 'UserId', 'description' => 'UserId', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'UserId'], + 'OwnerId' => ['title' => 'OwnerId', 'description' => 'OwnerId', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'OwnerId'], + 'GmtCreateTime' => ['title' => 'GmtCreateTime', 'description' => 'GmtCreateTime', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'GmtCreateTime'], + 'GmtModifiedTime' => ['title' => 'GmtModifiedTime', 'description' => 'GmtModifiedTime', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'GmtModifiedTime'], + 'Accessibility' => ['title' => 'Accessibility', 'description' => 'Accessibility', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'Accessibility'], ], ], 'TrialLabel' => [ 'title' => 'A short description of struct', 'description' => 'TrialLabel', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => 'Key of Trial Label', - 'description' => 'Key of Trial Label', - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => 'Value of Trial Label', - 'description' => 'Value of Trial Label', - 'type' => 'string', - 'example' => 'value', - ], - 'GmtCreateTime' => [ - 'title' => 'Create time', - 'description' => 'Create time', - 'type' => 'string', - 'example' => '2023-12-27T03:30:04Z', - ], - 'GmtModifiedTime' => [ - 'title' => 'Modified time', - 'description' => 'Modified time', - 'type' => 'string', - 'example' => '2023-12-27T03:30:04Z', - ], - 'TrialId' => [ - 'title' => 'trl-v0fw9a0sd8f9af', - 'description' => 'trl-v0fw9a0sd8f9af', - 'type' => 'string', - ], + 'Key' => ['title' => 'Key of Trial Label', 'description' => 'Key of Trial Label', 'visibility' => 'Public', 'type' => 'string', 'example' => 'key', 'backendName' => 'Key'], + 'Value' => ['title' => 'Value of Trial Label', 'description' => 'Value of Trial Label', 'visibility' => 'Public', 'type' => 'string', 'example' => 'value', 'backendName' => 'Value'], + 'GmtCreateTime' => ['title' => 'Create time', 'description' => 'Create time', 'visibility' => 'Public', 'type' => 'string', 'example' => '2023-12-27T03:30:04Z', 'backendName' => 'GmtCreateTime'], + 'GmtModifiedTime' => ['title' => 'Modified time', 'description' => 'Modified time', 'visibility' => 'Public', 'type' => 'string', 'example' => '2023-12-27T03:30:04Z', 'backendName' => 'GmtModifiedTime'], + 'TrialId' => ['title' => 'trl-v0fw9a0sd8f9af', 'description' => 'trl-v0fw9a0sd8f9af', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'TrialId'], ], ], ], ], 'apis' => [ - 'CreateExperiment' => [ - 'summary' => '创建实验', - 'path' => '/api/v1/experiments', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AcceptDataworksEvent' => [ + 'path' => '/api/v1/workspaces/action/acceptdataworksevent', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '206973', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259201', + 'abilityTreeNodes' => ['FEATURElearn8QX455'], ], 'parameters' => [ [ @@ -2914,57 +1343,11 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => 'body参数', + 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '478**', - ], - 'Labels' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'array', - 'items' => [ - 'description' => '标签', - 'required' => false, - '$ref' => '#/components/schemas/LabelInfo', - ], - 'required' => false, - ], - 'Name' => [ - 'title' => '名称', - 'description' => '实验（Experiment）的名称。命名规则如下：'."\n" - ."\n" - .'- 以小写字母、大写字母开头。'."\n" - .'- 可以包含大小写字母、数字、下划线（_）或短划线（-）。'."\n" - .'- 长度为1~63个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'exp-test', - ], - 'ArtifactUri' => [ - 'title' => 'Artifact路径', - 'description' => '关联到实验的所有任务的默认Artifact输出路径，当前仅支持OSS路径', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/test', - ], - 'Accessibility' => [ - 'description' => '可见性，分为私有（即仅创建者及其主账号可见）、公开（即所有人可见）；非必填，默认为私有。', - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE', - 'default' => 'PRIVATE', - 'enum' => [ - 'PRIVATE', - 'PUBLIC', - ], - ], + 'MessageId' => ['description' => 'DataWorks 开放消息的消息 ID。当触发扩展点事件后，可以从接收到的事件消息中获取消息 ID。消息格式，请参见[消息格式](~~436911~~)。', 'type' => 'string', 'required' => false, 'example' => '539306ba-*****-41a0-****-6dc81060985c'], + 'Data' => ['description' => '消息对应的事件内容。', 'type' => 'object', 'required' => false, 'example' => '{"eventCode":"d****ct","projectId":"8***6","tenantId":4*******8,"operator":"115*****901"}'], ], 'required' => false, ], @@ -2974,52 +1357,46 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '请求ID', - ], - 'ExperimentId' => [ - 'title' => '若创建接口为异步实现，则需返回明确的JobId。', - 'description' => '若创建接口为异步实现，则需返回明确的JobId。', - 'type' => 'string', - 'example' => 'API请求完成创建的实验ID', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"请求ID\\",\\n \\"ExperimentId\\": \\"API请求完成创建的实验ID\\"\\n}","type":"json"}]', - 'title' => '创建实验', - ], - 'UpdateExperiment' => [ - 'summary' => '更新实验', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '接收并处理DataWorks系统事件', + 'summary' => 'PAI系统用于接收并处理DataWorks发送的系统事件消息。', + 'description' => '此接口仅限于内部系统调用，外部用户无法使用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AcceptDataworksEvent'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + ], + 'AddImage' => [ + 'path' => '/api/v1/images', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '206975', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '61619', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ @@ -3027,303 +1404,322 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => 'body参数', + 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '名称', - 'description' => '实验（Experiment）的名称。命名规则如下：'."\n" + 'Name' => ['title' => '镜像名称', 'description' => '镜像名称。命名规则如下：'."\n" + .'- 长度为1~50个英文字符。'."\n" + .'- 支持小写字母、数字和短横线（-），以字母开头。'."\n" + .'- 同一工作空间内不可重复。', 'type' => 'string', 'required' => true, 'example' => 'nlp-compression'], + 'Description' => ['title' => '镜像描述', 'description' => '镜像的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'NLP model compression training image'], + 'ImageUri' => ['title' => '镜像地址', 'description' => '镜像地址，可以重复。关于如何查看镜像地址，详情请参见[ListImage](~~449118~~)。', 'type' => 'string', 'required' => true, 'example' => 'registry.cn-hangzhou.aliyuncs.com/pai-compression/nlp:gpu'], + 'Labels' => [ + 'title' => '镜像标签，是个数组', + 'description' => '镜像标签，是个数组，数组每一项包含key和value两个字段。'."\n" + .'官方镜像有如下标签：system.official=true'."\n" + .'目前支持添加的键如下：'."\n" ."\n" - .'- 以小写字母、大写字母开头。'."\n" - .'- 可以包含大小写字母、数字、下划线（_）或短划线（-）。'."\n" - .'- 长度为1~63个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'myName', - ], - 'Accessibility' => [ - 'description' => '工作空间可见度，取值如下。'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE', - 'enum' => [ - 'PRIVATE', - 'PUBLIC', + .'- system.chipType'."\n" + .'- system.dsw.cudaVersion'."\n" + .'- system.dsw.fromImageId'."\n" + .'- system.dsw.fromInstanceId'."\n" + .'- system.dsw.id'."\n" + .'- system.dsw.os'."\n" + .'- system.dsw.osVersion'."\n" + .'- system.dsw.resourceType'."\n" + .'- system.dsw.rootImageId'."\n" + .'- system.dsw.stage'."\n" + .'- system.dsw.tag'."\n" + .'- system.dsw.type'."\n" + .'- system.framework'."\n" + .'- system.origin'."\n" + .'- system.pythonVersion'."\n" + .'- system.source'."\n" + .'- system.supported.dlc'."\n" + .'- system.supported.dsw', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'Key', 'description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'system.chipType'], + 'Value' => ['title' => 'Value', 'description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'GPU'], + ], + 'required' => false, ], + 'required' => false, ], + 'WorkspaceId' => ['title' => '工作空间id', 'description' => '镜像所属的工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '15******45'], + 'Accessibility' => ['title' => '可见性 Public 公有 Private 私有', 'description' => '镜像的可见性，目前支持：'."\n" + ."\n" + .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" + .'- PRIVATE：只有创建者可以操作。', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], + 'Size' => ['description' => '镜像大小，单位为GB。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + 'ImageId' => ['description' => '镜像Id，如果不填，系统会自动生成。'."\n" + .'格式为image-18位大小写英文字母或者数字。', 'type' => 'string', 'required' => false, 'example' => 'image-k83*****cv'], + 'SourceType' => ['title' => '镜像来源类型：'."\n" + .' Import : 导入'."\n" + .' Build ：构建', 'type' => 'string', 'required' => false, 'description' => ''], + 'SourceId' => ['title' => '镜像来源 ID。 当镜像来源类型是“构建”时，来源 ID 对应镜像构建 ID。', 'type' => 'string', 'required' => false, 'description' => ''], ], 'required' => false, ], ], - [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => '实验ID', - 'type' => 'string', - 'required' => true, - 'example' => 'exp-1zpfthdx******', - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回结构体。'."\n" + ."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'ImageId' => ['title' => '镜像 id', 'description' => '镜像ID。', 'type' => 'string', 'example' => 'image-4c62******53uor'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '更新实验信息', - ], - 'GetExperiment' => [ - 'summary' => '获取实验', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加镜像', + 'summary' => '添加自定义镜像到工作空间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiimage:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ImageId\\": \\"image-4c62******53uor\\"\\n}","type":"json"}]', + ], + 'AddImageLabels' => [ + 'summary' => '为镜像添加标签。', + 'path' => '/api/v1/images/{ImageId}/labels', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '206972', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '61617', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ - 'name' => 'ExperimentId', + 'name' => 'ImageId', 'in' => 'path', - 'schema' => [ - 'description' => '实验ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'exp-1zpfthdx******', - ], + 'schema' => ['title' => '镜像Id', 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', 'type' => 'string', 'required' => true, 'example' => 'image-4c62******53uor'."\n"], ], [ - 'name' => 'Verbose', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '是否获取关联到Experiment的最新Run信息', - 'description' => '是否获取关联到Experiment的最新Run信息', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', + 'title' => '数据', + 'description' => '镜像标签。', + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'title' => '标签', + 'description' => '镜像标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'Key', 'description' => '标签的键，目前允许添加的键如下'."\n" + ."\n" + .'- system.chipType'."\n" + .'- system.dsw.cudaVersion'."\n" + .'- system.dsw.fromImageId'."\n" + .'- system.dsw.fromInstanceId'."\n" + .'- system.dsw.id'."\n" + .'- system.dsw.os'."\n" + .'- system.dsw.osVersion'."\n" + .'- system.dsw.resourceType'."\n" + .'- system.dsw.rootImageId'."\n" + .'- system.dsw.stage'."\n" + .'- system.dsw.tag'."\n" + .'- system.dsw.type'."\n" + .'- system.framework'."\n" + .'- system.origin'."\n" + .'- system.pythonVersion'."\n" + .'- system.source'."\n" + .'- system.supported.dlc'."\n" + .'- system.supported.dsw', 'type' => 'string', 'required' => false, 'example' => 'system.chipType'], + 'Value' => ['title' => 'Value', 'description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'GPU'], + ], + 'required' => false, + ], + 'required' => true, + ], ], - 'example' => 'false', - 'default' => 'false', + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Experiment实例信息', - '$ref' => '#/components/schemas/Experiment', + 'title' => 'Schema of Response', + 'description' => '返回结构体。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExperimentId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"ArtifactUri\\": \\"\\",\\n \\"TensorboardLogUri\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"GmtCreateTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"ExperimentId\\": \\"exp-890waerw09a0f\\"\\n }\\n ],\\n \\"UserId\\": \\"\\",\\n \\"OwnerId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"LatestRun\\": {\\n \\"Accessibility\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"\\",\\n \\"ExperimentId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => '获取实验详情', - ], - 'ListExperiment' => [ - 'summary' => '获取实验列表。', - 'path' => '/api/v1/experiments', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加镜像标签', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImageLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiimage:AddImageLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'AddMemberRole' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/members/{MemberId}/roles/{RoleName}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '206995', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, - ], + 'systemTags' => [], 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '实验名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'exp-test', - ], - ], [ 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实验所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。'."\n" - .'> 不填写工作空间ID，系统将返回默认工作空间的实验列表。'."\n" - .'>', - 'type' => 'string', - 'required' => false, - 'example' => '1517**', - ], + 'in' => 'path', + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '145883'], ], [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'description' => '标签过滤条件，多个条件以半角逗号（,）分隔。'."\n" - .'单个条件过滤格式为`Key=Value`。', - 'type' => 'string', - 'required' => false, - 'example' => 'is_evaluation:true', - ], + 'name' => 'MemberId', + 'in' => 'path', + 'schema' => ['title' => '成员 id', 'description' => '成员ID。如何获取成员ID，请参见[ListMembers](~~449135~~)。', 'type' => 'string', 'required' => true, 'example' => '145883-215139******688039'], ], [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '分页查询时的排序字段。目前GmtCreateTime字段用于排序。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - 'default' => 'GmtCreateTime', - ], + 'name' => 'RoleName', + 'in' => 'path', + 'schema' => ['title' => '角色', 'description' => '要添加的角色，支持官方角色与自定义角色：'."\n" + ."\n" + .'- 官方角色：如下所示，各角色权限请参见[附录：角色及权限列表](~~2840449~~) 。'."\n" + .' - PAI.AlgoDeveloper：算法开发。'."\n" + .' - PAI.AlgoOperator：算法运维。'."\n" + .' - PAI.LabelManager：标注管理员。'."\n" + .' - PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" + .' - PAI.WorkspaceAdmin：管理员。'."\n" + .' - PAI.WorkspaceGuest：访客。'."\n" + .' - PAI.WorkspaceOwner：负责人。'."\n" + ."\n" + .'- 自定义角色：填写角色ID。格式为role-开头，例如role-sw******2tij。', 'type' => 'string', 'required' => true, 'example' => 'PAI.AlgoDeveloper'], ], - [ - 'name' => 'Order', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '', - 'description' => '分页查询时，对指定的排序字段进行升序或降序。'."\n" - .'- ASC：升序。'."\n" - .'- DESC（默认）：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - 'default' => 'DESC', + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + ], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '分页编号，从1开始。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + ], + 'title' => '成员添加角色', + 'summary' => '为工作空间内的成员添加某个角色，使其拥有角色的权限。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMemberRole'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '排序方式字符串列表，支持排序的字段包括：GmtCreateTime、Name、GmtModifiedTime或ExperimentId。排序方式包括DESC和ASC，默认为ASC。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime DESC,Name ASC', - ], - ], - [ - 'name' => 'PageToken', - 'in' => 'query', - 'schema' => [ - 'description' => '分页token，从0开始，默认为0。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '请求的最大结果数，默认为10。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'default' => '10', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:AddMemberRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => '更改资源ID对应的资源组。', + 'path' => '/resourcegroups/action/changeresourcegroup', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'title' => '是否获取于实验相关的LatestRun', - 'description' => '是否获取于实验相关的LatestRun信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'False', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '249844', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], + ], + 'parameters' => [ [ - 'name' => 'Options', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '可选参数。', + 'description' => '请求body。', 'type' => 'object', 'properties' => [ - 'match_name_exactly' => [ - 'title' => '是否精确匹配名称，可以填“true“/”false“', - 'description' => '是否精确匹配名称，可以填“true“或”false“。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'ResourceId' => ['description' => '资源ID。这里的资源ID等于工作空间ID，如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '12**56'], + 'NewResourceGroupId' => ['description' => '新的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)', 'type' => 'string', 'required' => false, 'example' => 'rg-df********534dy'], + 'ResourceType' => ['description' => '资源组类型：必须填workspace。', 'type' => 'string', 'required' => false, 'example' => 'workspace'], ], 'required' => false, ], @@ -3333,126 +1729,58 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '对象。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C', - ], - 'TotalCount' => [ - 'description' => '记录总数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Experiments' => [ - 'description' => '实验列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实验详情。', - '$ref' => '#/components/schemas/Experiment', - ], - ], - 'NextPageToken' => [ - 'description' => '下一页标识。需记录下来，在下一次请求时传入即可。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6****27E-****-5144-A002-89C****8660F'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C\\",\\n \\"TotalCount\\": 5,\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"ArtifactUri\\": \\"\\",\\n \\"TensorboardLogUri\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"GmtCreateTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"ExperimentId\\": \\"exp-890waerw09a0f\\"\\n }\\n ],\\n \\"UserId\\": \\"\\",\\n \\"OwnerId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"LatestRun\\": {\\n \\"Accessibility\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"\\",\\n \\"ExperimentId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', - 'title' => '获取实验列表', - ], - 'DeleteExperiment' => [ - 'summary' => '删除实验', - 'path' => '/api/v1/experiments/{ExperimentId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '206974', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更改资源组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ], - 'autoTest' => true, + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => '实验ID', - 'type' => 'string', - 'required' => true, - 'example' => 'exp-1zpfthdx******', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', - 'title' => '删除实验', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6****27E-****-5144-A002-89C****8660F\\"\\n}","type":"json"}]', ], - 'SetExperimentLabels' => [ - 'summary' => '更新实验标签', - 'path' => '/api/v1/experiments/{ExperimentId}/labels', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateCodeSource' => [ + 'summary' => '创建代码配置到PAI，支持配置Git的代码分支与CommitId。创建完成后，可以在DLC作业中引用。', + 'path' => '/api/v1/codesources', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '207071', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55315', + 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], ], 'parameters' => [ [ @@ -3460,144 +1788,89 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => 'body参数', + 'description' => '请求结构。', 'type' => 'object', 'properties' => [ - 'Labels' => [ - 'description' => '标签列表', - 'type' => 'array', - 'items' => [ - 'description' => '标签详细信息，包括Key、Value。', - 'required' => false, - '$ref' => '#/components/schemas/LabelInfo', - ], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '1234'], + 'DisplayName' => ['title' => '代码源配置名称', 'description' => '代码配置名称。', 'type' => 'string', 'required' => true, 'example' => 'MyCodeSource1'], + 'Description' => ['title' => '代码源详细描述', 'description' => '代码配置的描述信息，便于区分不同的代码配置。', 'type' => 'string', 'required' => false, 'example' => 'code source of dlc examples'], + 'CodeRepo' => ['title' => '代码仓库地址', 'description' => '代码仓库地址（必填）。', 'type' => 'string', 'required' => false, 'example' => 'https://code.aliyun.com/******'], + 'CodeRepoUserName' => ['title' => '代码仓库的用户名', 'description' => '代码仓库的用户名。', 'type' => 'string', 'required' => false, 'example' => 'use***'], + 'CodeRepoAccessToken' => ['title' => '代码仓库访问Token', 'description' => '代码仓库访问Token。', 'type' => 'string', 'required' => false, 'example' => '***'], + 'CodeBranch' => ['title' => '代码分支', 'description' => '代码分支。', 'type' => 'string', 'required' => false, 'example' => 'master'], + 'MountPath' => ['title' => '代码本地挂载目录，默认挂载到/root/code/下', 'description' => '代码本地挂载目录（必填）。', 'type' => 'string', 'required' => false, 'example' => '/root/code/code-source-1'], + 'Accessibility' => [ + 'title' => '代码是否是本工作空间内公开的，可选值PRIVATE、PUBLIC', + 'description' => '代码配置的可见性。', + 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['PUBLIC' => '在此工作空间中，对所有人可见。', 'PRIVATE' => '在此工作空间中，仅对您和管理员可见。'], + 'example' => 'PRIVATE', ], + 'CodeCommit' => ['title' => '代码的CommitID。CodeCommit的优先级大于CodeBranch，即如果您填写了CodeCommit，则CodeBranch不会生效。', 'description' => '代码的CommitID。CodeCommit的优先级大于CodeBranch，如果填写了CodeCommit，则CodeBranch不会生效。', 'type' => 'string', 'required' => false, 'example' => '171de********a9d900d'], + 'CloneType' => ['description' => '克隆模式。取值如下：'."\n" + .'- 0（默认值）：新建子目录。'."\n" + .'- 1：平铺到当前目录。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], 'required' => false, ], ], - [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => '实验ID', - 'type' => 'string', - 'required' => true, - 'example' => 'exp-1zpfthdx******', - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'CodeSourceId' => ['title' => '创建的代码源配置的ID', 'description' => '创建的代码配置的ID。', 'type' => 'string', 'example' => 'code-20********'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3**********'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => 'SetExperimentLabels', - ], - 'DeleteExperimentLabel' => [ - 'summary' => '删除实验的标签', - 'path' => '/api/v1/experiments/{ExperimentId}/labels/{Key}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '207073', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-20********\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3**********\\"\\n}","type":"json"}]', + 'title' => '创建代码配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCodeSource'], ], - 'autoTest' => true, + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'parameters' => [ - [ - 'name' => 'ExperimentId', - 'in' => 'path', - 'schema' => [ - 'description' => '实验ID', - 'type' => 'string', - 'required' => true, - 'example' => 'exp-1zpfthdx******', - ], - ], + 'ramActions' => [ [ - 'name' => 'Key', - 'in' => 'path', - 'schema' => [ - 'description' => '要删除的实验标签的Key', - 'type' => 'string', - 'required' => true, - 'example' => 'is_evaluate', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paicodesource:CreateCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除实验的标签', ], - 'CreateRun' => [ - 'summary' => '创建一次运行，运行（Run）属于一个实验（Experiment），可以与具体的workload关联，也可以是一次单纯的代码运行。', - 'path' => '/api/v1/runs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateConnection' => [ + 'path' => '/api/v1/connections', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '233339', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267606', + 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ @@ -3605,162 +1878,432 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求结构体。', + 'description' => '请求结构体。创建连接所需要的参数信息。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => 'Run的名称，若创建时名称为空，则会使用服务端随机生成的RunID作为名称', - 'description' => '运行（Run）的名称。命名规则如下：'."\n" - .'- 以小写字母、大写字母开头。'."\n" - .'- 可以包含大小写字母、数字、下划线（_）或短划线（-）。'."\n" - .'- 长度为1~63个字符。'."\n" - ."\n" - .'若创建时名称为空，则会使用服务端生成的随机ID（RunID）作为名称', + 'Accessibility' => [ + 'description' => '工作空间可见度。默认值为PRIVATE。', 'type' => 'string', 'required' => false, - 'example' => 'myName', + 'enumValueTitles' => ['PUBLIC' => '在此工作空间中，仅对您和管理员可见。', 'PRIVATE' => '在此工作空间中，对所有人可见。'], + 'example' => 'PRIVATE', + 'default' => 'PRIVATE', ], - 'SourceType' => [ - 'title' => 'Run关联的PAI Workload类型', - 'description' => '与Run关联的PAI Workload来源类型，可选项包括TrainingService、DLC或为空。非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'DLC', + 'Configs' => [ + 'description' => '连接的配置信息。以key-valued的形式配置，不同的连接类型对应的Config配置的key不相同。具体参见请求参数补充说明。', + 'type' => 'object', + 'required' => true, + 'additionalProperties' => ['type' => 'string', 'example' => '6379', 'description' => '连接配置的value值。'], ], - 'SourceId' => [ - 'title' => 'Run关联的PAI Workload ID', - 'description' => 'Run关联的PAI Workload ID', + 'ConnectionName' => ['description' => '连接的名称。', 'type' => 'string', 'required' => true, 'example' => 'llm-connection'], + 'ConnectionType' => [ + 'description' => '连接的类型。', 'type' => 'string', 'required' => false, - 'example' => 'job-jdnhf***fnrimv', + 'enumValueTitles' => [ + 'ElasticsearchConnection' => 'Elasticsearch连接', 'MultimodalTagConnection' => '多模态VL智能标注模型', 'OpenSearchConnection' => 'OpenSearch 连接', 'IQSConnection' => '阿里云IQS联网搜索', 'RerankConnection' => '通用Reranker模型服务', 'DeepSeekConnection' => 'DeepSeek模型服务', 'MilvusConnection' => 'Milvus 连接', 'CustomMCPConnection' => '自定义MCP服务', 'HologresConnection' => 'Hologres 连接', 'DashScopeConnection' => '阿里云百炼大模型服务', + 'LindormConnection' => 'Lindorm连接', 'RDSConnection' => 'RDS 连接', 'OpenLLMConnection' => '通用LLM模型连接', 'OpenMultimodalEmbeddingConnection' => '通用多模态Embedding模型服务', 'CustomConnection' => '自定义连接', 'OpenEmbeddingConnection' => '通用Embedding模型服务', 'OpenSearchAIPlatformConnection' => 'AI搜索开放平台模型服务', 'FunctionAIMCPConnection' => 'Function AI MCP服务', + ], + 'example' => 'DashScopeConnection', ], - 'ExperimentId' => [ - 'title' => 'Run关联的实验ID', - 'description' => 'Run关联的实验ID', - 'type' => 'string', - 'required' => true, - 'example' => 'exp-6thbb5xrbmp*****', + 'Description' => ['description' => '连接的描述。', 'type' => 'string', 'required' => false, 'example' => 'Open-source LLM service connection.'], + 'Secrets' => [ + 'description' => '需要加密的连接配置信息。比如数据库的账密信息，模型服务的key等。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => '加密连接配置的value值。', 'example' => 'Dsjk***hsl01'], ], - 'Labels' => [ - 'title' => 'Run的标签', - 'description' => 'Run的标签列表', - 'type' => 'array', - 'items' => [ - 'description' => '标签详细信息', - 'required' => false, - '$ref' => '#/components/schemas/Label', + 'WorkspaceId' => ['description' => '工作空间ID，可从接口[ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => false, 'example' => '123**45'], + 'ResourceMeta' => [ + 'description' => '连接的资源信息。一般适用于数据库类型的连接配置。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'Test instance.'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ld-uf69****9nqjjes'], + 'Extra' => ['description' => '额外配置信息。', 'type' => 'string', 'required' => false, 'example' => '{"vpcId":"vpc-xxxx"}'], ], 'required' => false, ], - 'Params' => [ - 'description' => 'Run的参数列表', + 'Models' => [ + 'description' => '模型列表。适用于模型服务类型的连接。', 'type' => 'array', 'items' => [ - 'description' => '参数详细信息', - 'required' => false, - '$ref' => '#/components/schemas/RunParam', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ + 'description' => '模型。', + 'type' => 'object', + 'properties' => [ + 'Model' => ['description' => '模型标识符。OpenAI API请求中的model的参数值。', 'type' => 'string', 'required' => false, 'example' => 'model_001'], + 'DisplayName' => ['description' => '模型的显示名称。', 'type' => 'string', 'required' => false, 'example' => 'Language model'], + 'ModelType' => [ + 'description' => '模型类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Embedding' => 'Embedding 模型', 'LLM' => '大语言模型', 'ReRank' => 'ReRank 模型'], + 'example' => 'LLM', + ], + 'ToolCall' => [ + 'description' => '是否支持ToolCall工具调用。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '支持', 'false' => '不支持'], + 'example' => 'true', + ], + 'SupportReasoning' => [ + 'description' => '是否支持深度思考并将推理过程作为reasoning_content输出。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '支持', 'false' => '不支持'], + 'example' => 'true', + ], + 'SupportResponseSchema' => [ + 'description' => '是否支持OpenAI API的JSON Schema结构化输出。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '支持', 'false' => '不支持'], + 'example' => 'true', + ], + 'SupportVision' => [ + 'description' => '是否支持视觉理解。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '支持', 'false' => '不支持'], + 'example' => 'false', + ], + 'MaxModelLength' => ['description' => '上下文长度。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4096'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回信息。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', - ], - 'RunId' => [ - 'description' => '运行ID', - 'type' => 'string', - 'example' => 'run-1meoz7VJd2C6f****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'ConnectionId' => ['description' => '连接ID。', 'type' => 'string', 'example' => 'conn-pai9m***mi47'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"RunId\\": \\"run-1meoz7VJd2C6f****\\"\\n}","type":"json"}]', - 'title' => '创建运行', - ], - 'UpdateRun' => [ - 'summary' => '更新运行信息', - 'path' => '/api/v1/runs/{RunId}', - 'methods' => [ - 'put', + 'title' => '创建连接', + 'summary' => '创建连接。用于LangStudio、数据集多模态检索服务等场景中连接PAI云端到客户的模型、数据库等服务。', + 'requestParamsDescription' => '各种连接类型（ConnectionType）对应的Configs和Secrets配置格式：'."\n" + .'- **DashScopeConnection/OpenLLMConnection**'."\n" + .'```'."\n" + .'{'."\n" + .' "Secrets": {'."\n" + .' "api_key": "xxx"'."\n" + .' },'."\n" + .' "Configs": {'."\n" + .' "base_url": "cn-hangzhou.aigc.aliyuncs.com/api/v1/services/xxx"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- **OpenSearchConnection/LindormConnection/ElasticsearchConnection**'."\n" + .'```'."\n" + ."\n" + .'{'."\n" + .' "Secrets": {'."\n" + .' "password": "xxx"'."\n" + .' },'."\n" + .' "Confgs": {'."\n" + .' "uri": "xxx",'."\n" + .' "username": "xxx"'."\n" + .' }'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + ."\n" + .'- **MilvusConnection**'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "Secrets": {'."\n" + .' "password": "xxx"'."\n" + .' },'."\n" + .' "Confgs": {'."\n" + .' "uri": "xxx",'."\n" + .' "username": "xxx"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- **HologresConnection**'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "Secrets": {'."\n" + .' "password": "xxx"'."\n" + .' },'."\n" + .' "Configs": {'."\n" + .' "database": "xx",'."\n" + .' "port": "xx",'."\n" + .' "host": "xx",'."\n" + .' "user": "xx"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- **RDSConnection**'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "Secrets": {'."\n" + .' "password": "xxx"'."\n" + .' },'."\n" + .' "Configs": {'."\n" + .' "database": "xxx",'."\n" + .' "port": "xxx",'."\n" + .' "host": "xxx",'."\n" + .' "type": "db_type",'."\n" + .' "username": "xxx"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- **CustomConnection**'."\n" + ."\n" + .'自定义格式', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnection'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiworkspace:CreateConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\"\\n}","type":"json"}]', + ], + 'CreateDataset' => [ + 'path' => '/api/v1/datasets', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '233506', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '48562', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ - [ - 'name' => 'RunId', - 'in' => 'path', - 'schema' => [ - 'description' => '运行ID', - 'type' => 'string', - 'required' => true, - 'example' => 'run-1qJhzJ2YXgX****', - ], - ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求结构体。', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ 'Name' => [ - 'description' => '运行（Run）的名称。命名规则如下：'."\n" - .'- 以小写字母、大写字母开头。'."\n" - .'- 可以包含大小写字母、数字、下划线（_）或短划线（-）。'."\n" - .'- 长度为1~63个字符。', + 'title' => 'Name', + 'description' => '数据集的名称。命名规则如下：'."\n" + .'- 以小写字母、大写字母、数字或中文开头。'."\n" + .'- 可以包含下划线（_）或短划线（-）。'."\n" + .'- 长度为1~127个字符。', 'type' => 'string', - 'required' => false, + 'required' => true, + 'enumValueTitles' => [], 'example' => 'myName', ], + 'Property' => [ + 'title' => 'Property', + 'description' => '数据集的属性。支持以下取值：'."\n" + .'- FILE：文件。'."\n" + .'- DIRECTORY：文件夹。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], + 'example' => 'DIRECTORY', + ], + 'DataSourceType' => [ + 'title' => 'DataSourceType', + 'description' => '数据源类型。支持以下取值：'."\n" + .'- OSS：阿里云对象存储（OSS）。'."\n" + .'- NAS：阿里云文件存储（NAS）通用型。'."\n" + .'- EXTREMENAS：阿里云文件存储（NAS）极速型。'."\n" + .'- CPFS: 阿里云文件存储（CPFS）通用版。'."\n" + .'- BMCPFS：阿里云文件存储（CPFS）智算版。 '."\n" + .'- MAXCOMPUTE：阿里云云原生大数据计算服务（MaxCompute）。'."\n" + .'- URL：公网HTTP/HTTPS地址。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['NAS' => 'NAS', 'MAXCOMPUTE' => 'MAXCOMPUTE', 'CPFS' => 'CPFS', 'BMCPFS' => 'BMCPFS', 'EXTREMENAS' => 'EXTREMENAS', 'OSS' => 'OSS', 'URL' => 'URL'], + 'example' => 'NAS', + ], + 'Uri' => ['title' => 'Uri', 'description' => 'Uri配置样例如下：'."\n" + .'- 数据源类型为OSS：`oss://bucket.endpoint/object`'."\n" + .'- 数据源类型为NAS：'."\n" + .'通用型NAS格式为：`nas://.region/subpath/to/dir/`；'."\n" + .'CPFS1.0：`nas://.region/subpath/to/dir/`；'."\n" + .'CPFS2.0：`nas://.region//`。'."\n" + .'CPFS1.0和CPFS2.0根据fsid的格式来区分：CPFS1.0 格式为cpfs-<8位ASCII字符>；CPFS2.0 格式为cpfs-<16位ASCII字符>。', 'type' => 'string', 'required' => true, 'example' => 'nas://09f****f2.cn-hangzhou/'], + 'DataType' => [ + 'title' => 'DataType', + 'description' => '数据集的数据类型，默认为COMMON。支持以下取值：'."\n" + .'- COMMON：普通。'."\n" + .'- PIC：图片。'."\n" + .'- TEXT：文本。'."\n" + .'- VIDEO：视频。'."\n" + .'- AUDIO：音频。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['VIDEO' => 'VIDEO', 'COMMON' => 'COMMON', 'TEXT' => 'TEXT', 'PIC' => 'PIC', 'AUDIO' => 'AUDIO'], + 'example' => 'COMMON', + ], 'Labels' => [ - 'description' => '标签列表', + 'title' => 'Labels', + 'description' => '标签列表。', 'type' => 'array', - 'items' => [ - 'description' => '标签详细信息', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], + 'items' => ['description' => '为数据集添加的标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], 'required' => false, ], - 'Params' => [ - 'description' => '参数列表', + 'SourceType' => [ + 'title' => 'SourceType', + 'description' => '数据来源类型，默认为USER。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], + 'example' => 'USER', + ], + 'SourceId' => ['title' => 'SourceId', 'description' => '数据来源ID。'."\n" + .'- 当SourceType为USER时，SourceId支持自定义。'."\n" + .'- 当SourceType为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" + .'- 当SourceType为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', 'type' => 'string', 'required' => false, 'example' => 'jdnhf***fnrimv'], + 'Description' => ['title' => 'Description', 'description' => '对数据集进行自定义描述，以区分不同的数据集。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the dataset.'], + 'WorkspaceId' => ['title' => 'WorkspaceId', 'description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。'."\n" + .'如果不配置该参数，则会使用默认工作空间；如果默认工作空间不存在，则会报错。', 'type' => 'string', 'required' => false, 'example' => '478**'], + 'Options' => ['title' => 'Options', 'description' => '扩展字段，JsonString类型。'."\n" + .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}'], + 'Accessibility' => [ + 'title' => 'Accessibility', + 'description' => '工作空间可见度。支持以下取值：'."\n" + .'- PRIVATE（默认值）：表示工作空间内自己以及管理员可见。'."\n" + .'- PUBLIC：工作空间所有用户可见。'."\n" + .'- ROLE_PUBLIC：指定工作空间角色可见，角色列表参考：AccessibleRoleIdList。该条件下数据集所有者及管理员始终具备可见性。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], + 'example' => 'PRIVATE', + ], + 'ProviderType' => ['title' => 'ProviderType', 'description' => '数据集的数据源来源类型，支持配置的类型如下：'."\n" + .'- Ecs（默认值）'."\n" + .'- Lingjun', 'type' => 'string', 'required' => false, 'example' => 'Ecs'], + 'Provider' => ['description' => '数据集提供者。不允许设置为pai。', 'type' => 'string', 'required' => false, 'example' => 'Github'], + 'UserId' => ['title' => '数据集所有者', 'description' => '数据集所有者的阿里云账号ID。工作空间所有者和管理员有权限给指定工作空间成员创建数据集。', 'type' => 'string', 'required' => false, 'example' => '2485765****023475'], + 'SourceDatasetId' => ['title' => 'iTag标注集的源数据集', 'description' => '标注数据集的来源数据集ID。', 'type' => 'string', 'required' => false, 'example' => 'd-bvfasdfxxxxj8o411'], + 'SourceDatasetVersion' => ['title' => 'iTag标注集的源数据集版本', 'description' => '标注数据集的来源数据集版本。', 'type' => 'string', 'required' => false, 'example' => 'v2'], + 'VersionDescription' => ['description' => '数据集初始版本的描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the first dataset version.'], + 'VersionLabels' => [ + 'description' => '初始版本标签列表。', 'type' => 'array', - 'items' => [ - 'description' => '参数详细信息', - 'required' => false, - '$ref' => '#/components/schemas/RunParam', - ], + 'items' => ['description' => '为数据集初始版本添加的标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], + 'required' => false, + ], + 'DataSize' => ['description' => '数据集文件占据空间的大小。单位Byte 。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '999999999999', 'minimum' => '1', 'example' => '10000'], + 'DataCount' => ['description' => '数据集文件数量，单位个。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '999999999999', 'minimum' => '1', 'example' => '500'], + 'MountAccessReadWriteRoleIdList' => [ + 'description' => '指定该数据集被挂载时具有读写权限的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。'."\n" + .'- 指定角色下的账号： ["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"]'."\n" + .'- 全部账号：["*"]'."\n" + .'- 指定为数据集创建者: []', + 'type' => 'array', + 'items' => ['description' => '工作空间角色ID', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoOperator'], + 'required' => false, + ], + 'ImportInfo' => ['description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" + ."\n" + .'
'."\n" + .'OSS'."\n" + .'{
'."\n" + .'"region": "${region}",//地域ID
'."\n" + .'"bucket": "${bucket}",//bucket名称
'."\n" + .'"path": "${path}" //文件路径
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'NAS'."\n" + .'{
'."\n" + .'"region": "${region}",//地域ID
'."\n" + .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .'"path": "${path}", //文件系统路径
'."\n" + .'"mountTarget": "${mount_target}" //文件系统挂载点
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'CPFS'."\n" + .'{
'."\n" + .'"region": "${region}",//地域ID
'."\n" + .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .'"protocolServiceId":"${protocol_service_id}", //文件系统协议服务
'."\n" + .'"exportId": "${export_id}", //文件系统导出目录
'."\n" + .'"path": "${path}", //文件系统路径
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'智算CPFS'."\n" + .'{
'."\n" + .'"region": "${region}",//地域ID
'."\n" + .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .'"path": "${path}", //文件系统路径
'."\n" + .'"mountTarget": "${mount_target}" //文件系统挂载点，智算版特有
'."\n" + .'"isVpcMount": boolean, //是否为vpc挂载点, 智算版特有
'."\n" + .'}
'."\n" + .'
', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "region": "cn-wulanchabu",'."\n" + .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" + .' "path": "/mnt",'."\n" + .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" + .' "isVpcMount": true'."\n" + .'}'], + 'Edition' => [ + 'description' => '数据集类型。默认为BASIC，支持以下取值：'."\n" + ."\n" + .'- BASIC：基础型。不支持数据集文件元数据管理。'."\n" + .'- ADVANCED：高级型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。'."\n" + .'- LOGICAL：逻辑型。仅OSS类型支持，每个版本支持最多300万个文件元数据管理。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['LOGICAL' => 'LOGICAL', 'BASIC' => 'BASIC', 'ADVANCED' => 'ADVANCED'], + 'example' => 'ADVANCED', + ], + 'AccessibleRoleIdList' => [ + 'description' => '在Accessibility为ROLE_PUBLIC时生效。该数据集可见的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。', + 'type' => 'array', + 'items' => ['description' => '工作空间角色ID。', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoOperator'], 'required' => false, ], ], @@ -3772,280 +2315,85 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B2C51F93-1C07-5477-9705-5FDB****F19F'], + 'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'example' => 'd-rbvg5*****jhc9ks92'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', - 'title' => '更新运行信息', - ], - 'GetRun' => [ - 'summary' => '获取Run详情', - 'path' => '/api/v1/runs/{RunId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '233505', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据集', + 'summary' => '创建一个数据集。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'], ], - 'autoTest' => true, + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'parameters' => [ - [ - 'name' => 'RunId', - 'in' => 'path', - 'schema' => [ - 'description' => '运行ID', - 'type' => 'string', - 'required' => true, - 'example' => 'run-1qJhzJ2YXgX****', - ], - ], + 'ramActions' => [ [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'title' => '是否获取Metrics, Params, Labels信息', - 'description' => '是否获取Metrics, Params, Labels信息；非必填，默认为false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Run实例信息', - '$ref' => '#/components/schemas/Run', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Accessibility\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"\\",\\n \\"ExperimentId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', - 'title' => '获取Run详情', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2C51F93-1C07-5477-9705-5FDB****F19F\\",\\n \\"DatasetId\\": \\"d-rbvg5*****jhc9ks92\\"\\n}","type":"json"}]', ], - 'ListRuns' => [ - 'summary' => '获取Run列表。', - 'path' => '/api/v1/runs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateDatasetFileMetas' => [ + 'summary' => '批量创建数据集下的文件元数据记录。', + 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '237299', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260491', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '运行名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'myName', - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实验所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。'."\n" - .'> 不填写工作空间ID，系统将返回默认工作空间的运行列表。'."\n" - .'>', - 'type' => 'string', - 'required' => false, - 'example' => '228**', - ], - ], - [ - 'name' => 'ExperimentId', - 'in' => 'query', - 'schema' => [ - 'title' => 'Run所属实验ID', - 'description' => 'Run所属实验ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'exp-1zpfthdx******', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'title' => 'Run关联的PAI Workload类型', - 'description' => 'Run关联的PAI Workload类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'TrainingService', - ], - ], - [ - 'name' => 'SourceId', - 'in' => 'query', - 'schema' => [ - 'title' => 'Run关联的PAI Workload ID', - 'description' => 'Run关联的PAI Workload ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-rbvg5wzlj****', - ], - ], - [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'title' => '任务的标签，精确匹配'."\n" - .'● 支持单标签查询:"is_evaluation:true"'."\n" - .'● 多标签场景（非特殊场景不推荐，可能存在性能问题）:"is_evaluation:true,LLM_evaluation:true" 使用英文逗号分隔，表示多个标签key-value需要同时匹配', - 'description' => '任务的标签，精确匹配。支持：'."\n" - .'- 单标签查询："is_evaluation:true"'."\n" - .'- 多标签场景（非特殊场景不推荐，可能存在性能问题）："is_evaluation:true,LLM_evaluation:true" 使用半角逗号（,）分隔，表示多个标签key-value需要同时匹配。', - 'type' => 'string', - 'required' => false, - 'example' => 'is_evaluation:true', - ], - ], - [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'description' => '是否展示详细信息，包括：Metrics、Params和Labels。取值如下：'."\n" - .'- true：表示展示详细信息。'."\n" - .'- false（默认值）：表示不展示详细信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'GmtCreateTime', - 'in' => 'query', - 'schema' => [ - 'description' => '实例创建时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-30T12:51:33.028Z', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => '排序方式的字符串列表，支持排序的字段包括：GmtCreateTime、Name。排序方式包括DESC和ASC，默认为ASC。支持多个字段，用半角逗号","分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime DESC,Name ASC', - ], - ], - [ - 'name' => 'PageToken', - 'in' => 'query', - 'schema' => [ - 'description' => '分页token，从0开始，默认为0。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '请求的最大结果数，默认为10。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页数。 取值范围：大于0。 默认值：1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页显示的记录数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '用于排序的字段名，取值如下：'."\n" - .'- Name：Run名称。'."\n" - .'- GmtCreateTime（默认值）：Run创建时间。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - 'default' => 'GmtCreateTime', - ], + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-lfd60v0p****ujtsdx'], ], [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '', - 'description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。'."\n" - .'- ASC：升序。'."\n" - .'- DESC（默认值）：降序。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '478**'], + 'DatasetVersion' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => true, 'example' => 'v1'], + 'DatasetFileMetas' => [ + 'description' => '文件元数据内容列表。', + 'type' => 'array', + 'items' => ['description' => '文件元数据内容详情。', 'required' => false, '$ref' => '#/components/schemas/DatasetFileMetaContentCreate'], + 'required' => true, + ], + ], 'required' => false, - 'example' => 'DESC', - 'default' => 'DESC', ], ], ], @@ -4053,140 +2401,117 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'Status' => [ + 'description' => '本批元数据创建结果的状态。全部成功为true，如果为false，需要查看FailedDetails。', + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '成功', 'false' => '失败'], + 'example' => 'true', ], - 'Runs' => [ - 'description' => '任务列表。', + 'FailedDetails' => [ + 'description' => '创建失败的文件元数据列表。', 'type' => 'array', - 'items' => [ - 'description' => '运行实例详情。', - '$ref' => '#/components/schemas/Run', - ], + 'items' => ['description' => '创建失败的文件元数据详情。', '$ref' => '#/components/schemas/DatasetFileMetaResponse'], ], - 'TotalCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NextPageToken' => [ - 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为0时表示全部查完。可通过查询结果中的**NextPageToken**字段获取下一页token。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'SucceedDetails' => [ + 'description' => '创建成功的文件元数据列表。', + 'type' => 'array', + 'items' => ['description' => '创建成功的文件元数据详情。', '$ref' => '#/components/schemas/DatasetFileMetaResponse'], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"Runs\\": [\\n {\\n \\"Accessibility\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"\\",\\n \\"ExperimentId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', - 'title' => '获取运行列表', - ], - 'DeleteRun' => [ - 'summary' => '删除Run', - 'path' => '/api/v1/runs/{RunId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '批量创建数据集文件元数据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetFileMetas'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetFileMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6\\",\\n \\"Result\\": \\"Not Found\\",\\n \\"Uri\\": \\"oss://l*****-test/dataset/1653421.jpg\\"\\n }\\n ],\\n \\"SucceedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6\\",\\n \\"Result\\": \\"Not Found\\",\\n \\"Uri\\": \\"oss://l*****-test/dataset/1653421.jpg\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateDatasetJob' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '233507', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260335', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'RunId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'description' => '运行ID', - 'type' => 'string', - 'required' => true, - 'example' => 'run-1qJhzJ2YXgX****', - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', + 'DatasetVersion' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '478**'], + 'JobAction' => [ + 'description' => '任务操作。'."\n" + .'- SemanticIndex: 语义索引'."\n" + .'- IntelligentTag: 智能打标'."\n" + .'- FileMetaExport: 元数据导出'."\n" + .'- FileMetaBuild: 构建更新元数据'."\n" + .'- IntelligentTagRevert: 智能打标撤回'."\n" + .'- FileMetaImport: 元数据导入', 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', + 'required' => true, + 'enumValueTitles' => ['IntelligentTagRevert' => 'IntelligentTagRevert', 'SemanticIndex' => 'SemanticIndex', 'FileMetaImport' => 'FileMetaImport', 'IntelligentTag' => 'IntelligentTag', 'FileMetaExport' => 'FileMetaExport', 'FileMetaBuild' => 'FileMetaBuild'], + 'example' => 'SemanticIndex', ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', - 'title' => '删除Run', - ], - 'DeleteRunLabel' => [ - 'summary' => '删除Run标签', - 'path' => '/api/v1/runs/{RunId}/labels/{Key}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '233523', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, - ], - 'parameters' => [ - [ - 'name' => 'RunId', - 'in' => 'path', - 'schema' => [ - 'description' => '运行ID', - 'type' => 'string', - 'required' => true, - 'example' => 'run-1qJhzJ2YXgX****', - ], - ], - [ - 'name' => 'Key', - 'in' => 'path', - 'schema' => [ - 'description' => '要删除的Run标签的Key', - 'type' => 'string', - 'required' => true, - 'example' => 'is_evaluate', + 'JobMode' => [ + 'description' => '任务类型。'."\n" + .'* Full（默认值）：强制处理全量元数据。任务执行耗时久。'."\n" + .'* Increment：仅处理变更或者未处理成功的元数据； '."\n" + .'SemanticIndex和IntelligentTag任务支持Increment/Full，其余任务仅支持Full。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Increment' => 'Increment', 'Full' => 'Full'], + 'example' => 'Full', + ], + 'Description' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a job description.'], + 'JobSpec' => ['description' => '任务明细。', 'type' => 'string', 'required' => true, 'example' => '{\\"modelId\\":\\"xxx\\"}'], + ], + 'required' => false, ], ], ], @@ -4194,74 +2519,237 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '99341606-****-0757724D97EE'], + 'DatasetJobId' => ['description' => '数据集任务ID', 'type' => 'string', 'example' => 'dsjob-9jx1******uj9e'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', - 'title' => '删除Run标签', - ], - 'LogRunMetrics' => [ - 'summary' => '批量记录Run的指标', - 'path' => '/api/v1/runs/{RunId}/metrics/action/log', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据集任务', + 'summary' => '创建数据集任务。', + 'requestParamsDescription' => 'CreateDatasetJob中的JobSpec参数说明：'."\n" + .'### 语义索引任务'."\n" + ."\n" + .'示例：'."\n" + .'```{'."\n" + .' "modelId": "xxx",'."\n" + .' "modelVersion": "1.0.0",'."\n" + .' "contentList": ["file"],'."\n" + .' "embeddingConnectionId": "conn-xxx",'."\n" + .' "embeddingModel": "default",'."\n" + .' "databaseConnectionId": "conn-xxx",'."\n" + .' "databaseTableName": "table_xxx",'."\n" + .' "vectorIndexConfig":"{\\"shards\\":1,\\"similarity\\":\\"cosine\\",\\"indexType\\":\\"hnsw\\",\\"indexOptions\\":{\\"m\\":16,\\"efConstruction\\":200}}",'."\n" + .' "concurrency": 2'."\n" + .'}'."\n" + .'```'."\n" + .'字段说明：'."\n" + .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" + .'|---------------------|----------------|------------|------|------------------------------|'."\n" + .'| modelId | String | model-xxx | 否 | 官方模型ID。 |'."\n" + .'| modelVersion | String | 1.0.0 | 否 | 官方模型版本。 |'."\n" + .'| embeddingConnectionId | String | conn-xxx | 否 | eas模型服务连接ID。 |'."\n" + .'| embeddingModel | String | default | 否 | eas模型服务对应的模型名称。 |'."\n" + .'| databaseConnectionId | String | conn-xxx | 否 | 向量库服务连接ID。 |'."\n" + .'| databaseTableName | String | table_xxx | 否 | 向量库表名。 |'."\n" + .'| concurrency | Integer | 2 | 否 | 任务并行数 |'."\n" + .'| contentList | Array | | 是 | 索引内容列表。 |'."\n" + .'| +- | String | file | | 索引内容。一期只支持file(文件)。 |'."\n" + ."\n" + .'### 智能打标任务'."\n" + ."\n" + .'示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "intelligentTagConnectionId": "conn-keltvufiud3quopq11",'."\n" + .' "promptId": "pmt-gh6qaj1kvkf6yk7qx2",'."\n" + .' "modelId":"qwen-vl-max"'."\n" + .'}'."\n" + .'```'."\n" + .'字段说明：'."\n" + .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" + .'|---------------------------|--------|-------------------------------|------|--------------------|'."\n" + .'| modeId | String | qwen-vl-max | 是 | 模型名称 |'."\n" + .'| intelligentTagConnectionId| String | conn-keltvufiud3quopq11 | 是 | 打标连接管理 |'."\n" + .'| promptId | String | pmt-gh6qaj1kvkf6yk7qx2 | 是 | 提示词id |'."\n" + ."\n\n" + .'### 元数据导出任务'."\n" + .'示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "query":{'."\n" + .' "QueryType": "TAG",'."\n" + .' "QueryText": "",'."\n" + .' "TopK": 100,'."\n" + .' "ScoreThreshold":0.6'."\n" + .' },'."\n" + .' "filteredAttributes":"FileName,Uri",'."\n" + .' "exportDirUri": "oss://bucket/path/" '."\n" + .'}'."\n" + .'```'."\n" + .'字段说明：'."\n" + .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" + .'|---------------------|------------|----------------------------------------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| query | JSON | | 否 | 导出查询条件，字段与 `ListDatasetMetas` 接口保持一致。见：`QueryParms` |'."\n" + .'| filteredAttributes | String | 逗号分隔 | 否 | 当指定时，导出结果将只包含指定过滤的属性字段。字段列表：
* Uri (必有)
* DatasetFileMetaId
* FileName
* DataSize
* FileType
* ContentType
* Comment
* MetaAttributes
* FileFingerPrint
* FileCreateTime
* FileUpdateTime
* Tags.user: 用户自定义标签
* Tags.user-delete-ai-tags: 用户删除的算法标签
* Tags.ai：算法标签（所有打标任务聚合后的）
* Tags.all: 算法标签+用户自定义标签（已去除用户删除的算法标签） |'."\n" + .'| exportDirUri | String | oss://bucket/path/
或者
pvfs://cata_log/DB/lanceTable | 是 | 导出内容的 OSS 存储路径，需为目录地址。
会在该目录下创建文件夹：`{datasetId}-{datasetversion}-{time:yyyy-MM-dd-HH-mm-ss}`，下存放 yaml 和 jsonl 文件。 |'."\n" + ."\n" + .'**QueryParams**:'."\n" + .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" + .'|---------------------------|----------------|----------------------------------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| QueryType | String | MIX | 否 | MIX, VECTOR, TAG |'."\n" + .'| QueryText | String | “倒地的水马” | 否 | 待搜索文本内容 |'."\n" + .'| QueryImage | String | oss://bucket.cn-hangzhou.aliyuncs.com/image.jpg | 否 | 以图搜图时，该参数传入图片的信息。
支持传入图片的可公网访问的 oss url 格式 |'."\n" + .'| QueryTagsIncludeAll | String | 蓝色锥形桶,车道线 | 否 | 表示“同时包含以下标签”。
用户可以选择多个标签，查询结果必须同时满足这些标签。
如果为空，则不应用此条件。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" + .'| QueryTagsIncludeAny | String | 蓝天 | 否 | 表示“包含以下任意标签”。
用户可以选择多个标签，查询结果只需满足其中一个即可。
如果为空，则不应用此条件。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" + .'| QueryTagsExclude | String | 阴天 | 否 | 表示“排除以下标签”。
用户可以选择多个标签，查询结果中不能包含这些标签。
如果为空，则不应用此条件。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" + .'| QueryFileName | String | shuima | 否 | 文件名模糊搜索，基于 2-gram 模糊匹配 |'."\n" + .'| QueryFileDir | String | oss://cars/20250221/ | 否 | 文件目录模糊搜索，基于 2-gram 模糊匹配 |'."\n" + .'| QueryFileTypeIncludeAny | String | image,video | 否 | 表示“包含以下任意文件类型”。
用户可以选择多个文件类型，查询结果只需满足其中一个即可。
如果为空，则不应用此条件。 |'."\n" + .'| QueryContentTypeIncludeAny| String | image/jpeg,application/pdf | 否 | 表示“包含以下任意 MIME Type 类型”。
用户可以选择多个文件类型，查询结果只需满足其中一个即可。
如果为空，则不应用此条件 |'."\n" + .'| StartFileUpdateTime | String | 2021-01-12T14:36:01.000Z | 否 | 查询时间段范围内的文件元数据。起始文件更新时间。
iso8601 格式 UTC 时间戳，2021-01-12T14:36:01.000Z。 |'."\n" + .'| EndFileUpdateTime | String | 2021-01-12T14:36:01.000Z | 否 | 查询时间段范围内的文件元数据。结束文件更新时间。
iso8601 格式 UTC 时间戳，2021-01-12T14:36:01.000Z。 |'."\n" + .'| StartTagUpdateTime | String | 2021-01-12T14:36:01.000Z | 否 | 查询时间段范围内的文件元数据。起始最后标签更新时间。
iso8601 格式 UTC 时间戳，2021-01-12T14:36:01.000Z。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" + .'| EndTagUpdateTime | String | 2021-01-12T14:36:01.000Z | 否 | 查询时间段范围内的文件元数据。结束最后标签更新时间。
iso8601 格式 UTC 时间戳，2021-01-12T14:36:01.000Z。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" + .'| TopK | Integer | 100 | 否 | 导出的最大数量，默认无限制 |'."\n" + .'| ScoreThreshold | Float | 0.6 | | 相似度分数过滤。只返回大于 ScoreThreshold 的结果。
当 QueryType=VECTOR 或 MIX 时有效。 |'."\n" + .'| DatasetFileMetaIds | String | | 否 | 文件元数据 ID 列表，最大个数为 20。 |'."\n" + ."\n" + .'### 构建更新元数据任务'."\n" + .'示例：'."\n" + .'```'."\n" + .'{}'."\n" + .'```'."\n" + ."\n" + .'### 智能打标撤回任务'."\n" + .'示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "intelligentTagJobId": "dsjob-gh6qaj1kvkf6yk7qx2"'."\n" + .'}'."\n" + .'```'."\n" + .'字段说明：'."\n" + .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" + .'|------------------------|--------|-------------------------------|------|----------------------------|'."\n" + .'| intelligentTagJobId | String | dsjob-gh6qaj1kvkf6yk7qx2 | 是 | 待撤回的智能打标任务ID |'."\n" + ."\n\n" + .'### 元数据导入任务'."\n" + .'基于查询条件示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "srcDatasetId": "d-1234",'."\n" + .' "srcDatasetVersion": "v1",'."\n" + .' "srcWorkspaceId": "12729",'."\n" + .' "query":'."\n" + .' {'."\n" + .' "QueryType": "TAG",'."\n" + .' "QueryText": "",'."\n" + .' "TopK": 100,'."\n" + .' "ScoreThreshold": 0.6'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'基于pai_dataset_filemeta_manifest文件示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "manifestUri":"oss://bucket/export_path/d-mpdxv0lm9sndij7gpb-v1-2025-06-18-12-23-30/pai_dataset_filemeta_manifest.yaml"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'字段说明：'."\n" + .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" + .'|---------------------|------------|----------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| srcDatasetId | String | dsjob-gh6qaj1kvkf6yk7qx2 | 是(基于查询) | 导入来源数据集 ID |'."\n" + .'| srcDatasetVersion | String | v1 | 是(基于查询) | 导入来源数据集版本 |'."\n" + .'| srcWorkspaceId | String | 12729 | 是(基于查询) | 导入来源数据集工作空间 |'."\n" + .'| query | JSON | | 否(基于查询) | 在源数据集版本上应用的查询条件。
见：`QueryParams` |'."\n" + .'| manifestUri | String | oss://bucket/export_path/d-mpdxv0lm9sndij7gpb-v1-2025-06-18-12-23-30/pai_dataset_filemeta_manifest.yaml | 是(基于文件) | 导入来源的 manifest 文件地址。
仅支持不带 endpoint 的 oss uri |'."\n" + .'| filteredAttributes | String | FileName,Uri,FileFingerPrint,DataSize,DataSize,FileUpdateTime,Tags.ai | 否 | 默认导入所有属性字段。
当指定时，导入内容将只包含指定过滤的属性字段。
字段列表：
* FileName (必须)
* Uri (必须)
* FileFingerPrint (必须)
* DataSize (必须)
* FileType (必须)
* ContentType (必须)
* Comment
* MetaAttributes
* FileCreateTime
* FileUpdateTime
* Tags.user: 用户自定义标签
* Tags.user-delete-ai-tags: 用户删除的算法标签
* Tags.ai：算法标签（所有打标任务聚合后的） |'."\n" + .'| importMode | String | append | 否 | 导入模式：
append（默认）: 追加模式。同 uri 的文件会使用待导入的内容进行覆盖。
replace: 替换模式。该数据集版本下原有的文件元数据将会被删除。 |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetJob'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99341606-****-0757724D97EE\\",\\n \\"DatasetJobId\\": \\"dsjob-9jx1******uj9e\\"\\n}","type":"json"}]', + ], + 'CreateDatasetJobConfig' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '237449', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', - ], - 'autoTest' => true, + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260458', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'RunId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'description' => '运行ID', - 'type' => 'string', - 'required' => true, - 'example' => 'run-1qJhzJ2YXgX****', - ], + 'schema' => ['description' => '数据集Id', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wzlj****9ks92'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求结构体。', + 'description' => '请求Body。', 'type' => 'object', 'properties' => [ - 'Metrics' => [ - 'description' => '指标列表', - 'type' => 'array', - 'items' => [ - 'description' => '指标详细信息', - 'required' => false, - '$ref' => '#/components/schemas/RunMetric', - ], - 'required' => false, + 'WorkspaceId' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '454716'], + 'ConfigType' => [ + 'description' => '配置类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['MultimodalIntelligentTag' => 'MultimodalIntelligentTag', 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex'], + 'example' => 'MultimodalIntelligentTag', ], + 'Config' => ['description' => '配置内容'."\n" + .'其中配置内容格式如下：'."\n" + ."\n" + .'- MultimodalIntelligentTag'."\n" + ."\n" + .'{'."\n" + .' "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" + .'}'."\n" + ."\n" + .'- MultimodalSemanticIndex'."\n" + ."\n" + .'{'."\n" + .' "defaultModelId": "xxx"'."\n" + .' "defaultModelVersion":"1.0.0"'."\n" + .'}', 'type' => 'string', 'required' => true, 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'], + 'DatasetVersion' => ['description' => '数据集版本名。', 'type' => 'string', 'required' => false, 'example' => 'v1'], ], 'required' => false, ], @@ -4271,89 +2759,82 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'DatasetJobConfigId' => ['description' => '配置id', 'type' => 'string', 'example' => 'dscfg-xxxxxxxxxxxxxx'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', - 'title' => '批量记录Run的指标', - ], - 'ListRunMetrics' => [ - 'summary' => '获取Run的指标记录列表', - 'path' => '/api/v1/runs/{RunId}/metrics', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据集任务配置', + 'summary' => '创建数据集任务配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetJobConfig'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '237434', - 'abilityTreeNodes' => [ - 'FEATURElearnP1X97H', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetJobConfigId\\": \\"dscfg-xxxxxxxxxxxxxx\\"\\n}","type":"json"}]', + ], + 'CreateDatasetLabels' => [ + 'path' => '/api/v1/datasets/{DatasetId}/labels', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], - 'autoTest' => true, + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '48572', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'RunId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'description' => '运行ID', - 'type' => 'string', - 'required' => true, - 'example' => 'run-1qJhzJ2YXgX****', - ], - ], - [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => '运行的指标的Key', - 'type' => 'string', - 'required' => true, - 'example' => 'loss', - ], - ], - [ - 'name' => 'PageToken', - 'in' => 'query', - 'schema' => [ - 'description' => '分页token，从0开始，默认为0。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['title' => 'Dataset Id', 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => false, 'example' => 'd-lfd60v0p****ujtsdx'], ], [ - 'name' => 'MaxResults', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '请求的最大结果数，默认为10。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => ['description' => '为数据集添加的标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], + 'required' => false, + ], + ], 'required' => false, - 'example' => '100', - 'default' => '10', ], ], ], @@ -4361,192 +2842,183 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', - ], - 'Metrics' => [ - 'description' => '指标列表', - 'type' => 'array', - 'items' => [ - 'description' => '指标信息详情', - '$ref' => '#/components/schemas/RunMetric', - ], - ], - 'NextPageToken' => [ - 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为0时表示全部查完。可通过查询结果中的**NextPageToken**字段获取下一页token。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A083731B-4973-54D1-B324-E53****4DD44'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', - 'title' => '获取Run的指标记录列表', - ], - 'AddImage' => [ - 'summary' => '添加自定义镜像到工作空间。', - 'path' => '/api/v1/images', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据集标签', + 'summary' => '为数据集打标签。', + 'description' => '调用此接口时，需要注意：'."\n" + ."\n" + .'- 标签键和值是非空字符串，且长度不能大于128。'."\n" + .'- 标签键不能以 aliyun、acs、http://、https:// 开头。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A083731B-4973-54D1-B324-E53****4DD44\\"\\n}","type":"json"}]', + ], + 'CreateDatasetVersion' => [ + 'path' => '/api/v1/datasets/{DatasetId}/versions', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '61619', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], + 'abilityTreeCode' => '232558', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求结构体。', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '镜像名称', - 'description' => '镜像名称。命名规则如下：'."\n" - .'- 长度为1~50个英文字符。'."\n" - .'- 支持小写字母、数字和短横线（-），以字母开头。'."\n" - .'- 同一工作空间内不可重复。', + 'Property' => [ + 'description' => '数据集的属性。支持以下取值：'."\n" + .'- FILE：文件。'."\n" + .'- DIRECTORY：文件夹。', 'type' => 'string', 'required' => true, - 'example' => 'nlp-compression', - ], - 'Description' => [ - 'title' => '镜像描述', - 'description' => '镜像的描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'NLP模型压缩训练镜像', + 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], + 'example' => 'DIRECTORY', ], - 'ImageUri' => [ - 'title' => '镜像地址', - 'description' => '镜像地址，可以重复。关于如何查看镜像地址，详情请参见[ListImage](~~449118~~)。', + 'DataSourceType' => [ + 'description' => '数据源类型，多项之间使用半角逗号分隔。支持以下取值：'."\n" + ."\n" + .'- NAS：数据存储为阿里云文件存储（NAS）。'."\n" + ."\n" + .'- OSS：数据存储为阿里云对象存储（OSS）。'."\n" + ."\n" + .'- CPFS'."\n" + ."\n" + .'注意：当前的策略是版本的DataSourceType 需要与数据集DataSourceType 保持一致，创建版本的时候会和数据集的做校验。', 'type' => 'string', 'required' => true, - 'example' => 'registry.cn-hangzhou.aliyuncs.com/pai-compression/nlp:gpu', + 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], + 'example' => 'OSS', ], + 'Uri' => ['description' => 'Uri配置样例如下：'."\n" + .'- 数据源类型为OSS：`oss://bucket.endpoint/object`'."\n" + .'- 数据源类型为NAS：'."\n" + .'通用型NAS格式为：`nas://.region/subpath/to/dir/`；'."\n" + .'CPFS1.0：`nas://.region/subpath/to/dir/`；'."\n" + .'CPFS2.0：`nas://.region//`。'."\n" + .'CPFS1.0和CPFS2.0根据fsid的格式来区分：CPFS1.0 格式为cpfs-<8位ASCII字符>；CPFS2.0 格式为cpfs-<16位ASCII字符>。', 'type' => 'string', 'required' => true, 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/'], 'Labels' => [ - 'title' => '镜像标签，是个数组', - 'description' => '镜像标签，是个数组，数组每一项包含key和value两个字段。'."\n" - .'官方镜像有如下标签：system.official=true'."\n" - .'目前支持添加的键如下：'."\n" - ."\n" - .'- system.chipType'."\n" - .'- system.dsw.cudaVersion'."\n" - .'- system.dsw.fromImageId'."\n" - .'- system.dsw.fromInstanceId'."\n" - .'- system.dsw.id'."\n" - .'- system.dsw.os'."\n" - .'- system.dsw.osVersion'."\n" - .'- system.dsw.resourceType'."\n" - .'- system.dsw.rootImageId'."\n" - .'- system.dsw.stage'."\n" - .'- system.dsw.tag'."\n" - .'- system.dsw.type'."\n" - .'- system.framework'."\n" - .'- system.origin'."\n" - .'- system.pythonVersion'."\n" - .'- system.source'."\n" - .'- system.supported.dlc'."\n" - .'- system.supported.dsw', + 'description' => '数据集版本标签列表。', 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => 'Key', - 'description' => '标签的键。', - 'type' => 'string', - 'required' => false, - 'example' => 'system.chipType', - ], - 'Value' => [ - 'title' => 'Value', - 'description' => '标签的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'GPU', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'WorkspaceId' => [ - 'title' => '工作空间id', - 'description' => '镜像所属的工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '15******45', - ], - 'Accessibility' => [ - 'title' => '可见性 Public 公有 Private 私有', - 'description' => '镜像的可见性，目前支持：'."\n" - ."\n" - .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" - .'- PRIVATE：只有创建者可以操作。', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - ], - 'Size' => [ - 'description' => '镜像大小，单位为GB。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - 'ImageId' => [ - 'description' => '镜像Id，如果不填，系统会自动生成。'."\n" - .'格式为image-18位大小写英文字母或者数字。', - 'type' => 'string', + 'items' => ['description' => '标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], 'required' => false, - 'example' => 'image-k83*****cv', ], 'SourceType' => [ - 'title' => '镜像来源类型：'."\n" - .' Import : 导入'."\n" - .' Build ：构建', - 'type' => 'string', - 'required' => false, - ], - 'SourceId' => [ - 'title' => '镜像来源 ID。 当镜像来源类型是“构建”时，来源 ID 对应镜像构建 ID。', + 'description' => '数据来源类型，默认为USER。支持以下取值：'."\n" + .'- PAI-PUBLIC-DATASET：PAI公共数据集。'."\n" + .'- ITAG：iTAG模块标注结果生成的数据集。'."\n" + .'- USER：用户注册的数据集。', 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], + 'example' => 'USER', ], + 'SourceId' => ['description' => '数据来源ID。'."\n" + .'- 当SourceType为USER时，SourceId支持自定义。'."\n" + .'- 当SourceType为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" + .'- 当SourceType为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', 'type' => 'string', 'required' => false, 'example' => 'd-a0xbe5n03bhqof46ce'], + 'Options' => ['description' => '扩展字段，JsonString类型。'."\n" + .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}'], + 'Description' => ['description' => '对数据集版本进行自定义描述，以区分不同的数据集版本。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the dataset version.'], + 'DataSize' => ['description' => '数据集文件占据空间的大小。单位Byte 。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '19000'], + 'DataCount' => ['description' => '数据集文件数量，单位个。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'], + 'ImportInfo' => ['description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" + ."\n" + .'
'."\n" + .'OSS'."\n" + .'{
'."\n" + .' "region": "${region}",//地域ID
'."\n" + .' "bucket": "${bucket}",//bucket名称
'."\n" + .' "path": "${path}" //文件路径
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'NAS'."\n" + .'{
'."\n" + .' "region": "${region}",//地域ID
'."\n" + .' "fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .' "path": "${path}", //文件系统路径
'."\n" + .' "mountTarget": "${mount_target}" //文件系统挂载点
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n\n" + .'
'."\n" + .'CPFS'."\n" + .'{
'."\n" + .' "region": "${region}",//地域ID
'."\n" + .' "fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .' "protocolServiceId":"${protocol_service_id}", //文件系统协议服务
'."\n" + .' "exportId": "${export_id}", //文件系统导出目录
'."\n" + .' "path": "${path}", //文件系统路径
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'智算CPFS'."\n" + .'{
'."\n" + .' "region": "${region}",//地域ID
'."\n" + .' "fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .' "path": "${path}", //文件系统路径
'."\n" + .' "mountTarget": "${mount_target}" //文件系统挂载点，智算版特有
'."\n" + .' "isVpcMount": boolean, //是否为vpc挂载点, 智算版特有
'."\n" + .'}
'."\n" + .'
', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "region": "cn-wulanchabu",'."\n" + .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" + .' "path": "/mnt",'."\n" + .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" + .' "isVpcMount": true'."\n" + .'}'], ], 'required' => false, ], @@ -4556,129 +3028,83 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。'."\n" - ."\n", + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'ImageId' => [ - 'title' => '镜像 id', - 'description' => '镜像ID。', - 'type' => 'string', - 'example' => 'image-4c62******53uor', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '41A847C8-3D12-5F24-8CE9-7F9EB2DA9ECD'], + 'VersionName' => ['description' => '数据集版本名称。', 'type' => 'string', 'example' => 'v1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ImageId\\": \\"image-4c62******53uor\\"\\n}","type":"json"}]', - 'title' => '添加镜像', - ], - 'AddImageLabels' => [ - 'summary' => '为镜像添加标签。', - 'path' => '/api/v1/images/{ImageId}/labels', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据集版本', + 'summary' => '创建数据集版本。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetVersion'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41A847C8-3D12-5F24-8CE9-7F9EB2DA9ECD\\",\\n \\"VersionName\\": \\"v1\\"\\n}","type":"json"}]', + ], + 'CreateDatasetVersionLabels' => [ + 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}/labels', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '61617', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], + 'abilityTreeCode' => '232578', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'ImageId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'title' => '镜像Id', - 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', - 'type' => 'string', - 'required' => true, - 'example' => 'image-4c62******53uor'."\n", - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wzlj****9ks92'], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => true, 'example' => 'v1'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '数据', - 'description' => '镜像标签。', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ 'Labels' => [ - 'title' => '标签', - 'description' => '镜像标签列表。', + 'description' => '标签列表。', 'type' => 'array', - 'items' => [ - 'description' => '镜像标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => 'Key', - 'description' => '标签的键，目前允许添加的键如下'."\n" - ."\n" - .'- system.chipType'."\n" - .'- system.dsw.cudaVersion'."\n" - .'- system.dsw.fromImageId'."\n" - .'- system.dsw.fromInstanceId'."\n" - .'- system.dsw.id'."\n" - .'- system.dsw.os'."\n" - .'- system.dsw.osVersion'."\n" - .'- system.dsw.resourceType'."\n" - .'- system.dsw.rootImageId'."\n" - .'- system.dsw.stage'."\n" - .'- system.dsw.tag'."\n" - .'- system.dsw.type'."\n" - .'- system.framework'."\n" - .'- system.origin'."\n" - .'- system.pythonVersion'."\n" - .'- system.source'."\n" - .'- system.supported.dlc'."\n" - .'- system.supported.dsw', - 'type' => 'string', - 'required' => false, - 'example' => 'system.chipType', - ], - 'Value' => [ - 'title' => 'Value', - 'description' => '标签的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'GPU', - ], - ], - 'required' => false, - ], + 'items' => ['description' => '为数据集版本添加的标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], 'required' => true, ], ], @@ -4690,290 +3116,90 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。'."\n" - ."\n", + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '添加镜像标签', - ], - 'GetImage' => [ - 'summary' => '获取镜像详情。', - 'path' => '/api/v1/images/{ImageId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据集版本标签', + 'summary' => '创建数据集版本的标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetVersionLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetVersionLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', + ], + 'CreateExperiment' => [ + 'path' => '/api/v1/experiments', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '61616', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '206973', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'ImageId', - 'in' => 'path', - 'schema' => [ - 'title' => '镜像id', - 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', - 'type' => 'string', - 'required' => true, - 'example' => 'image-4c62******53uor', - ], - ], - [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'title' => '是否显示非必要信息：Labels', - 'description' => '是否显示非必要信息，非必要信息目前包含Labels。'."\n" - .'取值如下：'."\n" - .'- false（默认值）：不显示非必要信息。'."\n" - .'- true：显示非必要信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'title' => 'body参数', + 'description' => 'body参数', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'GmtCreateTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '镜像的创建UTC时间，格式ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'GmtModifiedTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '镜像的修改UTC时间，格式ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'Name' => [ - 'title' => '镜像名称', - 'description' => '镜像名称。', - 'type' => 'string', - 'example' => 'nlp-compression'."\n", - ], - 'Description' => [ - 'title' => '描述', - 'description' => '镜像描述。', - 'type' => 'string', - 'example' => 'NLP模型压缩训练镜像'."\n", - ], - 'ImageUri' => [ - 'title' => '镜像地址，包含版本号', - 'description' => '镜像地址，包含版本号。', - 'type' => 'string', - 'example' => 'registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu'."\n", - ], - 'UserId' => [ - 'title' => '创建人', - 'description' => '创建镜像的UID。', - 'type' => 'string', - 'example' => '15577******8921', - ], - 'ParentUserId' => [ - 'title' => '创建人父账户', - 'description' => '创建者的阿里云账号。', - 'type' => 'string', - 'example' => '15577******8921', - ], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '478**'], 'Labels' => [ - 'title' => '镜像标签', - 'description' => '镜像标签列表，数组类型，数组每一项包含Key和Value两个字段。'."\n" - .'官方镜像带有标签：key为system.official；value为true。', + 'title' => '标签', + 'description' => '标签', 'type' => 'array', - 'items' => [ - 'description' => '镜像标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => 'Key', - 'description' => '标签的键。', - 'type' => 'string', - 'example' => 'system.chipType'."\n", - ], - 'Value' => [ - 'title' => 'Value', - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'GPU', - ], - ], - ], - ], - 'WorkspaceId' => [ - 'title' => '工作空间id', - 'description' => '镜像所属的工作空间ID。', - 'type' => 'string', - 'example' => '15945', + 'items' => ['description' => '标签', 'required' => false, '$ref' => '#/components/schemas/LabelInfo'], + 'required' => false, ], + 'Name' => ['title' => '名称', 'description' => '实验（Experiment）的名称。命名规则如下：'."\n" + ."\n" + .'- 以小写字母、大写字母开头。'."\n" + .'- 可以包含大小写字母、数字、下划线（_）或短划线（-）。'."\n" + .'- 长度为1~63个字符。', 'type' => 'string', 'required' => true, 'example' => 'exp-test'], + 'ArtifactUri' => ['title' => 'Artifact路径', 'description' => '关联到实验的所有任务的默认Artifact输出路径，当前仅支持OSS路径', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/test'], 'Accessibility' => [ - 'title' => '可见性', - 'description' => '镜像的可见性，可能值：'."\n" - .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" - .'- PRIVATE：只有创建者可以操作。', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'Size' => [ - 'description' => '镜像大小，单位为byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'SourceType' => [ - 'title' => '镜像来源类型', - 'description' => '镜像来源类型', - 'type' => 'string', - ], - 'SourceId' => [ - 'title' => '镜像来源 ID', - 'description' => '镜像来源 ID', + 'description' => '可见性，分为私有（即仅创建者及其主账号可见）、公开（即所有人可见）；非必填，默认为私有。', 'type' => 'string', + 'required' => false, + 'example' => 'PRIVATE', + 'default' => 'PRIVATE', + 'enum' => ['PRIVATE', 'PUBLIC'], ], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Name\\": \\"nlp-compression\\\\n\\",\\n \\"Description\\": \\"NLP模型压缩训练镜像\\\\n\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu\\\\n\\",\\n \\"UserId\\": \\"15577******8921\\",\\n \\"ParentUserId\\": \\"15577******8921\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\\\n\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"WorkspaceId\\": \\"15945\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"Size\\": 10,\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\"\\n}","type":"json"}]', - 'title' => '获取镜像', - ], - 'ListImageLabels' => [ - 'summary' => '获取镜像标签列表。', - 'path' => '/api/v1/image/labels', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '61618', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], - ], - 'parameters' => [ - [ - 'name' => 'LabelKeys', - 'in' => 'query', - 'schema' => [ - 'title' => '标签列表，以逗号分隔', - 'description' => '标签键的列表，以半角逗号（,）分隔。'."\n" - .'系统标签以system开头，与LabelFilter分别独立生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'system.framework,system.official', - ], - ], - [ - 'name' => 'LabelFilter', - 'in' => 'query', - 'schema' => [ - 'title' => 'image过滤条件，获取满足条件的image的所有label', - 'description' => '标签过滤条件，多个条件以逗号分隔。'."\n" - .'单个条件过滤格式为`key=value`。'."\n" - .'与LabelKeys分别独立生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'system.framework=XGBoost 1.6.0,system.official=true', - ], - ], - [ - 'name' => 'ImageId', - 'in' => 'query', - 'schema' => [ - 'title' => '镜像id', - 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', - 'type' => 'string', - 'required' => false, - 'example' => 'image-4c62******53uor'."\n", - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '工作空间id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '镜像所属地域。', - 'type' => 'string', 'required' => false, - 'example' => 'cn-shanghai', ], ], ], @@ -4981,233 +3207,292 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。'."\n" - ."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'Labels' => [ - 'title' => '镜像标签', - 'description' => '镜像标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '镜像标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '键', - 'description' => '标签的键。', - 'type' => 'string', - 'example' => 'system.chipType', - ], - 'Value' => [ - 'title' => '值', - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'GPU', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的数量', - 'description' => '符合过滤条件的镜像标签列表数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'Request ID'], + 'ExperimentId' => ['title' => '若创建接口为异步实现，则需返回明确的JobId。', 'description' => '若创建接口为异步实现，则需返回明确的JobId。', 'type' => 'string', 'example' => 'ExperimentId-example-id-****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', - 'title' => '获取镜像标签列表', - ], - 'ListImages' => [ - 'summary' => '获取镜像列表。', - 'path' => '/api/v1/images', - 'methods' => [ - 'get', + 'title' => '创建实验', + 'summary' => '创建实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'CreateExperiment'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiexperiment:CreateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"Request ID\\",\\n \\"ExperimentId\\": \\"ExperimentId-example-id-****\\"\\n}","type":"json"}]', + ], + 'CreateImageBuild' => [ + 'path' => '/api/v1/imagebuilds', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '61620', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '259250', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '镜像名称，支持模糊搜索', - 'description' => '镜像名称，支持模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'tensorflow_2.9', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页，从1开始，默认1', - 'description' => '镜像列表的页码。起始值为1，默认为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小，默认20', - 'description' => '分页查询时设置的每页行数。默认为20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序字段', - 'description' => '分页查询时的排序字段。目前GmtCreateTime字段用于排序。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], - ], - [ - 'name' => 'Order', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'title' => '排序方向： ASC - 升序 DESC - 降序', - 'description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。默认ASC。'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], [ - 'name' => 'Labels', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '过滤值 以逗号分隔', - 'description' => '标签过滤条件，多个条件以半角逗号（,）分隔。'."\n" - .'单个条件过滤格式为`Key=Value`。'."\n" - .'Key支持如下值：'."\n" - ."\n" - .'- system.chipType'."\n" - .'- system.dsw.cudaVersion'."\n" - .'- system.dsw.fromImageId'."\n" - .'- system.dsw.fromInstanceId'."\n" - .'- system.dsw.id'."\n" - .'- system.dsw.os'."\n" - .'- system.dsw.osVersion'."\n" - .'- system.dsw.resourceType'."\n" - .'- system.dsw.rootImageId'."\n" - .'- system.dsw.stage'."\n" - .'- system.dsw.tag'."\n" - .'- system.dsw.type'."\n" - .'- system.framework'."\n" - .'- system.origin'."\n" - .'- system.pythonVersion'."\n" - .'- system.source'."\n" - .'- system.supported.dlc'."\n" - .'- system.supported.dsw', - 'type' => 'string', - 'required' => false, - 'example' => 'system.framework=XGBoost 1.6.0,system.official=true'."\n", - ], - ], - [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'title' => '是否显示非必要信息：Labels', - 'description' => '是否显示非必要信息，非必要信息目前包含Labels。取值如下：'."\n" - ."\n" - .'- true：包含非必要信息。'."\n" - .'- false：不包含非必要信息。', - 'type' => 'boolean', + 'title' => 'body参数', + 'description' => 'body参数', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'title' => '可见性', + 'description' => '可见性'."\n" + .'- **PUBLIC** 公有'."\n" + .'- **PRIVATE** 私有'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], + 'example' => 'PUBLIC', + ], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间 ID。', 'type' => 'string', 'required' => true, 'example' => '12345'], + 'Resource' => [ + 'title' => '构建任务运行资源', + 'description' => '任务运行资源'."\n", + 'type' => 'object', + 'properties' => [ + 'EcsSpec' => ['title' => '后付费资源规格', 'description' => '后付费资源规格。使用“公共资源组”时，此参数必填。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large'], + 'ResourceConfig' => [ + 'description' => '资源配置。使用预付费资源时需要指定，使用“公共资源组”时为空。', + 'type' => 'object', + 'properties' => [ + 'CPU' => ['description' => 'CPU 核心数', 'type' => 'string', 'required' => false, 'example' => '4'], + 'Memory' => ['description' => '内存容量。', 'type' => 'string', 'required' => false, 'example' => '8Gi'], + ], + 'required' => false, + ], + 'ResourceId' => ['description' => '资源配额 ID。仅针对预付费资源，使用后付费资源时不设置。', 'type' => 'string', 'required' => false, 'example' => 'quotaadzoqup693z'], + 'ResourceType' => [ + 'title' => '资源类型，使用预付费资源组时，此参数必填。当前仅支持 Lingjun', + 'description' => '预付费资源类型。目前只支持灵骏资源，使用预付费资源时需要指定。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Lingjun' => 'Lingjun'], + 'example' => 'Lingjun', + ], + ], + 'required' => true, + ], + 'UserVpc' => [ + 'title' => '用户专有网络信息', + 'description' => '用户专有网络信息。使用“公共资源组”时，此参数必填。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => '专有网络 ID', 'description' => '专有网络 ID。构建任务访问用户企业版 ACR 实例时，需要指定在用户 ACR 实例的访问控制里已添加的专有网络。', 'type' => 'string', 'required' => false, 'example' => 'vpc-abcdef**'], + 'SwitchId' => ['title' => '交换机 ID', 'description' => '交换机 ID，可选。', 'type' => 'string', 'required' => false, 'example' => 'vs-abcdef**'], + 'SecurityGroupId' => ['title' => '安全组 ID', 'description' => '安全组 ID。指定专有网络配置时，此参数必填。', 'type' => 'string', 'required' => false, 'example' => 'sg-abcdef**'], + 'ExtendedCidrs' => [ + 'title' => '扩展网段', + 'description' => '扩展网段。'."\n" + .'* 当交换机 ID 为空时，此参数可以不提供，系统会自动获取 VPC 下的所有网段；'."\n" + .'* 当交换机 ID 不为空时，此参数必须提供，建议填写 VPC 下的所有网段。', + 'type' => 'array', + 'items' => ['description' => '扩展网段', 'type' => 'string', 'required' => false, 'example' => '10.0.0.0/24'], + 'required' => false, + ], + 'DefaultRoute' => ['title' => '默认路由网卡出口', 'description' => '默认路由。'."\n" + .'* eth1：表示使用用户弹性网卡，通过私有网关访问外部网络。具体配置方法，请参考[配置 DSW 实例通过专有公网网关访问公网](https://help.aliyun.com/zh/pai/user-guide/configure-a-dsw-instance-to-access-the-internet-through-a-private-nat-gateway?spm=a2c4g.11186623.0.0.3b3965f6SZWm85)', 'type' => 'string', 'required' => false, 'example' => 'eth1'], + ], + 'required' => false, + ], + 'TargetRegistry' => [ + 'title' => '目标镜像服务配置', + 'description' => '**目标镜像服务配置。**'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '镜像服务实例 ID。 使用 ACR 作为镜像服务时，此参数必填。', 'type' => 'string', 'required' => false, 'example' => 'cri-**abcd'], + 'Type' => ['description' => '当前只支持企业版 ACR 作为目标镜像服务。', 'type' => 'string', 'required' => true, 'example' => 'AcrEnterprise'], + ], + 'required' => true, + ], + 'OverwriteImageTag' => ['title' => '是否覆盖更新镜像', 'description' => '是否覆盖更新镜像仓库中已经存在的镜像版本。', 'type' => 'boolean', 'required' => false], + 'BuildConfig' => [ + 'title' => '构建配置', + 'description' => '**构建配置，指定待构建的 Dockerfile 文件内容。**'."\n", + 'type' => 'object', + 'properties' => [ + 'Dockerfile' => ['title' => 'Dockerfile文件内容', 'description' => '指定待构建的 Dockerfile 文件内容。'."\n", 'type' => 'string', 'required' => true, 'example' => 'FROM ubuntu:18:04'."\n" + .'RUN pip3 install numpy==1.19.5'], + 'BuildType' => ['title' => 'BuildType 当前支持以下两种类型：'."\n" + .'PackageInstallation ： 基于指定镜像安装软件包。'."\n" + .'CustomDockerfile：基于定制 Dockerfile。', 'description' => '构建类型，当前支持以下两种类型：'."\n" + .'* **PackageInstallation** ： 基于指定镜像安装软件包。'."\n" + .'* **CustomDockerfile**：基于定制 Dockerfile。', 'type' => 'string', 'required' => true, 'example' => 'PackageInstallation'], + 'RegistryAuths' => ['title' => '私有仓库鉴权信息。', 'description' => '私有镜像仓库鉴权信息。可以指定非当前用户的 ACR 镜像仓库的鉴权信息，格式：{"user_registry_domain":{"Auth":"base64 encoded auth"}}', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com": {'."\n" + .' "Auth": "dXNlcjp0ZXN0"'."\n" + .' }'."\n" + .'}'], + ], + 'required' => true, + ], + 'RegionId' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu'], + 'ImageBuildJobName' => ['title' => '镜像构建任务名称', 'description' => '镜像构建任务名称。', 'type' => 'string', 'required' => false, 'example' => 'build-my-image'], + 'Image' => [ + 'description' => '镜像元数据信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '命名规则如下：'."\n" + .'* 长度为 1~50 个英文字符。'."\n" + .'* 支持小写字母、数字和短横线（-），以字母开头。'."\n" + .'* 同一工作空间内不可重复。', 'type' => 'string', 'required' => true, 'example' => 'test-v1'], + 'Description' => ['description' => '镜像描述。', 'type' => 'string', 'required' => false, 'example' => 'Build test image'], + 'Uri' => ['description' => '镜像地址。', 'type' => 'string', 'required' => true, 'example' => 'user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com/pai-test/pai-test:test-v1'], + 'Labels' => [ + 'description' => '镜像标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '镜像标签的键。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'Value' => ['description' => '镜像标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], 'required' => false, - 'example' => 'true', ], ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '工作空间id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '20******55', + 'title' => 'Schema of Response', + 'description' => '返回值都是json格式'."\n", + 'type' => 'object', + 'properties' => [ + 'ImageBuildId' => ['title' => '资源一级ID', 'description' => '镜像构建 ID。'."\n", 'type' => 'string', 'example' => 'build-****ks92'], + 'ImageBuildJobId' => ['title' => '构建任务 ID。', 'description' => '构建任务 ID。', 'type' => 'string', 'example' => 'dlc-****ks92'], + ], ], ], + ], + 'title' => '构建自定义镜像', + 'summary' => '根据指定配置构建自定义镜像， 构建成功后，会添加到当前工作空间的自定义镜像里。', + 'description' => '## 请求说明'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'Query', - 'in' => 'query', - 'schema' => [ - 'description' => '模糊搜索镜像名称以及描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiimage:CreateImageBuild', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageBuildId\\": \\"build-****ks92\\",\\n \\"ImageBuildJobId\\": \\"dlc-****ks92\\"\\n}","type":"json"}]', + ], + 'CreateMember' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/members', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Accessibility', - 'in' => 'query', - 'schema' => [ - 'description' => '镜像的可见性，目前只对自定义镜像生效。'."\n" - ."\n" - .'- PUBLIC表示公开。'."\n" - .'- PRIVATE表示私有。', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - ], + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ - 'name' => 'ImageUri', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'Members' => [ + 'title' => '用户列表', + 'description' => '成员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '成员详情。', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '用户 id', 'description' => '成员ID列表，多个成员ID以半角逗号（,）分隔。如何获取成员ID，请参见[ListMembers](~~449135~~)。', 'type' => 'string', 'required' => true, 'example' => '145883-21513926******88039,145883-2769726******87513'], + 'Roles' => [ + 'title' => '角色列表', + 'description' => '角色列表。', + 'type' => 'array', + 'items' => ['description' => '角色名。角色名和权限的对应关系，请参见[角色及权限列表](https://pai.console.aliyun.com/?regionId=cn-shanghai#/workspace/permission)。'."\n" + .'支持以下角色名：'."\n" + .'- PAI.AlgoDeveloper：算法开发。'."\n" + .'- PAI.AlgoOperator：算法运维。'."\n" + .'- PAI.LabelManager：标注管理员。'."\n" + .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" + .'- PAI.WorkspaceAdmin：管理员。'."\n" + .'- PAI.WorkspaceGuest：访客。'."\n" + .'- PAI.WorkspaceOwner：负责人。', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoDeveloper'], + 'required' => true, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], 'required' => false, ], ], @@ -5219,128 +3504,33 @@ 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'TotalCount' => [ - 'title' => '总数', - 'description' => '返回的镜像总量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Images' => [ - 'title' => '镜像列表', - 'description' => '镜像列表。', + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'], + 'Members' => [ + 'title' => '成员列表', + 'description' => '成员列表。', 'type' => 'array', 'items' => [ - 'description' => '镜像详情。', + 'description' => '成员详情。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '镜像名称', - 'description' => '镜像名称。', - 'type' => 'string', - 'example' => 'tensorflow_2.9', - ], - 'GmtCreateTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '创建UTC时间，日期格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'Description' => [ - 'title' => '镜像描述', - 'description' => '镜像描述。', - 'type' => 'string', - 'example' => 'desc', - ], - 'ImageUri' => [ - 'title' => '镜像地址，包含版本号', - 'description' => '镜像地址，包含版本号。', - 'type' => 'string', - 'example' => 'registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0', - ], - 'Labels' => [ - 'title' => '镜像标签，是个map', - 'description' => '镜像标签列表。', + 'UserId' => ['title' => '用户 id', 'description' => '用户ID。', 'type' => 'string', 'example' => '21513926******88039'."\n"], + 'Roles' => [ + 'title' => '角色列表', + 'description' => '角色列表。', 'type' => 'array', - 'items' => [ - 'description' => '镜像标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => 'Key', - 'description' => '标签的键。', - 'type' => 'string', - 'example' => 'system.chipType', - ], - 'Value' => [ - 'title' => 'Value', - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'GPU', - ], - ], - ], - ], - 'ImageId' => [ - 'title' => '镜像id', - 'description' => '镜像ID。', - 'type' => 'string', - 'example' => 'image-tzi7f9******s45t', - ], - 'Accessibility' => [ - 'title' => '可见性', - 'description' => '镜像的可见性，可能值：'."\n" - .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" - .'- PRIVATE：只有创建者可以操作。', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'GmtModifiedTime' => [ - 'title' => '修改时间', - 'description' => '修改UTC时间，格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z'."\n", - ], - 'UserId' => [ - 'title' => '创建人', - 'description' => '创建者的阿里云账号UID。', - 'type' => 'string', - 'example' => '155**********904', - ], - 'ParentUserId' => [ - 'title' => '父创建人', - 'description' => '创建者的阿里云账号UID。', - 'type' => 'string', - 'example' => '155**********904', - ], - 'WorkspaceId' => [ - 'title' => '工作空间id', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '20******55', - ], - 'Size' => [ - 'description' => '镜像大小，单位为字节。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'SourceType' => [ - 'title' => '镜像来源类型', - 'description' => '镜像来源类型', - 'type' => 'string', - ], - 'SourceId' => [ - 'title' => '镜像来源 ID', - 'description' => '镜像来源 ID', - 'type' => 'string', - ], + 'items' => ['description' => '角色名。角色名和权限的对应关系，请参见[角色及权限列表](https://pai.console.aliyun.com/?regionId=cn-shanghai#/workspace/permission)。'."\n" + .'角色名可能值：'."\n" + ."\n" + .'- PAI.AlgoDeveloper：算法开发'."\n" + .'- PAI.AlgoOperator：算法运维'."\n" + .'- PAI.LabelManager：标注管理员'."\n" + .'- PAI.MaxComputeDeveloper：MaxCompute开发'."\n" + .'- PAI.WorkspaceAdmin：管理员'."\n" + .'- PAI.WorkspaceGuest：访客'."\n" + .'- PAI.WorkspaceOwner：负责人', 'type' => 'string', 'example' => 'PAI.AlgoDeveloper'], + ], + 'DisplayName' => ['title' => '成员显示名', 'description' => '显示名。', 'type' => 'string', 'example' => 'myDisplayName'], + 'MemberId' => ['title' => '成员 id', 'description' => '成员ID。', 'type' => 'string', 'example' => '145883-21513926******88039'."\n"], ], ], ], @@ -5348,54 +3538,105 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 2,\\n \\"Images\\": [\\n {\\n \\"Name\\": \\"tensorflow_2.9\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Description\\": \\"desc\\",\\n \\"ImageUri\\": \\"registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"ImageId\\": \\"image-tzi7f9******s45t\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\\\n\\",\\n \\"UserId\\": \\"155**********904\\",\\n \\"ParentUserId\\": \\"155**********904\\",\\n \\"WorkspaceId\\": \\"20******55\\",\\n \\"Size\\": 2,\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取镜像列表', - ], - 'RemoveImage' => [ - 'summary' => '删除镜像。', - 'path' => '/api/v1/images/{ImageId}', - 'methods' => [ - 'delete', + 'title' => '工作空间添加成员', + 'summary' => '添加用户到工作空间，作为工作空间的成员，可以添加多个用户为成员。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMember'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:CreateMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\",\\n \\"Members\\": [\\n {\\n \\"UserId\\": \\"21513926******88039\\\\n\\",\\n \\"Roles\\": [\\n \\"PAI.AlgoDeveloper\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"145883-21513926******88039\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateModel' => [ + 'summary' => '创建模型。模型是模型版本的集合，创建模型时需要指定模型名称，描述等信息。', + 'path' => '/api/v1/models', + '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' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '61615', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], + 'abilityTreeCode' => '133752', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ - 'name' => 'ImageId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '镜像 id', - 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', - 'type' => 'string', - 'required' => true, - 'example' => 'image-rbv******c9ks92', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'ModelName' => ['title' => 'ModelName', 'description' => '模型名称，长度为1~127个字符。', 'type' => 'string', 'required' => true, 'example' => 'News classification'], + 'Labels' => [ + 'title' => 'Labels', + 'description' => '标签列表。将废弃，由Tag字段取代。', + 'type' => 'array', + 'items' => ['description' => '标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], + 'required' => false, + ], + 'Tag' => [ + 'title' => 'Tag', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。与Label一致。', 'required' => false, '$ref' => '#/components/schemas/Label'], + 'required' => false, + ], + 'ModelDescription' => ['title' => 'ModelDescription', 'description' => '模型描述，用于区分不同的模型。', 'type' => 'string', 'required' => false, 'example' => 'News classification.'], + 'WorkspaceId' => ['title' => 'WorkspaceId', 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '796**'], + 'Accessibility' => [ + 'title' => 'Accessibility', + 'description' => '工作空间可见度，取值如下。'."\n" + .'- PRIVATE（默认值）：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], + 'example' => 'PRIVATE', + ], + 'Origin' => ['title' => '模型源', 'description' => '模型源。描述源模型所属社区或组织，如ModelScope，HuggingFace等。', 'type' => 'string', 'required' => false, 'example' => 'ModelScope'], + 'Domain' => ['title' => '领域', 'description' => '领域。描述模型解决问题所属领域。例如：nlp（自然语言处理）、cv（计算机视觉）等。', 'type' => 'string', 'required' => false, 'example' => 'nlp'], + 'Task' => ['title' => '模型任务', 'description' => '任务。描述模型解决的具体问题。例如：text-classification（文本分类）等。', 'type' => 'string', 'required' => false, 'example' => 'text-classification'], + 'ModelDoc' => ['title' => '模型介绍文档', 'description' => '模型文档。', 'type' => 'string', 'required' => false, 'example' => 'https://*.md'], + 'OrderNumber' => ['title' => '序号', 'description' => '模型序号。可用于自定义排序。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + 'ModelType' => ['title' => '模型类型', 'description' => '模型类型。如Checkpoint，LoRA等。', 'type' => 'string', 'required' => false, 'example' => 'Checkpoint'], + 'ExtraInfo' => ['title' => '其它信息', 'description' => '模型的其它信息。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "RatingCount": 2866,'."\n" + .' "Rating": 4.94,'."\n" + .' "FavoriteCount": 34992,'."\n" + .' "CommentCount": 754,'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" + .' "TippedAmountCount": 32,'."\n" + .' "DownloadCount": 606056'."\n" + .'}'], + 'ParameterSize' => ['description' => '参数量，单位M。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3000'], + ], + 'required' => false, ], ], ], @@ -5403,68 +3644,80 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。'."\n" - ."\n", + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9DAD3112-AE22-5563-9A02-5C7E8****E35'], + 'ModelId' => ['description' => '模型ID。', 'type' => 'string', 'example' => 'model-rbvg5wzljz****ks92'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除镜像', - ], - 'PublishImage' => [ - 'summary' => '发布镜像，把镜像的可见性从PRIVATE变为PUBLIC。', - 'path' => '/api/v1/images/{ImageId}/publish', - 'methods' => [ - 'put', + 'title' => '创建模型', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModel'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paimodel:CreateModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DAD3112-AE22-5563-9A02-5C7E8****E35\\",\\n \\"ModelId\\": \\"model-rbvg5wzljz****ks92\\"\\n}","type":"json"}]', + ], + 'CreateModelLabels' => [ + 'path' => '/api/v1/models/{ModelId}/labels', + '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' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '72192', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], + 'abilityTreeCode' => '133787', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ - 'name' => 'ImageId', + 'name' => 'ModelId', 'in' => 'path', + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-1dkasjfhds23dft'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '镜像Id', - 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', - 'type' => 'string', - 'required' => true, - 'example' => 'image-dk******fa', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], + 'required' => false, + ], + ], + 'required' => false, ], ], ], @@ -5472,676 +3725,799 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', - ], - 'ImageId' => [ - 'title' => '镜像 id', - 'description' => '镜像ID。', - 'type' => 'string', - 'example' => 'image-dk******fa', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F81D9EC0-1872-50F5-A96C-A0647D****1D'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\",\\n \\"ImageId\\": \\"image-dk******fa\\"\\n}","type":"json"}]', - 'title' => '发布镜像', - ], - 'RemoveImageLabels' => [ - 'summary' => '移除镜像标签。', - 'path' => '/api/v1/images/{ImageId}/labels/{LabelKey}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建模型标签', + 'summary' => '为模型创建标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paimodel:CreateModelLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F81D9EC0-1872-50F5-A96C-A0647D****1D\\"\\n}","type":"json"}]', + ], + 'CreateModelVersion' => [ + 'summary' => '为指定模型新增版本。', + 'path' => '/api/v1/models/{ModelId}/versions', + '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' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '61614', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], + 'abilityTreeCode' => '133771', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ - 'name' => 'ImageId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '镜像 Id', - 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', - 'type' => 'string', - 'required' => true, - 'example' => 'image-d8df******dsjfd', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'VersionName' => ['title' => '模型版本，模型下唯一。', 'description' => '模型版本，模型下唯一。如果不填写该参数，则默认**0.1.0**为第一个版本。之后子版本号依次加1，例如：第二个版本号默认为**0.2.0**。'."\n" + .'版本号由主版本号、子版本号和阶段版本号组成，通过半角句号（.）分隔。其中：主版本号、子版本号为数字，阶段版本号以数字开头，下划线和字母组成。例如：版本号为1.1.0或2.3.4_beta。', 'type' => 'string', 'required' => false, 'example' => '0.1.0'], + 'Uri' => ['title' => '版本Uri', 'description' => '模型版本URI，即模型存储位置。模型地址类型如下：'."\n" + .'- 模型的HTTP（S）地址，例如：`https://myweb.com/mymodel.tar.gz`。'."\n" + .'- 如果模型存储在OSS中，格式为`oss://./object`。其中endpoint配置，请参见[访问域名和数据中心](~~31837~~)，例如：`oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`。', 'type' => 'string', 'required' => true, 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/'], + 'Labels' => [ + 'title' => '标签', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], + 'required' => false, + ], + 'VersionDescription' => ['title' => '版本描述', 'description' => '模型版本描述。', 'type' => 'string', 'required' => false, 'example' => 'Sentiment analysis.'], + 'FormatType' => [ + 'title' => '模型类型', + 'description' => '模型格式，取值如下：'."\n" + .'- OfflineModel'."\n" + .'- SavedModel'."\n" + .'- Keras H5'."\n" + .'- Frozen Pb'."\n" + .'- Caffe Prototxt'."\n" + .'- TorchScript'."\n" + .'- XGBoost'."\n" + .'- PMML'."\n" + .'- AlinkModel'."\n" + .'- ONNX', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['OfflineModel' => 'OfflineModel', 'SavedModel' => 'SavedModel', 'Keras H5' => 'Keras H5', 'Frozen Pb' => 'Frozen Pb', 'Caffe Prototxt' => 'Caffe Prototxt', 'TorchScript' => 'TorchScript', 'XGBoost' => 'XGBoost', 'PMML' => 'PMML', 'AlinkModel' => 'AlinkModel', 'ONNX' => 'ONNX'], + 'example' => 'SavedModel', + ], + 'FrameworkType' => [ + 'title' => '模型框架', + 'description' => '模型框架，取值如下：'."\n" + .'- Pytorch'."\n" + .'- XGBoost'."\n" + .'- Keras'."\n" + .'- Caffe'."\n" + .'- Alink'."\n" + .'- Xflow'."\n" + .'- TensorFlow', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Pytorch' => 'Pytorch', 'XGBoost' => 'XGBoost', 'Keras' => 'Keras', 'Caffe' => 'Caffe', 'Alink' => 'Alink', 'Xflow' => 'Xflow', 'TensorFlow' => 'TensorFlow'], + 'example' => 'TensorFlow', + ], + 'Options' => ['title' => '扩展字段', 'description' => '扩展字段。JsonString类型。', 'type' => 'string', 'required' => false, 'example' => '{}'], + 'Metrics' => ['title' => '指标', 'description' => '模型指标。'."\n" + .'序列化后长度限制为8192。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "Results": [{'."\n" + .' "Dataset": {'."\n" + .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" + .' },'."\n" + .' "Metrics": {'."\n" + .' "cer": 0.175'."\n" + .' }'."\n" + .' }, {'."\n" + .' "Dataset": {'."\n" + .' "Uri": "oss://xxxx/"'."\n" + .' },'."\n" + .' "Metrics": {'."\n" + .' "cer": 0.172'."\n" + .' }'."\n" + .' }]'."\n" + .'}'], + 'TrainingSpec' => ['title' => '训练配置', 'description' => '训练配置。用于微调、增量训练的配置。', 'type' => 'object', 'required' => false, 'example' => '{}'], + 'InferenceSpec' => ['title' => '描述如何应用于下游的推理应用', 'description' => '描述如何应用于下游的推理服务：例如描述EAS的processor、container等。例如：'."\n" + .'`{'."\n" + .' "processor": "tensorflow_gpu_1.12"'."\n" + .'}`', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "processor": "tensorflow_gpu_1.12"'."\n" + .'}'], + 'SourceType' => [ + 'title' => '来源类型', + 'description' => '模型来源类型，取值如下：'."\n" + .'- Custom（默认值）：自定义。'."\n" + .'- PAIFlow：PAI工作流。'."\n" + .'- TrainingService：PAI训练服务。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], + 'example' => 'PAIFlow', + ], + 'SourceId' => ['title' => '来源ID', 'description' => '来源ID。'."\n" + .'* 来源类型为Custom时，该字段不做限制。'."\n" + .'* 来源为PAIFlow、TrainingService时，格式为 '."\n" + .'```'."\n" + .'region=,workspaceId=,kind=,id='."\n" + .'```'."\n" + .'其中：'."\n" + .'- region为阿里云区域ID。'."\n" + .'- workspaceId为工作空间ID。'."\n" + .'- kind：为类型。取值：PipelineRun（PAIFlow工作流）；ServiceJob（训练服务）。'."\n" + .'- id：为唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], + 'ApprovalStatus' => ['title' => '准入状态', 'description' => '准入状态，取值如下：'."\n" + .'- Pending：待定。'."\n" + .'- Approved：允许上线。'."\n" + .'- Rejected：不允许上线。', 'type' => 'string', 'required' => false, 'example' => 'Approved'], + 'EvaluationSpec' => ['title' => '评测配置', 'description' => '评测配置。', 'type' => 'object', 'required' => false, 'example' => '{}'], + 'CompressionSpec' => ['title' => '压缩配置', 'description' => '压缩配置。', 'type' => 'object', 'required' => false, 'example' => '{}'], + 'ExtraInfo' => ['title' => '其它信息', 'description' => '其它信息。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" + .' "TrainedWords": ["albedo_overlord"]'."\n" + .'}'], + 'DistillationSpec' => ['description' => '蒸馏配置。', 'type' => 'object', 'required' => false, 'example' => '{}'], + ], + 'required' => false, ], ], [ - 'name' => 'LabelKey', + 'name' => 'ModelId', 'in' => 'path', - 'schema' => [ - 'title' => 'label 的 key', - 'description' => 'label 的 key', - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-dfs1****5c'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。'."\n" - ."\n", + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '21645FCD-BAB9-5742-89AE-AEB27****B2E'], + 'VersionName' => ['title' => '模型名称', 'description' => '模型版本。', 'type' => 'string', 'example' => '0.1.0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '移除镜像标签', - ], - 'CreateImageBuild' => [ - 'summary' => '根据指定配置构建自定义镜像， 构建成功后，会添加到当前工作空间的自定义镜像里。', - 'path' => '/api/v1/imagebuilds', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建模型版本', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelVersion'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paimodel:CreateModelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21645FCD-BAB9-5742-89AE-AEB27****B2E\\",\\n \\"VersionName\\": \\"0.1.0\\"\\n}","type":"json"}]', + ], + 'CreateModelVersionLabels' => [ + 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}/labels', + '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' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '259250', - 'abilityTreeNodes' => [ - 'FEATURElearnAFIS9K', - ], - 'autoTest' => true, + 'chargeType' => 'free', + 'abilityTreeCode' => '133790', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], - ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'body参数', - 'description' => 'body参数', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'Accessibility' => [ - 'title' => '可见性', - 'description' => '可见性'."\n" - .'- **PUBLIC** 公有'."\n" - .'- **PRIVATE** 私有'."\n", - 'type' => 'string', + 'Labels' => [ + 'title' => '版本标签', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。', 'required' => false, '$ref' => '#/components/schemas/Label'], 'required' => false, - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], - 'example' => 'PUBLIC', - ], - 'WorkspaceId' => [ - 'title' => '工作空间ID', - 'description' => '工作空间 ID。', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - 'Resource' => [ - 'title' => '构建任务运行资源', - 'description' => '任务运行资源'."\n", - 'type' => 'object', - 'properties' => [ - 'EcsSpec' => [ - 'title' => '后付费资源规格', - 'description' => '后付费资源规格。使用“公共资源组”时，此参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.c6.large', - ], - 'ResourceConfig' => [ - 'description' => '资源配置。使用预付费资源时需要指定，使用“公共资源组”时为空。', - 'type' => 'object', - 'properties' => [ - 'CPU' => [ - 'description' => 'CPU 核心数', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - 'Memory' => [ - 'description' => '内存容量。', - 'type' => 'string', - 'required' => false, - 'example' => '8Gi', - ], - ], - 'required' => false, - ], - 'ResourceId' => [ - 'description' => '资源配额 ID。仅针对预付费资源，使用后付费资源时不设置。', - 'type' => 'string', - 'required' => false, - 'example' => 'quotaadzoqup693z', - ], - 'ResourceType' => [ - 'title' => '资源类型，使用预付费资源组时，此参数必填。当前仅支持 Lingjun', - 'description' => '预付费资源类型。目前只支持灵骏资源，使用预付费资源时需要指定。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Lingjun' => 'Lingjun', - ], - 'example' => 'Lingjun', - ], - ], - 'required' => true, - ], - 'UserVpc' => [ - 'title' => '用户专有网络信息', - 'description' => '用户专有网络信息。使用“公共资源组”时，此参数必填。', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'title' => '专有网络 ID', - 'description' => '专有网络 ID。构建任务访问用户企业版 ACR 实例时，需要指定在用户 ACR 实例的访问控制里已添加的专有网络。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-abcdef**', - ], - 'SwitchId' => [ - 'title' => '交换机 ID', - 'description' => '交换机 ID，可选。', - 'type' => 'string', - 'required' => false, - 'example' => 'vs-abcdef**', - ], - 'SecurityGroupId' => [ - 'title' => '安全组 ID', - 'description' => '安全组 ID。指定专有网络配置时，此参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-abcdef**', - ], - 'ExtendedCidrs' => [ - 'title' => '扩展网段', - 'description' => '扩展网段。'."\n" - .'* 当交换机 ID 为空时，此参数可以不提供，系统会自动获取 VPC 下的所有网段；'."\n" - .'* 当交换机 ID 不为空时，此参数必须提供，建议填写 VPC 下的所有网段。', - 'type' => 'array', - 'items' => [ - 'description' => '扩展网段', - 'type' => 'string', - 'required' => false, - 'example' => '10.0.0.0/24', - ], - 'required' => false, - ], - 'DefaultRoute' => [ - 'title' => '默认路由网卡出口', - 'description' => '默认路由。'."\n" - .'* eth1：表示使用用户弹性网卡，通过私有网关访问外部网络。具体配置方法，请参考[配置 DSW 实例通过专有公网网关访问公网](https://help.aliyun.com/zh/pai/user-guide/configure-a-dsw-instance-to-access-the-internet-through-a-private-nat-gateway?spm=a2c4g.11186623.0.0.3b3965f6SZWm85)', - 'type' => 'string', - 'required' => false, - 'example' => 'eth1', - ], - ], - 'required' => false, - ], - 'TargetRegistry' => [ - 'title' => '目标镜像服务配置', - 'description' => '**目标镜像服务配置。**'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '镜像服务实例 ID。 使用 ACR 作为镜像服务时，此参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'cri-**abcd', - ], - 'Type' => [ - 'description' => '当前只支持企业版 ACR 作为目标镜像服务。', - 'type' => 'string', - 'required' => true, - 'example' => 'AcrEnterprise', - ], - ], - 'required' => true, - ], - 'OverwriteImageTag' => [ - 'title' => '是否覆盖更新镜像', - 'description' => '是否覆盖更新镜像仓库中已经存在的镜像版本。', - 'type' => 'boolean', - 'required' => false, - ], - 'BuildConfig' => [ - 'title' => '构建配置', - 'description' => '**构建配置，指定待构建的 Dockerfile 文件内容。**'."\n", - 'type' => 'object', - 'properties' => [ - 'Dockerfile' => [ - 'title' => 'Dockerfile文件内容', - 'description' => '指定待构建的 Dockerfile 文件内容。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'FROM ubuntu:18:04'."\n" - .'RUN pip3 install numpy==1.19.5', - ], - 'BuildType' => [ - 'title' => 'BuildType 当前支持以下两种类型：'."\n" - .'PackageInstallation ： 基于指定镜像安装软件包。'."\n" - .'CustomDockerfile：基于定制 Dockerfile。', - 'description' => '构建类型，当前支持以下两种类型：'."\n" - .'* **PackageInstallation** ： 基于指定镜像安装软件包。'."\n" - .'* **CustomDockerfile**：基于定制 Dockerfile。', - 'type' => 'string', - 'required' => true, - 'example' => 'PackageInstallation', - ], - 'RegistryAuths' => [ - 'title' => '私有仓库鉴权信息。', - 'description' => '私有镜像仓库鉴权信息。可以指定非当前用户的 ACR 镜像仓库的鉴权信息，格式：{"user_registry_domain":{"Auth":"base64 encoded auth"}}', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com": {'."\n" - .' "Auth": "dXNlcjp0ZXN0"'."\n" - .' }'."\n" - .'}', - ], - ], - 'required' => true, - ], - 'RegionId' => [ - 'title' => '地域ID', - 'description' => '地域ID', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-wulanchabu', - ], - 'ImageBuildJobName' => [ - 'title' => '镜像构建任务名称', - 'description' => '镜像构建任务名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'build-my-image', - ], - 'Image' => [ - 'description' => '镜像元数据信息。'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '命名规则如下：'."\n" - .'* 长度为 1~50 个英文字符。'."\n" - .'* 支持小写字母、数字和短横线（-），以字母开头。'."\n" - .'* 同一工作空间内不可重复。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-v1', - ], - 'Description' => [ - 'description' => '镜像描述。', - 'type' => 'string', - 'required' => false, - 'example' => '构建测试镜像', - ], - 'Uri' => [ - 'description' => '镜像地址。', - 'type' => 'string', - 'required' => true, - 'example' => 'user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com/pai-test/pai-test:test-v1', - ], - 'Labels' => [ - 'description' => '镜像标签。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '镜像标签的键。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '镜像标签的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => true, ], ], 'required' => false, ], ], + [ + 'name' => 'ModelId', + 'in' => 'path', + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wzljz****ks92'], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['title' => '模型版本', 'description' => '模型版本。', 'type' => 'string', 'required' => true, 'example' => '0.1.1'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回值都是json格式'."\n", + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'ImageBuildId' => [ - 'title' => '资源一级ID', - 'description' => '镜像构建 ID。'."\n", - 'type' => 'string', - 'example' => 'build-****ks92', - ], - 'ImageBuildJobId' => [ - 'title' => '构建任务 ID。', - 'description' => '构建任务 ID。', - 'type' => 'string', - 'example' => 'dlc-****ks92', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageBuildId\\": \\"build-****ks92\\",\\n \\"ImageBuildJobId\\": \\"dlc-****ks92\\"\\n}","type":"json"}]', - 'title' => '构建自定义镜像', - 'description' => '## 请求说明'."\n", - ], - 'ListPermissions' => [ - 'summary' => '获取用户在工作空间内的权限列表。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/permissions', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建模型版本标签', + 'summary' => '为模型版本创建标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelVersionLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paimodel:CreateModelVersionLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'CreateProductOrders' => [ + 'path' => '/api/v1/productorders', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '14249', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '75124', + 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '购买请求', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2AE63638-5420-56DC-B******8174039A0', - ], - 'Permissions' => [ - 'title' => '权限列表', - 'description' => '权限列表。', + 'AutoPay' => ['title' => '是否自动购买所有产品', 'description' => '是否自动购买（支付）Products参数中传入的所有产品。'."\n" + .'- true：自动支付。'."\n" + .'- false：不自动支付。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'Products' => [ + 'description' => '需要购买的产品列表，使用逗号分割。', 'type' => 'array', 'items' => [ - 'description' => '权限。', + 'description' => '需要购买的产品。', 'type' => 'object', 'properties' => [ - 'PermissionCode' => [ - 'title' => '权限 code', - 'description' => '权限点的名字，同地域内唯一。权限点介绍，请参见[附录：角色及权限列表](~~2840449~~)。'."\n" - .'例如示例值PaiDLC:GetTensorboard，指的是页面中DLC功能模块的查看Tensorboard详情权限。', + 'AutoRenew' => [ + 'description' => '是否自动续费。'."\n" + .'- true：自动续费。'."\n" + .'- false：不自动续费。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', + ], + 'ProductCode' => [ + 'description' => '产品code，目前支持的如下code：'."\n" + ."\n" + .'- DataWorks_share：Dataworks后付费商品。'."\n" + .'- MaxCompute_share：MaxCompute后付费商品。'."\n" + .'- PAI_share：PAI后付费商品。'."\n" + .'- OSS_share：OSS后付费商品。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['MaxCompute_share' => 'MaxCompute_share', 'OSS_share' => 'OSS_share', 'DataWorks_share' => 'DataWorks_share', 'PAI_share' => 'PAI_share'], + 'example' => 'DataWorks_share', + ], + 'ChargeType' => [ + 'description' => '付费类型，目前支持POSTPAY。', 'type' => 'string', - 'example' => 'PaiDLC:GetTensorboard', + 'required' => false, + 'enumValueTitles' => ['POSTPAY' => 'POSTPAY'], + 'example' => 'POSTPAY', ], - 'PermissionRules' => [ - 'description' => '权限规则列表。', + 'OrderType' => [ + 'description' => '订单类型，目前只支持BUY。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['BUY' => 'BUY'], + 'example' => 'BUY', + ], + 'PricingCycle' => [ + 'description' => '计价单位，目前支持如下值'."\n" + .'- Month：按月计价，DataWorks_share只支持Month。'."\n" + .'- Hour：按小时计价，OSS_share、MaxCompute_share只支持Hour。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Month' => 'Month', 'Hour' => 'Hour'], + 'example' => 'Month', + ], + 'Duration' => ['description' => '购买时长，与pricingCycle配合使用，目前只支持1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'InstanceProperties' => [ + 'description' => '实例属性信息列表。'."\n" + .'- DataWorks_share：'."\n" + .'[ {'."\n" + .'"Code": "region",'."\n" + .'"Value": "cn-shanghai"'."\n" + .'}'."\n" + .']'."\n" + .'- OSS_share：'."\n" + .'[ {'."\n" + .'"Code": "commodity_type",'."\n" + .'"Value": "oss",'."\n" + .'"Name": "对象存储OSS"'."\n" + .'},'."\n" + .'{'."\n" + .'"Code": "ord_time",'."\n" + .'"Value": "1:Hour",'."\n" + .'"Name": "1小时"'."\n" + .'}'."\n" + .']'."\n" + .'- PAI_share: 无'."\n" + .'- 国内bid MaxCompute_share：'."\n" + .'['."\n" + .'{'."\n" + .'"Code": "region",'."\n" + .'"Value": "cn-hangzhou"'."\n" + .'},'."\n" + .'{'."\n" + .'"Code": "odps_specification_type",'."\n" + .'"Value": "OdpsStandard"'."\n" + .'},'."\n" + .'{'."\n" + .'"Code": "ord_time",'."\n" + .'"Value": "1:Hour"'."\n" + .'}'."\n" + .']'."\n" + .'- 国际bid MaxCompute_share：'."\n" + .'['."\n" + .'{'."\n" + .'"Code": "region",'."\n" + .'"Value": "cn-hangzhou"'."\n" + .'},'."\n" + .'{'."\n" + .'"Code": "ord_time",'."\n" + .'"Value": "1:Hour"'."\n" + .'}'."\n" + .']', 'type' => 'array', 'items' => [ - 'description' => '权限规则。', + 'description' => '实例属性信息。', 'type' => 'object', 'properties' => [ - 'Accessibility' => [ - 'title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', - 'description' => '访问类型，可能值：'."\n" - ."\n" - .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" - .'- PRIVATE：只有创建者可以操作。'."\n" - .'- ANY：创建者和非创建者都可以操作。', - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'EntityAccessType' => [ - 'title' => '存取类型 CREATOR 代表能看自已创建的 OTHERS 代表可以看别人创建的 ALL代表所有', - 'description' => '存取类型。'."\n" - .'当Accessibility为PUBLIC，所有用户都能操作，此值无效；'."\n" - .'当Accessibility为PRIVATE时，根据EntityAccessType的值决定权限，EntityAccessType支持如下值：'."\n" - .'- CREATOR：只有创建者可以操作。'."\n" - .'- ANY：创建者和非创建者都可以操作。', - 'type' => 'string', - 'example' => 'CREATOR', - ], + 'Code' => ['description' => '实例属性Code。', 'type' => 'string', 'required' => false, 'example' => 'commodity_type'], + 'Name' => ['description' => '实例属性Name。', 'type' => 'string', 'required' => false, 'example' => 'Object Storage Service'], + 'Value' => ['description' => '实例属性Value。', 'type' => 'string', 'required' => false, 'example' => 'oss'], ], + 'required' => false, ], + 'required' => false, ], ], + 'required' => false, ], + 'required' => false, ], - 'TotalCount' => [ - 'title' => '符合过滤条件的数量', - 'description' => '符合过滤条件的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => 'ksdjf-jksd-*****slkdjf'], + 'OrderId' => ['title' => '订单id', 'description' => '购买订单ID。', 'type' => 'string', 'example' => '210292536260646'], + 'Message' => ['title' => '消息', 'description' => '购买返回消息。', 'type' => 'string', 'example' => 'Normal'], + 'BuyProductRequestId' => ['title' => '产品购买请求id', 'description' => '产品购买请求ID。', 'type' => 'string', 'example' => '3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb'], + 'ProductIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => ''], + 'description' => '', ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2AE63638-5420-56DC-B******8174039A0\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionCode\\": \\"PaiDLC:GetTensorboard\\",\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', - 'title' => '获取工作空间的权限列表', - ], - 'GetPermission' => [ - 'summary' => '获取工作空间的权限。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/permissions/{PermissionCode}', - 'methods' => [ - 'get', + 'title' => '购买产品', + 'summary' => '购买产品，目前只支持购买DataWorks后付费、OSS后付费、PAI后付费、MaxCompute后付费。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProductOrders'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:CreateOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ksdjf-jksd-*****slkdjf\\",\\n \\"OrderId\\": \\"210292536260646\\",\\n \\"Message\\": \\"Normal\\",\\n \\"BuyProductRequestId\\": \\"3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb\\",\\n \\"ProductIds\\": [\\n \\"\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n 210292536260646\\n 正常\\n 3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb\\n","errorExample":""}]', + ], + 'CreateRun' => [ + 'path' => '/api/v1/runs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '14248', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '233339', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => 'Run的名称，若创建时名称为空，则会使用服务端随机生成的RunID作为名称', 'description' => '运行（Run）的名称。命名规则如下：'."\n" + .'- 以小写字母、大写字母开头。'."\n" + .'- 可以包含大小写字母、数字、下划线（_）或短划线（-）。'."\n" + .'- 长度为1~63个字符。'."\n" + ."\n" + .'若创建时名称为空，则会使用服务端生成的随机ID（RunID）作为名称', 'type' => 'string', 'required' => false, 'example' => 'myName'], + 'SourceType' => ['title' => 'Run关联的PAI Workload类型', 'description' => '与Run关联的PAI Workload来源类型，可选项包括TrainingService、DLC或为空。非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => 'DLC'], + 'SourceId' => ['title' => 'Run关联的PAI Workload ID', 'description' => 'Run关联的PAI Workload ID', 'type' => 'string', 'required' => false, 'example' => 'job-jdnhf***fnrimv'], + 'ExperimentId' => ['title' => 'Run关联的实验ID', 'description' => 'Run关联的实验ID', 'type' => 'string', 'required' => true, 'example' => 'exp-6thbb5xrbmp*****'], + 'Labels' => [ + 'title' => 'Run的标签', + 'description' => 'Run的标签列表', + 'type' => 'array', + 'items' => ['description' => '标签详细信息', 'required' => false, '$ref' => '#/components/schemas/Label'], + 'required' => false, + ], + 'Params' => [ + 'description' => 'Run的参数列表', + 'type' => 'array', + 'items' => ['description' => '参数详细信息', 'required' => false, '$ref' => '#/components/schemas/RunParam'], + 'required' => false, + ], + ], + 'required' => false, ], ], - [ - 'name' => 'PermissionCode', - 'in' => 'path', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '权限 code', - 'description' => '权限点的名字，region内唯一。权限点介绍，请参见[附录：角色及权限列表](~~2840449~~)。 如何获取权限点名称，请参见[ListPermissions](~~449132~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'PaiDLC:GetTensorboard'."\n", + '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' => 'ADF6D849-*****-7E7030F0CE53'], + 'RunId' => ['description' => '运行ID', 'type' => 'string', 'example' => 'run-1meoz7VJd2C6f****'], + ], ], ], - [ - 'name' => 'Accessibility', - 'in' => 'query', - 'schema' => [ - 'title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', - 'description' => '访问类型，取值如下。'."\n" - ."\n" - .'- PUBLIC：当前工作空间所有成员都可以访问。'."\n" - .'- PRIVATE：只有创建者可以访问。', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - ], + ], + 'title' => '创建运行', + 'summary' => '创建一次运行，运行（Run）属于一个实验（Experiment），可以与具体的workload关联，也可以是一次单纯的代码运行。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'CreateRun'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'title' => '创建者', - 'description' => '工作空间权限创建者的阿里云账号UID。', - 'type' => 'string', - 'required' => false, - 'example' => '17915******4216', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiexperiment:CreateRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"RunId\\": \\"run-1meoz7VJd2C6f****\\"\\n}","type":"json"}]', + ], + 'CreateWorkspace' => [ + 'path' => '/api/v1/workspaces', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Resource', - 'in' => 'query', - 'schema' => [ - 'description' => '资源。', - 'type' => 'string', - 'required' => false, - 'example' => 'job/dlc-ksd******s12', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '14204', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], + ], + 'parameters' => [ [ - 'name' => 'Option', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '可选配置，多个配置用英文逗号（,）分隔，取值：'."\n" - .'- ResourceEmpty：资源为空。如果Resource没有设置，则为空。'."\n" - .'- DisableRam：不进行RAM检查。', - 'type' => 'string', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'WorkspaceName' => ['title' => '名字 3-23 个字符, 需要字母开头，只能包含字母下划线和数字，region内唯一', 'description' => '工作空间名称。格式如下：'."\n" + .'- 长度为3~23 个字符，可以包含字母、下划线或数字。'."\n" + .'- 必须以大小写字母开头。'."\n" + .'- 当前地域内唯一。', 'type' => 'string', 'required' => true, 'example' => 'workspace_example'], + 'Description' => ['title' => '描述，最多80个字符', 'description' => '工作空间描述，不超过80个字符。', 'type' => 'string', 'required' => true, 'example' => '这是一个工作空间描述示例。'], + 'DisplayName' => ['title' => '显示名称', 'description' => '建议基于业务属性命名，便于标识工作空间用途。如果不配置，默认为工作空间名称。', 'type' => 'string', 'required' => false, 'example' => 'demo工作空间'], + 'EnvTypes' => [ + 'title' => '环境列表', + 'description' => '工作空间包含的环境：'."\n" + .'- 简单模式只有生产环境（prod）。'."\n" + .'- 标准模式包含开发环境（dev）和生产环境（prod）。', + 'type' => 'array', + 'items' => ['description' => '环境类型，取值如下：'."\n" + ."\n" + .'- dev：开发环境。'."\n" + .'- prod：生产环境。', 'type' => 'string', 'required' => true, 'example' => 'dev'], + 'required' => true, + ], + 'ResourceGroupId' => ['description' => '资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmwp7rkyq****'], + ], 'required' => false, - 'example' => 'ResourceEmpty,DisableRam', ], ], - [ - 'name' => 'Labels', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'description' => '返回结构体。', 'type' => 'object', - 'required' => false, + 'properties' => [ + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde'], + 'WorkspaceId' => ['title' => '工作空间 id', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '12**'], + ], ], ], + ], + 'title' => '创建工作空间', + 'summary' => '创建工作空间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspace'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'CallerUid', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiworkspace:CreateWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"WorkspaceId\\": \\"12**\\"\\n}","type":"json"}]', + ], + 'CreateWorkspaceResource' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CallerType', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnC5P7SW'], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'Resources' => [ + 'title' => '资源列表', + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '资源名 长度需要在3到27个字符 region内唯一', 'description' => '资源名。格式如下。'."\n" + .'- 长度为3~28个字符，以字母开头，只能包含字母、数字和下划线（_）。'."\n" + .'- 同地域内唯一。'."\n" + .'- Option为Attach、Detach时，对于ResourceType为MaxCompute Name，Name为ProjectName。', 'type' => 'string', 'required' => true, 'example' => 'ResourceName'], + 'ProductType' => ['title' => '产品类型， 支持PAI，MaxCompute', 'description' => '**该字段已废弃，将会下线，请使用ResourceType字段**。', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'], + 'EnvType' => ['title' => '环境， 支持dev（开发）、prod（生产）', 'description' => '环境类型， 取值如下：'."\n" + .'- dev：开发环境'."\n" + .'- prod：生产环境', 'type' => 'string', 'required' => true, 'example' => 'prod'], + 'WorkspaceId' => ['title' => '所属的工作空间 id', 'description' => '所属的工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], + 'IsDefault' => ['title' => '是否默认资源 每个类型都有一个默认的资源', 'description' => '是否为默认资源（每种资源类型有一个默认的资源）。取值如下：'."\n" + .'- false（默认值）：不是默认资源'."\n" + .'- true：是默认资源', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Quotas' => [ + 'description' => '资源配额列表，目前只有MaxCompute资源有资源配额。', + 'type' => 'array', + 'items' => [ + 'description' => '资源配额详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '配额名称', 'description' => '资源配额ID。如何获取资源配额ID，请参见[ListQuotas](~~449144~~)，只有预付费MaxCompute资源需要填入该字段。'."\n" + .'对于ECS、Lingjun、ACS不用填入该字段，Quota信息都在Spec里设置。', 'type' => 'string', 'required' => false, 'example' => '232892******92912'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Spec' => ['description' => '资源规格说明，JSON格式。'."\n" + .'对于ECS、Lingjun，该字段格式为'."\n" + .'{ '."\n" + .' "clusterType": "cluster类型",'."\n" + .' "resourceId": "quota的Id",'."\n" + .' "resourceName": "quota的名字"'."\n" + .'}'."\n" + .'cluster取值如下：'."\n" + ."\n" + .'- share：公共资源组'."\n" + .'- private：专有资源组'."\n" + .'- FullyManaged：ACS 全托管资源', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "clusterType": "private",'."\n" + .' "resourceId": "quota1c******b4",'."\n" + .' "resourceName": "unif******90"'."\n" + .' }'."\n"], + 'GroupName' => ['title' => '分组名，主账户内唯一 一个 GroupName 下可能有一个 dev 资源和一个 prod 资源', 'description' => '资源分组名，主账户内唯一。对于MaxCompute、ECS、Lingjun、ACS、FLINK都是必填。', 'type' => 'string', 'required' => false, 'example' => 'groupName'], + 'ResourceType' => ['description' => '资源类型列表。取值如下：'."\n" + ."\n" + .'- MaxCompute：大数据计算服务资源'."\n" + .'- ECS：通用计算资源'."\n" + .'- Lingjun：灵骏智算资源'."\n" + .'- ACS：ACS计算资源'."\n" + .'- FLINK：Flink资源'."\n" + .'- SelfManagedAckPro：AckPro统一管控集群资源'."\n" + .'- SelfManagedAckLingjun：AckLinjun统一管控集群资源
'."\n" + .'- SelfManagedASI：ASI统一管控集群资源（三方云）', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'], + 'Labels' => [ + 'description' => '资源标签数组。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签的Key。', 'type' => 'string', 'required' => false, 'example' => 'system.support.eas'], + 'Value' => ['description' => '标签的Value。', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + ], + 'required' => true, + ], + 'Option' => ['description' => '创建行为，取值如下：'."\n" + .'- CreateAndAttach：创建资源并绑定到工作空间。'."\n" + .'- Attach：绑定资源到工作空间。Detach和Attach必填参数为Name、ResourceType、GroupName、EnvType。'."\n" + .'> MaxCompute只支持Attach。', 'type' => 'string', 'required' => false, 'example' => 'CreateAndAttach'], + ], 'required' => false, ], ], @@ -6153,151 +4529,88 @@ 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'PermissionCode' => [ - 'title' => '权限', - 'description' => '权限点的名字，同地域内唯一。权限点介绍，请参见[附录：角色及权限列表](~~2840449~~)。', - 'type' => 'string', - 'example' => 'PaiDLC:ListJobs', - ], - 'PermissionRules' => [ - 'description' => '权限规则列表。', + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde'], + 'Resources' => [ + 'title' => '资源集合', + 'description' => '资源集合', 'type' => 'array', 'items' => [ - 'description' => '权限规则。', + 'description' => '资源详情。', 'type' => 'object', 'properties' => [ - 'Accessibility' => [ - 'title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', - 'description' => '访问类型，可能值：'."\n" - ."\n" - .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" - .'- PRIVATE：只有创建者可以操作。'."\n" - .'- ANY：创建者和非创建者都可以操作。', - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'EntityAccessType' => [ - 'title' => '存取类型 CREATOR 代表能看自已创建的 OTHERS 代表可以看别人创建的 ALL代表所有', - 'description' => '存取类型。'."\n" - .'当Accessibility为PUBLIC，所有用户都能操作，此值无效；'."\n" - .'当Accessibility为PRIVATE，EntityAccessType支持如下值：'."\n" - .'- CREATOR：只有创建者可以操作。'."\n" - .'- ANY：创建者和非创建者都可以操作。', - 'type' => 'string', - 'example' => 'CREATOR', - ], + 'Id' => ['title' => '资源Id', 'description' => '资源ID。', 'type' => 'string', 'example' => '1234'], ], ], ], + 'TotalCount' => ['title' => '总数', 'description' => '资源总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"PermissionCode\\": \\"PaiDLC:ListJobs\\",\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取工作空间的权限', - ], - 'DeleteWorkspaceResource' => [ - 'summary' => '删除工作空间对资源的引用，不会删除底层的资源。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '创建工作空间的资源', + 'summary' => '添加资源引用到工作空间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspaceResource'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'security' => [ + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiworkspace:CreateWorkspaceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Resources\\": [\\n {\\n \\"Id\\": \\"1234\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + ], + 'CreateWorkspaceRole' => [ + 'summary' => '增加工作空间角色', + 'path' => '/api/v1/workspaces/{WorkspaceId}/roles', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221935', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], + ], 'parameters' => [ - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => '**该字段已废弃，将会下线，请使用ResourceType字段**', - 'type' => 'string', - 'required' => false, - 'example' => 'DLC', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '资源分组名。如果获取资源分组名，请参见[ListResources](~~449143~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'group', - ], - ], [ 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - ], - [ - 'name' => 'Option', - 'in' => 'query', - 'schema' => [ - 'description' => '删除行为，取值如下：'."\n" - ."\n" - .'- DetachAndDelete（默认值）：与工作空间解绑并删除资源（默认值）。'."\n" - .'- Detach：与工作空间解绑。', - 'type' => 'string', - 'required' => false, - 'example' => 'DetachAndDelete', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '资源类型列表。取值如下：'."\n" - ."\n" - .'- ECS：通用计算资源'."\n" - .'- Lingjun：灵骏智算资源'."\n" - .'- ACS：ACS计算资源'."\n" - .'- FLINK：Flink资源。'."\n" - .'- MaxCompute： MaxCompute资源，目前只支持Option为Detach，不支持DetachAndDelete。', - 'type' => 'string', - 'required' => false, - 'example' => 'DLC', - ], - ], - [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'description' => '标签列表，以逗号分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'system.supported.eas=true', - ], + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。可通过 [ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ - 'name' => 'ResourceIds', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '逗号分隔的多个资源ID，这多个资源ID的GroupName必须一致'."\n" - .'GroupName与ResourceIds不能都为空，可以两项都不为空。', - 'type' => 'string', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'RoleName' => ['description' => '（必填）自定义角色名称。同一个工作空间名字不允许重复。支持字母、数字、下划线_、中划线-，长度不超过64个字符。', 'type' => 'string', 'required' => false, 'example' => 'dev-test'], + 'RoleType' => ['description' => '角色类型。取值：custom（自定义角色）。仅支持自定义角色，为默认值。', 'type' => 'string', 'required' => false, 'example' => 'custom'], + 'ModulePermissions' => ['description' => '（必填）角色权限配置。', 'required' => false, '$ref' => '#/components/schemas/ModulePermissions'], + ], 'required' => false, - 'example' => 'Resource-dks******jkf,Resource-adf******dss', ], ], ], @@ -6305,189 +4618,105 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '返回结构体', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'ResourceIds' => [ - 'description' => '受影响的资源Id列表。', - 'type' => 'array', - 'items' => [ - 'description' => '受影响的资源Id。', - 'type' => 'string', - 'example' => 'Resource-dks******jkf', - ], - ], + 'RequestId' => ['title' => '请求 id', 'description' => '请求 id', 'type' => 'string', 'example' => 'A519F77D-28A0-52F5-AB82-5********8'], + 'InstanceJobId' => ['description' => '请求对应的任务id', 'type' => 'string', 'example' => 'CreateWorkspaceCustomRole-role-***abc*******'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ResourceIds\\": [\\n \\"Resource-dks******jkf\\"\\n ]\\n}","type":"json"}]', - 'title' => '删除工作空间的资源', - ], - 'UpdateWorkspaceResource' => [ - 'summary' => '更新工作空间的资源。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'AIWorkSpace::2021-02-04::GetInstanceJob', 'callbackInterval' => 2000, 'maxCallbackTimes' => 20], + 'title' => '创建自定义角色', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiworkspace:AddWorkspaceRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A519F77D-28A0-52F5-AB82-5********8\\",\\n \\"InstanceJobId\\": \\"CreateWorkspaceCustomRole-role-***abc*******\\"\\n}","type":"json"}]', + ], + 'DeleteCodeSource' => [ + 'summary' => '指定ID，删除一个代码配置。', + 'path' => '/api/v1/codesources/{CodeSourceId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '55455', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'CodeSourceId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求参数。', - 'type' => 'object', - 'properties' => [ - 'IsDefault' => [ - 'title' => '是否默认资源实例，目前只能填 true，不支持填 false', - 'description' => '是否为默认资源，目前该参数只支持传入true，暂不支持false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'ProductType' => [ - 'description' => '**该字段已废弃，将会下线，请使用ResourceType字段。**', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxCompute', - ], - 'GroupName' => [ - 'description' => '分组名。', - 'type' => 'string', - 'required' => false, - 'example' => 'group-kjds******sd', - ], - 'ResourceType' => [ - 'description' => '资源类型列表。取值如下：'."\n" - ."\n" - .'- MaxCompute：大数据计算服务资源'."\n" - .'- ECS：通用计算资源'."\n" - .'- Lingjun：灵骏智算资源'."\n" - .'- ACS：ACS计算资源'."\n" - .'- FLINK：Flink资源', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxCompute', - ], - 'Labels' => [ - 'description' => '资源标签集合。如果有多个标签，只有同时具备这些标签的资源才会被返回。', - 'type' => 'array', - 'items' => [ - 'description' => '资源标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签的键。', - 'type' => 'string', - 'required' => false, - 'example' => 'system.******', - ], - 'Value' => [ - 'description' => '标签的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'True', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ResourceIds' => [ - 'description' => '资源ID集合。'."\n" - ."\n" - .'GroupName与ResourceIds不能都为空，但可以都不为空；如果都不为空，集合内每个资源ID的GroupName必须一致。', - 'type' => 'array', - 'items' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'Resource-dks******jkf', - ], - 'required' => false, - ], - 'Spec' => [ - 'description' => '资源的规格。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "clusterType": "share"'."\n" - .'}', - ], - ], - 'required' => false, - ], + 'schema' => ['title' => '待删除的代码源配置', 'description' => '待删除的代码配置ID。如何获取代码配置ID，请参见[ListCodeSources](~~459922~~)。', 'type' => 'string', 'required' => true, 'example' => 'code-20210111103721-85qz78ia96lu'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'ResourceIds' => [ - 'description' => '本次更新的资源ID集合。', - 'type' => 'array', - 'items' => [ - 'description' => '这次更新的资源ID。', - 'type' => 'string', - 'example' => 'Resource-dks******jkf'."\n", - ], - 'example' => 'Resource-dks******jkf', - ], + 'CodeSourceId' => ['title' => '被删除的代码源配置ID', 'description' => '被删除的代码源配置ID。', 'type' => 'string', 'example' => 'code-20210111103721-85qz78ia96lu'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ResourceIds\\": [\\n \\"Resource-dks******jkf\\\\n\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1e195c5116124202371861018d5bde\\n","errorExample":""}]', - 'title' => '更新工作空间的资源', - ], - 'ListResources' => [ - 'summary' => '获取工作空间内已关联的资源列表。', - 'path' => '/api/v1/resources', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除代码配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCodeSource'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paicodesource:DeleteCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-20210111103721-85qz78ia96lu\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'DeleteConfig' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/configs/{ConfigKey}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6495,1185 +4724,760 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', + 'abilityTreeCode' => '117762', + 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。'."\n" - .'- 当参数Option为ListResourceByWorkspace时，该参数必填。'."\n" - .'- 当参数Option为ListResource时，该参数无需配置。', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'in' => 'path', + 'schema' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '98***'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页，从1开始，默认1', - 'description' => '资源列表的页码，起始值为1，默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ConfigKey', + 'in' => 'path', + 'schema' => ['title' => '配置键', 'description' => '配置项的键。目前支持如下键：'."\n" + ."\n" + .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" + .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" + .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" + .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" + .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', 'type' => 'string', 'required' => true, 'example' => 'tempStoragePath'], ], [ - 'name' => 'PageSize', + 'name' => 'CategoryName', 'in' => 'query', - 'schema' => [ - 'title' => '页大小，默认20', - 'description' => '分页查询时设置的每页行数，默认为20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '配置项的分类。目前支持如下分类'."\n" + ."\n" + .'- CommonResourceConfig 通用资源配置'."\n" + .'- DLCAutoRecycle DLC自动回收- DLCPriorityConfig DLC 优先级设置'."\n" + .'- DSWPriorityConfig DSW优先级设置'."\n" + .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" + .'- CommonTagConfig 标签设置', 'type' => 'string', 'required' => false, 'example' => 'CommonResourceConfig'], ], [ - 'name' => 'ProductTypes', + 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'title' => '逗号分隔的产品类型，可选值 MaxCompute，DLC', - 'description' => '**该字段已废弃，将会下线，请使用ResourceType字段。**', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxCompute', - ], + 'schema' => ['description' => '过滤条件，多个条件用逗号分隔，这些条件之间是与的关系。', 'type' => 'string', 'required' => false, 'example' => 'key1=value;key2=value2'], ], - [ - 'name' => 'GroupName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '资源的group名字', - 'description' => '资源分组名。如何获取资源分组名，请参见[ListResources](~~449143~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'group', + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n"], + ], ], ], - [ - 'name' => 'ResourceName', - 'in' => 'query', - 'schema' => [ - 'title' => '资源的名字', - 'description' => '资源名。格式为：'."\n" - .'- 长度为3~28个字符。'."\n" - .'- 同地域内唯一。', - 'type' => 'string', - 'required' => false, - 'example' => 'resource', - ], + ], + 'title' => '删除工作空间配置', + 'summary' => '删除工作空间配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConfig'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'Option', - 'in' => 'query', - 'schema' => [ - 'title' => '选项，目前支持 ListResourceByWorkspace 列举某个工作空间的资源 GetResource 获取所有工作空间下的资源 GetResourceGroup 获取所有工作空间下的资源组 ListResourceSummaryByWorkspaces 列举一组工作空间的资源汇总', - 'description' => '选项，取值如下：'."\n" - ."\n" - .'- ListResourceByWorkspace（默认值）：获取工作空间的资源列表。'."\n" - .'- ListResource：获取用户的资源列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'ListResourceByWorkspace', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', + ], + 'DeleteConnection' => [ + 'path' => '/api/v1/connections/{ConnectionId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Verbose', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267624', + 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], + ], + 'parameters' => [ + [ + 'name' => 'ConnectionId', + 'in' => 'path', + 'schema' => ['description' => '连接ID。如何获取连接 ID，详情请参见 [ListConnections](url)。', 'type' => 'string', 'required' => true, 'example' => 'conn-pai9m***mi47'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否展示详细信息，目前详细信息包含字段Quotas。取值如下：'."\n" - .'- true（默认值）：展示详细信息'."\n" - .'- false：不展示详细信息', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'title' => 'Schema of Response', + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + ], ], ], + ], + 'title' => '删除连接', + 'summary' => '删除连接。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'ResourceTypes', - 'in' => 'query', - 'schema' => [ - 'description' => '资源类型列表。取值如下：'."\n" - ."\n" - .'- MaxCompute：大数据计算服务资源'."\n" - .'- ECS：通用计算资源'."\n" - .'- Lingjun：灵骏智算资源'."\n" - .'- ACS：ACS计算资源'."\n" - .'- FLINK：Flink资源', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxCompute', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'DeleteDataset' => [ + 'path' => '/api/v1/datasets/{DatasetId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'QuotaIds', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '48570', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wzlj****9ks92'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'QuotaId集合，用逗号分割。只有同时具有这些QuotaId的资源才会被返回。'."\n" - ."\n\n" - .'> 目前只有ResourceTypes=ACS的资源才支持用该参数过滤。'."\n" - .'>', - 'type' => 'string', - 'required' => false, - 'example' => 'quota-k******da,quota-cd******w', + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据集', + 'summary' => '删除数据集。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'description' => 'Label过滤条件集合，多个条件用逗号分隔。只有同时满足这些标签的资源才会被返回。'."\n" - ."\n" - .'目前只有ProductType=ACS的资源才支持用该参数过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'system.supported.dsw=true,system.supported.dlc=true', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', + ], + 'DeleteDatasetFileMetas' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'VerboseFields', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260630', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-lfd60v0p****ujtsdx'], + ], + [ + 'name' => 'DatasetVersion', 'in' => 'query', - 'schema' => [ - 'description' => '逗号分隔的集合，表明要返回的字段。目前支持：'."\n" - .'- Quota'."\n" - .'- Label'."\n" - .'- IsDefault', - 'type' => 'string', - 'required' => false, - 'example' => 'Quota,IsDefault', - ], + 'schema' => ['description' => '数据集版本名。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '132602'], + ], + [ + 'name' => 'DatasetFileMetaIds', + 'in' => 'query', + 'schema' => ['description' => '数据集文件元数据ID。', 'type' => 'string', 'required' => true, 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1e195c5116124202371861018d5bde', - ], - 'Resources' => [ - 'title' => '资源列表', - 'description' => '资源列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'Status' => ['description' => '本批元数据删除结果的状态。全部成功为true，如果为false，需要查看FailedDetails。', 'type' => 'boolean', 'example' => 'true'], + 'FailedDetails' => [ + 'description' => '删除失败的文件元数据列表。', 'type' => 'array', - 'items' => [ - 'description' => '资源信息。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '资源 id', - 'description' => '资源ID。', - 'type' => 'string', - 'example' => '123', - ], - 'Name' => [ - 'title' => '资源名 长度需要在3到27个字符 region内唯一', - 'description' => '资源名。', - 'type' => 'string', - 'example' => 'ResourceName', - ], - 'ProductType' => [ - 'title' => '产品类型， 支持PAI，MaxCompute', - 'description' => '**该字段已废弃，将会下线，请使用ResourceType字段。**', - 'type' => 'string', - 'example' => 'MaxCompute', - ], - 'EnvType' => [ - 'title' => '环境， 支持dev（开发）、prod（生产）', - 'description' => '环境类型，可能值：'."\n" - .'- dev：开发环境'."\n" - .'- prod：生产环境', - 'type' => 'string', - 'example' => 'prod', - ], - 'WorkspaceId' => [ - 'title' => '所属的工作空间 id', - 'description' => '所属的工作空间ID。', - 'type' => 'string', - 'example' => '123', - ], - 'IsDefault' => [ - 'title' => '是否默认资源 每个类型都有一个默认的资源', - 'description' => '是否为默认资源，每种资源类型都有一个默认的资源。可能值：'."\n" - .'- true：是默认资源'."\n" - .'- false：不是默认资源', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Quotas' => [ - 'description' => '配额列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配额信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '配额名称', - 'description' => '配额名称。', - 'type' => 'string', - 'example' => 'QuotaName', - ], - 'ProductCode' => [ - 'title' => '商品 code', - 'description' => '产品名，可能值：'."\n" - .'- PAI_isolate：pai预付费资源组（pai cpu）'."\n" - .'- PAI_share：pai后付费资源组（pai gpu）'."\n" - .'- MaxCompute_share：MaxCompute后付费资源组'."\n" - .'- MaxCompute_isolate：MaxCompute预付费资源组'."\n" - .'- DataWorks_isolate：DataWorks预付费资源组'."\n" - .'- DataWorks_share：DataWorks后付费资源组'."\n" - .'- DLC_share：DLC后付费资源组', - 'type' => 'string', - 'example' => 'MaxCompute_isolate', - ], - 'QuotaType' => [ - 'title' => '产品类型， 支持PAI，MaxCompute', - 'description' => '资源配额类型， 可能值：'."\n" - .'- PAI'."\n" - .'- MaxCompute'."\n" - .'- DLC', - 'type' => 'string', - 'example' => 'MaxCompute', - ], - 'Mode' => [ - 'title' => '模式 isolate 预付费 share 后付费 develop 开发模式', - 'description' => '付费模式，可能值：'."\n" - ."\n" - .'- isolate：预付费'."\n" - .'- share：后付费', - 'type' => 'string', - 'example' => 'isolate', - ], - 'Specs' => [ - 'title' => '规格描述列表', - 'description' => '规格描述列表。', - 'type' => 'array', - 'items' => [ - 'description' => '规格描述信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '规格名字', - 'description' => '规格名字。', - 'type' => 'string', - 'example' => 'cu', - ], - 'Value' => [ - 'title' => '规格描述', - 'description' => '规格描述。', - 'type' => 'string', - 'example' => '11500', - ], - ], - ], - 'example' => '{\\"cu\\":\\"11500\\",\\"minCu\\":\\"2300\\",\\"parentId\\":\\"0\\"}', - ], - 'CardType' => [ - 'title' => '卡类型，支持cpu、gpu', - 'description' => '卡类型，可能值：'."\n" - .'- CPU'."\n" - .'- GPU', - 'type' => 'string', - 'example' => 'CPU', - ], - 'Id' => [ - 'title' => '配额id', - 'description' => '资源配额ID。', - 'type' => 'string', - 'example' => '123', - ], - 'DisplayName' => [ - 'description' => '资源配额别名。', - 'type' => 'string', - 'example' => '默认后付费Quota', - ], - ], - ], - ], - 'Spec' => [ - 'title' => '对于MaxCompute是个json，有如下key： Endpoint Project', - 'description' => '规格说明。', - 'type' => 'object', - 'example' => '对于MaxCompute {"Endpoint": "odps.alibaba-inc.com", "Project": "mignshi"}', - ], - 'GroupName' => [ - 'title' => '分组名，主账户内唯一 一个 GroupName 下可能有一个 dev 资源和一个 prod 资源', - 'description' => '资源分组名，主账户内唯一。', - 'type' => 'string', - 'example' => 'groupName', - ], - 'GmtCreateTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '创建UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'Executor' => [ - 'description' => '该字段无效，已废弃。', - 'type' => 'object', - 'properties' => [ - 'OwnerId' => [ - 'description' => '该字段无效，已废弃。', - 'type' => 'string', - 'example' => '110973******7793', - ], - ], - ], - 'Encryption' => [ - 'description' => '加密信息，目前只对MaxCompute资源有效。', - 'type' => 'object', - 'properties' => [ - 'Enabled' => [ - 'description' => '是否加密。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Algorithm' => [ - 'description' => '加密算法。', - 'type' => 'string', - 'example' => 'AESCTR', - ], - 'Key' => [ - 'description' => '加密主键。', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - ], - ], - 'ResourceType' => [ - 'description' => '资源类型，可能值：'."\n" - ."\n" - .'- MaxCompute：大数据计算服务资源'."\n" - .'- DLC：云原生资源'."\n" - .'- FLINK：Flink资源', - 'type' => 'string', - 'example' => 'MaxCompute', - ], - 'Labels' => [ - 'description' => '标签集合。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签的Key。', - 'type' => 'string', - 'example' => 'system.supported.dsw', - ], - 'Value' => [ - 'description' => '标签的Value。', - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的作业数量', - 'description' => '符合过滤条件的资源数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', + 'items' => ['description' => '删除失败的文件元数据详情。', '$ref' => '#/components/schemas/DatasetFileMetaResponse'], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Resources\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Name\\": \\"ResourceName\\",\\n \\"ProductType\\": \\"MaxCompute\\",\\n \\"EnvType\\": \\"prod\\",\\n \\"WorkspaceId\\": \\"123\\",\\n \\"IsDefault\\": true,\\n \\"Quotas\\": [\\n {\\n \\"Name\\": \\"QuotaName\\",\\n \\"ProductCode\\": \\"MaxCompute_isolate\\",\\n \\"QuotaType\\": \\"MaxCompute\\",\\n \\"Mode\\": \\"isolate\\",\\n \\"Specs\\": [\\n {\\n \\"Name\\": \\"cu\\",\\n \\"Value\\": \\"11500\\"\\n }\\n ],\\n \\"CardType\\": \\"CPU\\",\\n \\"Id\\": \\"123\\",\\n \\"DisplayName\\": \\"默认后付费Quota\\"\\n }\\n ],\\n \\"Spec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"GroupName\\": \\"groupName\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Executor\\": {\\n \\"OwnerId\\": \\"110973******7793\\"\\n },\\n \\"Encryption\\": {\\n \\"Enabled\\": false,\\n \\"Algorithm\\": \\"AESCTR\\",\\n \\"Key\\": \\"DEFAULT\\"\\n },\\n \\"ResourceType\\": \\"MaxCompute\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.supported.dsw\\",\\n \\"Value\\": \\"true\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n 1e195c5116124202371861018d5bde\\n \\n 123\\n ResourceName\\n MaxCompute\\n prod\\n 123\\n true\\n \\n QuotaName\\n MaxCompute_isolate\\n MaxCompute\\n develop\\n \\n quota\\n {\\\\\\"cu\\\\\\":\\\\\\"11500\\\\\\",\\\\\\"minCu\\\\\\":\\\\\\"2300\\\\\\",\\\\\\"parentId\\\\\\":\\\\\\"0\\\\\\"}\\n \\n cpu\\n 123\\n \\n groupName\\n 2021-01-21T17:12:35.232Z\\n \\n DLC\\n 2\\n \\n \\n 2\\n","errorExample":""}]', - 'title' => '获取工作空间的资源列表', - ], - 'CreateWorkspaceResource' => [ - 'summary' => '添加资源引用到工作空间。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '批量删除数据集文件元数据', + 'summary' => '批量删除数据集下的文件元数据记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetFileMetas'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetFileMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6\\",\\n \\"Result\\": \\"Not Found\\",\\n \\"Uri\\": \\"oss://l*****-test/dataset/1653421.jpg\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteDatasetJob' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260524', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'Resources' => [ - 'title' => '资源列表', - 'description' => '资源列表。', - 'type' => 'array', - 'items' => [ - 'description' => '资源信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '资源名 长度需要在3到27个字符 region内唯一', - 'description' => '资源名。格式如下。'."\n" - .'- 长度为3~28个字符，以字母开头，只能包含字母、数字和下划线（_）。'."\n" - .'- 同地域内唯一。'."\n" - .'- Option为Attach、Detach时，对于ResourceType为MaxCompute Name，Name为ProjectName。', - 'type' => 'string', - 'required' => true, - 'example' => 'ResourceName', - ], - 'ProductType' => [ - 'title' => '产品类型， 支持PAI，MaxCompute', - 'description' => '**该字段已废弃，将会下线，请使用ResourceType字段**。', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxCompute', - ], - 'EnvType' => [ - 'title' => '环境， 支持dev（开发）、prod（生产）', - 'description' => '环境类型， 取值如下：'."\n" - .'- dev：开发环境'."\n" - .'- prod：生产环境', - 'type' => 'string', - 'required' => true, - 'example' => 'prod', - ], - 'WorkspaceId' => [ - 'title' => '所属的工作空间 id', - 'description' => '所属的工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'IsDefault' => [ - 'title' => '是否默认资源 每个类型都有一个默认的资源', - 'description' => '是否为默认资源（每种资源类型有一个默认的资源）。取值如下：'."\n" - .'- false（默认值）：不是默认资源'."\n" - .'- true：是默认资源', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Quotas' => [ - 'description' => '资源配额列表，目前只有MaxCompute资源有资源配额。', - 'type' => 'array', - 'items' => [ - 'description' => '资源配额详情。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '配额名称', - 'description' => '资源配额ID。如何获取资源配额ID，请参见[ListQuotas](~~449144~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '232892******92912', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Spec' => [ - 'description' => '资源规格说明，JSON格式。', - 'type' => 'object', - 'required' => false, - 'example' => '对于MaxCompute {"Endpoint": "odps.alibaba-inc.com", "Project": "mignshi"}', - ], - 'GroupName' => [ - 'title' => '分组名，主账户内唯一 一个 GroupName 下可能有一个 dev 资源和一个 prod 资源', - 'description' => '资源分组名，主账户内唯一。对于MaxCompute、ECS、Lingjun、ACS、FLINK都是必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'groupName', - ], - 'ResourceType' => [ - 'description' => '资源类型列表。取值如下：'."\n" - ."\n" - .'- MaxCompute：大数据计算服务资源'."\n" - .'- ECS：通用计算资源'."\n" - .'- Lingjun：灵骏智算资源'."\n" - .'- ACS：ACS计算资源'."\n" - .'- FLINK：Flink资源', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxCompute', - ], - 'Labels' => [ - 'description' => '资源标签数组。', - 'type' => 'array', - 'items' => [ - 'description' => '资源标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签的Key。', - 'type' => 'string', - 'required' => false, - 'example' => 'system.support.eas', - ], - 'Value' => [ - 'description' => '标签的Value。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'Option' => [ - 'description' => '创建行为，取值如下：'."\n" - .'- CreateAndAttach：创建资源并绑定到工作空间。'."\n" - .'- Attach：绑定资源到工作空间。Detach和Attach必填参数为Name、ResourceType、GroupName、EnvType。'."\n" - .'> MaxCompute只支持Attach。', - 'type' => 'string', - 'required' => false, - 'example' => 'CreateAndAttach', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'DatasetJobId', + 'in' => 'path', + 'schema' => ['description' => '数据集任务ID', 'type' => 'string', 'required' => true, 'example' => 'dsjob-9jx1******uj9e'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1e195c5116124202371861018d5bde', - ], - 'Resources' => [ - 'title' => '资源集合', - 'description' => '资源集合', - 'type' => 'array', - 'items' => [ - 'description' => '资源详情。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '资源Id', - 'description' => '资源ID。', - 'type' => 'string', - 'example' => '1234', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '总数', - 'description' => '资源总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Resources\\": [\\n {\\n \\"Id\\": \\"1234\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', - 'title' => '创建工作空间的资源', - ], - 'AddMemberRole' => [ - 'summary' => '为工作空间内的成员添加某个角色，使其拥有角色的权限。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/members/{MemberId}/roles/{RoleName}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据集任务', + 'summary' => '删除数据集任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetJob'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + ], + 'DeleteDatasetJobConfig' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260472', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883', - ], + 'schema' => ['description' => '数据集id', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], ], [ - 'name' => 'MemberId', + 'name' => 'DatasetJobConfigId', 'in' => 'path', - 'schema' => [ - 'title' => '成员 id', - 'description' => '成员ID。如何获取成员ID，请参见[ListMembers](~~449135~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883-215139******688039', - ], + 'schema' => ['description' => '配置id', 'type' => 'string', 'required' => true, 'example' => 'dscfg-xxxxxxxxxxxx'], ], [ - 'name' => 'RoleName', - 'in' => 'path', - 'schema' => [ - 'title' => '角色', - 'description' => '角色名。角色名和权限的对应关系，请参见[附录：角色及权限列表](~~2840449~~) 。'."\n" - .'支持以下角色名：'."\n" - ."\n" - .'- PAI.AlgoDeveloper：算法开发。'."\n" - .'- PAI.AlgoOperator：算法运维。'."\n" - .'- PAI.LabelManager：标注管理员。'."\n" - .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" - .'- PAI.WorkspaceAdmin：管理员。'."\n" - .'- PAI.WorkspaceGuest：访客。'."\n" - .'- PAI.WorkspaceOwner：负责人。', - 'type' => 'string', - 'required' => true, - 'example' => 'PAI.AlgoDeveloper', - ], + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '513663'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '成员添加角色', - ], - 'RemoveMemberRole' => [ - 'summary' => '删除成员角色。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/members/{MemberId}/roles/{RoleName}', - 'methods' => [ - 'delete', + 'title' => '删除数据集任务配置', + 'summary' => '删除数据集任务配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetJobConfig'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\"\\n}","type":"json"}]', + ], + 'DeleteDatasetLabels' => [ + 'path' => '/api/v1/datasets/{DatasetId}/labels', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '48573', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883', - ], - ], - [ - 'name' => 'MemberId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'title' => '成员 id', - 'description' => '成员ID。如何获取成员ID，请参见[ListMembers](~~449135~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883-21513926******88039', - ], + 'schema' => ['title' => 'DatasetId', 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => false, 'example' => 'd-rbvg5****jhc9ks92'], ], [ - 'name' => 'RoleName', - 'in' => 'path', - 'schema' => [ - 'title' => '角色', - 'description' => '角色名。角色名和权限的对应关系，请参见[附录：角色及权限列表](~~2840449~~) 。'."\n" - .'支持以下角色名：'."\n" - ."\n" - .'- PAI.AlgoDeveloper：算法开发。'."\n" - .'- PAI.AlgoOperator：算法运维。'."\n" - .'- PAI.LabelManager：标注管理员。'."\n" - .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" - .'- PAI.WorkspaceAdmin：管理员。'."\n" - .'- PAI.WorkspaceGuest：访客。'."\n" - .'- PAI.WorkspaceOwner：负责人。', - 'type' => 'string', - 'required' => true, - 'example' => 'PAI.AlgoDeveloper', - ], + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => ['description' => '标签的键值。如何查询标签的键值，详情请参见[GetDataset](~~457218~~)。多项标签使用半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'key1,key2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '64B50C1D-D4C2-560C-86A3-A6ED****16D'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除成员角色 ', - ], - 'DeleteMembers' => [ - 'summary' => '删除工作空间的成员。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/members', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据集标签', + 'summary' => '删除数据集标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B50C1D-D4C2-560C-86A3-A6ED****16D\\"\\n}","type":"json"}]', + ], + 'DeleteDatasetVersion' => [ + 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232579', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883', - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-lfd60v0p****ujtsdx'], ], [ - 'name' => 'MemberIds', - 'in' => 'query', - 'schema' => [ - 'title' => '需要删除的成员 Id 列表，以逗号分隔', - 'description' => '成员ID列表，多个成员ID以半角逗号（,）分隔。如何获取成员ID，请参见[ListMembers](~~449135~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883-21513926******88039,145883-2769726******87513', - ], + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['description' => '数据集版本。版本号需要大于v1，v1版本会在删除数据集的时候同步删除。', 'type' => 'string', 'required' => true, 'example' => 'v2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9', - ], - 'Code' => [ - 'description' => '请求失败时返回的错误代码。', - 'type' => 'string', - 'example' => '100600017', - ], - 'Message' => [ - 'description' => '请求失败时的返回信息。', - 'type' => 'string', - 'example' => 'Owner not allowed to delete', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\",\\n \\"Code\\": \\"100600017\\",\\n \\"Message\\": \\"Owner not allowed to delete\\"\\n}","type":"json"}]', - 'title' => '工作空间删除成员 ', - ], - 'GetMember' => [ - 'summary' => '获取工作空间的成员。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/member', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据集版本', + 'summary' => '删除指定版本的数据集信息。其中版本v1无法使用本接口删除，需要使用DeleteDataset接口删除数据集的时候同步删除。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetVersion'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '36846', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', + ], + 'DeleteDatasetVersionLabels' => [ + 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}/labels', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232577', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883', - ], + 'schema' => ['description' => '数据集版本ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], ], [ - 'name' => 'UserId', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '用户id', - 'description' => '用户UID。如何查看用户UID，请参见 [ListWorkspaceUsers](~~449133~~)。'."\n" - .'UserId与MemberId必须指定一个，不能同时指定。', - 'type' => 'string', - 'required' => false, - 'example' => '21513926******88039', - ], + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => true, 'example' => 'v1'], ], [ - 'name' => 'MemberId', + 'name' => 'Keys', 'in' => 'query', - 'schema' => [ - 'description' => '成员UID。UserId与MemberId必须指定一个，不能同时指定。', - 'type' => 'string', - 'required' => false, - 'example' => '145883-21513926******88039', - ], + 'schema' => ['description' => '版本标签key, 多个标签key用英文逗号分隔。', 'type' => 'string', 'required' => true, 'example' => 'key1,key2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'UserId' => [ - 'title' => '用户 id', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '21513926******88039', - ], - 'MemberName' => [ - 'title' => '云账号用户名', - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'user1', - ], - 'GmtCreateTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '创建UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'Roles' => [ - 'title' => '角色列表', - 'description' => '角色列表。', - 'type' => 'array', - 'items' => [ - 'description' => '角色名。角色名和权限的对应关系，请参见[角色及权限列表](https://pai.console.aliyun.com/?spm=api-workbench.API%20Explorer.0.0.7a862392uO09Se®ionId=cn-shanghai#/workspace/permission)。'."\n" - .'角色名可能值：'."\n" - ."\n" - .'- PAI.AlgoDeveloper：算法开发。'."\n" - .'- PAI.AlgoOperator：算法运维。'."\n" - .'- PAI.LabelManager：标注管理员。'."\n" - .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" - .'- PAI.WorkspaceAdmin：管理员。'."\n" - .'- PAI.WorkspaceGuest：访客。'."\n" - .'- PAI.WorkspaceOwner：负责人。', - 'type' => 'string', - 'example' => 'myRole1', - ], - ], - 'DisplayName' => [ - 'title' => '成员显示名', - 'description' => '成员显示名。', - 'type' => 'string', - 'example' => 'myDisplayName', - ], - 'MemberId' => [ - 'title' => '成员 id', - 'description' => '成员ID。', - 'type' => 'string', - 'example' => '145883-21513926******88039'."\n", - ], - 'AccountType' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B2E89D7E-74F8-5656-A5D6-81D83403F9A8'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"UserId\\": \\"21513926******88039\\",\\n \\"MemberName\\": \\"user1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Roles\\": [\\n \\"myRole1\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"145883-21513926******88039\\\\n\\",\\n \\"AccountType\\": \\"\\"\\n}","type":"json"}]', - 'title' => '获取工作空间的成员', - ], - 'ListMembers' => [ - 'summary' => '获取工作空间的成员列表。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/members', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据集版本标签', + 'summary' => '删除数据集版本的标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetVersionLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetVersionLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2E89D7E-74F8-5656-A5D6-81D83403F9A8\\"\\n}","type":"json"}]', + ], + 'DeleteExperiment' => [ + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '14243', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '206974', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'ExperimentId', 'in' => 'path', + 'schema' => ['description' => '实验ID', 'type' => 'string', 'required' => true, 'example' => 'exp-1zpfthdx******'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], + ], ], ], + ], + 'title' => '删除实验', + 'summary' => '删除实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteExperiment'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页，从1开始，默认1', - 'description' => '工作空间列表的页码。起始值为1，默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiexperiment:DeleteExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', + ], + 'DeleteExperimentLabel' => [ + 'path' => '/api/v1/experiments/{ExperimentId}/labels/{Key}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小，默认20', - 'description' => '分页查询时设置的每页行数。默认为20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '207073', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, + ], + 'parameters' => [ [ - 'name' => 'Roles', - 'in' => 'query', - 'schema' => [ - 'title' => 'Role 过滤列表，逗号分隔', - 'description' => '使用角色过滤成员，多个角色以半角逗号（,）分隔。'."\n" - .'支持以下角色名：'."\n" - .'- PAI.AlgoDeveloper：算法开发。'."\n" - .'- PAI.AlgoOperator：算法运维。'."\n" - .'- PAI.LabelManager：标注管理员。'."\n" - .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" - .'- PAI.WorkspaceAdmin：管理员。'."\n" - .'- PAI.WorkspaceGuest：访客。'."\n" - .'- PAI.WorkspaceOwner：负责人。', - 'type' => 'string', - 'required' => false, - 'example' => 'PAI.AlgoDeveloper', - ], + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => '实验ID', 'type' => 'string', 'required' => true, 'example' => 'exp-1zpfthdx******'], ], [ - 'name' => 'MemberName', - 'in' => 'query', - 'schema' => [ - 'title' => '成员名', - 'description' => '成员名，支持模糊匹配。', - 'type' => 'string', - 'required' => false, - 'example' => 'zhangsan', - ], + 'name' => 'Key', + 'in' => 'path', + 'schema' => ['description' => '要删除的实验标签的Key', 'type' => 'string', 'required' => true, 'example' => 'is_evaluate'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Members' => [ - 'title' => '成员列表', - 'description' => '成员列表。', - 'type' => 'array', - 'items' => [ - 'description' => '成员详情。', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户 id', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '215139******88039', - ], - 'MemberName' => [ - 'title' => '云账号用户名', - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'user1', - ], - 'GmtCreateTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '创建UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'Roles' => [ - 'title' => '角色列表', - 'description' => '角色列表。', - 'type' => 'array', - 'items' => [ - 'description' => '角色名。角色名和权限的对应关系，请参见[附录：角色及权限列表](~~2840449~~)。'."\n" - ."\n" - .'角色名可能值：'."\n" - ."\n" - .'- PAI.AlgoDeveloper：算法开发。'."\n" - .'- PAI.AlgoOperator：算法运维。'."\n" - .'- PAI.LabelManager：标注管理员。'."\n" - .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" - .'- PAI.WorkspaceAdmin：管理员。'."\n" - .'- PAI.WorkspaceGuest：访客。'."\n" - .'- PAI.WorkspaceOwner：负责人。', - 'type' => 'string', - 'example' => 'PAI.AlgoDeveloper', - ], - ], - 'DisplayName' => [ - 'title' => '成员显示名', - 'description' => '成员显示名。', - 'type' => 'string', - 'example' => 'myDisplayName', - ], - 'MemberId' => [ - 'title' => '成员 id', - 'description' => '成员ID。', - 'type' => 'string', - 'example' => '14588*****51688039', - ], - 'AccountName' => [ - 'type' => 'string', - ], - 'AccountType' => [ - 'type' => 'string', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的数量', - 'description' => '符合过滤条件的成员数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Members\\": [\\n {\\n \\"UserId\\": \\"215139******88039\\",\\n \\"MemberName\\": \\"user1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Roles\\": [\\n \\"PAI.AlgoDeveloper\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"14588*****51688039\\",\\n \\"AccountName\\": \\"\\",\\n \\"AccountType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', - 'title' => '获取工作空间的成员列表', - ], - 'CreateMember' => [ - 'summary' => '添加用户到工作空间，作为工作空间的成员，可以添加多个用户为成员。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/members', - 'methods' => [ - 'post', + 'title' => '删除实验的标签', + 'summary' => '删除实验的标签', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteExperimentLabel'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiexperiment:DeleteExperimentLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'DeleteMembers' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/members', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7685,65 +5489,12 @@ [ 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '145883'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'Members' => [ - 'title' => '用户列表', - 'description' => '成员列表。', - 'type' => 'array', - 'items' => [ - 'description' => '成员详情。', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户 id', - 'description' => '成员ID列表，多个成员ID以半角逗号（,）分隔。如何获取成员ID，请参见[ListMembers](~~449135~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883-21513926******88039,145883-2769726******87513', - ], - 'Roles' => [ - 'title' => '角色列表', - 'description' => '角色列表。', - 'type' => 'array', - 'items' => [ - 'description' => '角色名。角色名和权限的对应关系，请参见[角色及权限列表](https://pai.console.aliyun.com/?regionId=cn-shanghai#/workspace/permission)。'."\n" - .'支持以下角色名：'."\n" - .'- PAI.AlgoDeveloper：算法开发。'."\n" - .'- PAI.AlgoOperator：算法运维。'."\n" - .'- PAI.LabelManager：标注管理员。'."\n" - .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" - .'- PAI.WorkspaceAdmin：管理员。'."\n" - .'- PAI.WorkspaceGuest：访客。'."\n" - .'- PAI.WorkspaceOwner：负责人。', - 'type' => 'string', - 'required' => false, - 'example' => 'PAI.AlgoDeveloper', - ], - 'required' => true, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - 'required' => false, - ], + 'name' => 'MemberIds', + 'in' => 'query', + 'schema' => ['title' => '需要删除的成员 Id 列表，以逗号分隔', 'description' => '成员ID列表，多个成员ID以半角逗号（,）分隔。如何获取成员ID，请参见[ListMembers](~~449135~~)。', 'type' => 'string', 'required' => true, 'example' => '145883-21513926******88039,145883-2769726******87513'], ], ], 'responses' => [ @@ -7753,566 +5504,317 @@ 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA', - ], - 'Members' => [ - 'title' => '成员列表', - 'description' => '成员列表。', - 'type' => 'array', - 'items' => [ - 'description' => '成员详情。', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户 id', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '21513926******88039'."\n", - ], - 'Roles' => [ - 'title' => '角色列表', - 'description' => '角色列表。', - 'type' => 'array', - 'items' => [ - 'description' => '角色名。角色名和权限的对应关系，请参见[角色及权限列表](https://pai.console.aliyun.com/?regionId=cn-shanghai#/workspace/permission)。'."\n" - .'角色名可能值：'."\n" - ."\n" - .'- PAI.AlgoDeveloper：算法开发'."\n" - .'- PAI.AlgoOperator：算法运维'."\n" - .'- PAI.LabelManager：标注管理员'."\n" - .'- PAI.MaxComputeDeveloper：MaxCompute开发'."\n" - .'- PAI.WorkspaceAdmin：管理员'."\n" - .'- PAI.WorkspaceGuest：访客'."\n" - .'- PAI.WorkspaceOwner：负责人', - 'type' => 'string', - 'example' => 'PAI.AlgoDeveloper', - ], - ], - 'DisplayName' => [ - 'title' => '成员显示名', - 'description' => '显示名。', - 'type' => 'string', - 'example' => 'myDisplayName', - ], - 'MemberId' => [ - 'title' => '成员 id', - 'description' => '成员ID。', - 'type' => 'string', - 'example' => '145883-21513926******88039'."\n", - ], - ], - ], - ], + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9'], + 'Code' => ['description' => '请求失败时返回的错误代码。', 'type' => 'string', 'example' => '100600017'], + 'Message' => ['description' => '请求失败时的返回信息。', 'type' => 'string', 'example' => 'Owner not allowed to delete'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\",\\n \\"Members\\": [\\n {\\n \\"UserId\\": \\"21513926******88039\\\\n\\",\\n \\"Roles\\": [\\n \\"PAI.AlgoDeveloper\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"145883-21513926******88039\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '工作空间添加成员', - ], - 'UpdateConfigs' => [ - 'summary' => '批量更新或新增工作空间配置。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/configs', - 'methods' => [ - 'put', + 'title' => '工作空间删除成员 ', + 'summary' => '删除工作空间的成员。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMembers'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\",\\n \\"Code\\": \\"100600017\\",\\n \\"Message\\": \\"Owner not allowed to delete\\"\\n}","type":"json"}]', + ], + 'DeleteModel' => [ + 'path' => '/api/v1/models/{ModelId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '117760', - 'abilityTreeNodes' => [ - 'FEATURElearnOTS2AE', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '133765', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'ModelId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '83***', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求。', - 'type' => 'object', - 'properties' => [ - 'Configs' => [ - 'title' => '配置列表', - 'description' => '要更新或者新增的工作空间配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '要更新或者新增的工作空间配置。', - 'type' => 'object', - 'properties' => [ - 'ConfigKey' => [ - 'title' => '配置键', - 'description' => '配置项的键。目前支持如下键：'."\n" - ."\n" - .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" - .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" - .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" - .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" - .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', - 'type' => 'string', - 'required' => false, - 'example' => 'tempStoragePath', - ], - 'ConfigValue' => [ - 'title' => '配置值', - 'description' => '配置值'."\n" - ."\n" - .'- 对于ConfigKey为predefinedTags，ConfigValue格式为[{"Type":"Tag","Key":"Key1","Value":"{\\"Products\\":\\"DLC,DSW,EAS\\",\\"Values\\":\\"value1,value2,value3\\"}"}]，Products代表哪些产品使用预置标签。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://test/s/', - ], - 'CategoryName' => [ - 'description' => '配置项的分类。目前支持如下分类'."\n" - ."\n" - .'- CommonResourceConfig 通用资源配置'."\n" - .'- DLCAutoRecycle DLC自动回收'."\n" - .'- DLCPriorityConfig DLC 优先级设置'."\n" - .'- DSWPriorityConfig DSW优先级设置'."\n" - .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" - .'- CommonTagConfig 标签设置', - 'type' => 'string', - 'required' => false, - 'example' => 'CommonResourceConfig', - ], - 'Labels' => [ - 'description' => '配置项的标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配置项的标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签的键。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '标签的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wzl****ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', - 'title' => '批量更新或新增工作空间配置', - ], - 'GetConfig' => [ - 'summary' => '获取工作空间配置。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/config', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除模型', + 'summary' => '删除模型。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModel'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paimodel:DeleteModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'DeleteModelLabels' => [ + 'path' => '/api/v1/models/{ModelId}/labels', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '240491', - 'abilityTreeNodes' => [ - 'FEATURElearnDVAH75', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '133789', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'ModelId', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1234******2', - ], - ], - [ - 'name' => 'CategoryName', - 'in' => 'query', - 'schema' => [ - 'description' => '配置项的分类。目前支持如下分类'."\n" - ."\n" - .'- CommonResourceConfig 通用资源配置'."\n" - .'- DLCAutoRecycle DLC自动回收'."\n" - .'- DLCPriorityConfig DLC 优先级设置'."\n" - .'- DSWPriorityConfig DSW优先级设置'."\n" - .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" - .'- CommonTagConfig 标签设置', - 'type' => 'string', - 'required' => false, - 'example' => 'CommonResourceConfig', - ], - ], - [ - 'name' => 'ConfigKey', - 'in' => 'query', - 'schema' => [ - 'description' => '配置项的键。目前支持如下键：'."\n" - ."\n" - .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" - .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" - .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" - .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" - .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', - 'type' => 'string', - 'required' => false, - 'example' => 'tempStoragePath', - ], + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-d8dfd****sjfd'], ], [ - 'name' => 'Verbose', + 'name' => 'LabelKeys', 'in' => 'query', - 'schema' => [ - 'description' => '配置项的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://***', - ], + 'schema' => ['title' => '需要删除的标签Keys', 'description' => '需要删除的标签键。多项之间使用半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'key1,key2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '1234******2'."\n", - ], - 'ConfigKey' => [ - 'description' => '配置项的键。目前支持如下键：'."\n" - ."\n" - .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" - .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" - .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" - .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" - .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', - 'type' => 'string', - 'example' => 'tempStoragePath', - ], - 'ConfigValue' => [ - 'description' => '配置项的值。', - 'type' => 'string', - 'example' => 'oss://***', - ], - 'CategoryName' => [ - 'description' => '配置项的分类。目前支持如下分类'."\n" - ."\n" - .'- CommonResourceConfig 通用资源配置'."\n" - .'- DLCAutoRecycle DLC自动回收'."\n" - .'- DLCPriorityConfig DLC 优先级设置'."\n" - .'- DSWPriorityConfig DSW优先级设置'."\n" - .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" - .'- CommonTagConfig 标签设置', - 'type' => 'string', - 'example' => 'CommonResourceConfig', - ], - 'Labels' => [ - 'description' => '配置项的标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配置项的标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签的键。', - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\",\\n \\"WorkspaceId\\": \\"1234******2\\\\n\\",\\n \\"ConfigKey\\": \\"tempStoragePath\\",\\n \\"ConfigValue\\": \\"oss://***\\",\\n \\"CategoryName\\": \\"CommonResourceConfig\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\"\\n}","type":"json"}]', - 'title' => '获取工作空间配置', - ], - 'ListConfigs' => [ - 'summary' => '获取工作空间配置列表。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/configs', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除模型标签', + 'summary' => '删除模型标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paimodel:DeleteModelLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'DeleteModelVersion' => [ + 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', + 'methods' => ['delete'], + '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' => '117761', - 'abilityTreeNodes' => [ - 'FEATURElearnDVAH75', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '133784', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'ModelId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '87***', - ], + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wzljz****ks92'], ], [ - 'name' => 'CategoryName', - 'in' => 'query', - 'schema' => [ - 'description' => '配置项的分类。目前支持如下分类'."\n" - ."\n" - .'- CommonResourceConfig 通用资源配置'."\n" - .'- DLCAutoRecycle DLC自动回收'."\n" - .'- DLCPriorityConfig DLC 优先级设置'."\n" - .'- DSWPriorityConfig DSW优先级设置'."\n" - .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" - .'- CommonTagConfig 标签设置', - 'type' => 'string', - 'required' => false, - 'example' => 'CommonResourceConfig', - ], + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['title' => '模型版本', 'description' => '模型版本。', 'type' => 'string', 'required' => true, 'example' => '0.1.1'], ], - [ - 'name' => 'ConfigKeys', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '配置键', - 'description' => '配置项的键。目前支持如下键：'."\n" - ."\n" - .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" - .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" - .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" - .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" - .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', - 'type' => 'string', - 'required' => false, - 'example' => 'tempStoragePath', + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除模型版本', + 'summary' => '删除模型版本。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelVersion'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'description' => '标签作为过滤条件，多个条件用逗号分隔，这些条件之间是与的关系。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1=value1,key2=value2', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paimodel:DeleteModelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'description' => '是否展示Label信息'."\n" - ."\n" - .'- true：展示Label信息'."\n" - .'- false：不展示Label信息', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'DeleteModelVersionLabels' => [ + 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}/labels', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '133792', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], + ], + 'parameters' => [ + [ + 'name' => 'ModelId', + 'in' => 'path', + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-d8dfd****sjfd'], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['title' => '模型版本', 'description' => '模型版本。', 'type' => 'string', 'required' => true, 'example' => '0.1.1'], + ], + [ + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => ['title' => '版本标签Keys', 'description' => '需要删除的标签键。多项之间使用半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'key1,key2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n", - ], - 'Configs' => [ - 'title' => '配置列表', - 'description' => '配置项列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配置项。', - 'type' => 'object', - 'properties' => [ - 'ConfigKey' => [ - 'title' => '配置键', - 'description' => '配置项的键。目前支持如下键：'."\n" - ."\n" - .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" - .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" - .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" - .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" - .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', - 'type' => 'string', - 'example' => 'tempTableLifecycle', - ], - 'ConfigValue' => [ - 'title' => '配置值', - 'description' => '配置值', - 'type' => 'string', - 'example' => 'oss://***'."\n", - ], - 'Labels' => [ - 'description' => '配置项的标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配置项的标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签的键。', - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'value1'."\n", - ], - ], - ], - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '返回数量', - 'description' => '返回数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigKey\\": \\"tempTableLifecycle\\",\\n \\"ConfigValue\\": \\"oss://***\\\\n\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\\\n\\"\\n }\\n ],\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', - 'title' => '获取工作空间配置列表', - ], - 'DeleteConfig' => [ - 'summary' => '删除工作空间配置。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/configs/{ConfigKey}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除模型版本标签', + 'summary' => '删除模型版本标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelVersionLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paimodel:DeleteModelVersionLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'DeleteRun' => [ + 'path' => '/api/v1/runs/{RunId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8321,96 +5823,57 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '117762', - 'abilityTreeNodes' => [ - 'FEATURElearnOTS2AE', - ], + 'abilityTreeCode' => '233507', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '98***', - ], - ], - [ - 'name' => 'ConfigKey', + 'name' => 'RunId', 'in' => 'path', - 'schema' => [ - 'title' => '配置键', - 'description' => '配置项的键。目前支持如下键：'."\n" - ."\n" - .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" - .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" - .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" - .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" - .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', - 'type' => 'string', - 'required' => true, - 'example' => 'tempStoragePath', - ], - ], - [ - 'name' => 'CategoryName', - 'in' => 'query', - 'schema' => [ - 'description' => '配置项的分类。目前支持如下分类'."\n" - ."\n" - .'- CommonResourceConfig 通用资源配置'."\n" - .'- DLCAutoRecycle DLC自动回收- DLCPriorityConfig DLC 优先级设置'."\n" - .'- DSWPriorityConfig DSW优先级设置'."\n" - .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" - .'- CommonTagConfig 标签设置', - 'type' => 'string', - 'required' => false, - 'example' => 'CommonResourceConfig', - ], - ], - [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'description' => '过滤条件，多个条件用逗号分隔，这些条件之间是与的关系。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1=value;key2=value2', - ], + 'schema' => ['description' => '运行ID', 'type' => 'string', 'required' => true, 'example' => 'run-1qJhzJ2YXgX****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n", - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', - 'title' => '删除工作空间配置', - ], - 'UpdateConfig' => [ - 'summary' => '更新或新增工作空间配置。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/config', - 'methods' => [ - 'put', + 'title' => '删除Run', + 'summary' => '删除Run', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteRun'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiexperiment:DeleteRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + ], + 'DeleteRunLabel' => [ + 'path' => '/api/v1/runs/{RunId}/labels/{Key}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8418,300 +5881,244 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '234915', - 'abilityTreeNodes' => [ - 'FEATURElearnOTS2AE', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '233523', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'RunId', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1234******2'."\n", - ], + 'schema' => ['description' => '运行ID', 'type' => 'string', 'required' => true, 'example' => 'run-1qJhzJ2YXgX****'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求参数。', - 'type' => 'object', - 'properties' => [ - 'ConfigKey' => [ - 'description' => '配置项的键。目前支持如下键：'."\n" - ."\n" - .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" - .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" - .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" - .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" - .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', - 'type' => 'string', - 'required' => false, - 'example' => 'tempStoragePath', - ], - 'ConfigValue' => [ - 'description' => '配置项的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://***'."\n", - ], - 'CategoryName' => [ - 'description' => '配置项的分类。目前支持如下分类'."\n" - ."\n" - .'- CommonResourceConfig 通用资源配置'."\n" - .'- DLCAutoRecycle DLC自动回收'."\n" - .'- DLCPriorityConfig DLC 优先级设置'."\n" - .'- DSWPriorityConfig DSW优先级设置'."\n" - .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" - .'- CommonTagConfig 标签设置', - 'type' => 'string', - 'required' => false, - 'example' => 'CommonResourceConfig', - ], - 'Labels' => [ - 'description' => '配置项的标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配置项的标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签的键。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '标签的值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'Key', + 'in' => 'path', + 'schema' => ['description' => '要删除的Run标签的Key', 'type' => 'string', 'required' => true, 'example' => 'is_evaluate'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n", - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '删除Run标签', + 'summary' => '删除Run标签', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteRunLabel'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiexperiment:DeleteRunLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', - 'title' => '更新或新增工作空间配置', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', ], - 'ListWorkspaces' => [ - 'summary' => '获取某个地域下的工作空间列表。', - 'path' => '/api/v1/workspaces', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteUserConfig' => [ + 'path' => '/api/v1/userconfigs/{CategoryName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '14203', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '194787', + 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'ConfigKey', 'in' => 'query', - 'schema' => [ - 'title' => '分页，从1开始，默认1', - 'description' => '工作空间列表的页码。起始值为1，默认为1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '配置键', 'description' => '配置键，目前只支持customizePAIAssumedRole。', 'type' => 'string', 'required' => false, 'example' => 'tempStoragePath'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小，默认20', - 'description' => '分页查询时设置的每页行数，默认为20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'CategoryName', + 'in' => 'path', + 'schema' => ['description' => '分类，目前只支持DataPrivacyConfig。', 'type' => 'string', 'required' => true, 'example' => 'DataPrivacyConfig'], ], [ - 'name' => 'SortBy', + 'name' => 'Scope', 'in' => 'query', - 'schema' => [ - 'title' => '排序字段：CreateTime', - 'description' => '分页查询时的排序字段，默认使用GmtCreateTime。取值如下。'."\n" - .'* GmtCreateTime（默认值）：按创建时间。'."\n" - .'* GmtModifiedTime：按修改时间。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'schema' => ['description' => '范围，目前支持subUser、owner。', 'type' => 'string', 'required' => false, 'example' => 'subUser'], ], - [ - 'name' => 'Order', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '排序方向： ASC - 升序 DESC - 降序', - 'description' => '分页查询时，对指定的排序字段进行升序或降序。取值如下：'."\n" - .'* ASC（默认值）：升序。'."\n" - .'* DESC ：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'dsjk****dfjksdf'], + ], ], ], + ], + 'title' => '删除用户配置', + 'summary' => '删除用户配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserConfig'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'WorkspaceName', - 'in' => 'query', - 'schema' => [ - 'title' => '工作空间名字', - 'description' => '工作空间名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pai:DeleteUserConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dsjk****dfjksdf\\"\\n}","type":"json"}]', + ], + 'DeleteWorkspace' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ModuleList', - 'in' => 'query', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '61546', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间id', 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '逗号分割的模块列表，目前填入PAI', - 'description' => '逗号分割的模块列表。默认值：PAI。', - 'type' => 'string', - 'required' => false, - 'example' => 'PAI', + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + ], ], ], + ], + 'title' => '删除工作空间', + 'summary' => '删除工作空间，关联的资源不会释放，需要您自已释放。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => '状态', - 'description' => '工作空间状态，目前支持如下值：'."\n" - ."\n" - .'- ENABLED：正常。'."\n" - .'- INITIALIZING：初始化中。'."\n" - .'- FAILURE：失败。'."\n" - .'- DISABLED：手动禁用。'."\n" - .'- FROZEN：欠费冻结。'."\n" - .'- UPDATING：项目更新中。', - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLED', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'DeleteWorkspaceResource' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Option', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'title' => '逗号分隔的选项', - 'description' => '选项，取值如下：'."\n" - .'* GetWorkspaces（默认值）：获取工作空间列表，会返回Workspaces。'."\n" - .'* GetResourceLimits：获取资源限制，会返回ResourceLimits。', - 'type' => 'string', - 'required' => false, - 'example' => 'GetWorkspaces', - ], + 'schema' => ['description' => '**该字段已废弃，将会下线，请使用ResourceType字段**', 'type' => 'string', 'required' => false, 'example' => 'DLC'], ], [ - 'name' => 'Verbose', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '是否显示详细信息，默认true', - 'description' => '是否显示工作空间详细信息。取值如下：'."\n" - .'- false（默认值）：不显示。'."\n" - .'- true：显示。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '资源分组名。如果获取资源分组名，请参见[ListResources](~~449143~~)。', 'type' => 'string', 'required' => false, 'example' => 'group'], ], [ - 'name' => 'Fields', + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], + ], + [ + 'name' => 'Option', 'in' => 'query', - 'schema' => [ - 'title' => 'GetWorkspaceFields的Field字段', - 'description' => '工作空间详情的返回字段列表。用于限定返回结果中的工作空间属性。'."\n" - .'多个属性用半角逗号（,）分隔。目前只支持Id，表示工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'Id', - ], + 'schema' => ['description' => '删除行为，取值如下：'."\n" + ."\n" + .'- DetachAndDelete（默认值）：与工作空间解绑并删除资源（默认值）。'."\n" + .'- Detach：与工作空间解绑。', 'type' => 'string', 'required' => false, 'example' => 'DetachAndDelete'], ], [ - 'name' => 'WorkspaceIds', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'title' => '工作空间id列表', - 'description' => '工作空间ID列表。多个工作空间ID用半角逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => '123,234', - ], + 'schema' => ['description' => '资源类型列表。取值如下：'."\n" + ."\n" + .'- ECS：通用计算资源'."\n" + .'- Lingjun：灵骏智算资源'."\n" + .'- ACS：ACS计算资源'."\n" + .'- FLINK：Flink资源。'."\n" + .'- MaxCompute： MaxCompute资源，目前只支持Option为Detach，不支持DetachAndDelete'."\n" + .'- SelfManagedAckPro：AckPro统一管控集群资源'."\n" + .'- SelfManagedAckLingjun：AckLinjun统一管控集群资源
'."\n" + .'- SelfManagedASI：ASI统一管控集群资源（三方云）', 'type' => 'string', 'required' => false, 'example' => 'DLC'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。如何查看资源组ID，请参见[查看资源组基本信息](~~151181~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmwp7rky****', - ], + 'schema' => ['description' => '标签列表，以逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'system.supported.eas=true'], ], [ - 'name' => 'UserId', + 'name' => 'ResourceIds', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '逗号分隔的多个资源ID，这多个资源ID的GroupName必须一致'."\n" + .'GroupName与ResourceIds不能都为空，可以两项都不为空。', 'type' => 'string', 'required' => false, 'example' => 'Resource-dks******jkf,Resource-adf******dss'], ], ], 'responses' => [ @@ -8721,162 +6128,66 @@ 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', - ], - 'Workspaces' => [ - 'title' => '工作空间列表', - 'description' => '工作空间详情列表，当Option为GetWorkspaces时会返回该列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'ResourceIds' => [ + 'description' => '受影响的资源Id列表。', 'type' => 'array', - 'items' => [ - 'description' => '工作空间详情。', - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '123', - ], - 'WorkspaceName' => [ - 'title' => '工作空间名字', - 'description' => '工作空间名称。', - 'type' => 'string', - 'example' => 'workspace-example', - ], - 'GmtCreateTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '工作空间创建时间。以ISO8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'GmtModifiedTime' => [ - 'title' => '修改 UTC 时间，日期格式 iso8601', - 'description' => '工作空间修改时间。以ISO8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '工作空间描述。', - 'type' => 'string', - 'example' => 'workspace description example', - ], - 'Creator' => [ - 'title' => '创建人', - 'description' => '创建者用户ID。', - 'type' => 'string', - 'example' => '122424353535', - ], - 'EnvTypes' => [ - 'title' => '环境，用作判断简单模式还是标准模式', - 'description' => '工作空间包含的环境列表。', - 'type' => 'array', - 'items' => [ - 'description' => '工作空间包含的环境，可能值：'."\n" - ."\n" - .'- 简单模式只有生产环境（prod）。'."\n" - .'- 标准模式包含开发环境（dev）和生产环境（prod）。', - 'type' => 'string', - 'example' => 'prod', - ], - ], - 'Status' => [ - 'title' => '工作空间状态', - 'description' => '工作空间状态。', - 'type' => 'string', - 'example' => 'ENABLED', - ], - 'AdminNames' => [ - 'title' => '管理员名字', - 'description' => '管理员账户名称列表。', - 'type' => 'array', - 'items' => [ - 'description' => '管理员账户名称。', - 'type' => 'string', - 'example' => 'demo_test@***.aliyunid.com', - ], - ], - 'IsDefault' => [ - 'title' => '是否为默认工作空间', - 'description' => '是否为默认工作空间。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ExtraInfos' => [ - 'title' => '附加信息', - 'description' => '扩展信息，目前包含TenantId，代表租户ID。', - 'type' => 'object', - 'example' => '{"TenantId": "4286******98"}', - ], - 'resourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfmwp7rky****', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的作业数量', - 'description' => '符合查询条件的工作空间总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ResourceLimits' => [ - 'title' => '资源限制', - 'description' => '用户在一个工作空间内允许开通的资源类型和数量限制，当Option为GetResourceLimits时会返回该列表。'."\n" - .'目前支持的资源类型包括：'."\n" - .'* MaxCompute_share：MaxCompute后付费。'."\n" - .'* MaxCompute_isolate：MaxCompute预付费。'."\n" - .'* DLC_share：DLC后付费。'."\n" - .'* PAI_isolate：PAI预付费。'."\n" - .'* PAI_share：PAI后付费。'."\n" - .'* DataWorks_isolate：Dataworks预付费。'."\n" - .'* DataWorks_share：Dataworks后付费。'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "MaxCompute_share": 1,'."\n" - .' "MaxCompute_isolate": 1,'."\n" - .' "DLC_share": 1'."\n" - .'}', + 'items' => ['description' => '受影响的资源Id。', 'type' => 'string', 'example' => 'Resource-dks******jkf'], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\",\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"123\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"Creator\\": \\"122424353535\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Status\\": \\"ENABLED\\",\\n \\"AdminNames\\": [\\n \\"demo_test@***.aliyunid.com\\"\\n ],\\n \\"IsDefault\\": false,\\n \\"ExtraInfos\\": {\\n \\"TenantId\\": \\"4286******98\\"\\n },\\n \\"resourceGroupId\\": \\"rg-acfmwp7rky****\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"ResourceLimits\\": {\\n \\"MaxCompute_share\\": 1,\\n \\"MaxCompute_isolate\\": 1,\\n \\"DLC_share\\": 1\\n }\\n}","type":"json"}]', - 'title' => '获取工作空间列表', - 'description' => '您可以通过option参数指定不同的查询选项，来获取不同的工作空间相关信息。', - ], - 'CreateWorkspace' => [ - 'summary' => '创建工作空间。', - 'path' => '/api/v1/workspaces', - 'methods' => [ - 'post', + 'title' => '删除工作空间的资源', + 'summary' => '删除工作空间对资源的引用，不会删除底层的资源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspaceResource'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteWorkspaceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ResourceIds\\": [\\n \\"Resource-dks******jkf\\"\\n ]\\n}","type":"json"}]', + ], + 'DeleteWorkspaceRoles' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/roles/action/delete', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '14204', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '221941', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间ID', 'description' => '工作空间ID。可通过 [ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => true, 'example' => '98***'], + ], [ 'name' => 'body', 'in' => 'body', @@ -8885,49 +6196,10 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'WorkspaceName' => [ - 'title' => '名字 3-23 个字符, 需要字母开头，只能包含字母下划线和数字，region内唯一', - 'description' => '工作空间名称。格式如下：'."\n" - .'- 长度为3~23 个字符，可以包含字母、下划线或数字。'."\n" - .'- 必须以大小写字母开头。'."\n" - .'- 当前地域内唯一。', - 'type' => 'string', - 'required' => true, - 'example' => 'workspace_example', - ], - 'Description' => [ - 'title' => '描述，最多80个字符', - 'description' => '工作空间描述，不超过80个字符。', - 'type' => 'string', - 'required' => true, - 'example' => '这是一个工作空间描述示例。', - ], - 'DisplayName' => [ - 'title' => '显示名称', - 'description' => '建议基于业务属性命名，便于标识工作空间用途。如果不配置，默认为工作空间名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'demo工作空间', - ], - 'EnvTypes' => [ - 'title' => '环境列表', - 'description' => '工作空间包含的环境：'."\n" - .'- 简单模式只有生产环境（prod）。'."\n" - .'- 标准模式包含开发环境（dev）和生产环境（prod）。', + 'RoleIds' => [ + 'description' => '（必填）角色ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '环境类型，取值如下：'."\n" - ."\n" - .'- dev：开发环境。'."\n" - .'- prod：生产环境。', - 'type' => 'string', - 'required' => true, - 'example' => 'dev', - ], - 'required' => true, - ], - 'ResourceGroupId' => [ - 'type' => 'string', + 'items' => ['description' => '角色ID。', 'type' => 'string', 'required' => false, 'example' => 'role-dhg*******'], 'required' => false, ], ], @@ -8938,882 +6210,697 @@ 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1e195c5116124202371861018d5bde', - ], - 'WorkspaceId' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '1234', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A519F77D-28A0-52F5-AB82-5********8'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"WorkspaceId\\": \\"1234\\"\\n}","type":"json"}]', - 'title' => '创建工作空间', - ], - 'GetWorkspace' => [ - 'summary' => '获取工作空间详细信息。', - 'path' => '/api/v1/workspaces/{WorkspaceId}', - 'methods' => [ - 'get', + 'title' => '删除自定义角色', + 'summary' => '批量删除工作空间角色', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiworkspace:RemoveWorkspaceRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A519F77D-28A0-52F5-AB82-5********8\\"\\n}","type":"json"}]', + ], + 'GetCodeSource' => [ + 'summary' => '获取一个代码配置的详细信息。', + 'path' => '/api/v1/codesources/{CodeSourceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '14101', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'CodeSourceId', 'in' => 'path', - 'schema' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'description' => '是否显示工作空间Owner等补充信息。取值如下：'."\n" - .'- false（默认值）：不显示补充信息。'."\n" - .'- true：显示补充信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '代码源配置ID', 'description' => '代码源配置ID。如何获取代码配置ID，请参见[ListCodeSources](~~459922~~)。', 'type' => 'string', 'required' => true, 'example' => 'code-202**********'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', + 'CodeSourceId' => ['title' => '代码源配置ID', 'description' => '代码源配置ID。', 'type' => 'string', 'example' => 'code-202**********'], + 'DisplayName' => ['title' => '代码源配置名字', 'description' => '代码源配置名字。', 'type' => 'string', 'example' => 'MyCodeSource1'], + 'Description' => ['title' => '详细描述', 'description' => '代码配置的详细描述。', 'type' => 'string', 'example' => 'This is my data source 1.'], + 'CodeRepo' => ['title' => '代码仓库地址', 'description' => '代码仓库地址。', 'type' => 'string', 'example' => 'https://code.aliyun.com/pai-dlc/examples.git'], + 'CodeBranch' => ['title' => '代码仓库分支', 'description' => '代码仓库分支。', 'type' => 'string', 'example' => 'master'], + 'CodeCommit' => ['title' => '代码Commit', 'description' => '代码CommitId。', 'type' => 'string', 'example' => '44da10***********'], + 'CodeRepoUserName' => ['title' => '代码仓库的用户名', 'description' => '代码仓库的用户名。', 'type' => 'string', 'example' => 'user1'], + 'CodeRepoAccessToken' => ['title' => '访问代码仓库的token', 'description' => '访问代码仓库的Token。', 'type' => 'string', 'example' => 'xxxx'], + 'MountPath' => ['title' => '代码本地挂载目录，默认挂载到/root/code/下', 'description' => '代码的本地挂载目录。', 'type' => 'string', 'example' => '/root/code'], + 'Accessibility' => [ + 'title' => '代码是否是本工作空间内公开的，可选值PRIVATE、PUBLIC', + 'description' => '代码配置的可见性。', 'type' => 'string', - 'example' => 'A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C', - ], - 'WorkspaceId' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '1234', - ], - 'WorkspaceName' => [ - 'title' => '项目空间名称， region 内唯一', - 'description' => '工作空间名称。', - 'type' => 'string', - 'example' => 'workspace-example', - ], - 'GmtCreateTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '工作空间创建UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'GmtModifiedTime' => [ - 'title' => '修改 UTC 时间，日期格式 iso8601', - 'description' => '工作空间修改UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', - ], - 'DisplayName' => [ - 'title' => '显示名称', - 'description' => '工作空间显示名称。', - 'type' => 'string', - 'example' => 'workspace-example', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '工作空间描述。', - 'type' => 'string', - 'example' => 'workspace description example', - ], - 'EnvTypes' => [ - 'title' => '环境，用作判断简单模式还是标准模式', - 'description' => '工作空间包含的环境，取值如下：'."\n" - ."\n" - .'* 简单模式只有生产环境（prod）。'."\n" - .'* 标准模式包含开发环境（dev）和生产环境（prod）。', - 'type' => 'array', - 'items' => [ - 'description' => '环境类型，可能值：'."\n" - ."\n" - .'- dev：开发环境。'."\n" - .'- prod：生产环境。', - 'type' => 'string', - 'example' => 'prod', - ], - ], - 'Creator' => [ - 'title' => '创建人', - 'description' => '创建者用户ID。', - 'type' => 'string', - 'example' => '1157******94123', - ], - 'Status' => [ - 'title' => '工作空间状态', - 'description' => '工作空间状态，可能值：'."\n" - ."\n" - .'- ENABLED：正常。'."\n" - .'- INITIALIZING：初始化中。'."\n" - .'- FAILURE：失败。'."\n" - .'- DISABLED：手动禁用。'."\n" - .'- FROZEN：欠费冻结。'."\n" - .'- UPDATING：项目更新中。', - 'type' => 'string', - 'example' => 'ENABLED', - ], - 'AdminNames' => [ - 'title' => '管理员账户', - 'description' => '管理员账户名称列表。', - 'type' => 'array', - 'items' => [ - 'description' => '管理员账户名称。当Verbose为true时显示。', - 'type' => 'string', - 'example' => 'demo_test@***.aliyunid.com', - ], - ], - 'IsDefault' => [ - 'title' => '是否为默认工作空间', - 'description' => '是否为默认工作空间，可能值：'."\n" - .'- false：不是默认工作空间。'."\n" - .'- true：是默认工作空间。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ExtraInfos' => [ - 'title' => '附加信息', - 'description' => '附加信息，目前包含TenantId（租户ID）。', - 'type' => 'object', - 'example' => '{"TenantId": "4286******98"}', - ], - 'Owner' => [ - 'description' => '工作空间所有者信息，当Verbose为true时显示。', - 'type' => 'object', - 'properties' => [ - 'UserKp' => [ - 'description' => '用户UID。', - 'type' => 'string', - 'example' => '1157******94123', - ], - 'UserId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1157******94123', - ], - 'UserName' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'mings****t', - ], - 'DisplayName' => [ - 'description' => '显示名。', - 'type' => 'string', - 'example' => 'mings****t', - ], - ], - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfmwp7rkyq****', + 'enumValueTitles' => ['PUBLIC' => '在此工作空间中，对所有人可见', 'PRIVATE' => '在此工作空间中，仅对您和管理员可见'], + 'example' => 'PRIVATE', ], + 'UserId' => ['title' => '代码配置源的创建者ID', 'description' => '代码配置源的创建者ID。', 'type' => 'string', 'example' => '1722********'], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '1234'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '代码配置创建时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-12T23:36:01.123Z'], + 'GmtModifyTime' => ['title' => '修改时间', 'description' => '代码配置修改时间。时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-12T23:36:01.123Z'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'CloneType' => ['description' => '克隆模式。取值如下：'."\n" + .'- 0：新建子目录。'."\n" + .'- 1：平铺到当前目录。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"DisplayName\\": \\"workspace-example\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Creator\\": \\"1157******94123\\",\\n \\"Status\\": \\"ENABLED\\",\\n \\"AdminNames\\": [\\n \\"demo_test@***.aliyunid.com\\"\\n ],\\n \\"IsDefault\\": true,\\n \\"ExtraInfos\\": {\\n \\"TenantId\\": \\"4286******98\\"\\n },\\n \\"Owner\\": {\\n \\"UserKp\\": \\"1157******94123\\",\\n \\"UserId\\": \\"1157******94123\\",\\n \\"UserName\\": \\"mings****t\\",\\n \\"DisplayName\\": \\"mings****t\\"\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmwp7rkyq****\\"\\n}","type":"json"}]', - 'title' => '获取工作空间', - ], - 'DeleteWorkspace' => [ - 'summary' => '删除工作空间，关联的资源不会释放，需要您自已释放。', - 'path' => '/api/v1/workspaces/{WorkspaceId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-202**********\\",\\n \\"DisplayName\\": \\"MyCodeSource1\\",\\n \\"Description\\": \\"This is my data source 1.\\",\\n \\"CodeRepo\\": \\"https://code.aliyun.com/pai-dlc/examples.git\\",\\n \\"CodeBranch\\": \\"master\\",\\n \\"CodeCommit\\": \\"44da10***********\\",\\n \\"CodeRepoUserName\\": \\"user1\\",\\n \\"CodeRepoAccessToken\\": \\"xxxx\\",\\n \\"MountPath\\": \\"/root/code\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"UserId\\": \\"1722********\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T23:36:01.123Z\\",\\n \\"GmtModifyTime\\": \\"2021-01-12T23:36:01.123Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"CloneType\\": 0\\n}","type":"json"}]', + 'title' => '获取代码配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCodeSource'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paicodesource:GetCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetConfig' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/config', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '61546', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '240491', + 'abilityTreeNodes' => ['FEATURElearnDVAH75'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '1234******2'], + ], + [ + 'name' => 'CategoryName', + 'in' => 'query', + 'schema' => ['description' => '配置项的分类。目前支持如下分类'."\n" + ."\n" + .'- CommonResourceConfig 通用资源配置'."\n" + .'- DLCAutoRecycle DLC自动回收'."\n" + .'- DLCPriorityConfig DLC 优先级设置'."\n" + .'- DSWPriorityConfig DSW优先级设置'."\n" + .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" + .'- CommonTagConfig 标签设置', 'type' => 'string', 'required' => false, 'example' => 'CommonResourceConfig'], + ], + [ + 'name' => 'ConfigKey', + 'in' => 'query', + 'schema' => ['description' => '配置项的键。目前支持如下键：'."\n" + ."\n" + .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" + .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" + .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" + .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" + .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', 'type' => 'string', 'required' => false, 'example' => 'tempStoragePath'], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['description' => '配置项的值。', 'type' => 'string', 'required' => false, 'example' => 'oss://***'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '响应。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'], + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '1234******2'."\n"], + 'ConfigKey' => ['description' => '配置项的键。目前支持如下键：'."\n" + ."\n" + .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" + .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" + .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" + .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" + .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', 'type' => 'string', 'example' => 'tempStoragePath'], + 'ConfigValue' => ['description' => '配置项的值。', 'type' => 'string', 'example' => 'oss://***'], + 'CategoryName' => ['description' => '配置项的分类。目前支持如下分类'."\n" + ."\n" + .'- CommonResourceConfig 通用资源配置'."\n" + .'- DLCAutoRecycle DLC自动回收'."\n" + .'- DLCPriorityConfig DLC 优先级设置'."\n" + .'- DSWPriorityConfig DSW优先级设置'."\n" + .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" + .'- CommonTagConfig 标签设置', 'type' => 'string', 'example' => 'CommonResourceConfig'], + 'Labels' => [ + 'description' => '配置项的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置项的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签的键。', 'type' => 'string', 'example' => 'key1'], + 'Value' => ['description' => '标签的值。', 'type' => 'string', 'example' => 'value1'], + ], + ], ], + 'GmtCreateTime' => ['type' => 'string', 'description' => ''], + 'GmtModifiedTime' => ['type' => 'string', 'description' => ''], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除工作空间', - ], - 'UpdateWorkspace' => [ - 'summary' => '更新工作空间名称和描述信息。', - 'path' => '/api/v1/workspaces/{WorkspaceId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取工作空间配置', + 'summary' => '获取工作空间配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConfig'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\",\\n \\"WorkspaceId\\": \\"1234******2\\\\n\\",\\n \\"ConfigKey\\": \\"tempStoragePath\\",\\n \\"ConfigValue\\": \\"oss://***\\",\\n \\"CategoryName\\": \\"CommonResourceConfig\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetConnection' => [ + 'path' => '/api/v1/connections/{ConnectionId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '14202', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267615', + 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'ConnectionId', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => '连接ID。如何获取连接 ID，详情请参见 [ListConnections](url)。', 'type' => 'string', 'required' => true, 'example' => 'conn-pai9m***mi47'."\n"], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'title' => '显示名称', - 'description' => '工作空间显示名称，格式如下。'."\n" - .'- 长度为3~23 个字符，可以包含字母、下划线或数字。'."\n" - .'- 必须以大小字母开头。'."\n" - .'- 当前地域内唯一。', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace-example', - ], - 'Description' => [ - 'title' => '描述', - 'description' => '工作空间描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => '这是一个示例工作空间。', - ], - ], - 'required' => false, - ], + 'name' => 'EncryptOption', + 'in' => 'query', + 'schema' => ['description' => '加密设置。可取值：'."\n" + .'- PlainText：明文。'."\n" + .'- Secret：密文。', 'type' => 'string', 'required' => false, 'example' => 'PlainText'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '响应信息。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '11**43'], + 'Accessibility' => ['description' => '资源可见性，取值如下：'."\n" + ."\n" + .'- PUBLIC：当前工作空间所有成员都可以访问。'."\n" + .'- PRIVATE：只有创建者可以访问。', 'type' => 'string', 'example' => 'PRIVATE'], + 'ConnectionId' => ['description' => '连接ID。', 'type' => 'string', 'example' => 'conn-pai9m***mi47'], + 'ConnectionType' => ['description' => '连接的类型。可能值：'."\n" + ."\n" + .'- DashScopeConnection：百炼服务连接。'."\n" + .'- OpenLLMConnection：开源模型连接。'."\n" + .'- MilvusConnection：Milvus连接。'."\n" + .'- OpenSearchConnection：OpenSearch连接。'."\n" + .'- LindormConnection：Lindorm连接。'."\n" + .'- ElasticsearchConnection：Elasticsearch连接。'."\n" + .'- HologresConnection：Hologres连接。'."\n" + .'- RDSConnection：RDS连接。'."\n" + .'- CustomConnection：自定义连接。', 'type' => 'string', 'example' => 'OpenSearchConnection'], + 'ConnectionName' => ['description' => '连接的名称。', 'type' => 'string', 'example' => 'Database connection'], + 'Description' => ['description' => '连接的描述。', 'type' => 'string', 'example' => '用于数据集检索。'], + 'Configs' => [ + 'description' => '连接的配置信息。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '12345', 'description' => '连接配置的value值。'], + ], + 'Secrets' => [ + 'description' => '需要加密的Key-Value配置。如数据库登录密码，模型连接的Key等。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => 'Dsjk***hsl01', 'description' => '加密连接配置的value值。'], + ], + 'GmtCreateTime' => ['description' => '创建连接的UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2025-03-07T07:54:56Z'], + 'GmtModifiedTime' => ['description' => '修改连接的UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2025-03-07T07:54:56Z'], + 'Creator' => ['description' => '连接的创建者。', 'type' => 'string', 'example' => '28632***898231'], + 'ResourceMeta' => [ + 'description' => '连接的实例资源信息。一般适用于数据库类型的连接。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ld-2vc1***v1zaqgzol'], + 'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'Test instance.'], + 'Extra' => ['description' => '额外配置信息。', 'type' => 'string', 'example' => '{"vpcId":"vpc-xxxx"}'], + ], + ], + 'Models' => [ + 'description' => '模型列表。适用于模型服务类型的连接。', + 'type' => 'array', + 'items' => [ + 'description' => '模型信息。', + 'type' => 'object', + 'properties' => [ + 'Model' => ['description' => '模型标识符。', 'type' => 'string', 'example' => 'model_001'], + 'DisplayName' => ['description' => '模型的显示名称。', 'type' => 'string', 'example' => '测试语言模型。'], + 'ModelType' => ['description' => '模型类型，取值为：'."\n" + .'- LLM：大语言模型。'."\n" + .'- Embedding：Embedding模型。'."\n" + .'- ReRank：ReRank模型。', 'type' => 'string', 'example' => 'LLM'], + 'ToolCall' => ['description' => '是否支持ToolCall工具调用。可取值：'."\n" + .'- true：支持'."\n" + .'- false：不支持', 'type' => 'boolean', 'example' => 'true'], + ], + ], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '更新工作空间', - ], - 'GetDefaultWorkspace' => [ - 'summary' => '获取默认工作空间详情。', - 'path' => '/api/v1/defaultWorkspaces', - 'methods' => [ - 'get', + 'title' => '查询连接', + 'summary' => '获取连接详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnection'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"WorkspaceId\\": \\"11**43\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\",\\n \\"ConnectionType\\": \\"OpenSearchConnection\\",\\n \\"ConnectionName\\": \\"Database connection\\",\\n \\"Description\\": \\"用于数据集检索。\\",\\n \\"Configs\\": {\\n \\"key\\": \\"12345\\"\\n },\\n \\"Secrets\\": {\\n \\"key\\": \\"Dsjk***hsl01\\"\\n },\\n \\"GmtCreateTime\\": \\"2025-03-07T07:54:56Z\\",\\n \\"GmtModifiedTime\\": \\"2025-03-07T07:54:56Z\\",\\n \\"Creator\\": \\"28632***898231\\",\\n \\"ResourceMeta\\": {\\n \\"InstanceId\\": \\"ld-2vc1***v1zaqgzol\\",\\n \\"InstanceName\\": \\"Test instance.\\",\\n \\"Extra\\": \\"{\\\\\\"vpcId\\\\\\":\\\\\\"vpc-xxxx\\\\\\"}\\"\\n },\\n \\"Models\\": [\\n {\\n \\"Model\\": \\"model_001\\",\\n \\"DisplayName\\": \\"测试语言模型。\\",\\n \\"ModelType\\": \\"LLM\\",\\n \\"ToolCall\\": true\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetDataset' => [ + 'path' => '/api/v1/datasets/{DatasetId}', + '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' => '48564', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'description' => '是否显示默认工作空间的详细信息，目前详细信息包含阶段列表详情（Conditions）。取值如下：'."\n" - .'- false（默认值）：不显示详细信息。'."\n" - .'- true：显示详细信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['title' => 'Dataset Id', 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'example' => 'd-rbvg5wz****c9ks92'], + 'Name' => ['description' => '数据集名称。', 'type' => 'string', 'example' => 'myName'], + 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => '用于标注的数据。'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + 'GmtModifiedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + 'UserId' => ['description' => '数据集所属用户ID。', 'type' => 'string', 'example' => '2485765****023475'], + 'OwnerId' => ['description' => '主账户ID。', 'type' => 'string', 'example' => '1631044****3440'], + 'Property' => [ + 'description' => '数据集初始版本v1的属性。可能值：'."\n" + .'- FILE：文件。'."\n" + .'- DIRECTORY：文件夹。', 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', + 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], + 'example' => 'DIRECTORY', ], - 'WorkspaceId' => [ - 'title' => '工作空间 ID', - 'description' => '工作空间ID。', + 'DataSourceType' => [ + 'description' => '数据源类型。可能值：'."\n" + .'- OSS：阿里云对象存储（OSS）。'."\n" + .'- NAS：阿里云文件存储（NAS）。', 'type' => 'string', - 'example' => '1234', + 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], + 'example' => 'NAS', ], - 'WorkspaceName' => [ - 'title' => '项目空间名称， region 内唯一', - 'description' => '工作空间名称， 同地域内唯一。', - 'type' => 'string', - 'example' => 'workspace-example', + 'Uri' => ['description' => '初始版本v1的Uri，样例格式：'."\n" + .'- 数据源类型为OSS：`oss://bucket.endpoint/object`。'."\n" + .'- 数据源类型为NAS：'."\n" + .'通用型NAS格式为：`nas://.region/subpath/to/dir/`；'."\n" + .'CPFS1.0：`nas://.region/subpath/to/dir/`；'."\n" + .'CPFS2.0：`nas://.region//`；'."\n" + .'CPFS1.0和CPFS2.0根据fsid的格式来区分：'."\n" + .'CPFS1.0 格式为cpfs-<8位ascii字符>；'."\n" + .'CPFS2.0 格式为cpfs-<16为ascii字符>。', 'type' => 'string', 'example' => 'nas://09f****f2.cn-hangzhou/'], + 'Labels' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => ['description' => '为数据集添加的标签。', 'example' => '{"Key": "env", "Value": "test"}', '$ref' => '#/components/schemas/Label'], ], - 'GmtCreateTime' => [ - 'title' => '创建 UTC 时间，日期格式 iso8601', - 'description' => '创建UTC时间，时间格式为ISO8601。', + 'DataType' => [ + 'description' => '数据集的数据类型，可能值：'."\n" + ."\n" + .'- COMMON：普通。'."\n" + .'- PIC：图片。'."\n" + .'- TEXT：文本。'."\n" + .'- VIDEO：视频。'."\n" + .'- AUDIO：音频。', 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', + 'enumValueTitles' => ['VIDEO' => 'VIDEO', 'COMMON' => 'COMMON', 'TEXT' => 'TEXT', 'PIC' => 'PIC', 'AUDIO' => 'AUDIO'], + 'example' => 'COMMON', ], - 'GmtModifiedTime' => [ - 'title' => '修改 UTC 时间，日期格式 iso8601', - 'description' => '修改UTC时间，时间格式为ISO8601。', + 'SourceType' => [ + 'description' => '数据来源初始版本v1的类型。', 'type' => 'string', - 'example' => '2021-01-21T17:12:35.232Z', + 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], + 'example' => 'USER', ], - 'DisplayName' => [ - 'title' => '显示名称', - 'description' => '工作空间显示名称。', + 'SourceId' => ['description' => '初始版本v1的数据来源ID，可能值：'."\n" + .'- 当SourceType为USER时，SourceId支持自定义。'."\n" + .'- 当SourceType为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" + .'- 当SourceType为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', 'type' => 'string', 'example' => 'jdnhf***fnrimv'], + 'WorkspaceId' => ['description' => '数据集所在工作空间ID。', 'type' => 'string', 'example' => '478**'], + 'Options' => ['description' => '初始版本v1的扩展字段，JsonString类型。'."\n" + .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', 'type' => 'string', 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}'], + 'Accessibility' => [ + 'description' => '工作空间可见度。可能值：'."\n" + .'- PRIVATE：表示工作空间内仅数据集所有者以及管理员可见。'."\n" + .'- PUBLIC：工作空间全体成员可见。'."\n" + .'- ROLE_PUBLIC: 指定工作空间角色可见，角色列表参考：AccessibleRoleIdList。该条件下数据集所有者及管理员始终具备可见性。', 'type' => 'string', - 'example' => 'workspace-example', + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], + 'example' => 'PRIVATE', ], - 'Description' => [ - 'title' => '描述', - 'description' => '工作空间描述。', - 'type' => 'string', - 'example' => 'workspace description example', + 'ProviderType' => ['description' => '数据集的数据源来源类型。取值如下：'."\n" + .'- Ecs （默认）'."\n" + .'- Lingjun', 'type' => 'string', 'example' => 'Ecs'], + 'Provider' => ['description' => '数据集提供方。返回值为"pai"时表示该数据集为PAI平台的公共数据集。', 'type' => 'string', 'example' => 'pai'], + 'SourceDatasetId' => ['description' => 'iTag标注集的来源数据集ID。', 'type' => 'string', 'example' => 'd-rcdg3wxxxxxhc5jk87'."\n"], + 'SourceDatasetVersion' => ['description' => '标注数据集的来源数据集版本。', 'type' => 'string', 'example' => 'v2'], + 'TagTemplateType' => ['description' => 'iTag标注数据集的标注模板', 'type' => 'string', 'example' => 'TextClassification'], + 'LatestVersion' => ['description' => '数据集的最新版本。', '$ref' => '#/components/schemas/DatasetVersion'], + 'MountAccess' => ['description' => '该数据集被挂载时的权限。'."\n" + .'- RO：只读挂载'."\n" + .'- RW：读写挂载', 'type' => 'string', 'example' => 'RW'], + 'MountAccessReadWriteRoleIdList' => [ + 'description' => '具有该数据集读写权限的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。', + 'type' => 'array', + 'items' => ['description' => '工作空间角色ID', 'type' => 'string', 'example' => 'PAI.AlgoOperator'], + ], + 'ImportInfo' => ['description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" + ."\n" + .'
'."\n" + .'OSS'."\n" + .'{
'."\n" + .'"region": "${region}",//地域ID
'."\n" + .'"bucket": "${bucket}",//bucket名称
'."\n" + .'"path": "${path}" //文件路径
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'NAS'."\n" + .'{
'."\n" + .'"region": "${region}",//地域ID
'."\n" + .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .'"path": "${path}", //文件系统路径
'."\n" + .'"mountTarget": "${mount_target}" //文件系统挂载点
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'CPFS'."\n" + .'{
'."\n" + .'"region": "${region}",//地域ID
'."\n" + .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .'"protocolServiceId":"${protocol_service_id}", //文件系统协议服务
'."\n" + .'"exportId": "${export_id}", //文件系统导出目录
'."\n" + .'"path": "${path}", //文件系统路径
'."\n" + .'}
'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'智算CPFS'."\n" + .'{
'."\n" + .'"region": "${region}",//地域ID
'."\n" + .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" + .'"path": "${path}", //文件系统路径
'."\n" + .'"mountTarget": "${mount_target}" //文件系统挂载点，智算版特有
'."\n" + .'"isVpcMount": boolean, //是否为vpc挂载点, 智算版特有
'."\n" + .'}
'."\n" + .'
', 'type' => 'string', 'example' => '{'."\n" + .' "region": "cn-wulanchabu",'."\n" + .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" + .' "path": "/mnt",'."\n" + .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" + .' "isVpcMount": true'."\n" + .'}'], + 'Edition' => ['description' => '数据集类型。枚举值：'."\n" + ."\n" + .'- BASIC：基础型。不支持数据集文件元数据管理。'."\n" + ."\n" + .' '."\n" + ."\n" + .'- ADVANCED：高级型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。', 'type' => 'string', 'example' => 'BASIC'], + 'IsShared' => [ + 'description' => '是否为共享数据集。', + 'type' => 'boolean', + 'enumValueTitles' => ['false' => 'false', 'true' => 'true'], + 'example' => 'false', ], - 'EnvTypes' => [ - 'title' => '环境，用作判断简单模式还是标准模式，含义见', - 'description' => '工作空间包含的环境，取值如下：'."\n" - .'* 简单模式只有生产环境（prod）。'."\n" - .'* 标准模式包含开发环境（dev）和生产环境（prod）。', - 'type' => 'array', - 'items' => [ - 'description' => '工作空间包含的环境，可能值：'."\n" - ."\n" - .'- dev：开发环境。'."\n" - .'- prod：生产环境。', - 'type' => 'string', - 'example' => 'prod', - ], - ], - 'Creator' => [ - 'title' => '创建人', - 'description' => '创建工作空间的阿里云账号信息。', - 'type' => 'string', - 'example' => '17915******4216'."\n", - ], - 'Owner' => [ - 'title' => '拥有者', - 'description' => '创建工作空间的阿里云账号信息。', + 'SharedFrom' => ['description' => '描述该分享数据集的来源关系。仅IsShared为true时有效。', '$ref' => '#/components/schemas/DatasetShareRelationship'], + 'SharingConfig' => [ + 'description' => '当前数据集的分享配置信息。', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'title' => '用户id', - 'description' => '用户UID。', - 'type' => 'string', - 'example' => '17915******4216', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'username', - ], - 'UserKp' => [ - 'title' => '用户kp', - 'description' => '用户UID。', - 'type' => 'string', - 'example' => '17915******4216', + 'SharedTo' => [ + 'description' => '多条分享配置关系。', + 'type' => 'array', + 'items' => ['description' => '该数据集被分享的分享配置关系。', '$ref' => '#/components/schemas/DatasetShareRelationship'], ], ], ], - 'Status' => [ - 'title' => '工作空间状态', - 'description' => '工作空间状态，可能值：'."\n" - ."\n" - .'- ENABLED：正常。'."\n" - .'- INITIALIZING：初始化中。'."\n" - .'- FAILURE：失败。'."\n" - .'- DISABLED：手动禁用。'."\n" - .'- FROZEN：欠费冻结。'."\n" - .'- UPDATING：项目更新中。', - 'type' => 'string', - 'example' => 'ENABLED', - ], - 'Conditions' => [ - 'title' => '任务详情 创建默认工作空间会有多个任务依次进行，如果一个任务未开始，不会显示在任务详情里。', - 'description' => '默认工作空间创建流程的阶段列表详情。', + 'AccessibleRoleIdList' => [ + 'description' => '在Accessibility为ROLE_PUBLIC时生效。该数据集可见的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。', 'type' => 'array', - 'items' => [ - 'description' => '默认工作空间创建流程的阶段详情。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '类型', - 'description' => '任务类型，可能值：'."\n" - ."\n" - .'- CREATING：创建中。'."\n" - .'- WORKSPACE_CREATED：工作空间创建完成。'."\n" - .'- MEMBERS_ADDED：成员添加完成。'."\n" - .'- ENABLED：总体完成。', - 'type' => 'string', - 'example' => 'CREATING ', - ], - 'Code' => [ - 'title' => '返回码，正常是200，其他都是错误', - 'description' => '返回码。200表示返回正常，其他表示返回异常。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'title' => '消息', - 'description' => '请求返回的错误消息。当返回码为200时，该字段为空。', - 'type' => 'string', - 'example' => 'Create Failed', - ], - ], - ], + 'items' => ['description' => '工作空间角色ID。', 'type' => 'string', 'example' => 'PAI.AlgoOperator'], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"DisplayName\\": \\"workspace-example\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Creator\\": \\"17915******4216\\\\n\\",\\n \\"Owner\\": {\\n \\"UserId\\": \\"17915******4216\\",\\n \\"UserName\\": \\"username\\",\\n \\"UserKp\\": \\"17915******4216\\"\\n },\\n \\"Status\\": \\"ENABLED\\",\\n \\"Conditions\\": [\\n {\\n \\"Type\\": \\"CREATING \\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Create Failed\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取默认工作空间', - ], - 'UpdateDefaultWorkspace' => [ - 'summary' => '将某个工作空间指定为默认工作空间。', - 'path' => '/api/v1/defaultWorkspaces', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据集', + 'summary' => '获取数据集。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataset'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'title' => '显示名称', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '17915******4216', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17915******4216\\"\\n}","type":"json"}]', - 'title' => '指定默认工作空间', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetId\\": \\"d-rbvg5wz****c9ks92\\",\\n \\"Name\\": \\"myName\\",\\n \\"Description\\": \\"用于标注的数据。\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"2485765****023475\\",\\n \\"OwnerId\\": \\"1631044****3440\\",\\n \\"Property\\": \\"DIRECTORY\\",\\n \\"DataSourceType\\": \\"NAS\\",\\n \\"Uri\\": \\"nas://09f****f2.cn-hangzhou/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"DataType\\": \\"COMMON\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"SourceId\\": \\"jdnhf***fnrimv\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"Provider\\": \\"pai\\",\\n \\"SourceDatasetId\\": \\"d-rcdg3wxxxxxhc5jk87\\\\n\\",\\n \\"SourceDatasetVersion\\": \\"v2\\",\\n \\"TagTemplateType\\": \\"TextClassification\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"base model v1\\",\\n \\"SourceId\\": \\"d-65mrsr5fub4u74lej3\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n },\\n \\"MountAccess\\": \\"RW\\",\\n \\"MountAccessReadWriteRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ],\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\",\\n \\"Edition\\": \\"BASIC\\",\\n \\"IsShared\\": false,\\n \\"SharedFrom\\": {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SourceTenantId\\": \\"148***************115\\",\\n \\"SourceWorkspaceId\\": \\"33**19\\",\\n \\"TenantId\\": \\"153***************249\\",\\n \\"WorkspaceId\\": \\"42**2\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"2025-08-27T12:23:58Z\\",\\n \\"ExpiresAt\\": \\"2026-08-27T12:23:58Z\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"RO\\"\\n ],\\n \\"Extra\\": \\"{\\\\\\"AllowExportModel\\\\\\":false,\\\\\\"AllowAccessDLCWebTerminal\\\\\\":false,\\\\\\"AllowAccessDLCFullLog\\\\\\":false}\\"\\n },\\n \\"SharingConfig\\": {\\n \\"SharedTo\\": [\\n {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SourceTenantId\\": \\"148***************115\\",\\n \\"SourceWorkspaceId\\": \\"33**19\\",\\n \\"TenantId\\": \\"153***************249\\",\\n \\"WorkspaceId\\": \\"42**2\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"2025-08-27T12:23:58Z\\",\\n \\"ExpiresAt\\": \\"2026-08-27T12:23:58Z\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"RO\\"\\n ],\\n \\"Extra\\": \\"{\\\\\\"AllowExportModel\\\\\\":false,\\\\\\"AllowAccessDLCWebTerminal\\\\\\":false,\\\\\\"AllowAccessDLCFullLog\\\\\\":false}\\"\\n }\\n ]\\n },\\n \\"AccessibleRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ]\\n}","type":"json"}]', ], - 'ListWorkspaceUsers' => [ - 'summary' => '列出未加入工作空间的用户列表，这些用户可被加入工作空间成为成员。', - 'path' => '/api/v1/workspaces/{WorkspaceId}/users', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetDatasetFileMeta' => [ + 'summary' => '获取数据集下的指定文件元数据记录。', + 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas/{DatasetFileMetaId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '14222', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', - ], + 'abilityTreeCode' => '260628', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间 id', - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], ], [ - 'name' => 'UserName', + 'name' => 'DatasetFileMetaId', + 'in' => 'path', + 'schema' => ['description' => '数据集文件元数据ID。', 'type' => 'string', 'required' => true, 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'], + ], + [ + 'name' => 'DatasetVersion', 'in' => 'query', - 'schema' => [ - 'description' => '支持添加为工作空间成员的用户显示名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'doctest****', - ], + 'schema' => ['description' => '数据集版本名。', 'type' => 'string', 'required' => false, 'example' => 'v1'], ], [ - 'name' => 'UserId', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '1234'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1e195c5116124202371861018d5bde', - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的用户数量', - 'description' => '符合过滤条件的用户数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Users' => [ - 'title' => '用户列表', - 'description' => '用户列表。', - 'type' => 'array', - 'items' => [ - 'description' => '用户。', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'title' => '用户 id', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1611******3000', - ], - 'UserName' => [ - 'title' => '用户名', - 'description' => '用户名。', - 'type' => 'string', - 'example' => 'she******mo', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'DatasetFileMeta' => ['description' => '获取的数据集文件元数据详情。', '$ref' => '#/components/schemas/DatasetFileMetaContentGet'], + 'DatasetVersion' => ['description' => '数据集版本名。', 'type' => 'string', 'example' => 'v1'], + 'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'example' => 'd-rbvg5wz****c9ks92'], + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '1234'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"TotalCount\\": 2,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"1611******3000\\",\\n \\"UserName\\": \\"she******mo\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取可被添加至工作空间的用户列表', - ], - 'ListQuotas' => [ - 'summary' => '获取资源配额列表。', - 'path' => '/api/v1/quotas', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '14241', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据集文件元数据详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetFileMeta'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '名字，支持模糊搜索', - 'description' => '资源配额名称，支持模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'quota-name', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Quotas' => [ - 'title' => '配额列表', - 'description' => '资源配额列表。', - 'type' => 'array', - 'items' => [ - 'description' => '资源配额详情。', - 'type' => 'object', - 'properties' => [ - 'QuotaType' => [ - 'title' => '产品类型， 支持PAI，MaxCompute', - 'description' => '资源配额类型，可能值：'."\n" - ."\n" - .'PAI：表示MaxCompute的GPU资源组集群。', - 'type' => 'string', - 'example' => 'PAI', - ], - 'Mode' => [ - 'title' => '模式 isolate 预付费 share 后付费 develop 开发模式', - 'description' => '付费模式，可能值：'."\n" - ."\n" - .'- isolate：预付费。'."\n" - .'- share：后付费。', - 'type' => 'string', - 'example' => 'isolate', - ], - 'ProductCode' => [ - 'title' => '产品代码', - 'description' => '产品名，可能值：'."\n" - .'- PAI_isolate：pai预付费资源组（pai cpu）。'."\n" - .'- PAI_share：pai后付费资源组（pai gpu）。', - 'type' => 'string', - 'example' => 'PAI_share', - ], - 'Name' => [ - 'title' => 'quota名字', - 'description' => '配额名称。', - 'type' => 'string', - 'example' => 'quota-name', - ], - 'Specs' => [ - 'title' => '规格描述列表', - 'description' => '规格描述列表。', - 'type' => 'array', - 'items' => [ - 'description' => '规格描述。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '规格名', - 'description' => '规格名。', - 'type' => 'string', - 'example' => 'cu', - ], - 'Value' => [ - 'title' => '规格描述', - 'description' => '规格值。', - 'type' => 'string', - 'example' => '11500', - ], - 'Type' => [ - 'title' => '类型，可为空', - 'description' => '类型，可为空。', - 'type' => 'string', - 'example' => 'string', - ], - ], - ], - 'example' => '{\\"cu\\":\\"11500\\",\\"minCu\\":\\"2300\\",\\"parentId\\":\\"0\\"}', - ], - 'Id' => [ - 'title' => 'quota的id', - 'description' => '配额的ID。', - 'type' => 'string', - 'example' => '1828233', - ], - 'DisplayName' => [ - 'description' => '资源配额别名。', - 'type' => 'string', - 'example' => '默认Quota。', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的数量', - 'description' => '符合过滤条件的资源配额数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetFileMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaType\\": \\"PAI\\",\\n \\"Mode\\": \\"isolate\\",\\n \\"ProductCode\\": \\"PAI_share\\",\\n \\"Name\\": \\"quota-name\\",\\n \\"Specs\\": [\\n {\\n \\"Name\\": \\"cu\\",\\n \\"Value\\": \\"11500\\",\\n \\"Type\\": \\"string\\"\\n }\\n ],\\n \\"Id\\": \\"1828233\\",\\n \\"DisplayName\\": \\"默认Quota。\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n MaxCompute\\n isolate\\n MaxCompute_share\\n quota-name\\n \\n name\\n {\\\\\\"cu\\\\\\":\\\\\\"11500\\\\\\",\\\\\\"minCu\\\\\\":\\\\\\"2300\\\\\\",\\\\\\"parentId\\\\\\":\\\\\\"0\\\\\\"}\\n abc\\n \\n 1828233\\n \\n 2\\n","errorExample":""}]', - 'title' => '获取MaxCompute GPU资源组的资源配额列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetFileMeta\\": {\\n \\"FileName\\": \\"00001.jpeg\\",\\n \\"Uri\\": \\"oss://*****-test/dataset/1653421.jpg\\\\nnas://0e25d***dff/dataset/1653421.jpg\\\\n\\",\\n \\"Comment\\": \\"The first image file in the dataset.\\",\\n \\"FileCreateTime\\": \\"2025-01-12T14:36:01Z\\",\\n \\"FileUpdateTime\\": \\"2025-01-12T14:36:01Z\\",\\n \\"FileFingerPrint\\": \\"D41D8CD98F*****E9800998ECF8\\\\n\\",\\n \\"DataSize\\": 10000,\\n \\"FileType\\": \\"image\\",\\n \\"ContentType\\": \\"image/png\\",\\n \\"MetaAttributes\\": \\"{\\\\n \\\\\\"ImageHeight\\\\\\": 1080,\\\\n \\\\\\"ImageWidth\\\\\\": 1920\\\\n}\\",\\n \\"Tags\\": \\"{\\\\n \\\\\\"ai\\\\\\":\\\\n [\\\\n \\\\\\"Lane line\\\\\\",\\\\n \\\\\\"Water horse\\\\\\",\\\\n \\\\\\"Sunny day\\\\\\"\\\\n ],\\\\n \\\\\\"user\\\\\\":\\\\n [\\\\n \\\\\\"Everett\\\\\\",\\\\n \\\\\\"Intelligent driving Dataset 1\\\\\\",\\\\n \\\\\\"Cloudy day\\\\\\"\\\\n ],\\\\n \\\\\\"user-delete-ai-tags\\\\\\":\\\\n [\\\\n \\\\\\"Sunny day\\\\\\"\\\\n ]\\\\n}\\",\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6\\\\n\\",\\n \\"FileDir\\": \\"icp_certificate_card/icp/1577179298694813/1716429710367\\",\\n \\"TagUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"SemanticIndexJobId\\": \\"dsjob-klfwtjtov*****scvt3\\",\\n \\"SemanticIndexUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"Status\\": \\"\\"\\n },\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"DatasetId\\": \\"d-rbvg5wz****c9ks92\\",\\n \\"WorkspaceId\\": \\"1234\\"\\n}","type":"json"}]', ], 'GetDatasetFileMetasStatistics' => [ - 'summary' => '获取数据集下元数据的统计信息。', 'path' => '/api/v1/statistics/datasets/{DatasetId}/datasetfilemetas', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -9821,9 +6908,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267067', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -9831,32 +6916,17 @@ [ 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wz****c9ks92', - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', - 'schema' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'schema' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => true, 'example' => 'v1'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '145883', - ], + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '145883'], ], [ 'name' => 'AggregateBy', @@ -9872,27 +6942,14 @@ .'- tags.all: 算法标签+用户自定义标签（ 已经去除用户删除的算法标签）', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'filetype' => 'filetype', - 'tags.user' => 'tags.user', - 'tags.ai' => 'tags.ai', - 'filedir' => 'filedir', - 'tags.user-delete-ai-tags' => 'tags.user-delete-ai-tags', - 'tags.all' => 'tags.all', - ], + 'enumValueTitles' => ['filetype' => 'filetype', 'tags.user' => 'tags.user', 'tags.ai' => 'tags.ai', 'filedir' => 'filedir', 'tags.user-delete-ai-tags' => 'tags.user-delete-ai-tags', 'tags.all' => 'tags.all'], 'example' => 'filedir', ], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '使用NextToken方式查询时，每次最多返回的结果数。取值范围：1~100。默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '使用NextToken方式查询时，每次最多返回的结果数。取值范围：1~100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -9902,156 +6959,53 @@ 'description' => '请求响应结果。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', - ], - 'TotalCount' => [ - 'description' => '返回统计结果数量。例如：统计有多少条元数据、有多少个用户标签。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '73', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], + 'TotalCount' => ['description' => '返回统计结果数量。例如：统计有多少条元数据、有多少个用户标签。', 'type' => 'integer', 'format' => 'int32', 'example' => '73'], 'DatasetFileMetasStats' => [ 'description' => '返回的聚合列表详情。可以获得每个聚合项的数量。列表默认按照Count DESC排序。', 'type' => 'array', - 'items' => [ - 'description' => '聚合项及其数量。', - '$ref' => '#/components/schemas/DatasetFileMetasStat', - ], + 'items' => ['description' => '聚合项及其数量。', '$ref' => '#/components/schemas/DatasetFileMetasStat'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"TotalCount\\": 73,\\n \\"DatasetFileMetasStats\\": [\\n {\\n \\"Key\\": \\"cat\\",\\n \\"Count\\": 10\\n }\\n ]\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取数据集下文件元数据的统计信息', - ], - 'StopDatasetJob' => [ - 'summary' => '停止数据集任务。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}/action/stop', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '260528', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', + 'summary' => '获取数据集下元数据的统计信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetFileMetasStatistics'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'parameters' => [ - [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集版本ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5*****jhc9ks92', - ], - ], - [ - 'name' => 'DatasetJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'dsjob-9jx1*****uj9e', - ], - ], + 'ramActions' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'DatasetVersion' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '478**', - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F620FFD3-FFDC-5873-A70C-6971CC45F467', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetFileMetasStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F620FFD3-FFDC-5873-A70C-6971CC45F467\\"\\n}","type":"json"}]', - 'title' => '停止数据集任务', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"TotalCount\\": 73,\\n \\"DatasetFileMetasStats\\": [\\n {\\n \\"Key\\": \\"cat\\",\\n \\"Count\\": 10\\n }\\n ]\\n}","type":"json"}]', ], 'GetDatasetJob' => [ - 'summary' => '获取数据集任务', 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -10059,50 +7013,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260532', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5*****jhc9ks92', - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'DatasetJobId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'dsjob-9jx1xxxxxxuj9e', - ], + 'schema' => ['description' => '数据集任务ID', 'type' => 'string', 'required' => true, 'example' => 'dsjob-9jx1xxxxxxuj9e'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', - 'schema' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], + 'schema' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => false, 'example' => 'v1'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '478**', - ], + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], ], ], 'responses' => [ @@ -10112,476 +7044,339 @@ 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '64B50C1D-D4C2-560C-86A3-A6ED****16D', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '64B50C1D-D4C2-560C-86A3-A6ED****16D'], 'JobAction' => [ 'description' => '任务操作。', 'type' => 'string', - 'enumValueTitles' => [ - 'SemanticIndex' => '语义索引任务', - 'IntelligentTag' => '智能打标任务', - 'FileMetaExport' => '元数据导出任务', - ], + 'enumValueTitles' => ['SemanticIndex' => '语义索引任务', 'IntelligentTag' => '智能打标任务', 'FileMetaExport' => '元数据导出任务'], 'example' => 'SemanticIndex', ], 'JobMode' => [ 'description' => '任务模式。', 'type' => 'string', - 'enumValueTitles' => [ - 'Full' => '全量模式', - ], + 'enumValueTitles' => ['Full' => '全量模式'], 'example' => 'Full', ], - 'CreateTime' => [ - 'description' => '任务启动时间。', - 'type' => 'string', - 'example' => '2024-11-15T07:06:42Z', - ], - 'FinishTime' => [ - 'description' => '任务结束时间。', - 'type' => 'string', - 'example' => '2024-07-16T02:03:23Z', - ], - 'JobSpec' => [ - 'description' => '任务明细。', - 'type' => 'string', - 'example' => '{\\"modelId\\":\\"xxx\\"}', - ], + 'CreateTime' => ['description' => '任务启动时间。', 'type' => 'string', 'example' => '2024-11-15T07:06:42Z'], + 'FinishTime' => ['description' => '任务结束时间。', 'type' => 'string', 'example' => '2024-07-16T02:03:23Z'], + 'JobSpec' => ['description' => '任务明细。', 'type' => 'string', 'example' => '{\\"modelId\\":\\"xxx\\"}'], 'Status' => [ 'description' => '任务状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'Succeeded' => '执行成功', - 'Failed' => '执行失败', - 'Running' => '运行中', - 'Pending' => '等待中', - 'PartialFailed' => '部分失败', - 'Deleting' => '删除中', - 'ManuallyStop' => '手动停止', - ], + 'enumValueTitles' => ['Succeeded' => '执行成功', 'Failed' => '执行失败', 'Running' => '运行中', 'Pending' => '等待中', 'PartialFailed' => '部分失败', 'Deleting' => '删除中', 'ManuallyStop' => '手动停止'], 'example' => 'Running', ], - 'Description' => [ - 'description' => '任务描述。', - 'type' => 'string', - 'example' => '这是一个任务描述。', - ], + 'Description' => ['description' => '任务描述。', 'type' => 'string', 'example' => 'This is a task description.'], 'Logs' => [ 'description' => '任务日志列表。', 'type' => 'array', - 'items' => [ - 'description' => '任务日志行。', - 'type' => 'string', - 'example' => '2025-02-17 09:58:10.143 INFO: Job completed successfully.', - ], - ], - 'TotalFileCount' => [ - 'description' => '任务文件总量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'CompletedFileCount' => [ - 'description' => '已完成文件总量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '990', - ], - 'FailedFileCount' => [ - 'description' => '失败文件总量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'items' => ['description' => '任务日志行。', 'type' => 'string', 'example' => '2025-02-17 09:58:10.143 INFO: Job completed successfully.'], ], + 'TotalFileCount' => ['description' => '任务文件总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'CompletedFileCount' => ['description' => '已完成文件总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '990'], + 'FailedFileCount' => ['description' => '失败文件总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B50C1D-D4C2-560C-86A3-A6ED****16D\\",\\n \\"JobAction\\": \\"SemanticIndex\\",\\n \\"JobMode\\": \\"Full\\",\\n \\"CreateTime\\": \\"2024-11-15T07:06:42Z\\",\\n \\"FinishTime\\": \\"2024-07-16T02:03:23Z\\",\\n \\"JobSpec\\": \\"{\\\\\\\\\\\\\\"modelId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\",\\n \\"Status\\": \\"Running\\",\\n \\"Description\\": \\"这是一个任务描述。\\",\\n \\"Logs\\": [\\n \\"2025-02-17 09:58:10.143 INFO: Job completed successfully.\\"\\n ],\\n \\"TotalFileCount\\": 1000,\\n \\"CompletedFileCount\\": 990,\\n \\"FailedFileCount\\": 10\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取数据集任务', - ], - 'CreateDatasetFileMetas' => [ - 'summary' => '批量创建数据集下的文件元数据记录。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', - 'methods' => [ - 'post', + 'summary' => '获取数据集任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetJob'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B50C1D-D4C2-560C-86A3-A6ED****16D\\",\\n \\"JobAction\\": \\"SemanticIndex\\",\\n \\"JobMode\\": \\"Full\\",\\n \\"CreateTime\\": \\"2024-11-15T07:06:42Z\\",\\n \\"FinishTime\\": \\"2024-07-16T02:03:23Z\\",\\n \\"JobSpec\\": \\"{\\\\\\\\\\\\\\"modelId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\",\\n \\"Status\\": \\"Running\\",\\n \\"Description\\": \\"This is a task description.\\",\\n \\"Logs\\": [\\n \\"2025-02-17 09:58:10.143 INFO: Job completed successfully.\\"\\n ],\\n \\"TotalFileCount\\": 1000,\\n \\"CompletedFileCount\\": 990,\\n \\"FailedFileCount\\": 10\\n}","type":"json"}]', + ], + 'GetDatasetJobConfig' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '260491', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '260462', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-lfd60v0p****ujtsdx', - ], + 'schema' => ['description' => '数据集ID。', 'type' => 'string', 'required' => true, 'example' => 'd-lfd60v0p****ujtsdx'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求Body。', - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '478**', - ], - 'DatasetVersion' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], - 'DatasetFileMetas' => [ - 'description' => '文件元数据内容列表。', - 'type' => 'array', - 'items' => [ - 'description' => '文件元数据内容详情。', - 'required' => false, - '$ref' => '#/components/schemas/DatasetFileMetaContentCreate', - ], - 'required' => true, - ], - ], - 'required' => false, - ], + 'name' => 'DatasetJobConfigId', + 'in' => 'path', + 'schema' => ['description' => '配置id', 'type' => 'string', 'required' => true, 'example' => 'dscfg-xxxxxxxxxxxx'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '114243'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'Status' => [ - 'description' => '本批元数据创建结果的状态。全部成功为true，如果为false，需要查看FailedDetails。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '成功', - 'false' => '失败', - ], - 'example' => 'true', - ], - 'FailedDetails' => [ - 'description' => '创建失败的文件元数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '创建失败的文件元数据详情。', - '$ref' => '#/components/schemas/DatasetFileMetaResponse', - ], - ], - 'SucceedDetails' => [ - 'description' => '创建成功的文件元数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '创建成功的文件元数据详情。', - '$ref' => '#/components/schemas/DatasetFileMetaResponse', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-10-16T01:44:10Z'], + 'ModifyTime' => ['description' => '配置的修改时间。', 'type' => 'string', 'example' => '2024-12-26T02:17:18Z'], + 'ConfigType' => ['description' => '配置类型'."\n" + ."\n" + .'- MultimodalIntelligentTag'."\n" + ."\n" + .'- MultimodalSemanticIndex', 'type' => 'string', 'example' => 'MultimodalIntelligentTag'], + 'Config' => ['description' => '配置内容'."\n" + .'其中MultimodalIntelligentTag 配置格式为'."\n" + ."\n" + .'{'."\n" + .' "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" + .'}'."\n" + ."\n" + .'MultimodalSemanticIndex'."\n" + ."\n" + .'{'."\n" + .' "defaultModelId": "xxx"'."\n" + .' "defaultModelVersion":"1.0.0"'."\n" + .'}', 'type' => 'string', 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'], + 'DatasetId' => ['description' => '数据集Id', 'type' => 'string', 'example' => 'd-lfd60v0p****ujtsdx'], + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '114243'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Result\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"SucceedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Result\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '批量创建数据集文件元数据', - ], - 'UpdateDatasetJob' => [ - 'summary' => '更新数据集任务。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}', - 'methods' => [ - 'put', + 'title' => '获取数据集任务配置', + 'summary' => '获取数据集任务配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetJobConfig'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\",\\n \\"CreateTime\\": \\"2024-10-16T01:44:10Z\\",\\n \\"ModifyTime\\": \\"2024-12-26T02:17:18Z\\",\\n \\"ConfigType\\": \\"MultimodalIntelligentTag\\",\\n \\"Config\\": \\"{ \\\\\\"apiKey\\\\\\":\\\\\\"sk-xxxxxxxxxxxxxxxxxxxxx\\\\\\" }\\",\\n \\"DatasetId\\": \\"d-lfd60v0p****ujtsdx\\",\\n \\"WorkspaceId\\": \\"114243\\"\\n}","type":"json"}]', + ], + 'GetDatasetVersion' => [ + 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '260531', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '232570', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集版本ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5*****jhc9ks92', - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-lfd60v0p****ujtsdx'], ], [ - 'name' => 'DatasetJobId', + 'name' => 'VersionName', 'in' => 'path', - 'schema' => [ - 'description' => '数据集任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'dsjob-9jx1*****uj9e', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'DatasetVersion' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID，可从接口[ListWorkspaces](~~449124~~)获取。', - 'type' => 'string', - 'required' => false, - 'example' => '478**', - ], - 'Description' => [ - 'description' => '数据集任务描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a job description of a dataset.', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => '软件版本名称。', 'type' => 'string', 'required' => true, 'example' => 'v1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C55DF3DA-F120-5E37-A374-F49365531701'], + 'DatasetId' => ['title' => '资源一级ID', 'description' => '资源一级ID', 'type' => 'string', 'deprecated' => false, 'example' => 'd-dkdbnnap0g7b6su4yg', 'pattern' => '', 'default' => ''], + 'VersionName' => ['title' => '数据集版本', 'description' => '数据集版本', 'type' => 'string', 'deprecated' => false, 'example' => 'v1', 'pattern' => '', 'default' => ''], + 'Property' => [ + 'title' => '数据集的属性。', + 'description' => '数据集的属性。', 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', + 'deprecated' => false, + 'required' => true, + 'example' => 'DIRECTORY', + 'pattern' => '', + 'default' => '', + 'enum' => ['FILE', 'DIRECTORY'], ], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2023-12-13T10:22:05.694Z'], + 'GmtModifiedTime' => ['title' => '创建时间。', 'description' => '最后修改时间。', 'type' => 'string', 'deprecated' => false, 'example' => '2023-12-13T10:22:05.694Z', 'pattern' => '', 'default' => ''], + 'DataSourceType' => [ + 'title' => '数据源类型。', + 'description' => '数据源类型。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'OSS', + 'pattern' => '', + 'default' => '', + 'enum' => ['OSS', 'NAS', 'CPFS'], + ], + 'Uri' => ['title' => 'Uri配置样例', 'description' => 'Uri配置样例', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'oss://ai4d-br7hx9ngzelo2o6uip.oss-cn-shanghai.aliyuncs.com/365349/data-1157703270994901/datasets/aka108o/', 'pattern' => '', 'default' => ''], + 'Labels' => [ + 'title' => '资源标签', + 'description' => '资源标签', + 'type' => 'array', + 'items' => ['description' => '标签。', 'deprecated' => false, '$ref' => '#/components/schemas/Label'], + 'deprecated' => false, + 'maxItems' => 20, + ], + 'Options' => ['title' => '扩展字段。', 'description' => '扩展字段。', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', 'pattern' => '', 'default' => ''], + 'SourceType' => [ + 'title' => '数据来源类型', + 'description' => '数据来源类型', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], + 'example' => 'USER', + 'pattern' => '', + 'default' => '', + 'enum' => ['USER', 'ITAG', 'PAI_PUBLIC_DATASET', 'CLEANING', 'ENHANCE', 'ADDVERSION'], + ], + 'Description' => ['title' => '版本描述', 'description' => '版本描述', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => 'This is a description of the dataset version.', 'pattern' => '', 'default' => ''], + 'SourceId' => ['title' => '数据集来源ID。', 'description' => '数据集来源ID。', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => 'd-rbvg5wzljzjhc9ks92', 'default' => ''], + 'DataCount' => ['title' => '数据量', 'description' => '数据量', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'example' => '10000', 'pattern' => '', 'default' => ''], + 'DataSize' => ['title' => '数据集大小。', 'description' => '数据集大小。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'example' => '10000', 'pattern' => '', 'default' => ''], + 'MountAccess' => ['description' => '该数据集被挂载时的权限。'."\n" + .'- RO：只读挂载'."\n" + .'- RW：读写挂载', 'type' => 'string', 'example' => 'RO'], + 'ImportInfo' => ['description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" + ."\n" + .'
'."\n" + .'OSS'."\n" + .'{'."\n" + .'"region": "${region}",//地域ID'."\n" + .'"bucket": "${bucket}",//bucket名称'."\n" + .'"path": "${path}" //文件路径'."\n" + .'}'."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'NAS'."\n" + ."\n" + .'
'."\n" + ."\n" + .'
'."\n" + .'CPFS'."\n" + .'区块内容'."\n" + .'
'."\n" + ."\n\n" + .'
'."\n" + .'智算CPFS'."\n" + .'区块内容'."\n" + .'
', 'type' => 'string', 'example' => '{'."\n" + .' "region": "cn-wulanchabu",'."\n" + .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" + .' "path": "/mnt",'."\n" + .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" + .' "isVpcMount": true'."\n" + .'}'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => '获取数据集版本', + 'summary' => '获取指定版本的数据集信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetVersion'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '更新数据集任务', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C55DF3DA-F120-5E37-A374-F49365531701\\",\\n \\"DatasetId\\": \\"d-dkdbnnap0g7b6su4yg\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"Property\\": \\"DIRECTORY\\",\\n \\"GmtCreateTime\\": \\"2023-12-13T10:22:05.694Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-13T10:22:05.694Z\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"oss://ai4d-br7hx9ngzelo2o6uip.oss-cn-shanghai.aliyuncs.com/365349/data-1157703270994901/datasets/aka108o/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"This is a description of the dataset version.\\",\\n \\"SourceId\\": \\"d-rbvg5wzljzjhc9ks92\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n}","type":"json"}]', ], - 'ListDatasetJobs' => [ - 'summary' => '获取数据集任务列表。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetDefaultWorkspace' => [ + 'path' => '/api/v1/defaultWorkspaces', + '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' => '260535', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集版本ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-lfd60v0p****ujtsdx', - ], - ], - [ - 'name' => 'DatasetVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '1234', - ], - ], - [ - 'name' => 'JobAction', - 'in' => 'query', - 'schema' => [ - 'description' => '任务操作。', - 'type' => 'string', - 'required' => false, - 'example' => 'SemanticIndex', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页编号。从1开始，默认为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'default' => '20', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '任务状态。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Succeeded' => 'Succeeded', - 'Failed' => 'Failed', - 'Starting' => 'Starting', - 'Running' => 'Running', - 'Deleted' => 'Deleted', - 'Pending' => 'Pending', - 'PartialFailed' => 'PartialFailed', - 'Deleting' => 'Deleting', - 'ManuallyStop' => 'ManuallyStop', - ], - 'example' => 'Running', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。默认DESC。'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], - ], - [ - 'name' => 'SortBy', + 'name' => 'Verbose', 'in' => 'query', - 'schema' => [ - 'description' => '排序参数，默认根据创建时间倒序', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Status' => 'Status', - 'JobAction' => 'JobAction', - 'FinishTime' => 'FinishTime', - 'CreateTime' => 'CreateTime', - ], - 'example' => 'CreateTime', - ], + 'schema' => ['description' => '是否显示默认工作空间的详细信息，目前详细信息包含阶段列表详情（Conditions）。取值如下：'."\n" + .'- false（默认值）：不显示详细信息。'."\n" + .'- true：显示详细信息。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -10591,170 +7386,189 @@ 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', - ], - 'TotalCount' => [ - 'description' => '任务总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'WorkspaceId' => ['title' => '工作空间 ID', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '1234'], + 'WorkspaceName' => ['title' => '项目空间名称， region 内唯一', 'description' => '工作空间名称， 同地域内唯一。', 'type' => 'string', 'example' => 'workspace-example'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '创建UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'GmtModifiedTime' => ['title' => '修改 UTC 时间，日期格式 iso8601', 'description' => '修改UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'DisplayName' => ['title' => '显示名称', 'description' => '工作空间显示名称。', 'type' => 'string', 'example' => 'workspace-example'], + 'Description' => ['title' => '描述', 'description' => '工作空间描述。', 'type' => 'string', 'example' => 'workspace description example'], + 'EnvTypes' => [ + 'title' => '环境，用作判断简单模式还是标准模式，含义见', + 'description' => '工作空间包含的环境，取值如下：'."\n" + .'* 简单模式只有生产环境（prod）。'."\n" + .'* 标准模式包含开发环境（dev）和生产环境（prod）。', + 'type' => 'array', + 'items' => ['description' => '工作空间包含的环境，可能值：'."\n" + ."\n" + .'- dev：开发环境。'."\n" + .'- prod：生产环境。', 'type' => 'string', 'example' => 'prod'], ], - 'DatasetJobs' => [ - 'description' => '数据集任务列表。', + 'Creator' => ['title' => '创建人', 'description' => '创建工作空间的阿里云账号信息。', 'type' => 'string', 'example' => '17915******4216'."\n"], + 'Owner' => [ + 'title' => '拥有者', + 'description' => '创建工作空间的阿里云账号信息。', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '用户id', 'description' => '用户UID。', 'type' => 'string', 'example' => '17915******4216'], + 'UserName' => ['title' => '用户名', 'description' => '用户名。', 'type' => 'string', 'example' => 'username'], + 'UserKp' => ['title' => '用户kp', 'description' => '用户UID。', 'type' => 'string', 'example' => '17915******4216'], + ], + ], + 'Status' => ['title' => '工作空间状态', 'description' => '工作空间状态，可能值：'."\n" + ."\n" + .'- ENABLED：正常。'."\n" + .'- INITIALIZING：初始化中。'."\n" + .'- FAILURE：失败。'."\n" + .'- DISABLED：手动禁用。'."\n" + .'- FROZEN：欠费冻结。'."\n" + .'- UPDATING：项目更新中。', 'type' => 'string', 'example' => 'ENABLED'], + 'Conditions' => [ + 'title' => '任务详情 创建默认工作空间会有多个任务依次进行，如果一个任务未开始，不会显示在任务详情里。', + 'description' => '默认工作空间创建流程的阶段列表详情。', 'type' => 'array', 'items' => [ - 'description' => '数据集任务详情。', - '$ref' => '#/components/schemas/DatasetJob', + 'description' => '默认工作空间创建流程的阶段详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '类型', 'description' => '任务类型，可能值：'."\n" + ."\n" + .'- CREATING：创建中。'."\n" + .'- WORKSPACE_CREATED：工作空间创建完成。'."\n" + .'- MEMBERS_ADDED：成员添加完成。'."\n" + .'- ENABLED：总体完成。', 'type' => 'string', 'example' => 'CREATING '], + 'Code' => ['title' => '返回码，正常是200，其他都是错误', 'description' => '返回码。200表示返回正常，其他表示返回异常。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'Message' => ['title' => '消息', 'description' => '请求返回的错误消息。当返回码为200时，该字段为空。', 'type' => 'string', 'example' => 'Create Failed'], + ], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\",\\n \\"TotalCount\\": 1,\\n \\"DatasetJobs\\": [\\n {\\n \\"DatasetJobId\\": \\"\\",\\n \\"JobAction\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"JobMode\\": \\"\\",\\n \\"JobSpec\\": \\"\\",\\n \\"Logs\\": [\\n \\"\\"\\n ],\\n \\"TotalFileCount\\": 0,\\n \\"CompletedFileCount\\": 0,\\n \\"FailedFileCount\\": 0,\\n \\"DatasetVersion\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取数据集任务列表', - ], - 'DeleteDatasetJobConfig' => [ - 'summary' => '删除数据集任务配置。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', - 'methods' => [ - 'delete', + 'title' => '获取默认工作空间', + 'summary' => '获取默认工作空间详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDefaultWorkspace'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetDefaultWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"DisplayName\\": \\"workspace-example\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Creator\\": \\"17915******4216\\\\n\\",\\n \\"Owner\\": {\\n \\"UserId\\": \\"17915******4216\\",\\n \\"UserName\\": \\"username\\",\\n \\"UserKp\\": \\"17915******4216\\"\\n },\\n \\"Status\\": \\"ENABLED\\",\\n \\"Conditions\\": [\\n {\\n \\"Type\\": \\"CREATING \\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Create Failed\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetExperiment' => [ + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '260472', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '206972', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集id', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wz****c9ks92', - ], - ], - [ - 'name' => 'DatasetJobConfigId', + 'name' => 'ExperimentId', 'in' => 'path', - 'schema' => [ - 'description' => '配置id', - 'type' => 'string', - 'required' => true, - 'example' => 'dscfg-xxxxxxxxxxxx', - ], + 'schema' => ['description' => '实验ID。', 'type' => 'string', 'required' => false, 'example' => 'exp-1zpfthdx******'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Verbose', 'in' => 'query', 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', + 'title' => '是否获取关联到Experiment的最新Run信息', + 'description' => '是否获取关联到Experiment的最新Run信息', + 'type' => 'boolean', 'required' => false, - 'example' => '513663', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'false', + 'default' => 'false', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结果', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA', - ], + 'schema' => ['description' => 'Experiment实例信息', '$ref' => '#/components/schemas/Experiment'], + ], + ], + 'title' => '获取实验详情', + 'summary' => '获取实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'GetExperiment'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiexperiment:GetExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\"\\n}","type":"json"}]', - 'title' => '删除数据集任务配置', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExperimentId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"ArtifactUri\\": \\"\\",\\n \\"TensorboardLogUri\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"GmtCreateTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"ExperimentId\\": \\"exp-890waerw09a0f\\"\\n }\\n ],\\n \\"UserId\\": \\"\\",\\n \\"OwnerId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"LatestRun\\": {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"SourceId\\": \\"train9s0afvjkf\\",\\n \\"SourceType\\": \\"TrainingService\\",\\n \\"WorkspaceId\\": \\"145883\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Name\\": \\"testrun\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"163104*****3440\\",\\n \\"ExperimentId\\": \\"exp-1zpfthdx******\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"run-1qJhzJ2YXgX****\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n }\\n}","type":"json"}]', ], - 'DeleteDatasetJob' => [ - 'summary' => '删除数据集任务。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'GetImage' => [ + 'path' => '/api/v1/images/{ImageId}', + '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' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '260524', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '61616', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'ImageId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5*****jhc9ks92', - ], + 'schema' => ['title' => '镜像id', 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', 'type' => 'string', 'required' => true, 'example' => 'image-4c62******53uor'], ], [ - 'name' => 'DatasetJobId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'dsjob-9jx1******uj9e', - ], + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['title' => '是否显示非必要信息：Labels', 'description' => '是否显示非必要信息，非必要信息目前包含Labels。'."\n" + .'取值如下：'."\n" + .'- false（默认值）：不显示非必要信息。'."\n" + .'- true：显示非必要信息。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -10764,2067 +7578,2269 @@ 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', - 'title' => '删除数据集任务', - ], - 'UpdateDatasetJobConfig' => [ - 'summary' => '更新数据集任务配置。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', - 'methods' => [ - 'put', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '镜像的创建UTC时间，格式ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'GmtModifiedTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '镜像的修改UTC时间，格式ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'Name' => ['title' => '镜像名称', 'description' => '镜像名称。', 'type' => 'string', 'example' => 'nlp-compression'."\n"], + 'Description' => ['title' => '描述', 'description' => '镜像描述。', 'type' => 'string', 'example' => 'NLP model compression training image'], + 'ImageUri' => ['title' => '镜像地址，包含版本号', 'description' => '镜像地址，包含版本号。', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu'."\n"], + 'UserId' => ['title' => '创建人', 'description' => '创建镜像的UID。', 'type' => 'string', 'example' => '15577******8921'], + 'ParentUserId' => ['title' => '创建人父账户', 'description' => '创建者的阿里云账号。', 'type' => 'string', 'example' => '15577******8921'], + 'Labels' => [ + 'title' => '镜像标签', + 'description' => '镜像标签列表，数组类型，数组每一项包含Key和Value两个字段。'."\n" + .'官方镜像带有标签：key为system.official；value为true。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'Key', 'description' => '标签的键。', 'type' => 'string', 'example' => 'system.chipType'."\n"], + 'Value' => ['title' => 'Value', 'description' => '标签的值。', 'type' => 'string', 'example' => 'GPU'], + ], + ], + ], + 'WorkspaceId' => ['title' => '工作空间id', 'description' => '镜像所属的工作空间ID。', 'type' => 'string', 'example' => '15945'], + 'Accessibility' => ['title' => '可见性', 'description' => '镜像的可见性，可能值：'."\n" + .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" + .'- PRIVATE：只有创建者可以操作。', 'type' => 'string', 'example' => 'PUBLIC'], + 'Size' => ['description' => '镜像大小，单位为byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'SourceType' => ['title' => '镜像来源类型', 'description' => '镜像来源类型', 'type' => 'string'], + 'SourceId' => ['title' => '镜像来源 ID', 'description' => '镜像来源 ID', 'type' => 'string'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取镜像', + 'summary' => '获取镜像详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetImage'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiimage:GetImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Name\\": \\"nlp-compression\\\\n\\",\\n \\"Description\\": \\"NLP model compression training image\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu\\\\n\\",\\n \\"UserId\\": \\"15577******8921\\",\\n \\"ParentUserId\\": \\"15577******8921\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\\\n\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"WorkspaceId\\": \\"15945\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"Size\\": 10,\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetInstanceJob' => [ + 'path' => '/api/v1/instancejobs/{InstanceJobId}', + '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' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '260467', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '219742', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集Id', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5*****jhc9ks92', - ], - ], - [ - 'name' => 'DatasetJobConfigId', + 'name' => 'InstanceJobId', 'in' => 'path', - 'schema' => [ - 'description' => '配置id', - 'type' => 'string', - 'required' => true, - 'example' => 'dscfg-xxxxxxxxxxxx', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求Body。', - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => false, - 'example' => '167497', - ], - 'ConfigType' => [ - 'description' => '配置类型'."\n" - ."\n" - .'- MultimodalIntelligentTag'."\n" - ."\n" - .'- MultimodalSemanticIndex', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MultimodalIntelligentTag' => 'MultimodalIntelligentTag', - 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex', - ], - 'example' => 'MultimodalSemanticIndex', - ], - 'Config' => [ - 'description' => '配置内容'."\n" - .'其中配置格式如下：'."\n" - ."\n" - .'- MultimodalIntelligentTag'."\n" - ."\n" - .'{'."\n" - .' "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" - .'}'."\n" - ."\n" - .'- MultimodalSemanticIndex'."\n" - ."\n" - .'{'."\n" - .' "defaultModelId": "xxx"'."\n" - .' "defaultModelVersion":"1.0.0"'."\n" - .'}', - 'type' => 'string', - 'required' => false, - 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => '请求对应的任务ID。', 'type' => 'string', 'required' => true, 'example' => '12345'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9', - ], + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde'], + 'Status' => ['title' => '工作空间状态', 'description' => '任务状态。可取值：'."\n" + .'- Creating：创建中'."\n" + .'- Updating：更新中'."\n" + .'- Deleting：删除中'."\n" + .'- Successful：成功（终态）'."\n" + .'- Failed：失败（终态）', 'type' => 'string', 'example' => 'Successful'], + 'ReasonMessage' => ['title' => '项目空间名称， region 内唯一', 'description' => '任务详情描述。', 'type' => 'string', 'example' => 'workspace-example'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '创建时间。ISO8601 格式的 UTC 时间。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'Type' => ['title' => '修改 UTC 时间，日期格式 iso8601', 'description' => '任务类型。取值：'."\n" + .'- CreateWorkspaceCustomRole'."\n" + .'- UpdateWorkspaceCustomRole'."\n" + .'- DeleteWorkspaceCustomRole', 'type' => 'string', 'example' => 'CreateWorkspaceCustomRole'], + 'InstanceJobId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 'CreateWorkspaceCustomRole-role-***abc*******'."\n"], + 'InstanceId' => ['description' => '任务实例ID。例如在创建自定义角色的任务中是生成的角色ID。', 'type' => 'string', 'example' => '*****12qb3*****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\"\\n}","type":"json"}]', - 'title' => '更新数据集任务配置', - ], - 'UpdateDatasetFileMetas' => [ - 'summary' => '批量更新数据集下的文件元数据记录', - 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', - 'methods' => [ - 'put', + 'title' => '获取任务结果', + 'summary' => '获取任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetInstanceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Status\\": \\"Successful\\",\\n \\"ReasonMessage\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Type\\": \\"CreateWorkspaceCustomRole\\",\\n \\"InstanceJobId\\": \\"CreateWorkspaceCustomRole-role-***abc*******\\\\n\\",\\n \\"InstanceId\\": \\"*****12qb3*****\\"\\n}","type":"json"}]', + ], + 'GetMember' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/member', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '260629', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '36846', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-lfd60v0p****ujtsdx', - ], + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '145883'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求Body。', - 'type' => 'object', - 'properties' => [ - 'DatasetVersion' => [ - 'description' => '数据集版本名。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'WorkspaceId' => [ - 'description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '796**', - ], - 'DatasetFileMetas' => [ - 'description' => '待更新的数据集文件元数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '待更新的文件元数据详情。', - 'required' => false, - '$ref' => '#/components/schemas/DatasetFileMetaConentUpdate', - ], - 'required' => true, - ], - 'TagJobId' => [ - 'description' => '更新数据集文件元数据标签相关联的打标任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'dsjob-hv0b1****u8taig3y', - ], - ], - 'required' => false, - ], + 'name' => 'UserId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '用户id', 'description' => '用户UID。如何查看用户UID，请参见 [ListWorkspaceUsers](~~449133~~)。'."\n" + .'UserId与MemberId必须指定一个，不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '21513926******88039'], + ], + [ + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => ['description' => '成员UID。UserId与MemberId必须指定一个，不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '145883-21513926******88039'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'Status' => [ - 'description' => '本批元数据更新结果的状态。全部成功为true，如果为false，需要查看FailedDetails。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailedDetails' => [ - 'description' => '更新失败的文件元数据列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'UserId' => ['title' => '用户 id', 'description' => '用户ID。', 'type' => 'string', 'example' => '21513926******88039'], + 'MemberName' => ['title' => '云账号用户名', 'description' => '用户名。', 'type' => 'string', 'example' => 'user1'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '创建UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'Roles' => [ + 'title' => '角色列表', + 'description' => '角色列表。', 'type' => 'array', - 'items' => [ - 'description' => '更新失败的文件元数据详情。', - '$ref' => '#/components/schemas/DatasetFileMetaResponse', - ], + 'items' => ['description' => '角色名。角色名和权限的对应关系，请参见[角色及权限列表](https://pai.console.aliyun.com/?spm=api-workbench.API%20Explorer.0.0.7a862392uO09Se®ionId=cn-shanghai#/workspace/permission)。'."\n" + .'角色名可能值：'."\n" + ."\n" + .'- PAI.AlgoDeveloper：算法开发。'."\n" + .'- PAI.AlgoOperator：算法运维。'."\n" + .'- PAI.LabelManager：标注管理员。'."\n" + .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" + .'- PAI.WorkspaceAdmin：管理员。'."\n" + .'- PAI.WorkspaceGuest：访客。'."\n" + .'- PAI.WorkspaceOwner：负责人。', 'type' => 'string', 'example' => 'myRole1'], ], + 'DisplayName' => ['title' => '成员显示名', 'description' => '成员显示名。', 'type' => 'string', 'example' => 'myDisplayName'], + 'MemberId' => ['title' => '成员 id', 'description' => '成员ID。', 'type' => 'string', 'example' => '145883-21513926******88039'."\n"], + 'AccountType' => ['type' => 'string', 'description' => ''], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Result\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '批量更新数据集文件元数据', - ], - 'ListDatasetJobConfigs' => [ - 'summary' => '批量查询数据集任务配置。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/', - 'methods' => [ - 'get', + 'title' => '获取工作空间的成员', + 'summary' => '获取工作空间的成员。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMember'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"UserId\\": \\"21513926******88039\\",\\n \\"MemberName\\": \\"user1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Roles\\": [\\n \\"myRole1\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"145883-21513926******88039\\\\n\\",\\n \\"AccountType\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetModel' => [ + 'path' => '/api/v1/models/{ModelId}', + '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' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '261468', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '133753', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'ModelId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集id', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wz****c9ks92', - ], + 'schema' => ['title' => 'Model Id', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5****c9ks92'], ], - [ - 'name' => 'WorkspaceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '431514', - ], + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'ModelId' => ['title' => '模型ID', 'description' => '模型ID。', 'type' => 'string', 'example' => 'model-rbvg5wzljz****ks92'], + 'ModelName' => ['title' => '模型名称', 'description' => '模型名称。', 'type' => 'string', 'example' => 'Sentiment analysis'], + 'ModelDescription' => ['title' => '模型描述', 'description' => '模型描述。', 'type' => 'string', 'example' => 'General sentiment analysis.'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建模型UTC时间，格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + 'GmtModifiedTime' => ['title' => '最后更新时间', 'description' => '最后更新模型UTC时间，格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + 'UserId' => ['title' => '创建模型的用户ID', 'description' => '用户ID。', 'type' => 'string', 'example' => '1234567890******'], + 'OwnerId' => ['title' => '云账号ID', 'description' => '阿里云账号ID。', 'type' => 'string', 'example' => '1234567890******'], + 'Origin' => ['title' => '模型源', 'description' => '模型源。描述源模型所属社区或组织，例如：ModelScope，HuggingFace等。', 'type' => 'string', 'example' => 'ModelScope'], + 'Provider' => ['title' => '提供者', 'description' => '提供者。', 'type' => 'string', 'example' => 'pai'], + 'Domain' => ['title' => '领域', 'description' => '领域。描述模型解决问题所属领域。例如：nlp（自然语言处理）、cv（计算机视觉）等。', 'type' => 'string', 'example' => 'cv'], + 'Task' => ['title' => '任务', 'description' => '任务。描述模型解决的具体问题，例如：text-classification（文本分类）等。', 'type' => 'string', 'example' => 'text-classification'], + 'ModelDoc' => ['title' => '模型文档', 'description' => '模型文档。', 'type' => 'string', 'example' => 'https://***.md'], + 'Labels' => [ + 'title' => '模型的标签', + 'description' => '模型的标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。', '$ref' => '#/components/schemas/Label'], + ], + 'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '234**'], + 'Accessibility' => ['title' => '可见性', 'description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PUBLIC'], + 'LatestVersion' => ['title' => '模型的最新版本', 'description' => '模型的最新版本。', '$ref' => '#/components/schemas/ModelVersion'], + 'ModelType' => ['title' => '模型类型', 'description' => '模型类型。', 'type' => 'string', 'example' => 'Checkpoint'], + 'ExtraInfo' => ['title' => '其它信息', 'description' => '模型的其它信息。', 'type' => 'object', 'example' => '{'."\n" + .' "RatingCount": 2866,'."\n" + .' "Rating": 4.94,'."\n" + .' "FavoriteCount": 34992,'."\n" + .' "CommentCount": 754,'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" + .' "TippedAmountCount": 32,'."\n" + .' "DownloadCount": 606056'."\n" + .'}'], + 'OrderNumber' => ['title' => '序号', 'description' => '序号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ParameterSize' => ['description' => '参数量，单位M。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000'], + 'GmtLatestVersionModifiedTime' => ['description' => '最后版本的更新时间。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取模型', + 'summary' => '获取指定模型详情信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModel'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'ConfigType', - 'in' => 'query', - 'schema' => [ - 'description' => '配置类型'."\n" - ."\n" - .'- MultimodalIntelligentTag'."\n" - ."\n" - .'- MultimodalSemanticIndex', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MultimodalIntelligentTag' => 'MultimodalIntelligentTag', - 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paimodel:GetModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => 'MultimodalIntelligentTag', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '代码配置列表的页码。起始值为1，默认值为1。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认为10。', - 'type' => 'string', - 'required' => false, - 'example' => '10', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ModelId\\": \\"model-rbvg5wzljz****ks92\\",\\n \\"ModelName\\": \\"Sentiment analysis\\",\\n \\"ModelDescription\\": \\"General sentiment analysis.\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"1234567890******\\",\\n \\"OwnerId\\": \\"1234567890******\\",\\n \\"Origin\\": \\"ModelScope\\",\\n \\"Provider\\": \\"pai\\",\\n \\"Domain\\": \\"cv\\",\\n \\"Task\\": \\"text-classification\\",\\n \\"ModelDoc\\": \\"https://***.md\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"WorkspaceId\\": \\"234**\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/\\",\\n \\"VersionDescription\\": \\"情感分析。\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"{}\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"DatasetId\\": \\"d-sdkjanksaklerhfd\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.175\\n }\\n },\\n {\\n \\"Dataset\\": {\\n \\"Uri\\": \\"oss://xxxx/\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.172\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"DistillationSpec\\": {}\\n },\\n \\"ModelType\\": \\"Checkpoint\\",\\n \\"ExtraInfo\\": {\\n \\"RatingCount\\": 2866,\\n \\"Rating\\": 4.94,\\n \\"FavoriteCount\\": 34992,\\n \\"CommentCount\\": 754,\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png\\"\\n ],\\n \\"TippedAmountCount\\": 32,\\n \\"DownloadCount\\": 606056\\n },\\n \\"OrderNumber\\": 1,\\n \\"ParameterSize\\": 3000,\\n \\"GmtLatestVersionModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\"\\n}","type":"json"}]', + ], + 'GetModelVersion' => [ + 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DatasetVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '数据集版本名。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '133779', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], + ], + 'parameters' => [ + [ + 'name' => 'ModelId', + 'in' => 'path', + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wzljz****ks92'], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['title' => '模型版本', 'description' => '模型版本。', 'type' => 'string', 'required' => true, 'example' => '1.0.1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建模型UTC时间，格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + 'GmtModifiedTime' => ['title' => '最后更新时间', 'description' => '最后更新模型UTC时间，格式ISO8601。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], + 'UserId' => ['title' => '创建者ID', 'description' => '用户ID。', 'type' => 'string', 'example' => '1234567890******'], + 'OwnerId' => ['title' => '云账号ID', 'description' => '阿里云账号ID。', 'type' => 'string', 'example' => '1234567890******'], + 'Uri' => ['title' => '模型Uri', 'description' => '模型版本URI，即模型存储位置。可能值为：'."\n" + .'- 模型的HTTP（S）地址，例如：`https://myweb.com/mymodel.tar.gz`。'."\n" + .'- 如果模型存储在OSS中，格式为`oss://./object`。其中endpoint配置，请参见[访问域名和数据中心](~~31837~~)，例如：`oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`。', 'type' => 'string', 'example' => 'oss://t***.cn-beijing.oss.aliyuncs.com/mod**/'], + 'Labels' => [ + 'title' => '模型版本标签', + 'description' => '模型版本标签列表。', + 'type' => 'array', + 'items' => ['description' => '标签。', '$ref' => '#/components/schemas/Label'], + ], + 'Options' => ['title' => '扩展字段', 'description' => '扩展字段。JsonString类型。', 'type' => 'string', 'example' => '{}'], + 'VersionName' => ['title' => '版本名', 'description' => '模型版本。', 'type' => 'string', 'example' => '0.1.0'], + 'VersionDescription' => ['title' => '版本描述', 'description' => '模型版本描述。', 'type' => 'string', 'example' => 'General sentiment analysis.'], + 'TrainingSpec' => ['title' => '训练配置', 'description' => '训练配置。用于微调，增量训练的配置。', 'type' => 'object', 'example' => '{}'], + 'InferenceSpec' => ['title' => '下游部署配置', 'description' => '描述如何应用于下游的推理服务：例如描述EAS的processor、container等。', 'type' => 'object', 'example' => '{'."\n" + .' "Processor": "tensorflow_gpu_1.12"'."\n" + .'}'], + 'FormatType' => [ + 'title' => '模型格式', + 'description' => '模型格式，可能值：'."\n" + .'- OfflineModel'."\n" + .'- SavedModel'."\n" + .'- Keras H5'."\n" + .'- Frozen Pb'."\n" + .'- Caffe Prototxt'."\n" + .'- TorchScript'."\n" + .'- XGBoost'."\n" + .'- PMML'."\n" + .'- AlinkModel'."\n" + .'- ONNX', 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', + 'enumValueTitles' => ['OfflineModel' => 'OfflineModel', 'SavedModel' => 'SavedModel', 'Keras H5' => 'Keras H5', 'Frozen Pb' => 'Frozen Pb', 'Caffe Prototxt' => 'Caffe Prototxt', 'TorchScript' => 'TorchScript', 'XGBoost' => 'XGBoost', 'PMML' => 'PMML', 'AlinkModel' => 'AlinkModel', 'ONNX' => 'ONNX'], + 'example' => 'SavedModel', ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', + 'FrameworkType' => [ + 'title' => '模型框架', + 'description' => '模型框架，可能值：'."\n" + .'- Pytorch'."\n" + .'-XGBoost'."\n" + .'- Keras'."\n" + .'- Caffe'."\n" + .'- Alink'."\n" + .'- Xflow'."\n" + .'- TensorFlow', + 'type' => 'string', + 'enumValueTitles' => ['Pytorch' => 'Pytorch', 'XGBoost' => 'XGBoost', 'Keras' => 'Keras', 'Caffe' => 'Caffe', 'Alink' => 'Alink', 'Xflow' => 'Xflow', 'TensorFlow' => 'TensorFlow'], + 'example' => 'TensorFlow', ], - 'DatasetJobConfigs' => [ - 'description' => '数据集任务配置列表', - 'type' => 'array', - 'items' => [ - 'description' => '数据集任务配置', - '$ref' => '#/components/schemas/DatasetJobConfig', - ], + 'SourceType' => [ + 'title' => '来源类型', + 'description' => '模型来源类型，可能值：'."\n" + .'- Custom：自定义。'."\n" + .'- PAIFlow：PAI工作流。'."\n" + .'- TrainingService：PAI训练服务。', + 'type' => 'string', + 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], + 'example' => 'PAIFlow', ], + 'SourceId' => ['title' => '来源ID', 'description' => '来源ID。'."\n" + .'* 来源类型为Custom时，该字段不做限制。'."\n" + .'* 来源为PAIFlow、TrainingService时，格式为 '."\n" + .'```'."\n" + .'region=,workspaceId=,kind=,id='."\n" + .'```'."\n" + .'其中：'."\n" + .'- region为阿里云区域ID。'."\n" + .'- workspaceId为工作空间ID。'."\n" + .'- kind：为类型。取值：PipelineRun（PAIFlow工作流）；ServiceJob（训练服务）。'."\n" + .'- id：为唯一标识。', 'type' => 'string', 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], + 'ApprovalStatus' => ['title' => '准入状态', 'description' => '准入状态，取值如下：'."\n" + .'- Pending：待定。'."\n" + .'- Approved：允许上线。'."\n" + .'- Rejected：不允许上线。', 'type' => 'string', 'example' => 'Approved'], + 'EvaluationSpec' => ['title' => '评测配置', 'description' => '评测配置', 'type' => 'object', 'example' => '{}'], + 'CompressionSpec' => ['title' => '压缩配置', 'description' => '压缩配置', 'type' => 'object', 'example' => '{}'], + 'ExtraInfo' => ['title' => '其它信息', 'description' => '其它信息。', 'type' => 'object', 'example' => '{'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" + .' "TrainedWords": ["albedo_overlord"]'."\n" + .'}'], + 'Metrics' => ['title' => '指标', 'description' => '指标', 'type' => 'object', 'example' => '{}'], + 'DistillationSpec' => ['description' => '蒸馏配置。', 'type' => 'object', 'example' => '{}'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取模型版本', + 'summary' => '获取模型版本。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModelVersion'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paimodel:GetModelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 15,\\n \\"DatasetJobConfigs\\": [\\n {\\n \\"DatasetJobConfigId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ModifyTime\\": \\"\\",\\n \\"ConfigType\\": \\"\\",\\n \\"Config\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"DatasetVersion\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取数据集任务配置列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"1234567890******\\",\\n \\"OwnerId\\": \\"1234567890******\\",\\n \\"Uri\\": \\"oss://t***.cn-beijing.oss.aliyuncs.com/mod**/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{}\\",\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"VersionDescription\\": \\"General sentiment analysis.\\",\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"Processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"Metrics\\": {},\\n \\"DistillationSpec\\": {}\\n}","type":"json"}]', ], - 'ListDatasetFileMetas' => [ - 'summary' => '查询数据集文件列表。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetPermission' => [ + 'summary' => '获取工作空间的权限。', + 'path' => '/api/v1/workspaces/{WorkspaceId}/permissions/{PermissionCode}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '259940', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '14248', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5*****jhc9ks92', - ], + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ - 'name' => 'DatasetVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '数据集版本名。', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'name' => 'PermissionCode', + 'in' => 'path', + 'schema' => ['title' => '权限 code', 'description' => '权限点的名字，region内唯一。权限点介绍，请参见[附录：角色及权限列表](~~2840449~~)。 如何获取权限点名称，请参见[ListPermissions](~~449132~~)。', 'type' => 'string', 'required' => true, 'example' => 'PaiDLC:GetTensorboard'."\n"], ], [ - 'name' => 'WorkspaceId', + 'name' => 'Accessibility', 'in' => 'query', - 'schema' => [ - 'description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '105173', - ], + 'schema' => ['title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', 'description' => '访问类型，取值如下。'."\n" + ."\n" + .'- PUBLIC：当前工作空间所有成员都可以访问。'."\n" + .'- PRIVATE：只有创建者可以访问。', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], ], [ - 'name' => 'QueryType', + 'name' => 'Creator', 'in' => 'query', - 'schema' => [ - 'description' => '检索类型。'."\n" - .'* MIX：混合检索（默认值）。'."\n" - .'* TAG：仅标签检索。'."\n" - .'* VECTOR：仅向量检索。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TAG' => 'TAG', - 'MIX' => 'MIX', - 'VECTOR' => 'VECTOR', - ], - 'example' => 'MIX', - ], + 'schema' => ['title' => '创建者', 'description' => '工作空间权限创建者的阿里云账号UID。', 'type' => 'string', 'required' => false, 'example' => '17915******4216'], ], [ - 'name' => 'QueryText', + 'name' => 'Resource', 'in' => 'query', - 'schema' => [ - 'description' => '待搜索文本内容。', - 'type' => 'string', - 'required' => false, - 'example' => 'A fallen water', - ], + 'schema' => ['description' => '资源。', 'type' => 'string', 'required' => false, 'example' => 'job/dlc-ksd******s12'], ], [ - 'name' => 'TopK', + 'name' => 'Option', 'in' => 'query', - 'schema' => [ - 'description' => '检索结果返回数量，最多只返回TopK个检索结果。'."\n" - .'> 当QueryType=VECTOR或MIX时有效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '5000', - 'minimum' => '1', - 'example' => '100', - 'default' => '10', - ], + 'schema' => ['description' => '可选配置，多个配置用英文逗号（,）分隔，取值：'."\n" + .'- ResourceEmpty：资源为空。如果Resource没有设置，则为空。'."\n" + .'- DisableRam：不进行RAM检查。', 'type' => 'string', 'required' => false, 'example' => 'ResourceEmpty,DisableRam'], ], [ - 'name' => 'ScoreThreshold', + 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => '相似度分数过滤。只返回大于ScoreThreshold的结果。'."\n" - .'> 当QueryType=VECTOR或MIX时有效。', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.6', - ], + 'style' => 'json', + 'schema' => ['type' => 'object', 'required' => false, 'description' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'CallerUid', 'in' => 'query', - 'schema' => [ - 'description' => '每页数量。如果同时传入MaxResults，则以MaxResults数量为准。'."\n" - .'> 该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。', - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => true, - 'required' => false, - 'example' => '10', - ], + 'schema' => ['type' => 'string'], ], [ - 'name' => 'NextToken', + 'name' => 'CallerType', 'in' => 'query', - 'schema' => [ - 'description' => '分页游标标识。'."\n" - .'> '."\n" - .'> 如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的NextToken作为参数再次请求获得下一页的数据，直到返回为Null为止，表示获取到了所有的数据。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '90a6ee35-****-4cd4-927e-1f45e1cb8b62_1729644433000', - ], + 'schema' => ['type' => 'string'], ], [ - 'name' => 'SortBy', + 'name' => 'CallerAccessKeyId', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时的排序字段，缺省时按检索时相关性由高到低排序。其他取值如下。'."\n" - .'* FileCreateTime：按文件创建时间。'."\n" - .'* FileUpdateTime：按文件最后修改时间。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'FileCreateTime' => 'FileCreateTime', - 'FileUpdateTime' => 'FileUpdateTime', - ], - 'example' => 'FileCreateTime', - ], + 'schema' => ['type' => 'string'], ], [ - 'name' => 'Order', + 'name' => 'CallerSecurityToken', 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。默认DESC。'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => 'ASC', - 'DESC' => 'DESC', + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'PermissionCode' => ['title' => '权限', 'description' => '权限点的名字，同地域内唯一。权限点介绍，请参见[附录：角色及权限列表](~~2840449~~)。', 'type' => 'string', 'example' => 'PaiDLC:ListJobs'], + 'PermissionRules' => [ + 'description' => '权限规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限规则。', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => ['title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', 'description' => '访问类型，可能值：'."\n" + ."\n" + .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" + .'- PRIVATE：只有创建者可以操作。'."\n" + .'- ANY：创建者和非创建者都可以操作。', 'type' => 'string', 'example' => 'PRIVATE'], + 'EntityAccessType' => ['title' => '存取类型 CREATOR 代表能看自已创建的 OTHERS 代表可以看别人创建的 ALL代表所有', 'description' => '存取类型。'."\n" + .'当Accessibility为PUBLIC，所有用户都能操作，此值无效；'."\n" + .'当Accessibility为PRIVATE，EntityAccessType支持如下值：'."\n" + .'- CREATOR：只有创建者可以操作。'."\n" + .'- ANY：创建者和非创建者都可以操作。', 'type' => 'string', 'example' => 'CREATOR'], + ], + ], + ], ], - 'example' => 'DESC', ], ], + ], + 'title' => '获取工作空间的权限', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPermission'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'EndFileUpdateTime', - 'in' => 'query', - 'schema' => [ - 'description' => '用于指定查询的起始文件更新时间。ISO 8601 格式的 UTC 时间戳。', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'required' => false, - 'example' => '2025-01-12T14:36:01.000Z'."\n", + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:AdministratePAI', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"PermissionCode\\": \\"PaiDLC:ListJobs\\",\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetRun' => [ + 'path' => '/api/v1/runs/{RunId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'StartFileUpdateTime', - 'in' => 'query', - 'schema' => [ - 'description' => '用于指定查询的结束文件更新时间。ISO 8601 格式的 UTC 时间戳。', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'required' => false, - 'example' => '2025-01-12T14:36:01.000Z'."\n", - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '233505', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, + ], + 'parameters' => [ [ - 'name' => 'QueryImage', - 'in' => 'query', - 'schema' => [ - 'description' => '以图搜图时，该参数传入图片的信息。'."\n" - .'* 支持传入图片的可公网访问的oss url格式。格式为：oss://{bucket_name}/{object_path}。其中bucket_name为bucket名称，object_path为文件在bucket中的路径。'."\n" - .'> 当QueryType=VECTOR或MIX时有效。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://test-xxx-oss/car/0001.png', - ], + 'name' => 'RunId', + 'in' => 'path', + 'schema' => ['description' => '运行ID', 'type' => 'string', 'required' => true, 'example' => 'run-1qJhzJ2YXgX****'], ], [ - 'name' => 'ThumbnailMode', + 'name' => 'Verbose', 'in' => 'query', - 'schema' => [ - 'description' => '图片缩略图的模式，当前仅OSS文件支持缩略图：'."\n" - .'- 等比例缩小: p_{percentage}, percentage表示期望的缩放比例，取值范围为[1, 100] 。示例：p_50表示使用原始文件的50%大小作为缩略图。'."\n" - .'- 宽度固定，高度自适应缩小: w_{width}, width表示期望的图片宽度，取值范围为[1, 16384]。示例：w_200表示将图片宽度固定为200像素，高度自适应进行缩小。'."\n" - .'- 高度固定，宽度自适应缩小：h_{height}, height表示期望的图片高度，取值范围为[1, 16384]。示例：h_100表示将图片高度固定为100像素，宽度自适应进行缩小。'."\n" - .'- 固定宽高，缩略填充：m_pad,w_{height},h_{height},color_{RGB}, m_pad表示图片缩放为指定w与h的矩形内的最大图片，RGB表示指定居中填充空白部分的颜色，若不设置该参数，默认用白色填充。width表示期望的图片宽度，height表示期望的图片高度。width和height的取值范围都为[1,16384]。示例:'."\n" - .'- 固定宽高，居中裁剪：m_fill,w_{width},h_{height}。m_fill表示图片等比缩放为延伸出指定w与h的矩形框外的最小图片，超出的部分进行居中裁剪。width表示期望的图片宽度，height表示期望的图片高度。width和height的取值范围都为[1,16384]示例：m_fill,w_100,h_100表示将图片宽度和高度都固定为100像素进行居中裁剪缩放。'."\n" - .'- 强制宽高缩放: m_fixed,w_{height},h_{height}，width表示期望的图片宽度，height表示期望的图片高度。width和height的取值范围都为[1,16384]。示例：m_fixed,w_100,h_100表示将图片宽度和高度都固定为100像素进行强制宽高缩放。', - 'type' => 'string', - 'required' => false, - 'example' => 'w_100', - ], + 'schema' => ['title' => '是否获取Metrics, Params, Labels信息', 'description' => '是否获取Metrics, Params, Labels信息；非必填，默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'Run实例信息', '$ref' => '#/components/schemas/Run'], + ], + ], + 'title' => '获取Run详情', + 'summary' => '获取Run详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'GetRun'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'DatasetFileMetaIds', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'simple', - 'schema' => [ - 'description' => '要查询的元数据ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '元数据ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5dc037c8ec0a6fc4e15741328e531bbee036exxxxxxxxx722eff66c38a90e08c', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiexperiment:GetRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 20, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"SourceId\\": \\"train9s0afvjkf\\",\\n \\"SourceType\\": \\"TrainingService\\",\\n \\"WorkspaceId\\": \\"145883\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Name\\": \\"testrun\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"163104*****3440\\",\\n \\"ExperimentId\\": \\"exp-1zpfthdx******\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"run-1qJhzJ2YXgX****\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'GetWorkspace' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'QueryTagsIncludeAll', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'simple', - 'schema' => [ - 'description' => '表示“同时包含以下标签”检索条件。用户可以选择多个标签，查询结果必须同时满足这些标签。如果为空，则不应用此条件。数组使用逗号分隔。'."\n" - ."\n" - .'> 当QueryType=TAG或MIX时有效。当QueryType=TAG时会将QueryText加入到该条件下。', - 'type' => 'array', - 'items' => [ - 'description' => '标签名。', - 'type' => 'string', - 'required' => false, - 'example' => 'Lane line', - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '14101', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], + ], + 'parameters' => [ [ - 'name' => 'QueryTagsIncludeAny', + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '12345'], + ], + [ + 'name' => 'Verbose', 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'simple', + 'schema' => ['description' => '是否显示工作空间Owner等补充信息。取值如下：'."\n" + .'- false（默认值）：不显示补充信息。'."\n" + .'- true：显示补充信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '表示“包含以下任意标签”检索条件。 用户可以选择多个标签，查询结果只需满足其中一个即可。 如果为空，则不应用此条件。数组使用逗号分隔。'."\n" - .'> 当QueryType=TAG或MIX时有效。', - 'type' => 'array', - 'items' => [ - 'description' => '标签名。', - 'type' => 'string', - 'required' => false, - 'example' => 'Lane line', + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C'], + 'WorkspaceId' => ['title' => '工作空间 id', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '1234'], + 'WorkspaceName' => ['title' => '项目空间名称， region 内唯一', 'description' => '工作空间名称。', 'type' => 'string', 'example' => 'workspace-example'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '工作空间创建UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'GmtModifiedTime' => ['title' => '修改 UTC 时间，日期格式 iso8601', 'description' => '工作空间修改UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'DisplayName' => ['title' => '显示名称', 'description' => '工作空间显示名称。', 'type' => 'string', 'example' => 'workspace-example'], + 'Description' => ['title' => '描述', 'description' => '工作空间描述。', 'type' => 'string', 'example' => 'workspace description example'], + 'EnvTypes' => [ + 'title' => '环境，用作判断简单模式还是标准模式', + 'description' => '工作空间包含的环境，取值如下：'."\n" + ."\n" + .'* 简单模式只有生产环境（prod）。'."\n" + .'* 标准模式包含开发环境（dev）和生产环境（prod）。', + 'type' => 'array', + 'items' => ['description' => '环境类型，可能值：'."\n" + ."\n" + .'- dev：开发环境。'."\n" + .'- prod：生产环境。', 'type' => 'string', 'example' => 'prod'], + ], + 'Creator' => ['title' => '创建人', 'description' => '创建者用户ID。', 'type' => 'string', 'example' => '1157******94123'], + 'Status' => ['title' => '工作空间状态', 'description' => '工作空间状态，可能值：'."\n" + ."\n" + .'- ENABLED：正常。'."\n" + .'- INITIALIZING：初始化中。'."\n" + .'- FAILURE：失败。'."\n" + .'- DISABLED：手动禁用。'."\n" + .'- FROZEN：欠费冻结。'."\n" + .'- UPDATING：项目更新中。', 'type' => 'string', 'example' => 'ENABLED'], + 'AdminNames' => [ + 'title' => '管理员账户', + 'description' => '管理员账户名称列表。', + 'type' => 'array', + 'items' => ['description' => '管理员账户名称。当Verbose为true时显示。', 'type' => 'string', 'example' => 'demo_test@***.aliyunid.com'], + ], + 'IsDefault' => ['title' => '是否为默认工作空间', 'description' => '是否为默认工作空间，可能值：'."\n" + .'- false：不是默认工作空间。'."\n" + .'- true：是默认工作空间。', 'type' => 'boolean', 'example' => 'true'], + 'ExtraInfos' => ['title' => '附加信息', 'description' => '附加信息，目前包含TenantId（租户ID）。', 'type' => 'object', 'example' => '{"TenantId": "4286******98"}'], + 'Owner' => [ + 'description' => '工作空间所有者信息，当Verbose为true时显示。', + 'type' => 'object', + 'properties' => [ + 'UserKp' => ['description' => '用户UID。', 'type' => 'string', 'example' => '1157******94123'], + 'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '1157******94123'], + 'UserName' => ['description' => '用户名。', 'type' => 'string', 'example' => 'mings****t'], + 'DisplayName' => ['description' => '显示名。', 'type' => 'string', 'example' => 'mings****t'], + ], + ], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfmwp7rkyq****'], ], - 'required' => false, ], ], + ], + 'title' => '获取工作空间', + 'summary' => '获取工作空间详细信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'QueryTagsExclude', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'simple', - 'schema' => [ - 'description' => '表示“排除以下标签”检索条件。用户可以选择多个标签，查询结果中不能包含这些标签。如果为空，则不应用此条件。'."\n" - .'> 当QueryType=TAG或MIX时有效。', - 'type' => 'array', - 'items' => [ - 'description' => '标签名。', - 'type' => 'string', - 'required' => false, - 'example' => 'Lane line', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"DisplayName\\": \\"workspace-example\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Creator\\": \\"1157******94123\\",\\n \\"Status\\": \\"ENABLED\\",\\n \\"AdminNames\\": [\\n \\"demo_test@***.aliyunid.com\\"\\n ],\\n \\"IsDefault\\": true,\\n \\"ExtraInfos\\": {\\n \\"TenantId\\": \\"4286******98\\"\\n },\\n \\"Owner\\": {\\n \\"UserKp\\": \\"1157******94123\\",\\n \\"UserId\\": \\"1157******94123\\",\\n \\"UserName\\": \\"mings****t\\",\\n \\"DisplayName\\": \\"mings****t\\"\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmwp7rkyq****\\"\\n}","type":"json"}]', + ], + 'GetWorkspaceRole' => [ + 'summary' => '获取工作空间角色', + 'path' => '/api/v1/workspaces/{WorkspaceId}/roles/{RoleId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'QueryFileName', - 'in' => 'query', - 'schema' => [ - 'description' => '文件名检索条件。支持模糊检索。', - 'type' => 'string', - 'required' => false, - 'example' => 'car', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '221948', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], + ], + 'parameters' => [ [ - 'name' => 'QueryFileDir', - 'in' => 'query', - 'schema' => [ - 'description' => '文件目录检索条件。支持模糊检索。', - 'type' => 'string', - 'required' => false, - 'example' => 'cars/20250221/', - ], + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '镜像id', 'description' => '工作空间ID。可通过 [ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'image-tzi7f9czc0cxs9s45t'], ], [ - 'name' => 'QueryFileTypeIncludeAny', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'RoleId', + 'in' => 'path', + 'schema' => ['description' => '自定义角色ID。', 'type' => 'string', 'required' => false, 'example' => 'role-sw******2tij'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '表示“包含以下任意文件类型”检索条件。用户可以选择多个文件类型，查询结果只需满足其中一个即可。如果为空，则不应用此条件。数组使用逗号分隔。', - 'type' => 'array', - 'items' => [ - 'description' => '文件类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'image', + 'title' => 'Schema of Response', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A519F77D-28A0-52F5-AB82-5********8'], + 'RoleName' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '角色名称。', 'type' => 'string', 'example' => 'dev-test'], + 'RoleId' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '角色ID。', 'type' => 'string', 'example' => 'role-dhg*******'."\n"], + 'GmtCreateTime' => ['title' => '镜像名称', 'description' => '创建时间。ISO8601 格式的 UTC 时间。', 'type' => 'string', 'example' => '2025-06-11T08:58:35.438Z'], + 'GmtModifiedTime' => ['title' => '描述', 'description' => '修改时间。ISO8601 格式的 UTC 时间。', 'type' => 'string', 'example' => '2026-03-27T02:26:33.872Z'], + 'Creator' => ['title' => '镜像地址，包含版本号', 'description' => '创建者的阿里云账号UID。', 'type' => 'string', 'example' => '2680******4103'], + 'ModulePermissions' => ['description' => '角色权限配置。', '$ref' => '#/components/schemas/ModulePermissions'], + 'Status' => ['description' => '任务状态。'."\n" + .'- Creating：创建中'."\n" + .'- Updating：更新中'."\n" + .'- Deleting：删除中'."\n" + .'- Successful：成功（终态）'."\n" + .'- Failed：失败（终态）', 'type' => 'string', 'example' => 'Successful'], ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取自定义角色详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'QueryContentTypeIncludeAny', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '表示“包含以下任意文件内容类型”检索条件。用户可以选择多个文件内容类型，查询结果只需满足其中一个即可。如果为空，则不应用此条件。数组使用逗号分隔。', - 'type' => 'array', - 'items' => [ - 'description' => '文件内容类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'image/jpeg', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetWorkspaceRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A519F77D-28A0-52F5-AB82-5********8\\",\\n \\"RoleName\\": \\"dev-test\\",\\n \\"RoleId\\": \\"role-dhg*******\\\\n\\",\\n \\"GmtCreateTime\\": \\"2025-06-11T08:58:35.438Z\\",\\n \\"GmtModifiedTime\\": \\"2026-03-27T02:26:33.872Z\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"ModulePermissions\\": [\\n {\\n \\"ModuleName\\": \\"PaiDesigner\\",\\n \\"PermissionType\\": \\"ReadOnly\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionCodes\\": [\\n \\"PaiDLC:GetTensorboard\\"\\n ],\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Status\\": \\"Successful\\"\\n}","type":"json"}]', + ], + 'ListCodeSources' => [ + 'summary' => '查询代码配置列表，支持分页、排序和按条件过滤。', + 'path' => '/api/v1/codesources', + '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' => '55462', + 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], + ], + 'parameters' => [ [ - 'name' => 'StartTagUpdateTime', + 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'description' => '用于指定查询的起始标签最后更新时间。ISO 8601 格式的 UTC 时间戳。', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'required' => false, - 'example' => '2025-01-12T14:36:01.000Z'."\n", - ], + 'schema' => ['title' => '代码源显示名称，支持模糊匹配', 'description' => '代码配置的显示名称，支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'MyDataSource'], ], [ - 'name' => 'EndTagUpdateTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '用于指定查询的结束标签最后更新时间。ISO 8601 格式的 UTC 时间戳。', - 'type' => 'string', - 'format' => 'iso8601_normal', - 'required' => false, - 'example' => '2025-01-12T14:36:01.000Z'."\n", - ], + 'schema' => ['title' => '取第几页的数据', 'description' => '代码配置列表的页码。起始值为1，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'MaxResults', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '使用NextToken方式查询时，每次最多返回的结果数。取值范围：1~100。默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '分页大小', 'description' => '分页查询时设置的每页行数。默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'QueryExpression', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => '查询语句（DSL）是一种用于表达复杂检索条件的领域特定语言。它支持分组、布尔逻辑（AND/OR/NOT）、范围比较（>, >=, <, <=）、属性存在性（HAS/NOT HAS）、分词匹配（:）与精确匹配（=）等，适用于高级检索场景。'."\n" - .'一般用于较为复杂的高级检索条件。'."\n" - .'为避免冲突，设置该查询语句后，建议不要与其他查询参数混用', + 'title' => '用于排序的字段名，可选字段名："DisplayName" "GmtCreateTime" "GmtModifyTime"', + 'description' => '用于排序的字段名，取值如下：'."\n" + .'- GmtModifyTime：代码源修改时间。'."\n" + .'- DisplayName：展示名称。'."\n" + .'- CodeSourceId：代码源ID。'."\n" + .'- GmtCreateTime（默认值）：代码源创建时间。', 'type' => 'string', 'required' => false, - 'example' => '(FileUpdateTime > \'2025-02-28T00:00:00Z\' AND FileUpdateTime < \'2025-05-30T09:27:29Z\') AND FileDir:\'blue_car\' AND NOT FileName="toyota.jpg" AND (( Tags.all=\'lane line\' AND Tags.all=\'barrier gate\') OR NOT Tags.user=\'rainy days\' ) AND HAS SemanticIndexJobId AND Content:\'a fallen water horse\' AND TopK=100 AND SignMode=\'PUBLIC\'', + 'enumValueTitles' => [], + 'example' => 'GmtModifyTime', ], ], [ - 'name' => 'Status', + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'description' => '指定要查询的元数据状态'."\n" - .'* ACTIVE: 仅查询未删除数据(缺省)'."\n" - .'* ALL: 查询全部数据'."\n" - .'* DELETED: 仅查询已逻辑删除数据', + 'title' => '排序顺序, 枚举值 desc 或者 asc', + 'description' => '分页查询时，对指定的排序字段进行升序或降序。取值：'."\n" + .'- ASC（默认值）：升序。'."\n" + .'- DESC：降序', 'type' => 'string', 'required' => false, - 'example' => 'ACTIVE', - 'enum' => [ - 'ACTIVE', - 'ALL', - 'DELETED', - ], + 'enumValueTitles' => [], + 'example' => 'desc', ], ], [ - 'name' => 'QueryVideo', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '以视频搜索时，该参数传入视频文件的信息。'."\n" - .'* 支持传入视频的可公网访问的oss url格式。格式为：oss://{bucket_name}/{object_path}。其中bucket_name为bucket名称，object_path为文件在bucket中的路径。'."\n" - .'> 当QueryType=VECTOR或MIX时有效。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://test-xxx-oss/car/0001.mp4', - ], + 'schema' => ['title' => '工作空间ID', 'description' => '工作空间ID（必填）。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '1234'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '返回数据总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'PageSize' => [ - 'description' => '当前页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => true, - 'example' => '30', - ], - 'NextToken' => [ - 'description' => '分页游标的标识。如果匹配查询条件的返回结果超过了分页大小，则会返回这个分页游标。如果需要获取下一页数据，将返回的游标值作为请求参数即可，直到无游标值返回，表示已经获取了全部数据。', - 'type' => 'string', - 'example' => '90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000', - ], - 'DatasetFileMetas' => [ - 'description' => '数据集文件元数据详情列表。', + 'CodeSources' => [ + 'title' => '代码源配置列表', + 'description' => '代码源配置列表。', 'type' => 'array', - 'items' => [ - 'description' => '数据集文件元数据详情。', - '$ref' => '#/components/schemas/DatasetFileMeta', - ], - ], - 'DatasetId' => [ - 'description' => '数据集ID。', - 'type' => 'string', - 'example' => 'd-rbvg5*****jhc9ks92'."\n", - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '105173', - ], - 'DatasetVersion' => [ - 'description' => '数据集版本名。', - 'type' => 'string', - 'example' => 'v1', - ], - 'MaxResults' => [ - 'description' => '使用NextToken方式查询时，每次最多返回的结果数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'items' => ['description' => '代码配置详情。', '$ref' => '#/components/schemas/CodeSourceItem'], ], + 'TotalCount' => ['title' => '符合过滤条件的代码源配置的总数量', 'description' => '符合过滤条件的代码源配置的总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'RequestId' => ['title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 123,\\n \\"PageSize\\": 30,\\n \\"NextToken\\": \\"90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000\\",\\n \\"DatasetFileMetas\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Uri\\": \\"oss://test-bucket/dataset/car.png\\",\\n \\"FileName\\": \\"car.png\\",\\n \\"DownloadUrl\\": \\"\\",\\n \\"Score\\": 0.6,\\n \\"DataSize\\": 12,\\n \\"FileFingerPrint\\": \\"\\",\\n \\"FileUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"Tags\\": \\"\\",\\n \\"ThumbnailUrl\\": \\"\\",\\n \\"MetaAttributes\\": \\"{ \\\\\\"ImageHeight\\\\\\": 400, \\\\\\"ImageWidth\\\\\\": 800 }\\",\\n \\"SyncTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"TagUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"SemanticIndexJobId\\": \\"\\",\\n \\"SemanticIndexUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileCreateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"DatasetId\\": \\"d-rbvg5*****jhc9ks92\\\\n\\",\\n \\"WorkspaceId\\": \\"105173\\",\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', - 'title' => '获取数据集文件元数据列表', - 'requestParamsDescription' => '## DSL查询语法说明'."\n" - ."\n" - .'| keyword | 说明 | 范例 |'."\n" - .'|------------------|----------------------------------------------------------------------|----------------------------------------------------------------------|'."\n" - .'| : | 分词匹配 | `FileName:\'车道线\'`
查找文件名分词后包含“车道线”的数据 |'."\n" - .'| NOT : | 分词不匹配 | `NOT FileName : \'车道线\'`
查找文件名分词后不包含“车道线”的数据 |'."\n" - .'| = | 精确值匹配 | `FileType=\'image\'`
查找文件类型为“image”的数据（精确匹配） |'."\n" - .'| NOT = | 精确值排除 | `NOT FileType = \'video\'`
查找所有FileType不等于"video"的数据 |'."\n" - .'| HAS | 存在 | `HAS SemanticIndexJobId`
查找所有存在SemanticIndexJobId属性的数据 |'."\n" - .'| NOT HAS | 不存在 | `NOT HAS SemanticIndexJobId`
查找所有不存在SemanticIndexJobId属性的数据 |'."\n" - .'| "" | 对值的字符串类型进行包裹 | 单双引号效果一致 |'."\n" - .'| () | 分组操作 | `(FileName:\'black\' AND ContentType=\'image/jpeg\') OR (FileName:\'white\' AND ContentType=\'image/png\')`
查找FileName为模糊匹配black并且ContentType为image/jpeg 或者 FileName为模糊匹配white并且ContentType为image/png |'."\n" - .'| > | 范围查询：
大于 | `FileUpdateTime> \'2025-01-16T11:52:56.000Z\' AND DataSize >= 12345`
文件最后修改时间在2025-01-16T11:52:56.000Z之后的并且文件大小大于等于12345字节 |'."\n" - .'| >= | 范围查询：
大于等于 | 同上 |'."\n" - .'| < | 范围查询：
小于 | `FileUpdateTime < \'2025-01-16T11:52:56.000Z\' AND DataSize <= 12345`
文件最后修改时间在2025-01-16T11:52:56.000Z之前并且文件大小小于等于12345字节 |'."\n" - .'| <= | 范围查询：
小于等于 | 同上 |'."\n" - .'| AND | 并且
大小写都支持 | `FileType=\'image\' AND ContentType:\'image/png\'`
查找文件类型为image且文件格式为png的图片 |'."\n" - .'| OR | 或者
大小写都支持 | `FileType=\'image\' OR FileType=\'video\'`
查找文件类型为image或video的数据 |'."\n" - ."\n" - .'### DSL查询属性支持列表'."\n" - ."\n" - .'支持文件基础元数据属性、标签属性、向量检索属性、通用检索属性.'."\n" - .'所有属性在查询条件中都必须是非必选的。'."\n" - ."\n" - .'类型的说明：'."\n" - .'* KEYWORD：仅支持等于、不等于、存在、不存在中的一种或多种'."\n" - .'* TEXT：仅支持分词包含、分词不包含、等于、不等于、存在、不存在中的一种或多种'."\n" - .'* NUMBER：仅支持范围查询、等于、存在、不存在中的一种或多种'."\n" - .'* DATE：仅支持范围查询、存在、不存在中的一种或多种'."\n" - ."\n" - .'#### 基础元数据属性'."\n" - ."\n" - .'| 属性名 | 内部类型 | 分词包含 | 分词不包含 | 等于 | 不等于 | 存在/不存在 | 范围查询 | AND逻辑 | OR逻辑 |'."\n" - .'|-------------------------|----------|----------|------------|------|--------|-------------|----------|---------|--------|'."\n" - .'| DatasetFileMetaId | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" - .'| FileName | TEXT | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" - .'| FileDir | TEXT | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" - .'| FileType | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" - .'| ContentType | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" - .'| DataSize | NUMBER | - | - | ✅ | - | ✅ | ✅ | ✅ | ✅ |'."\n" - .'| FileUpdateTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |'."\n" - .'| SyncTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |'."\n" - .'| TagUpdateTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |'."\n" - .'| SemanticIndexUpdateTime| DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |'."\n" - .'| Status | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" - ."\n\n" - .'#### 标签属性'."\n" - ."\n" - .'| 属性名 | 内部类型 | 分词包含 | 分词不包含 | 等于 | 不等于 | 存在/不存在 | 范围查询 | AND逻辑 | OR逻辑 |'."\n" - .'|--------------|----------|----------|------------|------|--------|-------------|----------|---------|--------|'."\n" - .'| Tags.ai | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" - .'| Tags.user | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" - .'| Tags.all | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" - ."\n\n" - .'#### 向量查询属性'."\n" - ."\n" - .'| 属性名 | 内部类型 | 分词包含 | 分词不包含 | 等于 | 不等于 | 存在/不存在 | 范围查询 | AND逻辑 | OR逻辑 |'."\n" - .'|--------------|----------|----------|------------|------|--------|-------------|----------|---------|--------|'."\n" - .'| Content | TEXT | ✅ | - | ❌ | ❌ | ❌ | - | ✅ | ❌ |'."\n" - .'| TopK | NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |'."\n" - .'| ScoreThreshold| NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |'."\n" - ."\n\n" - .'#### 通用查询属性'."\n" - ."\n" - .'| 属性名 | 内部类型 | 分词包含 | 分词不包含 | 等于 | 不等于 | 存在/不存在 | 范围查询 | AND逻辑 | OR逻辑 |'."\n" - .'|--------------|----------|----------|------------|------|--------|-------------|----------|---------|--------|'."\n" - .'| QueryType | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" - .'| SignMode | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" - .'| ThumbnailMode| KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" - .'| SortBy | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" - .'| Order | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" - .'| NextToken | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" - .'| MaxResults | NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |', - ], - 'GetDatasetJobConfig' => [ - 'summary' => '获取数据集任务配置。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSources\\": [\\n {\\n \\"CodeSourceId\\": \\"code-202**********\\",\\n \\"DisplayName\\": \\"MyCodeSourceName1\\",\\n \\"Description\\": \\"code source of dlc examples\\",\\n \\"CodeRepo\\": \\"https://code.aliyun.com/****\\",\\n \\"CodeBranch\\": \\"master\\",\\n \\"CodeCommit\\": \\"44da10**********\\",\\n \\"CodeRepoUserName\\": \\"user\\",\\n \\"CodeRepoAccessToken\\": \\"\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"UserId\\": \\"1157290171663117\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"GmtCreateTime\\": \\"2021-01-18T12:52:15Z\\",\\n \\"GmtModifyTime\\": \\"2021-01-18T12:52:15Z\\",\\n \\"MountPath\\": \\"/root/code/\\",\\n \\"CloneType\\": 0\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => '获取代码配置列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCodeSources'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paicodesource:ListCodeSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListConfigs' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/configs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '260462', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], - 'autoTest' => true, + 'operationType' => 'list', + 'abilityTreeCode' => '117761', + 'abilityTreeNodes' => ['FEATURElearnDVAH75'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-lfd60v0p****ujtsdx', - ], + 'schema' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '87***'], ], [ - 'name' => 'DatasetJobConfigId', - 'in' => 'path', - 'schema' => [ - 'description' => '配置id', - 'type' => 'string', - 'required' => true, - 'example' => 'dscfg-xxxxxxxxxxxx', - ], + 'name' => 'CategoryName', + 'in' => 'query', + 'schema' => ['description' => '配置项的分类。目前支持如下分类'."\n" + ."\n" + .'- CommonResourceConfig 通用资源配置'."\n" + .'- DLCAutoRecycle DLC自动回收'."\n" + .'- DLCPriorityConfig DLC 优先级设置'."\n" + .'- DSWPriorityConfig DSW优先级设置'."\n" + .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" + .'- CommonTagConfig 标签设置', 'type' => 'string', 'required' => false, 'example' => 'CommonResourceConfig'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'ConfigKeys', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '114243', - ], + 'schema' => ['title' => '配置键', 'description' => '配置项的键。目前支持如下键：'."\n" + ."\n" + .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" + .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" + .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" + .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" + .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', 'type' => 'string', 'required' => false, 'example' => 'tempStoragePath'], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => ['description' => '标签作为过滤条件，多个条件用逗号分隔，这些条件之间是与的关系。', 'type' => 'string', 'required' => false, 'example' => 'key1=value1,key2=value2'], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['description' => '是否展示Label信息'."\n" + ."\n" + .'- true：展示Label信息'."\n" + .'- false：不展示Label信息', 'type' => 'string', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => '响应。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2024-10-16T01:44:10Z', - ], - 'ModifyTime' => [ - 'description' => '配置的修改时间。', - 'type' => 'string', - 'example' => '2024-12-26T02:17:18Z', - ], - 'ConfigType' => [ - 'description' => '配置类型'."\n" - ."\n" - .'- MultimodalIntelligentTag'."\n" - ."\n" - .'- MultimodalSemanticIndex', - 'type' => 'string', - 'example' => 'MultimodalIntelligentTag', - ], - 'Config' => [ - 'description' => '配置内容'."\n" - .'其中MultimodalIntelligentTag 配置格式为'."\n" - ."\n" - .'{'."\n" - .' "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" - .'}'."\n" - ."\n" - .'MultimodalSemanticIndex'."\n" - ."\n" - .'{'."\n" - .' "defaultModelId": "xxx"'."\n" - .' "defaultModelVersion":"1.0.0"'."\n" - .'}', - 'type' => 'string', - 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', - ], - 'DatasetId' => [ - 'description' => '数据集Id', - 'type' => 'string', - 'example' => 'd-lfd60v0p****ujtsdx', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '114243', + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n"], + 'Configs' => [ + 'title' => '配置列表', + 'description' => '配置项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置项。', + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => ['title' => '配置键', 'description' => '配置项的键。目前支持如下键：'."\n" + ."\n" + .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" + .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" + .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" + .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" + .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', 'type' => 'string', 'example' => 'tempTableLifecycle'], + 'ConfigValue' => ['title' => '配置值', 'description' => '配置值', 'type' => 'string', 'example' => 'oss://***'."\n"], + 'Labels' => [ + 'description' => '配置项的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置项的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签的键。', 'type' => 'string', 'example' => 'key1'], + 'Value' => ['description' => '标签的值。', 'type' => 'string', 'example' => 'value1'."\n"], + ], + ], + ], + 'GmtCreateTime' => ['type' => 'string', 'description' => ''], + 'GmtModifiedTime' => ['type' => 'string', 'description' => ''], + ], + ], ], + 'TotalCount' => ['title' => '返回数量', 'description' => '返回数量', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\",\\n \\"CreateTime\\": \\"2024-10-16T01:44:10Z\\",\\n \\"ModifyTime\\": \\"2024-12-26T02:17:18Z\\",\\n \\"ConfigType\\": \\"MultimodalIntelligentTag\\",\\n \\"Config\\": \\"{ \\\\\\"apiKey\\\\\\":\\\\\\"sk-xxxxxxxxxxxxxxxxxxxxx\\\\\\" }\\",\\n \\"DatasetId\\": \\"d-lfd60v0p****ujtsdx\\",\\n \\"WorkspaceId\\": \\"114243\\"\\n}","type":"json"}]', - 'title' => '获取数据集任务配置', - ], - 'GetDatasetFileMeta' => [ - 'summary' => '获取数据集下的指定文件元数据记录。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas/{DatasetFileMetaId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取工作空间配置列表', + 'summary' => '获取工作空间配置列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigs'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigKey\\": \\"tempTableLifecycle\\",\\n \\"ConfigValue\\": \\"oss://***\\\\n\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\\\n\\"\\n }\\n ],\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', + ], + 'ListConnections' => [ + 'path' => '/api/v1/connections', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '260628', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '267625', + 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wz****c9ks92', - ], + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], ], [ - 'name' => 'DatasetFileMetaId', - 'in' => 'path', + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页游标的标识。用于标记下一页查询的起始位置。', 'type' => 'string', 'required' => false, 'example' => '15'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '每页的最大数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '分页查询时的排序字段，默认使用GmtCreateTime。取值如下。'."\n" + .'- GmtCreateTime（默认值）：按创建时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。'."\n" + .'- ASC：升序。'."\n" + .'- DESC（默认值）：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'ConnectionIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '数据集文件元数据ID。', - 'type' => 'string', - 'required' => true, - 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6', + 'description' => '连接ID列表。', + 'type' => 'array', + 'items' => ['description' => '连接ID。', 'type' => 'string', 'required' => false, 'example' => 'conn-ljasd***jsx'], + 'required' => false, ], ], [ - 'name' => 'DatasetVersion', + 'name' => 'ConnectionName', 'in' => 'query', + 'schema' => ['description' => '连接的名称。', 'type' => 'string', 'required' => false, 'example' => 'Database connection'], + ], + [ + 'name' => 'ConnectionTypes', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '数据集版本名。', - 'type' => 'string', + 'description' => '连接类型列表。', + 'type' => 'array', + 'items' => ['description' => '连接类型。可选值：'."\n" + .'- DashScopeConnection：百炼服务连接。'."\n" + .'- OpenLLMConnection：开源模型连接。'."\n" + .'- MilvusConnection：Milvus连接。'."\n" + .'- OpenSearchConnection：OpenSearch连接。'."\n" + .'- LindormConnection：Lindorm连接。'."\n" + .'- ElasticsearchConnection：Elasticsearch连接。'."\n" + .'- HologresConnection：Hologres连接。'."\n" + .'- RDSConnection：RDS连接。'."\n" + .'- CustomConnection：自定义连接。', 'type' => 'string', 'required' => false, 'example' => 'OpenLLMConnection'], 'required' => false, - 'example' => 'v1', ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'EncryptOption', + 'in' => 'query', + 'schema' => ['description' => '加密设置。可取值：'."\n" + .'- PlainText（明文）'."\n" + .'- Secret（密文）', 'type' => 'string', 'required' => false, 'example' => 'PlainText'], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => ['description' => '模型标识符。', 'type' => 'string', 'required' => false, 'example' => 'model_001'], + ], + [ + 'name' => 'ModelTypes', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', + 'description' => '模型类型列表。', + 'type' => 'array', + 'items' => ['description' => '模型类型。可取值：'."\n" + .'- LLM'."\n" + .'- Embedding'."\n" + .'- ReRank', 'type' => 'string', 'required' => false, 'example' => 'LLM'], 'required' => false, - 'example' => '1234', ], ], + [ + 'name' => 'ToolCall', + 'in' => 'query', + 'schema' => ['description' => '是否支持ToolCall工具调用。可取值：'."\n" + .'- true：支持'."\n" + .'- false：不支持', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => '创建者。', 'type' => 'string', 'required' => false, 'example' => '12908*******3242'], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => ['description' => '可见性。可取值：'."\n" + .'- PUBLIC：工作空间内公开可见'."\n" + .'- PRIVATE：仅创建者可见', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求结果。', + 'description' => '响应信息。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'DatasetFileMeta' => [ - 'description' => '获取的数据集文件元数据详情。', - '$ref' => '#/components/schemas/DatasetFileMetaContentGet', - ], - 'DatasetVersion' => [ - 'description' => '数据集版本名。', - 'type' => 'string', - 'example' => 'v1', - ], - 'DatasetId' => [ - 'description' => '数据集ID。', - 'type' => 'string', - 'example' => 'd-rbvg5wz****c9ks92', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '1234', + 'Connections' => [ + 'description' => '连接列表信息。', + 'type' => 'array', + 'items' => ['description' => '连接信息。', '$ref' => '#/components/schemas/Connection'], ], + 'MaxResults' => ['description' => '每页的最大数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['description' => '分页游标的标识。用于标记下一页查询的起始位置。', 'type' => 'string', 'example' => '15'], + 'TotalCount' => ['description' => '符合过滤条件的连接总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '27'], + 'RequestId' => ['description' => '请求唯一ID。', 'type' => 'string', 'example' => 'B2C51F93-1C07-5477-9705-5FDB****F19F'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetFileMeta\\": {\\n \\"FileName\\": \\"\\",\\n \\"Uri\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"FileCreateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileFingerPrint\\": \\"\\",\\n \\"DataSize\\": 0,\\n \\"FileType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"MetaAttributes\\": \\"\\",\\n \\"Tags\\": \\"\\",\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"FileDir\\": \\"\\",\\n \\"TagUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"SemanticIndexJobId\\": \\"\\",\\n \\"SemanticIndexUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"Status\\": \\"\\"\\n },\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"DatasetId\\": \\"d-rbvg5wz****c9ks92\\",\\n \\"WorkspaceId\\": \\"1234\\"\\n}","type":"json"}]', - 'title' => '获取数据集文件元数据详情', - ], - 'DeleteDatasetFileMetas' => [ - 'summary' => '批量删除数据集下的文件元数据记录', - 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', - 'methods' => [ - 'delete', + 'title' => '获取连接列表', + 'summary' => '获取连接列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnections'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListConnections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Connections\\": [\\n {\\n \\"ConnectionType\\": \\"ElasticsearchConnection\\",\\n \\"Description\\": \\"This is a description of a database connection.\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"WorkspaceId\\": \\"228**\\",\\n \\"Creator\\": \\"20925961****557803\\",\\n \\"ResourceMeta\\": {\\n \\"InstanceName\\": \\"lindorm-xxxxxxx\\",\\n \\"InstanceId\\": \\"ld-2vc1***v1zaqgzol\\",\\n \\"Extra\\": \\"{\\\\\\"vpcId\\\\\\":\\\\\\"vpc-xxxx\\\\\\"}\\"\\n },\\n \\"GmtModifiedTime\\": \\"2025-03-07T07:54:56Z\\\\n\\",\\n \\"ConnectionName\\": \\"lindorm-connection\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\",\\n \\"GmtCreateTime\\": \\"2025-03-07T07:54:56Z\\\\n\\",\\n \\"Secrets\\": {\\n \\"key\\": \\"Dsjk***hsl01\\\\n\\"\\n },\\n \\"Configs\\": {\\n \\"key\\": \\"12345\\"\\n },\\n \\"Models\\": [\\n {\\n \\"Model\\": \\"model_001\\",\\n \\"DisplayName\\": \\"BGE model deploy.\\",\\n \\"ModelType\\": \\"LLM\\",\\n \\"ToolCall\\": true\\n }\\n ]\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"15\\",\\n \\"TotalCount\\": 27,\\n \\"RequestId\\": \\"B2C51F93-1C07-5477-9705-5FDB****F19F\\"\\n}","type":"json"}]', + ], + 'ListDatasetFileMetas' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '260630', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '259940', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-lfd60v0p****ujtsdx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', + 'schema' => ['description' => '数据集版本名。', 'type' => 'string', 'required' => true, 'example' => 'v1'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '105173'], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', 'schema' => [ - 'description' => '数据集版本名。', + 'description' => '检索类型。'."\n" + .'* MIX：混合检索（默认值）。'."\n" + .'* TAG：仅标签检索。'."\n" + .'* VECTOR：仅向量检索。', 'type' => 'string', 'required' => false, - 'example' => 'v1', + 'enumValueTitles' => ['TAG' => 'TAG', 'MIX' => 'MIX', 'VECTOR' => 'VECTOR'], + 'example' => 'MIX', ], ], [ - 'name' => 'WorkspaceId', + 'name' => 'QueryText', + 'in' => 'query', + 'schema' => ['description' => '待搜索文本内容。', 'type' => 'string', 'required' => false, 'example' => 'A fallen water'], + ], + [ + 'name' => 'TopK', + 'in' => 'query', + 'schema' => ['description' => '检索结果返回数量，最多只返回TopK个检索结果。'."\n" + .'> 当QueryType=VECTOR或MIX时有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5000', 'minimum' => '1', 'example' => '100', 'default' => '10'], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => ['description' => '相似度分数过滤。只返回大于ScoreThreshold的结果。'."\n" + .'> 当QueryType=VECTOR或MIX时有效。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.6'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页数量。如果同时传入MaxResults，则以MaxResults数量为准。'."\n" + .'> 该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'NextToken', 'in' => 'query', 'schema' => [ - 'description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', + 'description' => '分页游标标识。'."\n" + .'> '."\n" + .'> 如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的NextToken作为参数再次请求获得下一页的数据，直到返回为Null为止，表示获取到了所有的数据。', 'type' => 'string', 'required' => false, - 'example' => '132602', + 'enumValueTitles' => [], + 'example' => '90a6ee35-****-4cd4-927e-1f45e1cb8b62_1729644433000', ], ], [ - 'name' => 'DatasetFileMetaIds', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => '数据集文件元数据ID。', + 'description' => '分页查询时的排序字段，缺省时按检索时相关性由高到低排序。其他取值如下。'."\n" + .'* FileCreateTime：按文件创建时间。'."\n" + .'* FileUpdateTime：按文件最后修改时间。', 'type' => 'string', - 'required' => true, - 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n", + 'required' => false, + 'enumValueTitles' => ['FileCreateTime' => 'FileCreateTime', 'FileUpdateTime' => 'FileUpdateTime'], + 'example' => 'FileCreateTime', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Order', + 'in' => 'query', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '请求结果。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'Status' => [ - 'description' => '本批元数据删除结果的状态。全部成功为true，如果为false，需要查看FailedDetails。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailedDetails' => [ - 'description' => '删除失败的文件元数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '删除失败的文件元数据详情。', - '$ref' => '#/components/schemas/DatasetFileMetaResponse', - ], - ], - ], + 'description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。默认DESC。'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'], + 'example' => 'DESC', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Result\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '批量删除数据集文件元数据', - ], - 'CreateDatasetJobConfig' => [ - 'summary' => '创建数据集任务配置。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EndFileUpdateTime', + 'in' => 'query', + 'schema' => ['description' => '用于指定查询的起始文件更新时间。ISO 8601 格式的 UTC 时间戳。', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '2025-01-12T14:36:01.000Z'."\n"], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '260458', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', + [ + 'name' => 'StartFileUpdateTime', + 'in' => 'query', + 'schema' => ['description' => '用于指定查询的结束文件更新时间。ISO 8601 格式的 UTC 时间戳。', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '2025-01-12T14:36:01.000Z'."\n"], ], - ], - 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', + 'name' => 'QueryImage', + 'in' => 'query', + 'schema' => ['description' => '以图搜图时，该参数传入图片的信息。'."\n" + .'* 支持传入图片的可公网访问的oss url格式。格式为：oss://{bucket_name}/{object_path}。其中bucket_name为bucket名称，object_path为文件在bucket中的路径。'."\n" + .'> 当QueryType=VECTOR或MIX时有效。', 'type' => 'string', 'required' => false, 'example' => 'oss://test-xxx-oss/car/0001.png'], + ], + [ + 'name' => 'ThumbnailMode', + 'in' => 'query', + 'schema' => ['description' => '图片缩略图的模式，当前仅OSS文件支持缩略图：'."\n" + .'- 等比例缩小: p_{percentage}, percentage表示期望的缩放比例，取值范围为[1, 100] 。示例：p_50表示使用原始文件的50%大小作为缩略图。'."\n" + .'- 宽度固定，高度自适应缩小: w_{width}, width表示期望的图片宽度，取值范围为[1, 16384]。示例：w_200表示将图片宽度固定为200像素，高度自适应进行缩小。'."\n" + .'- 高度固定，宽度自适应缩小：h_{height}, height表示期望的图片高度，取值范围为[1, 16384]。示例：h_100表示将图片高度固定为100像素，宽度自适应进行缩小。'."\n" + .'- 固定宽高，缩略填充：m_pad,w_{height},h_{height},color_{RGB}, m_pad表示图片缩放为指定w与h的矩形内的最大图片，RGB表示指定居中填充空白部分的颜色，若不设置该参数，默认用白色填充。width表示期望的图片宽度，height表示期望的图片高度。width和height的取值范围都为[1,16384]。示例:'."\n" + .'- 固定宽高，居中裁剪：m_fill,w_{width},h_{height}。m_fill表示图片等比缩放为延伸出指定w与h的矩形框外的最小图片，超出的部分进行居中裁剪。width表示期望的图片宽度，height表示期望的图片高度。width和height的取值范围都为[1,16384]示例：m_fill,w_100,h_100表示将图片宽度和高度都固定为100像素进行居中裁剪缩放。'."\n" + .'- 强制宽高缩放: m_fixed,w_{height},h_{height}，width表示期望的图片宽度，height表示期望的图片高度。width和height的取值范围都为[1,16384]。示例：m_fixed,w_100,h_100表示将图片宽度和高度都固定为100像素进行强制宽高缩放。', 'type' => 'string', 'required' => false, 'example' => 'w_100'], + ], + [ + 'name' => 'DatasetFileMetaIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'simple', 'schema' => [ - 'description' => '数据集Id', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wzlj****9ks92', + 'description' => '要查询的元数据ID列表。', + 'type' => 'array', + 'items' => ['description' => '元数据ID。', 'type' => 'string', 'required' => false, 'example' => '5dc037c8ec0a6fc4e15741328e531bbee036exxxxxxxxx722eff66c38a90e08c'], + 'required' => false, + 'maxItems' => 20, ], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'QueryTagsIncludeAll', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'simple', 'schema' => [ - 'description' => '请求Body。', - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '454716', - ], - 'ConfigType' => [ - 'description' => '配置类型', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'MultimodalIntelligentTag' => 'MultimodalIntelligentTag', - 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex', - ], - 'example' => 'MultimodalIntelligentTag', - ], - 'Config' => [ - 'description' => '配置内容'."\n" - .'其中配置内容格式如下：'."\n" - ."\n" - .'- MultimodalIntelligentTag'."\n" - ."\n" - .'{'."\n" - .' "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" - .'}'."\n" - ."\n" - .'- MultimodalSemanticIndex'."\n" - ."\n" - .'{'."\n" - .' "defaultModelId": "xxx"'."\n" - .' "defaultModelVersion":"1.0.0"'."\n" - .'}', - 'type' => 'string', - 'required' => true, - 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', - ], - 'DatasetVersion' => [ - 'description' => '数据集版本名。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - ], + 'description' => '表示“同时包含以下标签”检索条件。用户可以选择多个标签，查询结果必须同时满足这些标签。如果为空，则不应用此条件。数组使用逗号分隔。'."\n" + ."\n" + .'> 当QueryType=TAG或MIX时有效。当QueryType=TAG时会将QueryText加入到该条件下。', + 'type' => 'array', + 'items' => ['description' => '标签名。', 'type' => 'string', 'required' => false, 'example' => 'Lane line'], 'required' => false, ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'QueryTagsIncludeAny', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'simple', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'DatasetJobConfigId' => [ - 'description' => '配置id', - 'type' => 'string', - 'example' => 'dscfg-xxxxxxxxxxxxxx', - ], - ], + 'description' => '表示“包含以下任意标签”检索条件。 用户可以选择多个标签，查询结果只需满足其中一个即可。 如果为空，则不应用此条件。数组使用逗号分隔。'."\n" + .'> 当QueryType=TAG或MIX时有效。', + 'type' => 'array', + 'items' => ['description' => '标签名。', 'type' => 'string', 'required' => false, 'example' => 'Lane line'], + 'required' => false, ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetJobConfigId\\": \\"dscfg-xxxxxxxxxxxxxx\\"\\n}","type":"json"}]', - 'title' => '创建数据集任务配置', - ], - 'CreateDatasetJob' => [ - 'summary' => '创建数据集任务。', - 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'QueryTagsExclude', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'simple', + 'schema' => [ + 'description' => '表示“排除以下标签”检索条件。用户可以选择多个标签，查询结果中不能包含这些标签。如果为空，则不应用此条件。'."\n" + .'> 当QueryType=TAG或MIX时有效。', + 'type' => 'array', + 'items' => ['description' => '标签名。', 'type' => 'string', 'required' => false, 'example' => 'Lane line'], + 'required' => false, + ], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '260335', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', + [ + 'name' => 'QueryFileName', + 'in' => 'query', + 'schema' => ['description' => '文件名检索条件。支持模糊检索。', 'type' => 'string', 'required' => false, 'example' => 'car'], ], - ], - 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wz****c9ks92', - ], + 'name' => 'QueryFileDir', + 'in' => 'query', + 'schema' => ['description' => '文件目录检索条件。支持模糊检索。', 'type' => 'string', 'required' => false, 'example' => 'cars/20250221/'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'DatasetVersion' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '478**', - ], - 'JobAction' => [ - 'description' => '任务操作。'."\n" - .'- SemanticIndex: 语义索引'."\n" - .'- IntelligentTag: 智能打标'."\n" - .'- FileMetaExport: 元数据导出'."\n" - .'- FileMetaBuild: 构建更新元数据'."\n" - .'- IntelligentTagRevert: 智能打标撤回'."\n" - .'- FileMetaImport: 元数据导入', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'IntelligentTagRevert' => 'IntelligentTagRevert', - 'SemanticIndex' => 'SemanticIndex', - 'FileMetaImport' => 'FileMetaImport', - 'IntelligentTag' => 'IntelligentTag', - 'FileMetaExport' => 'FileMetaExport', - 'FileMetaBuild' => 'FileMetaBuild', - ], - 'example' => 'SemanticIndex', - ], - 'JobMode' => [ - 'description' => '任务类型。'."\n" - .'* Full（默认值）：强制处理全量元数据。任务执行耗时久。'."\n" - .'* Increment：仅处理变更或者未处理成功的元数据； '."\n" - .'SemanticIndex和IntelligentTag任务支持Increment/Full，其余任务仅支持Full。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Increment' => 'Increment', - 'Full' => 'Full', - ], - 'example' => 'Full', - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a job description.', - ], - 'JobSpec' => [ - 'description' => '任务明细。', - 'type' => 'string', - 'required' => true, - 'example' => '{\\"modelId\\":\\"xxx\\"}', - ], - ], + 'name' => 'QueryFileTypeIncludeAny', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '表示“包含以下任意文件类型”检索条件。用户可以选择多个文件类型，查询结果只需满足其中一个即可。如果为空，则不应用此条件。数组使用逗号分隔。', + 'type' => 'array', + 'items' => ['description' => '文件类型。', 'type' => 'string', 'required' => false, 'example' => 'image'], + 'required' => false, + ], + ], + [ + 'name' => 'QueryContentTypeIncludeAny', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '表示“包含以下任意文件内容类型”检索条件。用户可以选择多个文件内容类型，查询结果只需满足其中一个即可。如果为空，则不应用此条件。数组使用逗号分隔。', + 'type' => 'array', + 'items' => ['description' => '文件内容类型。', 'type' => 'string', 'required' => false, 'example' => 'image/jpeg'], + 'required' => false, + ], + ], + [ + 'name' => 'StartTagUpdateTime', + 'in' => 'query', + 'schema' => ['description' => '用于指定查询的起始标签最后更新时间。ISO 8601 格式的 UTC 时间戳。', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '2025-01-12T14:36:01.000Z'."\n"], + ], + [ + 'name' => 'EndTagUpdateTime', + 'in' => 'query', + 'schema' => ['description' => '用于指定查询的结束标签最后更新时间。ISO 8601 格式的 UTC 时间戳。', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '2025-01-12T14:36:01.000Z'."\n"], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '使用NextToken方式查询时，每次最多返回的结果数。取值范围：1~100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'QueryExpression', + 'in' => 'query', + 'schema' => ['description' => '查询语句（DSL）是一种用于表达复杂检索条件的领域特定语言。它支持分组、布尔逻辑（AND/OR/NOT）、范围比较（>, >=, <, <=）、属性存在性（HAS/NOT HAS）、分词匹配（:）与精确匹配（=）等，适用于高级检索场景。'."\n" + .'一般用于较为复杂的高级检索条件。'."\n" + .'为避免冲突，设置该查询语句后，建议不要与其他查询参数混用', 'type' => 'string', 'required' => false, 'example' => '(FileUpdateTime > \'2025-02-28T00:00:00Z\' AND FileUpdateTime < \'2025-05-30T09:27:29Z\') AND FileDir:\'blue_car\' AND NOT FileName="toyota.jpg" AND (( Tags.all=\'lane line\' AND Tags.all=\'barrier gate\') OR NOT Tags.user=\'rainy days\' ) AND HAS SemanticIndexJobId AND Content:\'a fallen water horse\' AND TopK=100 AND SignMode=\'PUBLIC\''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的元数据状态'."\n" + .'* ACTIVE: 仅查询未删除数据(缺省)'."\n" + .'* ALL: 查询全部数据'."\n" + .'* DELETED: 仅查询已逻辑删除数据', + 'type' => 'string', 'required' => false, + 'example' => 'ACTIVE', + 'enum' => ['ACTIVE', 'ALL', 'DELETED'], ], ], + [ + 'name' => 'QueryVideo', + 'in' => 'query', + 'schema' => ['description' => '以视频搜索时，该参数传入视频文件的信息。'."\n" + .'* 支持传入视频的可公网访问的oss url格式。格式为：oss://{bucket_name}/{object_path}。其中bucket_name为bucket名称，object_path为文件在bucket中的路径。'."\n" + .'> 当QueryType=VECTOR或MIX时有效。', 'type' => 'string', 'required' => false, 'example' => 'oss://test-xxx-oss/car/0001.mp4'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '99341606-****-0757724D97EE', - ], - 'DatasetJobId' => [ - 'description' => '数据集任务ID', - 'type' => 'string', - 'example' => 'dsjob-9jx1******uj9e', + 'TotalCount' => ['description' => '返回数据总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'PageSize' => ['description' => '当前页大小。', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'example' => '30'], + 'NextToken' => ['description' => '分页游标的标识。如果匹配查询条件的返回结果超过了分页大小，则会返回这个分页游标。如果需要获取下一页数据，将返回的游标值作为请求参数即可，直到无游标值返回，表示已经获取了全部数据。', 'type' => 'string', 'example' => '90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000'], + 'DatasetFileMetas' => [ + 'description' => '数据集文件元数据详情列表。', + 'type' => 'array', + 'items' => ['description' => '数据集文件元数据详情。', '$ref' => '#/components/schemas/DatasetFileMeta'], ], + 'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'example' => 'd-rbvg5*****jhc9ks92'."\n"], + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '105173'], + 'DatasetVersion' => ['description' => '数据集版本名。', 'type' => 'string', 'example' => 'v1'], + 'MaxResults' => ['description' => '使用NextToken方式查询时，每次最多返回的结果数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99341606-****-0757724D97EE\\",\\n \\"DatasetJobId\\": \\"dsjob-9jx1******uj9e\\"\\n}","type":"json"}]', - 'title' => '创建数据集任务', - 'requestParamsDescription' => 'CreateDatasetJob中的JobSpec参数说明：'."\n" - .'### 语义索引任务'."\n" + 'title' => '获取数据集文件元数据列表', + 'summary' => '查询数据集文件列表。', + 'requestParamsDescription' => '## DSL查询语法说明'."\n" ."\n" - .'示例：'."\n" - .'```{'."\n" - .' "modelId": "xxx",'."\n" - .' "modelVersion": "1.0.0",'."\n" - .' "contentList": ["file"],'."\n" - .' "embeddingConnectionId": "conn-xxx",'."\n" - .' "embeddingModel": "default",'."\n" - .' "databaseConnectionId": "conn-xxx",'."\n" - .' "databaseTableName": "table_xxx",'."\n" - .' "vectorIndexConfig":"{\\"shards\\":1,\\"similarity\\":\\"cosine\\",\\"indexType\\":\\"hnsw\\",\\"indexOptions\\":{\\"m\\":16,\\"efConstruction\\":200}}",'."\n" - .' "concurrency": 2'."\n" - .'}'."\n" - .'```'."\n" - .'字段说明：'."\n" - .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" - .'|---------------------|----------------|------------|------|------------------------------|'."\n" - .'| modelId | String | model-xxx | 否 | 官方模型ID。 |'."\n" - .'| modelVersion | String | 1.0.0 | 否 | 官方模型版本。 |'."\n" - .'| embeddingConnectionId | String | conn-xxx | 否 | eas模型服务连接ID。 |'."\n" - .'| embeddingModel | String | default | 否 | eas模型服务对应的模型名称。 |'."\n" - .'| databaseConnectionId | String | conn-xxx | 否 | 向量库服务连接ID。 |'."\n" - .'| databaseTableName | String | table_xxx | 否 | 向量库表名。 |'."\n" - .'| concurrency | Integer | 2 | 否 | 任务并行数 |'."\n" - .'| contentList | Array | | 是 | 索引内容列表。 |'."\n" - .'| +- | String | file | | 索引内容。一期只支持file(文件)。 |'."\n" + .'| keyword | 说明 | 范例 |'."\n" + .'|------------------|----------------------------------------------------------------------|----------------------------------------------------------------------|'."\n" + .'| : | 分词匹配 | `FileName:\'车道线\'`
查找文件名分词后包含“车道线”的数据 |'."\n" + .'| NOT : | 分词不匹配 | `NOT FileName : \'车道线\'`
查找文件名分词后不包含“车道线”的数据 |'."\n" + .'| = | 精确值匹配 | `FileType=\'image\'`
查找文件类型为“image”的数据（精确匹配） |'."\n" + .'| NOT = | 精确值排除 | `NOT FileType = \'video\'`
查找所有FileType不等于"video"的数据 |'."\n" + .'| HAS | 存在 | `HAS SemanticIndexJobId`
查找所有存在SemanticIndexJobId属性的数据 |'."\n" + .'| NOT HAS | 不存在 | `NOT HAS SemanticIndexJobId`
查找所有不存在SemanticIndexJobId属性的数据 |'."\n" + .'| "" | 对值的字符串类型进行包裹 | 单双引号效果一致 |'."\n" + .'| () | 分组操作 | `(FileName:\'black\' AND ContentType=\'image/jpeg\') OR (FileName:\'white\' AND ContentType=\'image/png\')`
查找FileName为模糊匹配black并且ContentType为image/jpeg 或者 FileName为模糊匹配white并且ContentType为image/png |'."\n" + .'| > | 范围查询：
大于 | `FileUpdateTime> \'2025-01-16T11:52:56.000Z\' AND DataSize >= 12345`
文件最后修改时间在2025-01-16T11:52:56.000Z之后的并且文件大小大于等于12345字节 |'."\n" + .'| >= | 范围查询：
大于等于 | 同上 |'."\n" + .'| < | 范围查询：
小于 | `FileUpdateTime < \'2025-01-16T11:52:56.000Z\' AND DataSize <= 12345`
文件最后修改时间在2025-01-16T11:52:56.000Z之前并且文件大小小于等于12345字节 |'."\n" + .'| <= | 范围查询：
小于等于 | 同上 |'."\n" + .'| AND | 并且
大小写都支持 | `FileType=\'image\' AND ContentType:\'image/png\'`
查找文件类型为image且文件格式为png的图片 |'."\n" + .'| OR | 或者
大小写都支持 | `FileType=\'image\' OR FileType=\'video\'`
查找文件类型为image或video的数据 |'."\n" ."\n" - .'### 智能打标任务'."\n" + .'### DSL查询属性支持列表'."\n" ."\n" - .'示例：'."\n" - .'```'."\n" - .'{'."\n" - .' "intelligentTagConnectionId": "conn-keltvufiud3quopq11",'."\n" - .' "promptId": "pmt-gh6qaj1kvkf6yk7qx2",'."\n" - .' "modelId":"qwen-vl-max"'."\n" - .'}'."\n" - .'```'."\n" - .'字段说明：'."\n" - .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" - .'|---------------------------|--------|-------------------------------|------|--------------------|'."\n" - .'| modeId | String | qwen-vl-max | 是 | 模型名称 |'."\n" - .'| intelligentTagConnectionId| String | conn-keltvufiud3quopq11 | 是 | 打标连接管理 |'."\n" - .'| promptId | String | pmt-gh6qaj1kvkf6yk7qx2 | 是 | 提示词id |'."\n" - ."\n\n" - .'### 元数据导出任务'."\n" - .'示例：'."\n" - .'```'."\n" - .'{'."\n" - .' "query":{'."\n" - .' "QueryType": "TAG",'."\n" - .' "QueryText": "",'."\n" - .' "TopK": 100,'."\n" - .' "ScoreThreshold":0.6'."\n" - .' },'."\n" - .' "filteredAttributes":"FileName,Uri",'."\n" - .' "exportDirUri": "oss://bucket/path/" '."\n" - .'}'."\n" - .'```'."\n" - .'字段说明：'."\n" - .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" - .'|---------------------|------------|----------------------------------------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" - .'| query | JSON | | 否 | 导出查询条件，字段与 `ListDatasetMetas` 接口保持一致。见：`QueryParms` |'."\n" - .'| filteredAttributes | String | 逗号分隔 | 否 | 当指定时，导出结果将只包含指定过滤的属性字段。字段列表：
* Uri (必有)
* DatasetFileMetaId
* FileName
* DataSize
* FileType
* ContentType
* Comment
* MetaAttributes
* FileFingerPrint
* FileCreateTime
* FileUpdateTime
* Tags.user: 用户自定义标签
* Tags.user-delete-ai-tags: 用户删除的算法标签
* Tags.ai：算法标签（所有打标任务聚合后的）
* Tags.all: 算法标签+用户自定义标签（已去除用户删除的算法标签） |'."\n" - .'| exportDirUri | String | oss://bucket/path/
或者
pvfs://cata_log/DB/lanceTable | 是 | 导出内容的 OSS 存储路径，需为目录地址。
会在该目录下创建文件夹：`{datasetId}-{datasetversion}-{time:yyyy-MM-dd-HH-mm-ss}`，下存放 yaml 和 jsonl 文件。 |'."\n" + .'支持文件基础元数据属性、标签属性、向量检索属性、通用检索属性.'."\n" + .'所有属性在查询条件中都必须是非必选的。'."\n" ."\n" - .'**QueryParams**:'."\n" - .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" - .'|---------------------------|----------------|----------------------------------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" - .'| QueryType | String | MIX | 否 | MIX, VECTOR, TAG |'."\n" - .'| QueryText | String | “倒地的水马” | 否 | 待搜索文本内容 |'."\n" - .'| QueryImage | String | oss://bucket.cn-hangzhou.aliyuncs.com/image.jpg | 否 | 以图搜图时，该参数传入图片的信息。
支持传入图片的可公网访问的 oss url 格式 |'."\n" - .'| QueryTagsIncludeAll | String | 蓝色锥形桶,车道线 | 否 | 表示“同时包含以下标签”。
用户可以选择多个标签，查询结果必须同时满足这些标签。
如果为空，则不应用此条件。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" - .'| QueryTagsIncludeAny | String | 蓝天 | 否 | 表示“包含以下任意标签”。
用户可以选择多个标签，查询结果只需满足其中一个即可。
如果为空，则不应用此条件。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" - .'| QueryTagsExclude | String | 阴天 | 否 | 表示“排除以下标签”。
用户可以选择多个标签，查询结果中不能包含这些标签。
如果为空，则不应用此条件。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" - .'| QueryFileName | String | shuima | 否 | 文件名模糊搜索，基于 2-gram 模糊匹配 |'."\n" - .'| QueryFileDir | String | oss://cars/20250221/ | 否 | 文件目录模糊搜索，基于 2-gram 模糊匹配 |'."\n" - .'| QueryFileTypeIncludeAny | String | image,video | 否 | 表示“包含以下任意文件类型”。
用户可以选择多个文件类型，查询结果只需满足其中一个即可。
如果为空，则不应用此条件。 |'."\n" - .'| QueryContentTypeIncludeAny| String | image/jpeg,application/pdf | 否 | 表示“包含以下任意 MIME Type 类型”。
用户可以选择多个文件类型，查询结果只需满足其中一个即可。
如果为空，则不应用此条件 |'."\n" - .'| StartFileUpdateTime | String | 2021-01-12T14:36:01.000Z | 否 | 查询时间段范围内的文件元数据。起始文件更新时间。
iso8601 格式 UTC 时间戳，2021-01-12T14:36:01.000Z。 |'."\n" - .'| EndFileUpdateTime | String | 2021-01-12T14:36:01.000Z | 否 | 查询时间段范围内的文件元数据。结束文件更新时间。
iso8601 格式 UTC 时间戳，2021-01-12T14:36:01.000Z。 |'."\n" - .'| StartTagUpdateTime | String | 2021-01-12T14:36:01.000Z | 否 | 查询时间段范围内的文件元数据。起始最后标签更新时间。
iso8601 格式 UTC 时间戳，2021-01-12T14:36:01.000Z。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" - .'| EndTagUpdateTime | String | 2021-01-12T14:36:01.000Z | 否 | 查询时间段范围内的文件元数据。结束最后标签更新时间。
iso8601 格式 UTC 时间戳，2021-01-12T14:36:01.000Z。
当 QueryType=TAG 或 MIX 时有效。 |'."\n" - .'| TopK | Integer | 100 | 否 | 导出的最大数量，默认无限制 |'."\n" - .'| ScoreThreshold | Float | 0.6 | | 相似度分数过滤。只返回大于 ScoreThreshold 的结果。
当 QueryType=VECTOR 或 MIX 时有效。 |'."\n" - .'| DatasetFileMetaIds | String | | 否 | 文件元数据 ID 列表，最大个数为 20。 |'."\n" + .'类型的说明：'."\n" + .'* KEYWORD：仅支持等于、不等于、存在、不存在中的一种或多种'."\n" + .'* TEXT：仅支持分词包含、分词不包含、等于、不等于、存在、不存在中的一种或多种'."\n" + .'* NUMBER：仅支持范围查询、等于、存在、不存在中的一种或多种'."\n" + .'* DATE：仅支持范围查询、存在、不存在中的一种或多种'."\n" ."\n" - .'### 构建更新元数据任务'."\n" - .'示例：'."\n" - .'```'."\n" - .'{}'."\n" - .'```'."\n" + .'#### 基础元数据属性'."\n" ."\n" - .'### 智能打标撤回任务'."\n" - .'示例：'."\n" - .'```'."\n" - .'{'."\n" - .' "intelligentTagJobId": "dsjob-gh6qaj1kvkf6yk7qx2"'."\n" - .'}'."\n" - .'```'."\n" - .'字段说明：'."\n" - .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" - .'|------------------------|--------|-------------------------------|------|----------------------------|'."\n" - .'| intelligentTagJobId | String | dsjob-gh6qaj1kvkf6yk7qx2 | 是 | 待撤回的智能打标任务ID |'."\n" + .'| 属性名 | 内部类型 | 分词包含 | 分词不包含 | 等于 | 不等于 | 存在/不存在 | 范围查询 | AND逻辑 | OR逻辑 |'."\n" + .'|-------------------------|----------|----------|------------|------|--------|-------------|----------|---------|--------|'."\n" + .'| DatasetFileMetaId | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" + .'| FileName | TEXT | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" + .'| FileDir | TEXT | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" + .'| FileType | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" + .'| ContentType | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" + .'| DataSize | NUMBER | - | - | ✅ | - | ✅ | ✅ | ✅ | ✅ |'."\n" + .'| FileUpdateTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |'."\n" + .'| SyncTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |'."\n" + .'| TagUpdateTime | DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |'."\n" + .'| SemanticIndexUpdateTime| DATE | - | - | - | - | ✅ | ✅ | ✅ | ✅ |'."\n" + .'| Status | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" ."\n\n" - .'### 元数据导入任务'."\n" - .'基于查询条件示例：'."\n" - .'```'."\n" - .'{'."\n" - .' "srcDatasetId": "d-1234",'."\n" - .' "srcDatasetVersion": "v1",'."\n" - .' "srcWorkspaceId": "12729",'."\n" - .' "query":'."\n" - .' {'."\n" - .' "QueryType": "TAG",'."\n" - .' "QueryText": "",'."\n" - .' "TopK": 100,'."\n" - .' "ScoreThreshold": 0.6'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - .'基于pai_dataset_filemeta_manifest文件示例：'."\n" - .'```'."\n" - .'{'."\n" - .' "manifestUri":"oss://bucket/export_path/d-mpdxv0lm9sndij7gpb-v1-2025-06-18-12-23-30/pai_dataset_filemeta_manifest.yaml"'."\n" - .'}'."\n" - .'```'."\n" + .'#### 标签属性'."\n" ."\n" - .'字段说明：'."\n" - .'| 字段名称 | 类型 | 示例 | 必选 | 参数说明 |'."\n" - .'|---------------------|------------|----------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|'."\n" - .'| srcDatasetId | String | dsjob-gh6qaj1kvkf6yk7qx2 | 是(基于查询) | 导入来源数据集 ID |'."\n" - .'| srcDatasetVersion | String | v1 | 是(基于查询) | 导入来源数据集版本 |'."\n" - .'| srcWorkspaceId | String | 12729 | 是(基于查询) | 导入来源数据集工作空间 |'."\n" - .'| query | JSON | | 否(基于查询) | 在源数据集版本上应用的查询条件。
见：`QueryParams` |'."\n" - .'| manifestUri | String | oss://bucket/export_path/d-mpdxv0lm9sndij7gpb-v1-2025-06-18-12-23-30/pai_dataset_filemeta_manifest.yaml | 是(基于文件) | 导入来源的 manifest 文件地址。
仅支持不带 endpoint 的 oss uri |'."\n" - .'| filteredAttributes | String | FileName,Uri,FileFingerPrint,DataSize,DataSize,FileUpdateTime,Tags.ai | 否 | 默认导入所有属性字段。
当指定时，导入内容将只包含指定过滤的属性字段。
字段列表：
* FileName (必须)
* Uri (必须)
* FileFingerPrint (必须)
* DataSize (必须)
* FileType (必须)
* ContentType (必须)
* Comment
* MetaAttributes
* FileCreateTime
* FileUpdateTime
* Tags.user: 用户自定义标签
* Tags.user-delete-ai-tags: 用户删除的算法标签
* Tags.ai：算法标签（所有打标任务聚合后的） |'."\n" - .'| importMode | String | append | 否 | 导入模式：
append（默认）: 追加模式。同 uri 的文件会使用待导入的内容进行覆盖。
replace: 替换模式。该数据集版本下原有的文件元数据将会被删除。 |', + .'| 属性名 | 内部类型 | 分词包含 | 分词不包含 | 等于 | 不等于 | 存在/不存在 | 范围查询 | AND逻辑 | OR逻辑 |'."\n" + .'|--------------|----------|----------|------------|------|--------|-------------|----------|---------|--------|'."\n" + .'| Tags.ai | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" + .'| Tags.user | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" + .'| Tags.all | KEYWORD | - | - | ✅ | ✅ | ✅ | - | ✅ | ✅ |'."\n" + ."\n\n" + .'#### 向量查询属性'."\n" + ."\n" + .'| 属性名 | 内部类型 | 分词包含 | 分词不包含 | 等于 | 不等于 | 存在/不存在 | 范围查询 | AND逻辑 | OR逻辑 |'."\n" + .'|--------------|----------|----------|------------|------|--------|-------------|----------|---------|--------|'."\n" + .'| Content | TEXT | ✅ | - | ❌ | ❌ | ❌ | - | ✅ | ❌ |'."\n" + .'| TopK | NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |'."\n" + .'| ScoreThreshold| NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |'."\n" + ."\n\n" + .'#### 通用查询属性'."\n" + ."\n" + .'| 属性名 | 内部类型 | 分词包含 | 分词不包含 | 等于 | 不等于 | 存在/不存在 | 范围查询 | AND逻辑 | OR逻辑 |'."\n" + .'|--------------|----------|----------|------------|------|--------|-------------|----------|---------|--------|'."\n" + .'| QueryType | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" + .'| SignMode | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" + .'| ThumbnailMode| KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" + .'| SortBy | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" + .'| Order | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" + .'| NextToken | KEYWORD | - | - | ✅ | ❌ | ❌ | - | ✅ | ❌ |'."\n" + .'| MaxResults | NUMBER | - | - | ✅ | - | ❌ | ❌ | ✅ | ❌ |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetFileMetas'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasetFileMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 123,\\n \\"PageSize\\": 30,\\n \\"NextToken\\": \\"90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000\\",\\n \\"DatasetFileMetas\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6\\",\\n \\"Uri\\": \\"oss://test-bucket/dataset/cat.png\\",\\n \\"FileName\\": \\"cat.png\\",\\n \\"DownloadUrl\\": \\"https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D\\",\\n \\"Score\\": 0.6,\\n \\"DataSize\\": 120000,\\n \\"FileFingerPrint\\": \\"D41D8CD98F*****E9800998ECF8\\\\n\\",\\n \\"FileUpdateTime\\": \\"2025-01-12T14:36:01Z\\",\\n \\"Tags\\": \\"{\\\\n \\\\\\"ai\\\\\\":\\\\n [\\\\n \\\\\\"Lane line\\\\\\",\\\\n \\\\\\"Water horse\\\\\\",\\\\n \\\\\\"Sunny day\\\\\\"\\\\n ],\\\\n \\\\\\"user\\\\\\":\\\\n [\\\\n \\\\\\"Everett\\\\\\",\\\\n \\\\\\"Intelligent driving Dataset 1\\\\\\",\\\\n \\\\\\"Cloudy day\\\\\\"\\\\n ],\\\\n \\\\\\"user-delete-ai-tags\\\\\\":\\\\n [\\\\n \\\\\\"Sunny day\\\\\\"\\\\n ]\\\\n}\\",\\n \\"ThumbnailUrl\\": \\"https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D\\",\\n \\"MetaAttributes\\": \\"{ \\\\\\"ImageHeight\\\\\\": 400, \\\\\\"ImageWidth\\\\\\": 800 }\\",\\n \\"SemanticIndexJobId\\": \\"dsjob-klfwtjto****scvt3\\",\\n \\"SemanticIndexUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileCreateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Status\\": \\"ACTIVE\\"\\n }\\n ],\\n \\"DatasetId\\": \\"d-rbvg5*****jhc9ks92\\\\n\\",\\n \\"WorkspaceId\\": \\"105173\\",\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', ], - 'CreateDataset' => [ - 'summary' => '创建一个数据集。', - 'path' => '/api/v1/datasets', - 'methods' => [ - 'post', + 'ListDatasetJobConfigs' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261468', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集id', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '431514'], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型'."\n" + ."\n" + .'- MultimodalIntelligentTag'."\n" + ."\n" + .'- MultimodalSemanticIndex', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['MultimodalIntelligentTag' => 'MultimodalIntelligentTag', 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex'], + 'example' => 'MultimodalIntelligentTag', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '代码配置列表的页码。起始值为1，默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，默认为10。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => ['description' => '数据集版本名。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], + 'DatasetJobConfigs' => [ + 'description' => '数据集任务配置列表', + 'type' => 'array', + 'items' => ['description' => '数据集任务配置', '$ref' => '#/components/schemas/DatasetJobConfig'], + ], + ], + ], + ], + ], + 'title' => '获取数据集任务配置列表', + 'summary' => '批量查询数据集任务配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetJobConfigs'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasetJobConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 15,\\n \\"DatasetJobConfigs\\": [\\n {\\n \\"DatasetJobConfigId\\": \\"dscfg-xxxxxxxxxxxx\\",\\n \\"CreateTime\\": \\"2025-01-14T01:37:37Z\\",\\n \\"ModifyTime\\": \\"2024-10-11T02:18:54Z\\",\\n \\"ConfigType\\": \\"MultimodalIntelligentTag\\",\\n \\"Config\\": \\"{ \\\\\\"apiKey\\\\\\":\\\\\\"sk-xxxxxxxxxxxxxxxxxxxxx\\\\\\" }\\",\\n \\"WorkspaceId\\": \\"234*34\\",\\n \\"DatasetVersion\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDatasetJobs' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260535', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集版本ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-lfd60v0p****ujtsdx'], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '1234'], + ], + [ + 'name' => 'JobAction', + 'in' => 'query', + 'schema' => ['description' => '任务操作。', 'type' => 'string', 'required' => false, 'example' => 'SemanticIndex'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页编号。从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'default' => '20'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Succeeded' => 'Succeeded', 'Failed' => 'Failed', 'Starting' => 'Starting', 'Running' => 'Running', 'Deleted' => 'Deleted', 'Pending' => 'Pending', 'PartialFailed' => 'PartialFailed', 'Deleting' => 'Deleting', 'ManuallyStop' => 'ManuallyStop'], + 'example' => 'Running', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。默认DESC。'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序参数，默认根据创建时间倒序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Status' => 'Status', 'JobAction' => 'JobAction', 'FinishTime' => 'FinishTime', 'CreateTime' => 'CreateTime'], + 'example' => 'CreateTime', + ], + ], + [ + 'name' => 'WithLogs', + 'in' => 'query', + 'schema' => ['type' => 'boolean'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], + 'TotalCount' => ['description' => '任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DatasetJobs' => [ + 'description' => '数据集任务列表。', + 'type' => 'array', + 'items' => ['description' => '数据集任务详情。', '$ref' => '#/components/schemas/DatasetJob'], + ], + ], + ], + ], ], - 'produces' => [ - 'application/json', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据集任务列表', + 'summary' => '获取数据集任务列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetJobs'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'operationType' => 'write', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasetJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\",\\n \\"TotalCount\\": 1,\\n \\"DatasetJobs\\": [\\n {\\n \\"DatasetJobId\\": \\"dsjob-9jx1*****uj9e\\",\\n \\"JobAction\\": \\"SemanticIndex\\",\\n \\"CreateTime\\": \\"2023-06-20T04:05:59Z\\",\\n \\"FinishTime\\": \\"2023-06-20T06:03:48Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"Description\\": \\"This is a job description of a dataset.\\",\\n \\"JobMode\\": \\"Full\\",\\n \\"JobSpec\\": \\"{\\\\\\\\\\\\\\"modelId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\",\\n \\"Logs\\": [\\n \\"2025-02-17 09:58:10.143 INFO: Job completed successfully.\\"\\n ],\\n \\"TotalFileCount\\": 1000,\\n \\"CompletedFileCount\\": 990,\\n \\"FailedFileCount\\": 10,\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"WorkspaceId\\": \\"145883\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDatasetVersions' => [ + 'path' => '/api/v1/datasets/{DatasetId}/versions', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '48562', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', + 'abilityTreeCode' => '232574', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '数据集列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页查询时设置的每页行数。默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，对指定的排序字段进行升序或降序。默认值为ASC。'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'], + 'example' => 'ASC', + ], + ], + [ + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => ['description' => '数据集标签，用于过滤数据集列表。标签Key或Value中，有指定字符串的，都会被过滤出来。', 'type' => 'string', 'required' => false, 'example' => 'key1,key2'], + ], + [ + 'name' => 'LabelValues', + 'in' => 'query', + 'schema' => ['description' => '数据集标签，用于过滤数据集列表。标签Key或Value中，有指定字符串的，都会被过滤出来。', 'type' => 'string', 'required' => false, 'example' => 'value1,value2'], + ], + [ + 'name' => 'Properties', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集属性，支持以下取值：'."\n" + .'- DIRECTORY：文件夹。'."\n" + .'- FILE：文件。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], + 'example' => 'DIRECTORY', + ], + ], + [ + 'name' => 'SourceTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '来源类型，支持以下取值：'."\n" + .'- PAI-PUBLIC-DATASET：PAI公共数据集。'."\n" + .'- ITAG：iTAG模块标注结果生成的数据集。'."\n" + .'- USER：用户注册的数据集。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], + 'example' => 'USER', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['description' => '数据来源ID。'."\n" + .'- 当SourceTypes为USER时，SourceId支持自定义。'."\n" + .'- 当SourceTypes为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" + .'- 当SourceTypes为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', 'type' => 'string', 'required' => false, 'example' => 'd-a0xbe5n03bhqof46ce'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的排序字段，默认使用GmtCreateTime。取值如下。'."\n" + .'- GmtCreateTime（默认值）：按创建时间。'."\n" + ."\n" + .'- GmtModifiedTime：按修改时间。'."\n" + ."\n" + .'- SourceType'."\n" + ."\n" + .'- DataSourceType'."\n" + ."\n" + .'- Property'."\n" + ."\n" + .'- DataSize'."\n" + ."\n" + .'- DataCount', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['SourceType' => 'SourceType', 'DataSourceType' => 'DataSourceType', 'DataSize' => 'DataSize', 'DataCount' => 'DataCount', 'Property' => 'Property', 'GmtCreateTime' => 'GmtCreateTime', 'GmtModifiedTime' => 'GmtModifiedTime', 'DatasetId' => 'DatasetId'], + 'example' => 'GmtCreateTime', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0648C5BB-68D0-54D2-92A5-607135B8806B'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '当前页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '符合过滤条件的资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'DatasetVersions' => [ + 'description' => '数据集版本列表', + 'type' => 'array', + 'items' => ['description' => '数据集版本', '$ref' => '#/components/schemas/DatasetVersion'], + ], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据集版本列表', + 'summary' => '获取数据集版本列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetVersions'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasetVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0648C5BB-68D0-54D2-92A5-607135B8806B\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 5,\\n \\"DatasetVersions\\": [\\n {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"base model v1\\",\\n \\"SourceId\\": \\"d-65mrsr5fub4u74lej3\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDatasets' => [ + 'path' => '/api/v1/datasets', + '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' => '48568', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '数据集列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页查询时设置的每页行数。默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，对指定的排序字段进行升序或降序。默认值为ASC。'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'], + 'example' => 'ASC', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '数据集名称，支持根据数据集名称模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'myName'], + ], + [ + 'name' => 'Properties', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集属性，多项之间使用半角逗号（,）分隔。支持以下取值：'."\n" + .'- DIRECTORY：文件夹。'."\n" + .'- FILE：文件。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], + 'example' => 'FILE', + ], + ], + [ + 'name' => 'DataSourceTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源类型，多项之间使用半角逗号分隔。支持以下取值：'."\n" + .'- NAS：数据存储为阿里云文件存储（NAS）。'."\n" + .'- OSS：数据存储为阿里云对象存储（OSS）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], + 'example' => 'OSS', + ], + ], + [ + 'name' => 'DataTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集的数据类型，多项之间使用半角逗号（,）分隔。支持以下取值：'."\n" + .'- VIDEO：视频。'."\n" + .'- COMMON：通用。'."\n" + .'- TEXT：文本。'."\n" + .'- PIC：图片。'."\n" + .'- AUDIO：音频。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['VIDEO' => 'VIDEO', 'COMMON' => 'COMMON', 'TEXT' => 'TEXT', 'PIC' => 'PIC', 'AUDIO' => 'AUDIO'], + 'example' => 'COMMON,TEXT', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['description' => '数据来源ID。'."\n" + .'- 当SourceTypes为USER时，SourceId支持自定义。'."\n" + .'- 当SourceTypes为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" + .'- 当SourceTypes为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', 'type' => 'string', 'required' => false, 'example' => 'd-rbvg5wzljzjhc9ks92'], + ], + [ + 'name' => 'SourceTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '来源类型，多项之间使用半角逗号分隔。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], + 'example' => 'USER,ITAG', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['title' => 'Workspace Id', 'description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。'."\n" + .'如果不配置该参数，则会使用默认工作空间；如果默认工作空间不存在，则会报错。', 'type' => 'string', 'required' => false, 'example' => '324**'], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => ['description' => '数据集标签，用于过滤数据集列表。标签Key或Value中，有指定字符串的，都会被过滤出来。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Provider', + 'in' => 'query', + 'schema' => ['description' => '数据集提供方。返回值为"pai"时表示该数据集为PAI平台的公共数据集。', 'type' => 'string', 'required' => false, 'example' => 'pai'], + ], + [ + 'name' => 'SourceDatasetId', + 'in' => 'query', + 'schema' => ['title' => 'iTag标注集的源数据集。', 'description' => 'iTag标注集的来源数据集ID。', 'type' => 'string', 'required' => false, 'example' => 'd-rcdg3wxxxxxhc5jk87'."\n"], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => '排序字段', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['DataSourceType' => 'DataSourceType', 'DataType' => 'DataType', 'GmtCreateTime' => 'GmtCreateTime', 'GmtModifiedTime' => 'GmtModifiedTime'], + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'ShareScope', + 'in' => 'query', + 'schema' => [ + 'description' => '分享数据集过滤器：'."\n" + .'* TO_ME: 仅过滤分享给我的数据集。'."\n" + .'* BY_ME: 仅过滤我分享给他人的数据集，展示分享配置详情。'."\n" + .'* 不设置该参数或设置为空：获取当前工作空间的所有的数据集，包括TO_ME。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['TO_ME' => 'TO_ME', 'BY_ME' => 'BY_ME'], + 'example' => 'BY_ME', + ], + ], + [ + 'name' => 'Edition', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集类型。枚举值：'."\n" + ."\n" + .'- BASIC：基础型。不支持数据集文件元数据管理。'."\n" + .'- ADVANCED：高级型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。'."\n" + .'- LOGICAL: 逻辑型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。适用于绝大部分场景，需配合SDK使用。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['LOGICAL' => 'LOGICAL', 'BASIC' => 'BASIC', 'ADVANCED' => 'ADVANCED'], + 'example' => 'BASIC', + ], ], - ], - 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'Accessibility', + 'in' => 'query', 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => 'Name', - 'description' => '数据集的名称。命名规则如下：'."\n" - .'- 以小写字母、大写字母、数字或中文开头。'."\n" - .'- 可以包含下划线（_）或短划线（-）。'."\n" - .'- 长度为1~127个字符。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'myName', - ], - 'Property' => [ - 'title' => 'Property', - 'description' => '数据集的属性。支持以下取值：'."\n" - .'- FILE：文件。'."\n" - .'- DIRECTORY：文件夹。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'DIRECTORY' => 'DIRECTORY', - 'FILE' => 'FILE', - ], - 'example' => 'DIRECTORY', - ], - 'DataSourceType' => [ - 'title' => 'DataSourceType', - 'description' => '数据源类型。支持以下取值：'."\n" - .'- OSS：阿里云对象存储（OSS）。'."\n" - .'- NAS：阿里云文件存储（NAS）通用型。'."\n" - .'- EXTREMENAS：阿里云文件存储（NAS）极速型。'."\n" - .'- CPFS: 阿里云文件存储（CPFS）通用版。'."\n" - .'- BMCPFS：阿里云文件存储（CPFS）智算版。 '."\n" - .'- MAXCOMPUTE：阿里云云原生大数据计算服务（MaxCompute）。'."\n" - .'- URL：公网HTTP/HTTPS地址。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'NAS' => 'NAS', - 'MAXCOMPUTE' => 'MAXCOMPUTE', - 'CPFS' => 'CPFS', - 'BMCPFS' => 'BMCPFS', - 'EXTREMENAS' => 'EXTREMENAS', - 'OSS' => 'OSS', - 'URL' => 'URL', - ], - 'example' => 'NAS', - ], - 'Uri' => [ - 'title' => 'Uri', - 'description' => 'Uri配置样例如下：'."\n" - .'- 数据源类型为OSS：`oss://bucket.endpoint/object`'."\n" - .'- 数据源类型为NAS：'."\n" - .'通用型NAS格式为：`nas://.region/subpath/to/dir/`；'."\n" - .'CPFS1.0：`nas://.region/subpath/to/dir/`；'."\n" - .'CPFS2.0：`nas://.region//`。'."\n" - .'CPFS1.0和CPFS2.0根据fsid的格式来区分：CPFS1.0 格式为cpfs-<8位ASCII字符>；CPFS2.0 格式为cpfs-<16位ASCII字符>。', - 'type' => 'string', - 'required' => true, - 'example' => 'nas://09f****f2.cn-hangzhou/', - ], - 'DataType' => [ - 'title' => 'DataType', - 'description' => '数据集的数据类型，默认为COMMON。支持以下取值：'."\n" - .'- COMMON：普通。'."\n" - .'- PIC：图片。'."\n" - .'- TEXT：文本。'."\n" - .'- VIDEO：视频。'."\n" - .'- AUDIO：音频。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'VIDEO' => 'VIDEO', - 'COMMON' => 'COMMON', - 'TEXT' => 'TEXT', - 'PIC' => 'PIC', - 'AUDIO' => 'AUDIO', - ], - 'example' => 'COMMON', - ], - 'Labels' => [ - 'title' => 'Labels', - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '为数据集添加的标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - 'SourceType' => [ - 'title' => 'SourceType', - 'description' => '数据来源类型，默认为USER。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', - 'ITAG' => 'ITAG', - 'USER' => 'USER', - ], - 'example' => 'USER', - ], - 'SourceId' => [ - 'title' => 'SourceId', - 'description' => '数据来源ID。'."\n" - .'- 当SourceType为USER时，SourceId支持自定义。'."\n" - .'- 当SourceType为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" - .'- 当SourceType为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'jdnhf***fnrimv', - ], - 'Description' => [ - 'title' => 'Description', - 'description' => '对数据集进行自定义描述，以区分不同的数据集。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the dataset.', - ], - 'WorkspaceId' => [ - 'title' => 'WorkspaceId', - 'description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。'."\n" - .'如果不配置该参数，则会使用默认工作空间；如果默认工作空间不存在，则会报错。', - 'type' => 'string', - 'required' => false, - 'example' => '478**', - ], - 'Options' => [ - 'title' => 'Options', - 'description' => '扩展字段，JsonString类型。'."\n" - .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "mountPath": "/mnt/data/"'."\n" - .'}', - ], - 'Accessibility' => [ - 'title' => 'Accessibility', - 'description' => '工作空间可见度。支持以下取值：'."\n" - .'- PRIVATE（默认值）：表示工作空间内自己以及管理员可见。'."\n" - .'- PUBLIC为：工作空间所有用户可见。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], - 'example' => 'PRIVATE', - ], - 'ProviderType' => [ - 'title' => 'ProviderType', - 'description' => '数据集的数据源来源类型，支持配置的类型如下：'."\n" - .'- Ecs（默认值）'."\n" - .'- Lingjun', - 'type' => 'string', - 'required' => false, - 'example' => 'Ecs', - ], - 'Provider' => [ - 'description' => '数据集提供者。不允许设置为pai。', - 'type' => 'string', - 'required' => false, - 'example' => 'Github', - ], - 'UserId' => [ - 'title' => '数据集所有者', - 'description' => '数据集所有者的阿里云账号ID。工作空间所有者和管理员有权限给指定工作空间成员创建数据集。', - 'type' => 'string', - 'required' => false, - 'example' => '2485765****023475', - ], - 'SourceDatasetId' => [ - 'title' => 'iTag标注集的源数据集', - 'description' => '标注数据集的来源数据集ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-bvfasdfxxxxj8o411', - ], - 'SourceDatasetVersion' => [ - 'title' => 'iTag标注集的源数据集版本', - 'description' => '标注数据集的来源数据集版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'v2', - ], - 'VersionDescription' => [ - 'description' => '数据集初始版本的描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the first dataset version.', - ], - 'VersionLabels' => [ - 'description' => '初始版本标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '为数据集初始版本添加的标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - 'DataSize' => [ - 'description' => '数据集文件占据空间的大小。单位Byte 。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '999999999999', - 'minimum' => '1', - 'example' => '10000', - ], - 'DataCount' => [ - 'description' => '数据集文件数量，单位个。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '999999999999', - 'minimum' => '1', - 'example' => '500', - ], - 'MountAccessReadWriteRoleIdList' => [ - 'description' => '指定该数据集被挂载时具有读写权限的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。'."\n" - .'- 指定角色下的账号： ["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"]'."\n" - .'- 全部账号：["*"]'."\n" - .'- 指定为数据集创建者: []', - 'type' => 'array', - 'items' => [ - 'description' => '工作空间角色ID', - 'type' => 'string', - 'required' => false, - 'example' => 'PAI.AlgoOperator', - ], - 'required' => false, - ], - 'ImportInfo' => [ - 'description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" - ."\n" - .'
'."\n" - .'OSS'."\n" - .'{
'."\n" - .'"region": "${region}",//地域ID
'."\n" - .'"bucket": "${bucket}",//bucket名称
'."\n" - .'"path": "${path}" //文件路径
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'NAS'."\n" - .'{
'."\n" - .'"region": "${region}",//地域ID
'."\n" - .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .'"path": "${path}", //文件系统路径
'."\n" - .'"mountTarget": "${mount_target}" //文件系统挂载点
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'CPFS'."\n" - .'{
'."\n" - .'"region": "${region}",//地域ID
'."\n" - .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .'"protocolServiceId":"${protocol_service_id}", //文件系统协议服务
'."\n" - .'"exportId": "${export_id}", //文件系统导出目录
'."\n" - .'"path": "${path}", //文件系统路径
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'智算CPFS'."\n" - .'{
'."\n" - .'"region": "${region}",//地域ID
'."\n" - .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .'"path": "${path}", //文件系统路径
'."\n" - .'"mountTarget": "${mount_target}" //文件系统挂载点，智算版特有
'."\n" - .'"isVpcMount": boolean, //是否为vpc挂载点, 智算版特有
'."\n" - .'}
'."\n" - .'
', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "region": "cn-wulanchabu",'."\n" - .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" - .' "path": "/mnt",'."\n" - .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" - .' "isVpcMount": true'."\n" - .'}', - ], - 'Edition' => [ - 'description' => '数据集类型。默认为BASIC，支持以下取值：'."\n" - ."\n" - .'- BASIC：基础型。不支持数据集文件元数据管理。'."\n" - .'- ADVANCED：高级型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。'."\n" - .'- LOGICAL：逻辑型。仅OSS类型支持，每个版本支持最多300万个文件元数据管理。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LOGICAL' => 'LOGICAL', - 'BASIC' => 'BASIC', - 'ADVANCED' => 'ADVANCED', - ], - 'example' => 'ADVANCED', - ], - ], + 'description' => '数据集的可见性。'."\n" + ."\n" + .'- PUBLIC表示公开。'."\n" + .'- PRIVATE表示私有。', + 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], + 'example' => 'PRIVATE', ], ], + [ + 'name' => 'DatasetIds', + 'in' => 'query', + 'schema' => ['description' => '数据集ID（支持输入多个数据集ID，用","分隔）。', 'type' => 'string', 'required' => false, 'example' => 'd-rcdg3wxxxxxhc5jk87'], + ], ], 'responses' => [ 200 => [ @@ -12833,69 +9849,132 @@ 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B2C51F93-1C07-5477-9705-5FDB****F19F', - ], - 'DatasetId' => [ - 'description' => '数据集ID。', - 'type' => 'string', - 'example' => 'd-rbvg5*****jhc9ks92', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'Datasets' => [ + 'description' => '数据集列表。', + 'type' => 'array', + 'items' => ['description' => '数据集。', '$ref' => '#/components/schemas/Dataset'], ], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2C51F93-1C07-5477-9705-5FDB****F19F\\",\\n \\"DatasetId\\": \\"d-rbvg5*****jhc9ks92\\"\\n}","type":"json"}]', - 'title' => '创建数据集', - ], - 'GetDataset' => [ - 'summary' => '获取数据集。', - 'path' => '/api/v1/datasets/{DatasetId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取数据集列表', + 'summary' => '获取某个工作空间下的数据集列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasets'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Datasets\\": [\\n {\\n \\"DatasetId\\": \\"d-c0h44g3****j8o4348\\",\\n \\"UserId\\": \\"2485765****023475\\",\\n \\"OwnerId\\": \\"1631044****3440\\",\\n \\"Name\\": \\"myName\\",\\n \\"DataSourceType\\": \\"NAS\\",\\n \\"Uri\\": \\"nas://09f****f2.cn-hangzhou/\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"DataType\\": \\"COMMON\\",\\n \\"Property\\": \\"DIRECTORY\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"SourceId\\": \\"jdnhf***fnrimv\\",\\n \\"Description\\": \\"This is a description of a dataset.\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"SourceDatasetId\\": \\"d-bvfasdfxxxxj8o411\\",\\n \\"SourceDatasetVersion\\": \\"v2\\",\\n \\"TagTemplateType\\": \\"text-classification\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"base model v1\\",\\n \\"SourceId\\": \\"d-65mrsr5fub4u74lej3\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n },\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\",\\n \\"Edition\\": \\"BASIC\\",\\n \\"IsShared\\": false,\\n \\"SharedFrom\\": {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SourceTenantId\\": \\"148***************115\\",\\n \\"SourceWorkspaceId\\": \\"33**19\\",\\n \\"TenantId\\": \\"153***************249\\",\\n \\"WorkspaceId\\": \\"42**2\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"2025-08-27T12:23:58Z\\",\\n \\"ExpiresAt\\": \\"2026-08-27T12:23:58Z\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"RO\\"\\n ],\\n \\"Extra\\": \\"{\\\\\\"AllowExportModel\\\\\\":false,\\\\\\"AllowAccessDLCWebTerminal\\\\\\":false,\\\\\\"AllowAccessDLCFullLog\\\\\\":false}\\"\\n },\\n \\"SharingConfig\\": {\\n \\"SharedTo\\": [\\n {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SourceTenantId\\": \\"148***************115\\",\\n \\"SourceWorkspaceId\\": \\"33**19\\",\\n \\"TenantId\\": \\"153***************249\\",\\n \\"WorkspaceId\\": \\"42**2\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"2025-08-27T12:23:58Z\\",\\n \\"ExpiresAt\\": \\"2026-08-27T12:23:58Z\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"RO\\"\\n ],\\n \\"Extra\\": \\"{\\\\\\"AllowExportModel\\\\\\":false,\\\\\\"AllowAccessDLCWebTerminal\\\\\\":false,\\\\\\"AllowAccessDLCFullLog\\\\\\":false}\\"\\n }\\n ]\\n },\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"MountAccessReadWriteRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ],\\n \\"AccessibleRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', + ], + 'ListExperiment' => [ + 'path' => '/api/v1/experiments', + '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' => '48564', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', + 'operationType' => 'list', + 'abilityTreeCode' => '206995', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '实验名称。', 'type' => 'string', 'required' => false, 'example' => 'exp-test'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '实验所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。'."\n" + .'> 不填写工作空间ID，系统将返回默认工作空间的实验列表。'."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => '1517**'], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => ['description' => '标签过滤条件，多个条件以半角逗号（,）分隔。'."\n" + .'单个条件过滤格式为`Key=Value`。', 'type' => 'string', 'required' => false, 'example' => 'is_evaluation:true'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => '分页查询时的排序字段。目前GmtCreateTime字段用于排序。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'default' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => '分页查询时，对指定的排序字段进行升序或降序。'."\n" + .'- ASC：升序。'."\n" + .'- DESC（默认）：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => '分页编号，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '排序方式字符串列表，支持排序的字段包括：GmtCreateTime、Name、GmtModifiedTime或ExperimentId。排序方式包括DESC和ASC，默认为ASC。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime DESC,Name ASC'], + ], + [ + 'name' => 'PageToken', + 'in' => 'query', + 'schema' => ['description' => '分页token，从0开始，默认为0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => '0'], ], - ], - 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '请求的最大结果数，默认为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['title' => '是否获取于实验相关的LatestRun', 'description' => '是否获取于实验相关的LatestRun信息。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'False'], + ], + [ + 'name' => 'Options', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Dataset Id', - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wz****c9ks92', + 'description' => '可选参数。', + 'type' => 'object', + 'properties' => [ + 'match_name_exactly' => ['title' => '是否精确匹配名称，可以填“true“/”false“', 'description' => '是否精确匹配名称，可以填“true“或”false“。', 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + 'required' => false, ], ], ], @@ -12903,781 +9982,661 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'DatasetId' => [ - 'description' => '数据集ID。', - 'type' => 'string', - 'example' => 'd-rbvg5wz****c9ks92', - ], - 'Name' => [ - 'description' => '数据集名称。', - 'type' => 'string', - 'example' => 'myName', - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => '用于标注的数据。', - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'GmtModifiedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'UserId' => [ - 'description' => '数据集所属用户ID。', - 'type' => 'string', - 'example' => '2485765****023475', - ], - 'OwnerId' => [ - 'description' => '主账户ID。', - 'type' => 'string', - 'example' => '1631044****3440', - ], - 'Property' => [ - 'description' => '数据集初始版本v1的属性。可能值：'."\n" - .'- FILE：文件。'."\n" - .'- DIRECTORY：文件夹。', - 'type' => 'string', - 'enumValueTitles' => [ - 'DIRECTORY' => 'DIRECTORY', - 'FILE' => 'FILE', - ], - 'example' => 'DIRECTORY', - ], - 'DataSourceType' => [ - 'description' => '数据源类型。可能值：'."\n" - .'- OSS：阿里云对象存储（OSS）。'."\n" - .'- NAS：阿里云文件存储（NAS）。', - 'type' => 'string', - 'enumValueTitles' => [ - 'NAS' => 'NAS', - 'OSS' => 'OSS', - ], - 'example' => 'NAS', - ], - 'Uri' => [ - 'description' => '初始版本v1的Uri，样例格式：'."\n" - .'- 数据源类型为OSS：`oss://bucket.endpoint/object`。'."\n" - .'- 数据源类型为NAS：'."\n" - .'通用型NAS格式为：`nas://.region/subpath/to/dir/`；'."\n" - .'CPFS1.0：`nas://.region/subpath/to/dir/`；'."\n" - .'CPFS2.0：`nas://.region//`；'."\n" - .'CPFS1.0和CPFS2.0根据fsid的格式来区分：'."\n" - .'CPFS1.0 格式为cpfs-<8位ascii字符>；'."\n" - .'CPFS2.0 格式为cpfs-<16为ascii字符>。', - 'type' => 'string', - 'example' => 'nas://09f****f2.cn-hangzhou/', - ], - 'Labels' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '为数据集添加的标签。', - 'example' => '{"Key": "env", "Value": "test"}', - '$ref' => '#/components/schemas/Label', - ], - ], - 'DataType' => [ - 'description' => '数据集的数据类型，可能值：'."\n" - ."\n" - .'- COMMON：普通。'."\n" - .'- PIC：图片。'."\n" - .'- TEXT：文本。'."\n" - .'- VIDEO：视频。'."\n" - .'- AUDIO：音频。', - 'type' => 'string', - 'enumValueTitles' => [ - 'VIDEO' => 'VIDEO', - 'COMMON' => 'COMMON', - 'TEXT' => 'TEXT', - 'PIC' => 'PIC', - 'AUDIO' => 'AUDIO', - ], - 'example' => 'COMMON', - ], - 'SourceType' => [ - 'description' => '数据来源初始版本v1的类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', - 'ITAG' => 'ITAG', - 'USER' => 'USER', - ], - 'example' => 'USER', - ], - 'SourceId' => [ - 'description' => '初始版本v1的数据来源ID，可能值：'."\n" - .'- 当SourceType为USER时，SourceId支持自定义。'."\n" - .'- 当SourceType为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" - .'- 当SourceType为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', - 'type' => 'string', - 'example' => 'jdnhf***fnrimv', - ], - 'WorkspaceId' => [ - 'description' => '数据集所在工作空间ID。', - 'type' => 'string', - 'example' => '478**', - ], - 'Options' => [ - 'description' => '初始版本v1的扩展字段，JsonString类型。'."\n" - .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', - 'type' => 'string', - 'example' => '{'."\n" - .' "mountPath": "/mnt/data/"'."\n" - .'}', - ], - 'Accessibility' => [ - 'description' => '工作空间可见度。可能值：'."\n" - .'- PRIVATE：表示工作空间内自己以及管理员可见。'."\n" - .'- PUBLIC：为工作空间所有用户可见。', - 'type' => 'string', - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], - 'example' => 'PRIVATE', - ], - 'ProviderType' => [ - 'description' => '数据集的数据源来源类型。取值如下：'."\n" - .'- Ecs （默认）'."\n" - .'- Lingjun', - 'type' => 'string', - 'example' => 'Ecs', - ], - 'Provider' => [ - 'description' => '数据集提供方。返回值为"pai"时表示该数据集为PAI平台的公共数据集。', - 'type' => 'string', - 'example' => 'pai', - ], - 'SourceDatasetId' => [ - 'description' => 'iTag标注集的来源数据集ID。', - 'type' => 'string', - 'example' => 'd-rcdg3wxxxxxhc5jk87'."\n", - ], - 'SourceDatasetVersion' => [ - 'description' => '标注数据集的来源数据集版本。', - 'type' => 'string', - 'example' => 'v2', - ], - 'TagTemplateType' => [ - 'description' => 'iTag标注数据集的标注模板', - 'type' => 'string', - 'example' => 'TextClassification', - ], - 'LatestVersion' => [ - 'description' => '数据集的最新版本。', - '$ref' => '#/components/schemas/DatasetVersion', - ], - 'MountAccess' => [ - 'description' => '该数据集被挂载时的权限。'."\n" - .'- RO：只读挂载'."\n" - .'- RW：读写挂载', - 'type' => 'string', - 'example' => 'RW', - ], - 'MountAccessReadWriteRoleIdList' => [ - 'description' => '具有该数据集读写权限的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C'], + 'TotalCount' => ['description' => '记录总数', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'Experiments' => [ + 'description' => '实验列表。', 'type' => 'array', - 'items' => [ - 'description' => '工作空间角色ID', - 'type' => 'string', - 'example' => 'PAI.AlgoOperator', - ], - ], - 'ImportInfo' => [ - 'description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" - ."\n" - .'
'."\n" - .'OSS'."\n" - .'{
'."\n" - .'"region": "${region}",//地域ID
'."\n" - .'"bucket": "${bucket}",//bucket名称
'."\n" - .'"path": "${path}" //文件路径
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'NAS'."\n" - .'{
'."\n" - .'"region": "${region}",//地域ID
'."\n" - .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .'"path": "${path}", //文件系统路径
'."\n" - .'"mountTarget": "${mount_target}" //文件系统挂载点
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'CPFS'."\n" - .'{
'."\n" - .'"region": "${region}",//地域ID
'."\n" - .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .'"protocolServiceId":"${protocol_service_id}", //文件系统协议服务
'."\n" - .'"exportId": "${export_id}", //文件系统导出目录
'."\n" - .'"path": "${path}", //文件系统路径
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'智算CPFS'."\n" - .'{
'."\n" - .'"region": "${region}",//地域ID
'."\n" - .'"fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .'"path": "${path}", //文件系统路径
'."\n" - .'"mountTarget": "${mount_target}" //文件系统挂载点，智算版特有
'."\n" - .'"isVpcMount": boolean, //是否为vpc挂载点, 智算版特有
'."\n" - .'}
'."\n" - .'
', - 'type' => 'string', - 'example' => '{'."\n" - .' "region": "cn-wulanchabu",'."\n" - .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" - .' "path": "/mnt",'."\n" - .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" - .' "isVpcMount": true'."\n" - .'}', - ], - 'Edition' => [ - 'description' => '数据集类型。枚举值：'."\n" - ."\n" - .'- BASIC：基础型。不支持数据集文件元数据管理。'."\n" - ."\n" - .' '."\n" - ."\n" - .'- ADVANCED：高级型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。', - 'type' => 'string', - 'example' => 'BASIC', - ], - 'IsShared' => [ - 'description' => '是否为共享数据集。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'false' => 'false', - 'true' => 'true', - ], - 'example' => 'false', - ], - 'SharedFrom' => [ - 'description' => '描述该分享数据集的来源关系。仅IsShared为true时有效。', - '$ref' => '#/components/schemas/DatasetShareRelationship', - ], - 'SharingConfig' => [ - 'description' => '当前数据集的分享配置信息。', - 'type' => 'object', - 'properties' => [ - 'SharedTo' => [ - 'description' => '多条分享配置关系。', - 'type' => 'array', - 'items' => [ - 'description' => '该数据集被分享的分享配置关系。', - '$ref' => '#/components/schemas/DatasetShareRelationship', - ], - ], - ], + 'items' => ['description' => '实验详情。', '$ref' => '#/components/schemas/Experiment'], ], + 'NextPageToken' => ['description' => '下一页标识。需记录下来，在下一次请求时传入即可。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetId\\": \\"d-rbvg5wz****c9ks92\\",\\n \\"Name\\": \\"myName\\",\\n \\"Description\\": \\"用于标注的数据。\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"2485765****023475\\",\\n \\"OwnerId\\": \\"1631044****3440\\",\\n \\"Property\\": \\"DIRECTORY\\",\\n \\"DataSourceType\\": \\"NAS\\",\\n \\"Uri\\": \\"nas://09f****f2.cn-hangzhou/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"DataType\\": \\"COMMON\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"SourceId\\": \\"jdnhf***fnrimv\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"Provider\\": \\"pai\\",\\n \\"SourceDatasetId\\": \\"d-rcdg3wxxxxxhc5jk87\\\\n\\",\\n \\"SourceDatasetVersion\\": \\"v2\\",\\n \\"TagTemplateType\\": \\"TextClassification\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"DataCount\\": 0,\\n \\"DataSize\\": 0,\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"\\"\\n },\\n \\"MountAccess\\": \\"RW\\",\\n \\"MountAccessReadWriteRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ],\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\",\\n \\"Edition\\": \\"BASIC\\",\\n \\"IsShared\\": false,\\n \\"SharedFrom\\": {\\n \\"Status\\": \\"\\",\\n \\"SourceTenantId\\": \\"\\",\\n \\"SourceWorkspaceId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"\\",\\n \\"ExpiresAt\\": \\"\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"\\"\\n ],\\n \\"Extra\\": \\"\\"\\n },\\n \\"SharingConfig\\": {\\n \\"SharedTo\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"SourceTenantId\\": \\"\\",\\n \\"SourceWorkspaceId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"\\",\\n \\"ExpiresAt\\": \\"\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"\\"\\n ],\\n \\"Extra\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取数据集', - ], - 'UpdateDataset' => [ - 'summary' => '更新数据集，支持更新名称，描述等。', - 'path' => '/api/v1/datasets/{DatasetId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取实验列表', + 'summary' => '获取实验列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListExperiment'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiexperiment:ListExperiments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C\\",\\n \\"TotalCount\\": 5,\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"ArtifactUri\\": \\"\\",\\n \\"TensorboardLogUri\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"GmtCreateTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"ExperimentId\\": \\"exp-890waerw09a0f\\"\\n }\\n ],\\n \\"UserId\\": \\"\\",\\n \\"OwnerId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"LatestRun\\": {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"SourceId\\": \\"train9s0afvjkf\\",\\n \\"SourceType\\": \\"TrainingService\\",\\n \\"WorkspaceId\\": \\"145883\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Name\\": \\"testrun\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"163104*****3440\\",\\n \\"ExperimentId\\": \\"exp-1zpfthdx******\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"run-1qJhzJ2YXgX****\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', + ], + 'ListFeatures' => [ + 'path' => '/api/v1/features', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '48566', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '101118', + 'abilityTreeNodes' => ['FEATURElearnZO51AS'], ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wz****c9ks92', - ], + 'name' => 'Names', + 'in' => 'query', + 'schema' => ['title' => '特性名称，以逗号分隔', 'description' => '特性名称，以逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'PaiConsole:IntegrateWithWorkspace'], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体。', + 'title' => 'Schema of Response', + 'description' => '响应。', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '数据集名称。如何获取数据集名称，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'myName', - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the dataset.', - ], - 'Options' => [ - 'description' => '扩展字段，JsonString类型。'."\n" - .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "mountPath": "/mnt/data/"'."\n" - .'}', - ], - 'Edition' => [ - 'description' => '数据集类型。支持从BASIC（基础型）升级为ADVANCED（高级型）。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'ADVANCED', - ], - 'MountAccessReadWriteRoleIdList' => [ - 'description' => '指定该数据集被挂载时具有读写权限的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。'."\n" - .'- 指定角色下的账号： ["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"]'."\n" - .'- 全部账号：["*"]'."\n" - .'- 指定为数据集创建者: []', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'TotalCount' => ['title' => '特性总数', 'description' => '特性总数', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Features' => [ + 'title' => '特性列表', + 'description' => '特性列表', 'type' => 'array', - 'items' => [ - 'description' => '工作空间角色ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'PAI.AlgoOperator'."\n", - ], - 'required' => false, - ], - 'SharingConfig' => [ - 'description' => '当前数据集的分享配置信息。', - 'type' => 'object', - 'properties' => [ - 'SharedTo' => [ - 'description' => '该数据集被分享的分享配置关系。', - 'type' => 'array', - 'items' => [ - 'description' => '分享配置关系。', - 'required' => false, - '$ref' => '#/components/schemas/DatasetShareRelationship', - ], - 'required' => false, - ], - ], - 'required' => false, + 'items' => ['description' => '特性。', 'type' => 'string', 'example' => 'PaiConsole:IntegrateWithWorkspace'."\n"], ], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列举客户特性', + 'summary' => '列举特性', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFeatures'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListFeatures', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 2,\\n \\"Features\\": [\\n \\"PaiConsole:IntegrateWithWorkspace\\\\n\\"\\n ]\\n}","type":"json"}]', + ], + 'ListImageLabels' => [ + 'path' => '/api/v1/image/labels', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '61618', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], + ], + 'parameters' => [ + [ + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => ['title' => '标签列表，以逗号分隔', 'description' => '标签键的列表，以半角逗号（,）分隔。'."\n" + .'系统标签以system开头，与LabelFilter分别独立生效。', 'type' => 'string', 'required' => false, 'example' => 'system.framework,system.official'], + ], + [ + 'name' => 'LabelFilter', + 'in' => 'query', + 'schema' => ['title' => 'image过滤条件，获取满足条件的image的所有label', 'description' => '标签过滤条件，多个条件以逗号分隔。'."\n" + .'单个条件过滤格式为`key=value`。'."\n" + .'与LabelKeys分别独立生效。', 'type' => 'string', 'required' => false, 'example' => 'system.framework=XGBoost 1.6.0,system.official=true'], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => ['title' => '镜像id', 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', 'type' => 'string', 'required' => false, 'example' => 'image-4c62******53uor'."\n"], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['title' => '工作空间id', 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '12345'], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['title' => '地域', 'description' => '镜像所属地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '返回结构体。'."\n" + ."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'Labels' => [ + 'title' => '镜像标签', + 'description' => '镜像标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '键', 'description' => '标签的键。', 'type' => 'string', 'example' => 'system.chipType'], + 'Value' => ['title' => '值', 'description' => '标签的值。', 'type' => 'string', 'example' => 'GPU'], + ], + ], ], + 'TotalCount' => ['title' => '符合过滤条件的数量', 'description' => '符合过滤条件的镜像标签列表数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '更新数据集', - ], - 'PublishDataset' => [ - 'summary' => '将私有数据集在工作空间内公开。', - 'path' => '/api/v1/datasets/{DatasetId}/publish', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取镜像标签列表', + 'summary' => '获取镜像标签列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiimage:ListImageLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', + ], + 'ListImages' => [ + 'path' => '/api/v1/images', + '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' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '48571', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '61620', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5w****c9ks92', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '镜像名称，支持模糊搜索', 'description' => '镜像名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'tensorflow_2.9'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '分页，从1开始，默认1', 'description' => '镜像列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '页大小，默认20', 'description' => '分页查询时设置的每页行数。默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '排序字段', 'description' => '分页查询时的排序字段。目前GmtCreateTime字段用于排序。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '排序方向： ASC - 升序 DESC - 降序', 'description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。默认ASC。'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => ['title' => '过滤值 以逗号分隔', 'description' => '标签过滤条件，多个条件以半角逗号（,）分隔。'."\n" + .'单个条件过滤格式为`Key=Value`。'."\n" + .'Key支持如下值：'."\n" + ."\n" + .'- system.chipType'."\n" + .'- system.dsw.cudaVersion'."\n" + .'- system.dsw.fromImageId'."\n" + .'- system.dsw.fromInstanceId'."\n" + .'- system.dsw.id'."\n" + .'- system.dsw.os'."\n" + .'- system.dsw.osVersion'."\n" + .'- system.dsw.resourceType'."\n" + .'- system.dsw.rootImageId'."\n" + .'- system.dsw.stage'."\n" + .'- system.dsw.tag'."\n" + .'- system.dsw.type'."\n" + .'- system.framework'."\n" + .'- system.origin'."\n" + .'- system.pythonVersion'."\n" + .'- system.source'."\n" + .'- system.supported.dlc'."\n" + .'- system.supported.dsw', 'type' => 'string', 'required' => false, 'example' => 'system.framework=XGBoost 1.6.0,system.official=true'."\n"], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['title' => '是否显示非必要信息：Labels', 'description' => '是否显示非必要信息，非必要信息目前包含Labels。取值如下：'."\n" + ."\n" + .'- true：包含非必要信息。'."\n" + .'- false：不包含非必要信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['title' => '工作空间id', 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '20******55'], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => ['description' => '模糊搜索镜像名称以及描述。', 'type' => 'string', 'required' => false, 'example' => 'name'], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => ['description' => '镜像的可见性，目前只对自定义镜像生效。'."\n" + ."\n" + .'- PUBLIC表示公开。'."\n" + .'- PRIVATE表示私有。', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'TotalCount' => ['title' => '总数', 'description' => '返回的镜像总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Images' => [ + 'title' => '镜像列表', + 'description' => '镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '镜像名称', 'description' => '镜像名称。', 'type' => 'string', 'example' => 'tensorflow_2.9'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '创建UTC时间，日期格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'Description' => ['title' => '镜像描述', 'description' => '镜像描述。', 'type' => 'string', 'example' => 'desc'], + 'ImageUri' => ['title' => '镜像地址，包含版本号', 'description' => '镜像地址，包含版本号。', 'type' => 'string', 'example' => 'registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0'], + 'Labels' => [ + 'title' => '镜像标签，是个map', + 'description' => '镜像标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'Key', 'description' => '标签的键。', 'type' => 'string', 'example' => 'system.chipType'], + 'Value' => ['title' => 'Value', 'description' => '标签的值。', 'type' => 'string', 'example' => 'GPU'], + ], + ], + ], + 'ImageId' => ['title' => '镜像id', 'description' => '镜像ID。', 'type' => 'string', 'example' => 'image-tzi7f9******s45t'], + 'Accessibility' => ['title' => '可见性', 'description' => '镜像的可见性，可能值：'."\n" + .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" + .'- PRIVATE：只有创建者可以操作。', 'type' => 'string', 'example' => 'PUBLIC'], + 'GmtModifiedTime' => ['title' => '修改时间', 'description' => '修改UTC时间，格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'."\n"], + 'UserId' => ['title' => '创建人', 'description' => '创建者的阿里云账号UID。', 'type' => 'string', 'example' => '155**********904'], + 'ParentUserId' => ['title' => '父创建人', 'description' => '创建者的阿里云账号UID。', 'type' => 'string', 'example' => '155**********904'], + 'WorkspaceId' => ['title' => '工作空间id', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '20******55'], + 'Size' => ['description' => '镜像大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'SourceType' => ['title' => '镜像来源类型', 'description' => '镜像来源类型', 'type' => 'string'], + 'SourceId' => ['title' => '镜像来源 ID', 'description' => '镜像来源 ID', 'type' => 'string'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', - 'title' => '发布数据集', - ], - 'ListDatasets' => [ - 'summary' => '获取某个工作空间下的数据集列表。', - 'path' => '/api/v1/datasets', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取镜像列表', + 'summary' => '获取镜像列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiimage:ListImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 2,\\n \\"Images\\": [\\n {\\n \\"Name\\": \\"tensorflow_2.9\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Description\\": \\"desc\\",\\n \\"ImageUri\\": \\"registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"ImageId\\": \\"image-tzi7f9******s45t\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\\\n\\",\\n \\"UserId\\": \\"155**********904\\",\\n \\"ParentUserId\\": \\"155**********904\\",\\n \\"WorkspaceId\\": \\"20******55\\",\\n \\"Size\\": 2,\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListMembers' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/members', + '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' => '48568', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '14243', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], + ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '数据集列表的页码。起始值为1，默认为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '分页，从1开始，默认1', 'description' => '工作空间列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时设置的每页行数。默认为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '页大小，默认20', 'description' => '分页查询时设置的每页行数。默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ - 'name' => 'Order', + 'name' => 'Roles', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，对指定的排序字段进行升序或降序。默认值为ASC。'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => 'ASC', - 'DESC' => 'DESC', - ], - 'example' => 'ASC', - ], + 'schema' => ['title' => 'Role 过滤列表，逗号分隔', 'description' => '使用角色过滤成员，多个角色以半角逗号（,）分隔。'."\n" + .'支持以下角色名：'."\n" + .'- PAI.AlgoDeveloper：算法开发。'."\n" + .'- PAI.AlgoOperator：算法运维。'."\n" + .'- PAI.LabelManager：标注管理员。'."\n" + .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" + .'- PAI.WorkspaceAdmin：管理员。'."\n" + .'- PAI.WorkspaceGuest：访客。'."\n" + .'- PAI.WorkspaceOwner：负责人。', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoDeveloper'], ], [ - 'name' => 'Name', + 'name' => 'MemberName', 'in' => 'query', - 'schema' => [ - 'description' => '数据集名称，支持根据数据集名称模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'myName', - ], + 'schema' => ['title' => '成员名', 'description' => '成员名，支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'zhangsan'], ], [ - 'name' => 'Properties', + 'name' => 'UserId', 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '2788******129'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据集属性，多项之间使用半角逗号（,）分隔。支持以下取值：'."\n" - .'- DIRECTORY：文件夹。'."\n" - .'- FILE：文件。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DIRECTORY' => 'DIRECTORY', - 'FILE' => 'FILE', + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'Members' => [ + 'title' => '成员列表', + 'description' => '成员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '成员详情。', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['title' => '用户 id', 'description' => '用户ID。', 'type' => 'string', 'example' => '215139******88039'], + 'MemberName' => ['title' => '云账号用户名', 'description' => '用户名。', 'type' => 'string', 'example' => 'user1'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '创建UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'Roles' => [ + 'title' => '角色列表', + 'description' => '角色列表。', + 'type' => 'array', + 'items' => ['description' => '角色名。角色名和权限的对应关系，请参见[附录：角色及权限列表](~~2840449~~)。'."\n" + ."\n" + .'角色名可能值：'."\n" + ."\n" + .'- PAI.AlgoDeveloper：算法开发。'."\n" + .'- PAI.AlgoOperator：算法运维。'."\n" + .'- PAI.LabelManager：标注管理员。'."\n" + .'- PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" + .'- PAI.WorkspaceAdmin：管理员。'."\n" + .'- PAI.WorkspaceGuest：访客。'."\n" + .'- PAI.WorkspaceOwner：负责人。', 'type' => 'string', 'example' => 'PAI.AlgoDeveloper'], + ], + 'DisplayName' => ['title' => '成员显示名', 'description' => '成员显示名。', 'type' => 'string', 'example' => 'myDisplayName'], + 'MemberId' => ['title' => '成员 id', 'description' => '成员ID。', 'type' => 'string', 'example' => '14588*****51688039'], + 'AccountName' => ['type' => 'string', 'example' => 'testAccount', 'description' => ''], + 'AccountType' => ['type' => 'string', 'example' => '5', 'description' => ''], + ], + ], + ], + 'TotalCount' => ['title' => '符合过滤条件的数量', 'description' => '符合过滤条件的成员数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取工作空间的成员列表', + 'summary' => '获取工作空间的成员列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMembers'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => 'FILE', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Members\\": [\\n {\\n \\"UserId\\": \\"215139******88039\\",\\n \\"MemberName\\": \\"user1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Roles\\": [\\n \\"PAI.AlgoDeveloper\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"14588*****51688039\\",\\n \\"AccountName\\": \\"testAccount\\",\\n \\"AccountType\\": \\"5\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + ], + 'ListModelVersions' => [ + 'summary' => '获取模型版本列表。', + 'path' => '/api/v1/models/{ModelId}/versions', + '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' => '133782', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], + ], + 'parameters' => [ [ - 'name' => 'DataSourceTypes', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '数据源类型，多项之间使用半角逗号分隔。支持以下取值：'."\n" - .'- NAS：数据存储为阿里云文件存储（NAS）。'."\n" - .'- OSS：数据存储为阿里云对象存储（OSS）。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NAS' => 'NAS', - 'OSS' => 'OSS', - ], - 'example' => 'OSS', - ], + 'schema' => ['title' => '页数', 'description' => '模型版本列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DataTypes', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '数据集的数据类型，多项之间使用半角逗号（,）分隔。支持以下取值：'."\n" - .'- VIDEO：视频。'."\n" - .'- COMMON：通用。'."\n" - .'- TEXT：文本。'."\n" - .'- PIC：图片。'."\n" - .'- AUDIO：音频。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'VIDEO' => 'VIDEO', - 'COMMON' => 'COMMON', - 'TEXT' => 'TEXT', - 'PIC' => 'PIC', - 'AUDIO' => 'AUDIO', - ], - 'example' => 'COMMON,TEXT', - ], + 'schema' => ['title' => '每页大小', 'description' => '分页查询时设置的每页行数。默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'SourceId', + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'description' => '数据来源ID。'."\n" - .'- 当SourceTypes为USER时，SourceId支持自定义。'."\n" - .'- 当SourceTypes为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" - .'- 当SourceTypes为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-rbvg5wzljzjhc9ks92', - ], + 'schema' => ['title' => '顺序', 'description' => '分页查询时，对指定的排序字段进行升序或降序。默认ASC。'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], [ - 'name' => 'SourceTypes', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => '来源类型，多项之间使用半角逗号分隔。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', - 'ITAG' => 'ITAG', - 'USER' => 'USER', - ], - 'example' => 'USER,ITAG', - ], + 'schema' => ['title' => '排序依据', 'description' => '分页查询时的排序字段。目前GmtCreateTime字段用于排序。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], ], [ - 'name' => 'WorkspaceId', + 'name' => 'VersionName', 'in' => 'query', - 'schema' => [ - 'title' => 'Workspace Id', - 'description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。'."\n" - .'如果不配置该参数，则会使用默认工作空间；如果默认工作空间不存在，则会报错。', - 'type' => 'string', - 'required' => false, - 'example' => '324**', - ], + 'schema' => ['title' => '模型版本名称', 'description' => '配置模型版本名称，来过滤模型版本列表。', 'type' => 'string', 'required' => false, 'example' => '1.0.1'], ], [ - 'name' => 'Label', + 'name' => 'FormatType', 'in' => 'query', 'schema' => [ - 'description' => '数据集标签，用于过滤数据集列表。标签Key或Value中，有指定字符串的，都会被过滤出来。', + 'title' => '模型格式类型', + 'description' => '配置模型格式，来过滤模型版本列表。取值如下：'."\n" + .'- OfflineModel'."\n" + .'- SavedModel'."\n" + .'- Keras H5'."\n" + .'- Frozen Pb'."\n" + .'- Caffe Prototxt'."\n" + .'- TorchScript'."\n" + .'- XGBoost'."\n" + .'- PMML'."\n" + .'- AlinkModel'."\n" + .'- ONNX', 'type' => 'string', 'required' => false, - 'example' => 'test', + 'enumValueTitles' => ['OfflineModel' => 'OfflineModel', 'SavedModel' => 'SavedModel', 'Keras H5' => 'Keras H5', 'Frozen Pb' => 'Frozen Pb', 'Caffe Prototxt' => 'Caffe Prototxt', 'TorchScript' => 'TorchScript', 'XGBoost' => 'XGBoost', 'PMML' => 'PMML', 'AlinkModel' => 'AlinkModel', 'ONNX' => 'ONNX'], + 'example' => 'SavedModel', ], ], [ - 'name' => 'Provider', + 'name' => 'FrameworkType', 'in' => 'query', 'schema' => [ - 'description' => '数据集提供方。返回值为"pai"时表示该数据集为PAI平台的公共数据集。', + 'title' => '模型框架', + 'description' => '配置模型框架，来过滤模型版本列表，取值如下：'."\n" + .'- Pytorch'."\n" + .'-XGBoost'."\n" + .'- Keras'."\n" + .'- Caffe'."\n" + .'- Alink'."\n" + .'- Xflow'."\n" + .'- TensorFlow', 'type' => 'string', 'required' => false, - 'example' => 'pai', + 'enumValueTitles' => ['Pytorch' => 'Pytorch', 'XGBoost' => 'XGBoost', 'Keras' => 'Keras', 'Caffe' => 'Caffe', 'Alink' => 'Alink', 'Xflow' => 'Xflow', 'TensorFlow' => 'TensorFlow'], + 'example' => 'TensorFlow', ], ], [ - 'name' => 'SourceDatasetId', - 'in' => 'query', - 'schema' => [ - 'title' => 'iTag标注集的源数据集。', - 'description' => 'iTag标注集的来源数据集ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-rcdg3wxxxxxhc5jk87'."\n", - ], + 'name' => 'ModelId', + 'in' => 'path', + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-dajbueh******'], ], [ - 'name' => 'SortBy', + 'name' => 'SourceType', 'in' => 'query', 'schema' => [ - 'title' => '排序字段', - 'description' => '排序字段', + 'title' => '来源类型', + 'description' => '根据模型来源类型，来过滤模型版本列表。取值如下：'."\n" + .'- Custom（默认值）：自定义。'."\n" + .'- PAIFlow：PAI工作流。'."\n" + .'- TrainingService：PAI训练服务。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'DataSourceType' => 'DataSourceType', - 'DataType' => 'DataType', - 'GmtCreateTime' => 'GmtCreateTime', - 'GmtModifiedTime' => 'GmtModifiedTime', - ], - 'example' => 'GmtCreateTime', + 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], + 'example' => 'PAIFlow', ], ], [ - 'name' => 'ShareScope', + 'name' => 'SourceId', 'in' => 'query', - 'schema' => [ - 'description' => '分享数据集过滤器：'."\n" - .'* TO_ME: 仅过滤分享给我的数据集。'."\n" - .'* BY_ME: 仅过滤我分享给他人的数据集，展示分享配置详情。'."\n" - .'* 不设置该参数或设置为空：获取当前工作空间的所有的数据集，包括TO_ME。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TO_ME' => 'TO_ME', - 'BY_ME' => 'BY_ME', - ], - 'example' => 'BY_ME', - ], + 'schema' => ['title' => '来源ID', 'description' => '来源ID。'."\n" + .'* 来源类型为Custom时，该字段不做限制。'."\n" + .'* 来源为PAIFlow、TrainingService时，格式为 '."\n" + .'```'."\n" + .'region=,workspaceId=,kind=,id='."\n" + .'```'."\n" + .'其中：'."\n" + .'- region为阿里云区域ID。'."\n" + .'- workspacceId为工作空间ID。'."\n" + .'- kind：为类型。取值：PipelineRun（PAIFlow工作流）；ServiceJob（训练服务）。'."\n" + .'- id：为唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], ], [ - 'name' => 'Edition', + 'name' => 'Label', 'in' => 'query', - 'schema' => [ - 'description' => '数据集类型。枚举值：'."\n" - ."\n" - .'- BASIC：基础型。不支持数据集文件元数据管理。'."\n" - .'- ADVANCED：高级型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。'."\n" - .'- LOGICAL: 逻辑型。仅OSS类型支持，每个版本支持最多100万个文件元数据管理。适用于绝大部分场景，需配合SDK使用。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LOGICAL' => 'LOGICAL', - 'BASIC' => 'BASIC', - 'ADVANCED' => 'ADVANCED', - ], - 'example' => 'BASIC', - ], + 'schema' => ['title' => '标签串', 'description' => '标签串。用于列表过滤，标签中Key或Value中，有指定字符串的，都会被过滤出来。', 'type' => 'string', 'required' => false, 'example' => 'key1'], ], [ - 'name' => 'Accessibility', + 'name' => 'ApprovalStatus', 'in' => 'query', - 'schema' => [ - 'description' => '数据集的可见性。'."\n" - ."\n" - .'- PUBLIC表示公开。'."\n" - .'- PRIVATE表示私有。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], - 'example' => 'PRIVATE', - ], + 'schema' => ['title' => '准入状态', 'description' => '根据准入状态来过滤模型版本列表，取值如下：'."\n" + .'- Pending：待定。'."\n" + .'- Approved：允许上线。'."\n" + .'- Rejected：不允许上线。', 'type' => 'string', 'required' => false, 'example' => 'Approved'], ], ], 'responses' => [ @@ -13687,165 +10646,173 @@ 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'Datasets' => [ - 'description' => '数据集列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC***3C83E'], + 'Versions' => [ + 'title' => '模型版本列表', + 'description' => '模型版本列表。', 'type' => 'array', - 'items' => [ - 'description' => '数据集。', - '$ref' => '#/components/schemas/Dataset', - ], - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', + 'items' => ['description' => '模型版本。', '$ref' => '#/components/schemas/ModelVersion'], ], + 'TotalCount' => ['title' => '总数', 'description' => '模型版本列表总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Datasets\\": [\\n {\\n \\"DatasetId\\": \\"d-c0h44g3wlwkj8o4348\\",\\n \\"UserId\\": \\"2004110000006048\\",\\n \\"OwnerId\\": \\"1004110000006048\\",\\n \\"Name\\": \\"AnimalDataset\\",\\n \\"DataSourceType\\": \\"OSS URL\\",\\n \\"Uri\\": \\"oss://xxx\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"DataType\\": \\"COMMON PIC TEXT VIDEO AUDIO\\",\\n \\"Property\\": \\"FILE DIRECTORY TABULAR\\",\\n \\"SourceType\\": \\"USER ITAG PAI_PUBLIC_DATASET\\",\\n \\"SourceId\\": \\"Source Id\\",\\n \\"Description\\": \\"Animal images.\\",\\n \\"WorkspaceId\\": \\"Workspace Id\\",\\n \\"Options\\": \\"jsonstring\\",\\n \\"Accessibility\\": \\"PRIVATE PUBLIC\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"SourceDatasetId\\": \\"d-bvfasdf4wxxj8o411\\",\\n \\"SourceDatasetVersion\\": \\"v2\\",\\n \\"TagTemplateType\\": \\"text-classification\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"DataCount\\": 0,\\n \\"DataSize\\": 0,\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"\\"\\n },\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"\\",\\n \\"Edition\\": \\"BASIC\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"MountAccessReadWriteRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ],\\n \\"IsShared\\": true,\\n \\"SharedFrom\\": {\\n \\"Status\\": \\"\\",\\n \\"SourceTenantId\\": \\"\\",\\n \\"SourceWorkspaceId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"\\",\\n \\"ExpiresAt\\": \\"\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"\\"\\n ],\\n \\"Extra\\": \\"\\"\\n },\\n \\"SharingConfig\\": {\\n \\"SharedTo\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"SourceTenantId\\": \\"\\",\\n \\"SourceWorkspaceId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"\\",\\n \\"ExpiresAt\\": \\"\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"\\"\\n ],\\n \\"Extra\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', - 'title' => '获取数据集列表', - ], - 'DeleteDataset' => [ - 'summary' => '删除数据集。', - 'path' => '/api/v1/datasets/{DatasetId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '48570', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取模型版本列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModelVersions'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wzlj****9ks92', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paimodel:ListModelVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', - 'title' => '删除数据集', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC***3C83E\\",\\n \\"Versions\\": [\\n {\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/\\",\\n \\"VersionDescription\\": \\"情感分析。\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"{}\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"DatasetId\\": \\"d-sdkjanksaklerhfd\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.175\\n }\\n },\\n {\\n \\"Dataset\\": {\\n \\"Uri\\": \\"oss://xxxx/\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.172\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"DistillationSpec\\": {}\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', ], - 'CreateDatasetLabels' => [ - 'summary' => '为数据集打标签。', - 'path' => '/api/v1/datasets/{DatasetId}/labels', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListModels' => [ + 'path' => '/api/v1/models', + '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' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '48572', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '133768', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '页数', 'description' => '模型列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页大小', 'description' => '分页查询时设置的每页显示的模型数量，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '顺序', 'description' => '分页查询时，对指定的排序字段进行升序或降序。默认ASC。'."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '排序依据', 'description' => '分页查询时的排序字段。目前使用GmtCreateTime字段用于排序。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['title' => '工作空间ID', 'description' => '配置工作空间ID，返回列表中只获取该工作空间内的模型列表。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '324**'], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => ['title' => '模型名称', 'description' => '配置模型名称，用来过滤获取的模型列表。', 'type' => 'string', 'required' => false, 'example' => 'Sentiment analysis'], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => ['title' => '标签', 'description' => '标签串。用于列表过滤，标签中key或value中，有指定字符串的，都会被过滤出来。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + ], + [ + 'name' => 'Provider', + 'in' => 'query', + 'schema' => ['title' => '模型提供者', 'description' => '提供者。指定提供者，则只返回该提供者公开的模型。不填则返回用户自己的模型。', 'type' => 'string', 'required' => false, 'example' => 'pai'], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => ['title' => '领域', 'description' => '配置领域来过滤该领域内的模型列表。例如：nlp（自然语言处理）、cv（计算机视觉）等。', 'type' => 'string', 'required' => false, 'example' => 'nlp'], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => ['title' => '模型任务', 'description' => '配置任务来过滤属于该任务类型的模型列表。例如：text-classification（文本分类）等。', 'type' => 'string', 'required' => false, 'example' => 'text-classification'], + ], + [ + 'name' => 'Origin', + 'in' => 'query', + 'schema' => ['title' => '模型源', 'description' => '配置模型源，来过滤属于该社区或组织的模型列表。例如ModelScope，HuggingFace等。', 'type' => 'string', 'required' => false, 'example' => 'ModelScope'], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => ['title' => '筛选请求串', 'description' => '配置查询条件。ModelName、Domain、Task、LabelKey、LabelValue相似匹配。'."\n" + .'例如输入为nlp，则ModelName、Domain、Task、LabelKey、LabelValue中匹配的模型都会返回。', 'type' => 'string', 'required' => false, 'example' => 'nlp'], + ], + [ + 'name' => 'ModelType', + 'in' => 'query', + 'schema' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'required' => false, 'example' => 'Endpoint'], + ], + [ + 'name' => 'Collections', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '模型所在Collection，支持填写多个，用英文逗号分割', 'description' => '模型所在Collection，支持填写多个，用英文逗号分割', 'type' => 'string', 'required' => false, 'example' => 'AI4D,QuickStart'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Dataset Id', - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签的key。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'Value' => ['description' => '标签的value。', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'd-lfd60v0p****ujtsdx', + 'example' => 'Endpoint', ], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'Conditions', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'Labels' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '为数据集添加的标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, + 'description' => '条件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Column' => ['description' => '参数名。如：ParameterSize。', 'type' => 'string', 'required' => false, 'example' => 'ParameterSize'], + 'Operator' => ['description' => '操作符。如：LessThan。', 'type' => 'string', 'required' => false, 'example' => 'LessThan'], + 'Value' => ['description' => '值，如3000。', 'type' => 'string', 'required' => false, 'example' => '3000'], ], + 'required' => false, + 'description' => '', ], 'required' => false, ], @@ -13858,1770 +10825,1310 @@ 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A083731B-4973-54D1-B324-E53****4DD44', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'Models' => [ + 'title' => '模型列表', + 'description' => '模型列表。', + 'type' => 'array', + 'items' => ['description' => '模型。', '$ref' => '#/components/schemas/Model'], ], + 'TotalCount' => ['title' => '总数', 'description' => '模型总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A083731B-4973-54D1-B324-E53****4DD44\\"\\n}","type":"json"}]', - 'title' => '创建数据集标签', - 'description' => '调用此接口时，需要注意：'."\n" - ."\n" - .'- 标签键和值是非空字符串，且长度不能大于128。'."\n" - .'- 标签键不能以 aliyun、acs、http://、https:// 开头。'."\n", - ], - 'DeleteDatasetLabels' => [ - 'summary' => '删除数据集标签。', - 'path' => '/api/v1/datasets/{DatasetId}/labels', - 'methods' => [ - 'delete', + 'title' => '获取模型列表', + 'summary' => '获取模型列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paimodel:ListModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Models\\": [\\n {\\n \\"ModelId\\": \\"model-1123*****\\",\\n \\"ModelName\\": \\"情感分析\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"WorkspaceId\\": \\"234**\\",\\n \\"UserId\\": \\"1557702098******\\",\\n \\"OwnerId\\": \\"1557702098******\\",\\n \\"ModelDescription\\": \\"情感分析。\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/\\",\\n \\"VersionDescription\\": \\"情感分析。\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"{}\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"DatasetId\\": \\"d-sdkjanksaklerhfd\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.175\\n }\\n },\\n {\\n \\"Dataset\\": {\\n \\"Uri\\": \\"oss://xxxx/\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.172\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"DistillationSpec\\": {}\\n },\\n \\"OrderNumber\\": 101,\\n \\"Origin\\": \\"ModelScope\\",\\n \\"Domain\\": \\"nlp\\",\\n \\"Task\\": \\"text-classifiaction\\",\\n \\"ModelDoc\\": \\"https://***.md\\",\\n \\"Provider\\": \\"pai\\",\\n \\"ModelType\\": \\"Checkpoint\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"RatingCount\\": 2866,\\n \\"Rating\\": 4.94,\\n \\"FavoriteCount\\": 34992,\\n \\"CommentCount\\": 754,\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png\\"\\n ],\\n \\"TippedAmountCount\\": 32,\\n \\"DownloadCount\\": 606056\\n },\\n \\"ParameterSize\\": 1024,\\n \\"GmtLatestVersionModifiedTime\\": \\"2021-01-21T17:12:35Z\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', + ], + 'ListPermissions' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/permissions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '48573', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '14249', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'title' => 'DatasetId', - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-rbvg5****jhc9ks92', - ], - ], - [ - 'name' => 'LabelKeys', - 'in' => 'query', - 'schema' => [ - 'description' => '标签的键值。如何查询标签的键值，详情请参见[GetDataset](~~457218~~)。多项标签使用半角逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1,key2', - ], + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '64B50C1D-D4C2-560C-86A3-A6ED****16D', + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '2AE63638-5420-56DC-B******8174039A0'], + 'Permissions' => [ + 'title' => '权限列表', + 'description' => '权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限。', + 'type' => 'object', + 'properties' => [ + 'PermissionCode' => ['title' => '权限 code', 'description' => '权限点的名字，同地域内唯一。权限点介绍，请参见[附录：角色及权限列表](~~2840449~~)。'."\n" + .'例如示例值PaiDLC:GetTensorboard，指的是页面中DLC功能模块的查看Tensorboard详情权限。', 'type' => 'string', 'example' => 'PaiDLC:GetTensorboard'], + 'PermissionRules' => [ + 'description' => '权限规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '权限规则。', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => ['title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', 'description' => '访问类型，可能值：'."\n" + ."\n" + .'- PUBLIC：当前工作空间所有成员都可以操作。'."\n" + .'- PRIVATE：只有创建者可以操作。'."\n" + .'- ANY：创建者和非创建者都可以操作。', 'type' => 'string', 'example' => 'PRIVATE'], + 'EntityAccessType' => ['title' => '存取类型 CREATOR 代表能看自已创建的 OTHERS 代表可以看别人创建的 ALL代表所有', 'description' => '存取类型。'."\n" + .'当Accessibility为PUBLIC，所有用户都能操作，此值无效；'."\n" + .'当Accessibility为PRIVATE时，根据EntityAccessType的值决定权限，EntityAccessType支持如下值：'."\n" + .'- CREATOR：只有创建者可以操作。'."\n" + .'- ANY：创建者和非创建者都可以操作。', 'type' => 'string', 'example' => 'CREATOR'], + ], + ], + ], + ], + ], ], + 'TotalCount' => ['title' => '符合过滤条件的数量', 'description' => '符合过滤条件的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B50C1D-D4C2-560C-86A3-A6ED****16D\\"\\n}","type":"json"}]', - 'title' => '删除数据集标签', - ], - 'CreateDatasetVersion' => [ - 'summary' => '创建数据集版本。', - 'path' => '/api/v1/datasets/{DatasetId}/versions', - 'methods' => [ - 'post', + 'title' => '获取工作空间的权限列表', + 'summary' => '获取用户在工作空间内的权限列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPermissions'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2AE63638-5420-56DC-B******8174039A0\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionCode\\": \\"PaiDLC:GetTensorboard\\",\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + ], + 'ListProducts' => [ + 'path' => '/api/v1/products', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '232558', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '14207', + 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5*****jhc9ks92', - ], + 'name' => 'ProductCodes', + 'in' => 'query', + 'schema' => ['title' => '逗号分割的商品 code', 'type' => 'string', 'required' => false, 'example' => 'PAI_isolate', 'description' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'Property' => [ - 'description' => '数据集的属性。支持以下取值：'."\n" - .'- FILE：文件。'."\n" - .'- DIRECTORY：文件夹。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'DIRECTORY' => 'DIRECTORY', - 'FILE' => 'FILE', - ], - 'example' => 'DIRECTORY', - ], - 'DataSourceType' => [ - 'description' => '数据源类型，多项之间使用半角逗号分隔。支持以下取值：'."\n" - ."\n" - .'- NAS：数据存储为阿里云文件存储（NAS）。'."\n" - ."\n" - .'- OSS：数据存储为阿里云对象存储（OSS）。'."\n" - ."\n" - .'- CPFS'."\n" - ."\n" - .'注意：当前的策略是版本的DataSourceType 需要与数据集DataSourceType 保持一致，创建版本的时候会和数据集的做校验。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'NAS' => 'NAS', - 'OSS' => 'OSS', - ], - 'example' => 'OSS', - ], - 'Uri' => [ - 'description' => 'Uri配置样例如下：'."\n" - .'- 数据源类型为OSS：`oss://bucket.endpoint/object`'."\n" - .'- 数据源类型为NAS：'."\n" - .'通用型NAS格式为：`nas://.region/subpath/to/dir/`；'."\n" - .'CPFS1.0：`nas://.region/subpath/to/dir/`；'."\n" - .'CPFS2.0：`nas://.region//`。'."\n" - .'CPFS1.0和CPFS2.0根据fsid的格式来区分：CPFS1.0 格式为cpfs-<8位ASCII字符>；CPFS2.0 格式为cpfs-<16位ASCII字符>。', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/', - ], - 'Labels' => [ - 'description' => '数据集版本标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - 'SourceType' => [ - 'description' => '数据来源类型，默认为USER。支持以下取值：'."\n" - .'- PAI-PUBLIC-DATASET：PAI公共数据集。'."\n" - .'- ITAG：iTAG模块标注结果生成的数据集。'."\n" - .'- USER：用户注册的数据集。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', - 'ITAG' => 'ITAG', - 'USER' => 'USER', - ], - 'example' => 'USER', - ], - 'SourceId' => [ - 'description' => '数据来源ID。'."\n" - .'- 当SourceType为USER时，SourceId支持自定义。'."\n" - .'- 当SourceType为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" - .'- 当SourceType为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-a0xbe5n03bhqof46ce', - ], - 'Options' => [ - 'description' => '扩展字段，JsonString类型。'."\n" - .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "mountPath": "/mnt/data/"'."\n" - .'}', - ], - 'Description' => [ - 'description' => '对数据集版本进行自定义描述，以区分不同的数据集版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the dataset version.', - ], - 'DataSize' => [ - 'description' => '数据集文件占据空间的大小。单位Byte 。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '19000', - ], - 'DataCount' => [ - 'description' => '数据集文件数量，单位个。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], - 'ImportInfo' => [ - 'description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" - ."\n" - .'
'."\n" - .'OSS'."\n" - .'{
'."\n" - .' "region": "${region}",//地域ID
'."\n" - .' "bucket": "${bucket}",//bucket名称
'."\n" - .' "path": "${path}" //文件路径
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'NAS'."\n" - .'{
'."\n" - .' "region": "${region}",//地域ID
'."\n" - .' "fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .' "path": "${path}", //文件系统路径
'."\n" - .' "mountTarget": "${mount_target}" //文件系统挂载点
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n\n" - .'
'."\n" - .'CPFS'."\n" - .'{
'."\n" - .' "region": "${region}",//地域ID
'."\n" - .' "fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .' "protocolServiceId":"${protocol_service_id}", //文件系统协议服务
'."\n" - .' "exportId": "${export_id}", //文件系统导出目录
'."\n" - .' "path": "${path}", //文件系统路径
'."\n" - .'}
'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'智算CPFS'."\n" - .'{
'."\n" - .' "region": "${region}",//地域ID
'."\n" - .' "fileSystemId": "${file_system_id}", //文件系统ID
'."\n" - .' "path": "${path}", //文件系统路径
'."\n" - .' "mountTarget": "${mount_target}" //文件系统挂载点，智算版特有
'."\n" - .' "isVpcMount": boolean, //是否为vpc挂载点, 智算版特有
'."\n" - .'}
'."\n" - .'
', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "region": "cn-wulanchabu",'."\n" - .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" - .' "path": "/mnt",'."\n" - .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" - .' "isVpcMount": true'."\n" - .'}', - ], - ], - 'required' => false, - ], + 'name' => 'ServiceCodes', + 'in' => 'query', + 'schema' => ['title' => '逗号分割的服务 code', 'type' => 'string', 'example' => 'oss', 'description' => ''], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '41A847C8-3D12-5F24-8CE9-7F9EB2DA9ECD', + 'RequestId' => ['title' => '请求 id', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde', 'description' => ''], + 'Products' => [ + 'title' => '产品列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PurchaseUrl' => ['title' => '购买链接', 'type' => 'string', 'example' => 'https://common-buy.aliy', 'description' => ''], + 'ProductCode' => ['title' => '商品 code', 'type' => 'string', 'example' => 'DataWorks_isolate', 'description' => ''], + 'IsPurchased' => ['title' => '是否已购买', 'type' => 'boolean', 'example' => 'true', 'description' => ''], + 'HasPermissionToPurchase' => ['title' => 'Whether user has permission to purchase', 'type' => 'boolean', 'description' => ''], + 'ProductId' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', ], - 'VersionName' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'example' => 'v1', + 'Services' => [ + 'title' => '服务列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsOpen' => ['title' => '是否开通', 'type' => 'boolean', 'example' => 'true', 'description' => ''], + 'OpenUrl' => ['title' => '开通链接', 'type' => 'string', 'description' => ''], + 'ServiceCode' => ['title' => '服务Code', 'type' => 'string', 'example' => 'oss', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41A847C8-3D12-5F24-8CE9-7F9EB2DA9ECD\\",\\n \\"VersionName\\": \\"v1\\"\\n}","type":"json"}]', - 'title' => '创建数据集版本', - ], - 'GetDatasetVersion' => [ - 'summary' => '获取指定版本的数据集信息。', - 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', - 'methods' => [ - 'get', + 'summary' => '列举产品', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListProducts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Products\\": [\\n {\\n \\"PurchaseUrl\\": \\"https://common-buy.aliy\\",\\n \\"ProductCode\\": \\"DataWorks_isolate\\",\\n \\"IsPurchased\\": true,\\n \\"HasPermissionToPurchase\\": true,\\n \\"ProductId\\": \\"\\"\\n }\\n ],\\n \\"Services\\": [\\n {\\n \\"IsOpen\\": true,\\n \\"OpenUrl\\": \\"\\",\\n \\"ServiceCode\\": \\"oss\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListQuotas' => [ + 'summary' => '获取资源配额列表。', + 'path' => '/api/v1/quotas', + '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' => '232570', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '14241', + 'abilityTreeNodes' => ['FEATURElearnZO51AS'], ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-lfd60v0p****ujtsdx', - ], - ], - [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'description' => '软件版本名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '名字，支持模糊搜索', 'description' => '资源配额名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'quota-name'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C55DF3DA-F120-5E37-A374-F49365531701', - ], - 'DatasetId' => [ - 'title' => '资源一级ID', - 'description' => '资源一级ID', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'd-dkdbnnap0g7b6su4yg', - 'pattern' => '', - 'default' => '', - ], - 'VersionName' => [ - 'title' => '数据集版本', - 'description' => '数据集版本', - 'type' => 'string', - 'deprecated' => false, - 'example' => 'v1', - 'pattern' => '', - 'default' => '', - ], - 'Property' => [ - 'title' => '数据集的属性。', - 'description' => '数据集的属性。', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'DIRECTORY', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'FILE', - 'DIRECTORY', - ], - ], - 'GmtCreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2023-12-13T10:22:05.694Z', - ], - 'GmtModifiedTime' => [ - 'title' => '创建时间。', - 'description' => '最后修改时间。', - 'type' => 'string', - 'deprecated' => false, - 'example' => '2023-12-13T10:22:05.694Z', - 'pattern' => '', - 'default' => '', - ], - 'DataSourceType' => [ - 'title' => '数据源类型。', - 'description' => '数据源类型。', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'OSS', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'OSS', - 'NAS', - 'CPFS', - ], - ], - 'Uri' => [ - 'title' => 'Uri配置样例', - 'description' => 'Uri配置样例', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'oss://ai4d-br7hx9ngzelo2o6uip.oss-cn-shanghai.aliyuncs.com/365349/data-1157703270994901/datasets/aka108o/', - 'pattern' => '', - 'default' => '', - ], - 'Labels' => [ - 'title' => '资源标签', - 'description' => '资源标签', + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], + 'Quotas' => [ + 'title' => '配额列表', + 'description' => '资源配额列表。', 'type' => 'array', 'items' => [ - 'description' => '标签。', - 'deprecated' => false, - '$ref' => '#/components/schemas/Label', - ], - 'deprecated' => false, - 'maxItems' => 20, - ], - 'Options' => [ - 'title' => '扩展字段。', - 'description' => '扩展字段。', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => '{'."\n" - .' "mountPath": "/mnt/data/"'."\n" - .'}', - 'pattern' => '', - 'default' => '', - ], - 'SourceType' => [ - 'title' => '数据来源类型', - 'description' => '数据来源类型', - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [ - 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', - 'ITAG' => 'ITAG', - 'USER' => 'USER', - ], - 'example' => 'USER', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'USER', - 'ITAG', - 'PAI_PUBLIC_DATASET', - 'CLEANING', - 'ENHANCE', - 'ADDVERSION', + 'description' => '资源配额详情。', + 'type' => 'object', + 'properties' => [ + 'QuotaType' => ['title' => '产品类型， 支持PAI，MaxCompute', 'description' => '资源配额类型，可能值：'."\n" + ."\n" + .'PAI：表示MaxCompute的GPU资源组集群。', 'type' => 'string', 'example' => 'PAI'], + 'Mode' => ['title' => '模式 isolate 预付费 share 后付费 develop 开发模式', 'description' => '付费模式，可能值：'."\n" + ."\n" + .'- isolate：预付费。'."\n" + .'- share：后付费。', 'type' => 'string', 'example' => 'isolate'], + 'ProductCode' => ['title' => '产品代码', 'description' => '产品名，可能值：'."\n" + .'- PAI_isolate：pai预付费资源组（pai cpu）。'."\n" + .'- PAI_share：pai后付费资源组（pai gpu）。', 'type' => 'string', 'example' => 'PAI_share'], + 'Name' => ['title' => 'quota名字', 'description' => '配额名称。', 'type' => 'string', 'example' => 'quota-name'], + 'Specs' => [ + 'title' => '规格描述列表', + 'description' => '规格描述列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规格描述。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '规格名', 'description' => '规格名。', 'type' => 'string', 'example' => 'cu'], + 'Value' => ['title' => '规格描述', 'description' => '规格值。', 'type' => 'string', 'example' => '11500'], + 'Type' => ['title' => '类型，可为空', 'description' => '类型，可为空。', 'type' => 'string', 'example' => 'string'], + ], + ], + 'example' => '{\\"cu\\":\\"11500\\",\\"minCu\\":\\"2300\\",\\"parentId\\":\\"0\\"}', + ], + 'Id' => ['title' => 'quota的id', 'description' => '配额的ID。', 'type' => 'string', 'example' => '1828233'], + 'DisplayName' => ['description' => '资源配额别名。', 'type' => 'string', 'example' => '默认Quota。'], + ], ], ], - 'Description' => [ - 'title' => '版本描述', - 'description' => '版本描述', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'This is a description of the dataset version.', - 'pattern' => '', - 'default' => '', - ], - 'SourceId' => [ - 'title' => '数据集来源ID。', - 'description' => '数据集来源ID。', - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'd-rbvg5wzljzjhc9ks92', - 'default' => '', - ], - 'DataCount' => [ - 'title' => '数据量', - 'description' => '数据量', - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => false, - 'example' => '10000', - 'pattern' => '', - 'default' => '', - ], - 'DataSize' => [ - 'title' => '数据集大小。', - 'description' => '数据集大小。', - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => false, - 'example' => '10000', - 'pattern' => '', - 'default' => '', - ], - 'MountAccess' => [ - 'description' => '该数据集被挂载时的权限。'."\n" - .'- RO：只读挂载'."\n" - .'- RW：读写挂载', - 'type' => 'string', - 'example' => 'RO', - ], - 'ImportInfo' => [ - 'description' => '数据集的存储导入配置信息，支持OSS/NAS/CPFS等。'."\n" - ."\n" - .'
'."\n" - .'OSS'."\n" - .'{'."\n" - .'"region": "${region}",//地域ID'."\n" - .'"bucket": "${bucket}",//bucket名称'."\n" - .'"path": "${path}" //文件路径'."\n" - .'}'."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'NAS'."\n" - ."\n" - .'
'."\n" - ."\n" - .'
'."\n" - .'CPFS'."\n" - .'区块内容'."\n" - .'
'."\n" - ."\n\n" - .'
'."\n" - .'智算CPFS'."\n" - .'区块内容'."\n" - .'
', - 'type' => 'string', - 'example' => '{'."\n" - .' "region": "cn-wulanchabu",'."\n" - .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" - .' "path": "/mnt",'."\n" - .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" - .' "isVpcMount": true'."\n" - .'}', - ], + 'TotalCount' => ['title' => '符合过滤条件的数量', 'description' => '符合过滤条件的资源配额数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C55DF3DA-F120-5E37-A374-F49365531701\\",\\n \\"DatasetId\\": \\"d-dkdbnnap0g7b6su4yg\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"Property\\": \\"DIRECTORY\\",\\n \\"GmtCreateTime\\": \\"2023-12-13T10:22:05.694Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-13T10:22:05.694Z\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"oss://ai4d-br7hx9ngzelo2o6uip.oss-cn-shanghai.aliyuncs.com/365349/data-1157703270994901/datasets/aka108o/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"This is a description of the dataset version.\\",\\n \\"SourceId\\": \\"d-rbvg5wzljzjhc9ks92\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n}","type":"json"}]', - 'title' => '获取数据集版本', - ], - 'ListDatasetVersions' => [ - 'summary' => '获取数据集版本列表。', - 'path' => '/api/v1/datasets/{DatasetId}/versions', - 'methods' => [ - 'get', + 'title' => '获取MaxCompute GPU资源组的资源配额列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotas'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListQuotas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaType\\": \\"PAI\\",\\n \\"Mode\\": \\"isolate\\",\\n \\"ProductCode\\": \\"PAI_share\\",\\n \\"Name\\": \\"quota-name\\",\\n \\"Specs\\": [\\n {\\n \\"Name\\": \\"cu\\",\\n \\"Value\\": \\"11500\\",\\n \\"Type\\": \\"string\\"\\n }\\n ],\\n \\"Id\\": \\"1828233\\",\\n \\"DisplayName\\": \\"默认Quota。\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n MaxCompute\\n isolate\\n MaxCompute_share\\n quota-name\\n \\n name\\n {\\\\\\"cu\\\\\\":\\\\\\"11500\\\\\\",\\\\\\"minCu\\\\\\":\\\\\\"2300\\\\\\",\\\\\\"parentId\\\\\\":\\\\\\"0\\\\\\"}\\n abc\\n \\n 1828233\\n \\n 2\\n","errorExample":""}]', + ], + 'ListResources' => [ + 'path' => '/api/v1/resources', + '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' => '232574', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wz****c9ks92', - ], + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。'."\n" + .'- 当参数Option为ListResourceByWorkspace时，该参数必填。'."\n" + .'- 当参数Option为ListResource时，该参数无需配置。', 'type' => 'string', 'required' => false, 'example' => '123'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '数据集列表的页码。起始值为1，默认为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '分页，从1开始，默认1', 'description' => '资源列表的页码，起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时设置的每页行数。默认为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '页大小，默认20', 'description' => '分页查询时设置的每页行数，默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ - 'name' => 'Order', + 'name' => 'ProductTypes', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，对指定的排序字段进行升序或降序。默认值为ASC。'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => 'ASC', - 'DESC' => 'DESC', - ], - 'example' => 'ASC', - ], + 'schema' => ['title' => '逗号分隔的产品类型，可选值 MaxCompute，DLC', 'description' => '**该字段已废弃，将会下线，请使用ResourceType字段。**', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'], ], [ - 'name' => 'LabelKeys', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '数据集标签，用于过滤数据集列表。标签Key或Value中，有指定字符串的，都会被过滤出来。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1,key2', - ], + 'schema' => ['title' => '资源的group名字', 'description' => '资源分组名。如何获取资源分组名，请参见[ListResources](~~449143~~)。', 'type' => 'string', 'required' => false, 'example' => 'group'], ], [ - 'name' => 'LabelValues', + 'name' => 'ResourceName', 'in' => 'query', - 'schema' => [ - 'description' => '数据集标签，用于过滤数据集列表。标签Key或Value中，有指定字符串的，都会被过滤出来。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1,value2', - ], + 'schema' => ['title' => '资源的名字', 'description' => '资源名。格式为：'."\n" + .'- 长度为3~28个字符。'."\n" + .'- 同地域内唯一。', 'type' => 'string', 'required' => false, 'example' => 'resource'], ], [ - 'name' => 'Properties', + 'name' => 'Option', 'in' => 'query', - 'schema' => [ - 'description' => '数据集属性，支持以下取值：'."\n" - .'- DIRECTORY：文件夹。'."\n" - .'- FILE：文件。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DIRECTORY' => 'DIRECTORY', - 'FILE' => 'FILE', - ], - 'example' => 'DIRECTORY', - ], + 'schema' => ['title' => '选项，目前支持 ListResourceByWorkspace 列举某个工作空间的资源 GetResource 获取所有工作空间下的资源 GetResourceGroup 获取所有工作空间下的资源组 ListResourceSummaryByWorkspaces 列举一组工作空间的资源汇总', 'description' => '选项，取值如下：'."\n" + ."\n" + .'- ListResourceByWorkspace（默认值）：获取工作空间的资源列表。'."\n" + .'- ListResource：获取用户的资源列表。', 'type' => 'string', 'required' => false, 'example' => 'ListResourceByWorkspace'], ], [ - 'name' => 'SourceTypes', + 'name' => 'Verbose', 'in' => 'query', - 'schema' => [ - 'description' => '来源类型，支持以下取值：'."\n" - .'- PAI-PUBLIC-DATASET：PAI公共数据集。'."\n" - .'- ITAG：iTAG模块标注结果生成的数据集。'."\n" - .'- USER：用户注册的数据集。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', - 'ITAG' => 'ITAG', - 'USER' => 'USER', - ], - 'example' => 'USER', - ], + 'schema' => ['description' => '是否展示详细信息，目前详细信息包含字段Quotas。取值如下：'."\n" + .'- true（默认值）：展示详细信息'."\n" + .'- false：不展示详细信息', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'SourceId', + 'name' => 'ResourceTypes', 'in' => 'query', - 'schema' => [ - 'description' => '数据来源ID。'."\n" - .'- 当SourceTypes为USER时，SourceId支持自定义。'."\n" - .'- 当SourceTypes为ITAG时，即iTAG模块标注结果生成的数据集时，SourceId为ITAG的任务ID。'."\n" - .'- 当SourceTypes为PAI_PUBLIC_DATASET时，即使用PAI公共数据集创建的数据集时，SourceId默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-a0xbe5n03bhqof46ce', - ], + 'schema' => ['description' => '资源类型列表。取值如下：'."\n" + ."\n" + .'- MaxCompute：大数据计算服务资源'."\n" + .'- ECS：通用计算资源'."\n" + .'- Lingjun：灵骏智算资源'."\n" + .'- ACS：ACS计算资源'."\n" + .'- FLINK：Flink资源'."\n" + .'- SelfManagedAckPro：AckPro统一管控集群资源'."\n" + .'- SelfManagedAckLingjun：AckLinjun统一管控集群资源
'."\n" + .'- SelfManagedASI：ASI统一管控集群资源（三方云）', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'], + ], + [ + 'name' => 'QuotaIds', + 'in' => 'query', + 'schema' => ['description' => 'QuotaId集合，用逗号分割。只有同时具有这些QuotaId的资源才会被返回。'."\n" + ."\n\n" + .'> 目前只有ResourceTypes=ACS的资源才支持用该参数过滤。'."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => 'quota-k******da,quota-cd******w'], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => ['description' => 'Label过滤条件集合，多个条件用逗号分隔。只有同时满足这些标签的资源才会被返回。'."\n" + ."\n" + .'目前只有ProductType=ACS的资源才支持用该参数过滤。', 'type' => 'string', 'required' => false, 'example' => 'system.supported.dsw=true,system.supported.dlc=true'], ], [ - 'name' => 'SortBy', + 'name' => 'VerboseFields', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时的排序字段，默认使用GmtCreateTime。取值如下。'."\n" - .'- GmtCreateTime（默认值）：按创建时间。'."\n" - ."\n" - .'- GmtModifiedTime：按修改时间。'."\n" - ."\n" - .'- SourceType'."\n" - ."\n" - .'- DataSourceType'."\n" - ."\n" - .'- Property'."\n" - ."\n" - .'- DataSize'."\n" - ."\n" - .'- DataCount', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SourceType' => 'SourceType', - 'DataSourceType' => 'DataSourceType', - 'DataSize' => 'DataSize', - 'DataCount' => 'DataCount', - 'Property' => 'Property', - 'GmtCreateTime' => 'GmtCreateTime', - 'GmtModifiedTime' => 'GmtModifiedTime', - 'DatasetId' => 'DatasetId', - ], - 'example' => 'GmtCreateTime', - ], + 'schema' => ['description' => '逗号分隔的集合，表明要返回的字段。目前支持：'."\n" + .'- Quota'."\n" + .'- Label'."\n" + .'- IsDefault', 'type' => 'string', 'required' => false, 'example' => 'Quota,IsDefault'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0648C5BB-68D0-54D2-92A5-607135B8806B', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '当前页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '符合过滤条件的资源数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'DatasetVersions' => [ - 'description' => '数据集版本列表', + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde'], + 'Resources' => [ + 'title' => '资源列表', + 'description' => '资源列表。', 'type' => 'array', 'items' => [ - 'description' => '数据集版本', - '$ref' => '#/components/schemas/DatasetVersion', + 'description' => '资源信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '资源 id', 'description' => '资源ID。', 'type' => 'string', 'example' => '123'], + 'Name' => ['title' => '资源名 长度需要在3到27个字符 region内唯一', 'description' => '资源名。', 'type' => 'string', 'example' => 'ResourceName'], + 'ProductType' => ['title' => '产品类型， 支持PAI，MaxCompute', 'description' => '**该字段已废弃，将会下线，请使用ResourceType字段。**', 'type' => 'string', 'example' => 'MaxCompute'], + 'EnvType' => ['title' => '环境， 支持dev（开发）、prod（生产）', 'description' => '环境类型，可能值：'."\n" + .'- dev：开发环境'."\n" + .'- prod：生产环境', 'type' => 'string', 'example' => 'prod'], + 'WorkspaceId' => ['title' => '所属的工作空间 id', 'description' => '所属的工作空间ID。', 'type' => 'string', 'example' => '123'], + 'IsDefault' => ['title' => '是否默认资源 每个类型都有一个默认的资源', 'description' => '是否为默认资源，每种资源类型都有一个默认的资源。可能值：'."\n" + .'- true：是默认资源'."\n" + .'- false：不是默认资源', 'type' => 'boolean', 'example' => 'true'], + 'Quotas' => [ + 'description' => '配额列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配额信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '配额名称', 'description' => '配额名称。', 'type' => 'string', 'example' => 'QuotaName'], + 'ProductCode' => ['title' => '商品 code', 'description' => '产品名，可能值：'."\n" + .'- PAI_isolate：pai预付费资源组（pai cpu）'."\n" + .'- PAI_share：pai后付费资源组（pai gpu）'."\n" + .'- MaxCompute_share：MaxCompute后付费资源组'."\n" + .'- MaxCompute_isolate：MaxCompute预付费资源组'."\n" + .'- DataWorks_isolate：DataWorks预付费资源组'."\n" + .'- DataWorks_share：DataWorks后付费资源组'."\n" + .'- DLC_share：DLC后付费资源组', 'type' => 'string', 'example' => 'MaxCompute_isolate'], + 'QuotaType' => ['title' => '产品类型， 支持PAI，MaxCompute', 'description' => '资源配额类型， 可能值：'."\n" + .'- PAI'."\n" + .'- MaxCompute'."\n" + .'- DLC', 'type' => 'string', 'example' => 'MaxCompute'], + 'Mode' => ['title' => '模式 isolate 预付费 share 后付费 develop 开发模式', 'description' => '付费模式，可能值：'."\n" + ."\n" + .'- isolate：预付费'."\n" + .'- share：后付费', 'type' => 'string', 'example' => 'isolate'], + 'Specs' => [ + 'title' => '规格描述列表', + 'description' => '规格描述列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规格描述信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '规格名字', 'description' => '规格名字。', 'type' => 'string', 'example' => 'cu'], + 'Value' => ['title' => '规格描述', 'description' => '规格描述。', 'type' => 'string', 'example' => '11500'], + ], + ], + 'example' => '{\\"cu\\":\\"11500\\",\\"minCu\\":\\"2300\\",\\"parentId\\":\\"0\\"}', + ], + 'CardType' => ['title' => '卡类型，支持cpu、gpu', 'description' => '卡类型，可能值：'."\n" + .'- CPU'."\n" + .'- GPU', 'type' => 'string', 'example' => 'CPU'], + 'Id' => ['title' => '配额id', 'description' => '资源配额ID。', 'type' => 'string', 'example' => '123'], + 'DisplayName' => ['description' => '资源配额别名。', 'type' => 'string', 'example' => '默认后付费Quota'], + ], + ], + ], + 'Spec' => ['title' => '对于MaxCompute是个json，有如下key： Endpoint Project', 'description' => '规格说明。', 'type' => 'object', 'example' => '对于MaxCompute {"Endpoint": "odps.alibaba-inc.com", "Project": "mignshi"}'], + 'GroupName' => ['title' => '分组名，主账户内唯一 一个 GroupName 下可能有一个 dev 资源和一个 prod 资源', 'description' => '资源分组名，主账户内唯一。', 'type' => 'string', 'example' => 'groupName'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '创建UTC时间，时间格式为ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'Executor' => [ + 'description' => '该字段无效，已废弃。', + 'type' => 'object', + 'properties' => [ + 'OwnerId' => ['description' => '该字段无效，已废弃。', 'type' => 'string', 'example' => '110973******7793'], + ], + ], + 'Encryption' => [ + 'description' => '加密信息，目前只对MaxCompute资源有效。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['description' => '是否加密。', 'type' => 'boolean', 'example' => 'false'], + 'Algorithm' => ['description' => '加密算法。', 'type' => 'string', 'example' => 'AESCTR'], + 'Key' => ['description' => '加密主键。', 'type' => 'string', 'example' => 'DEFAULT'], + ], + ], + 'ResourceType' => ['description' => '资源类型。取值如下：'."\n" + ."\n" + .'- MaxCompute：大数据计算服务资源'."\n" + .'- ECS：通用计算资源'."\n" + .'- Lingjun：灵骏智算资源'."\n" + .'- ACS：ACS计算资源'."\n" + .'- FLINK：Flink资源'."\n" + .'- SelfManagedAckPro：AckPro统一管控集群资源'."\n" + .'- SelfManagedAckLingjun：AckLinjun统一管控集群资源
'."\n" + .'- SelfManagedASI：ASI统一管控集群资源（三方云）', 'type' => 'string', 'example' => 'MaxCompute'], + 'Labels' => [ + 'description' => '标签集合。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签的Key。', 'type' => 'string', 'example' => 'system.supported.dsw'], + 'Value' => ['description' => '标签的Value。', 'type' => 'string', 'example' => 'true'], + ], + ], + ], + ], ], ], + 'TotalCount' => ['title' => '符合过滤条件的作业数量', 'description' => '符合过滤条件的资源数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0648C5BB-68D0-54D2-92A5-607135B8806B\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 5,\\n \\"DatasetVersions\\": [\\n {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"DataCount\\": 0,\\n \\"DataSize\\": 0,\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取数据集版本列表', - ], - 'UpdateDatasetVersion' => [ - 'summary' => '更新指定版本的数据集信息。', - 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', - 'methods' => [ - 'put', + 'title' => '获取工作空间的资源列表', + 'summary' => '获取工作空间内已关联的资源列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResources'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Resources\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Name\\": \\"ResourceName\\",\\n \\"ProductType\\": \\"MaxCompute\\",\\n \\"EnvType\\": \\"prod\\",\\n \\"WorkspaceId\\": \\"123\\",\\n \\"IsDefault\\": true,\\n \\"Quotas\\": [\\n {\\n \\"Name\\": \\"QuotaName\\",\\n \\"ProductCode\\": \\"MaxCompute_isolate\\",\\n \\"QuotaType\\": \\"MaxCompute\\",\\n \\"Mode\\": \\"isolate\\",\\n \\"Specs\\": [\\n {\\n \\"Name\\": \\"cu\\",\\n \\"Value\\": \\"11500\\"\\n }\\n ],\\n \\"CardType\\": \\"CPU\\",\\n \\"Id\\": \\"123\\",\\n \\"DisplayName\\": \\"默认后付费Quota\\"\\n }\\n ],\\n \\"Spec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"GroupName\\": \\"groupName\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Executor\\": {\\n \\"OwnerId\\": \\"110973******7793\\"\\n },\\n \\"Encryption\\": {\\n \\"Enabled\\": false,\\n \\"Algorithm\\": \\"AESCTR\\",\\n \\"Key\\": \\"DEFAULT\\"\\n },\\n \\"ResourceType\\": \\"MaxCompute\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.supported.dsw\\",\\n \\"Value\\": \\"true\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n 1e195c5116124202371861018d5bde\\n \\n 123\\n ResourceName\\n MaxCompute\\n prod\\n 123\\n true\\n \\n QuotaName\\n MaxCompute_isolate\\n MaxCompute\\n develop\\n \\n quota\\n {\\\\\\"cu\\\\\\":\\\\\\"11500\\\\\\",\\\\\\"minCu\\\\\\":\\\\\\"2300\\\\\\",\\\\\\"parentId\\\\\\":\\\\\\"0\\\\\\"}\\n \\n cpu\\n 123\\n \\n groupName\\n 2021-01-21T17:12:35.232Z\\n \\n DLC\\n 2\\n \\n \\n 2\\n","errorExample":""}]', + ], + 'ListRunMetrics' => [ + 'path' => '/api/v1/runs/{RunId}/metrics', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '232571', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '237434', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'RunId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5****jhc9ks92', - ], + 'schema' => ['description' => '运行ID', 'type' => 'string', 'required' => true, 'example' => 'run-1qJhzJ2YXgX****'], ], [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => '运行的指标的Key', 'type' => 'string', 'required' => true, 'example' => 'loss'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'Options' => [ - 'description' => '扩展字段，JsonString类型。'."\n" - .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "mountPath": "/mnt/data/"'."\n" - .'}', - ], - 'Description' => [ - 'description' => '对数据集进行自定义描述，以区分不同的数据集。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of a dataset version.', - ], - 'DataSize' => [ - 'description' => '数据集文件占据空间的大小。单位Byte 。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100000', - ], - 'DataCount' => [ - 'description' => '数据集文件数量，单位个。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - ], - 'required' => false, - ], + 'name' => 'PageToken', + 'in' => 'query', + 'schema' => ['description' => '分页token，从0开始，默认为0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '请求的最大结果数，默认为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'default' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], + 'Metrics' => [ + 'description' => '指标列表', + 'type' => 'array', + 'items' => ['description' => '指标信息详情', '$ref' => '#/components/schemas/RunMetric'], ], + 'NextPageToken' => ['description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为0时表示全部查完。可通过查询结果中的**NextPageToken**字段获取下一页token。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', - 'title' => '更新数据集版本', - ], - 'DeleteDatasetVersion' => [ - 'summary' => '删除指定版本的数据集信息。其中版本v1无法使用本接口删除，需要使用DeleteDataset接口删除数据集的时候同步删除。', - 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', - 'methods' => [ - 'delete', + 'title' => '获取Run的指标记录列表', + 'summary' => '获取Run的指标记录列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListRunMetrics'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiexperiment:ListRunMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', + ], + 'ListRuns' => [ + 'summary' => '获取Run列表。', + 'path' => '/api/v1/runs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '232579', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '237299', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-lfd60v0p****ujtsdx', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '运行名称。', 'type' => 'string', 'required' => false, 'example' => 'myName'], ], [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集版本。版本号需要大于v1，v1版本会在删除数据集的时候同步删除。', - 'type' => 'string', - 'required' => true, - 'example' => 'v2', - ], + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '实验所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。'."\n" + .'> 不填写工作空间ID，系统将返回默认工作空间的运行列表。'."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => '228**'], + ], + [ + 'name' => 'ExperimentId', + 'in' => 'query', + 'schema' => ['title' => 'Run所属实验ID', 'description' => 'Run所属实验ID。', 'type' => 'string', 'required' => false, 'example' => 'exp-1zpfthdx******'], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['title' => 'Run关联的PAI Workload类型', 'description' => 'Run关联的PAI Workload类型。', 'type' => 'string', 'required' => false, 'example' => 'TrainingService'], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['title' => 'Run关联的PAI Workload ID', 'description' => 'Run关联的PAI Workload ID。', 'type' => 'string', 'required' => false, 'example' => 'job-rbvg5wzlj****'], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => ['title' => '任务的标签，精确匹配'."\n" + .'● 支持单标签查询:"is_evaluation:true"'."\n" + .'● 多标签场景（非特殊场景不推荐，可能存在性能问题）:"is_evaluation:true,LLM_evaluation:true" 使用英文逗号分隔，表示多个标签key-value需要同时匹配', 'description' => '任务的标签，精确匹配。支持：'."\n" + .'- 单标签查询："is_evaluation:true"'."\n" + .'- 多标签场景（非特殊场景不推荐，可能存在性能问题）："is_evaluation:true,LLM_evaluation:true" 使用半角逗号（,）分隔，表示多个标签key-value需要同时匹配。', 'type' => 'string', 'required' => false, 'example' => 'is_evaluation:true'], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['description' => '是否展示详细信息，包括：Metrics、Params和Labels。取值如下：'."\n" + .'- true：表示展示详细信息。'."\n" + .'- false（默认值）：表示不展示详细信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'GmtCreateTime', + 'in' => 'query', + 'schema' => ['description' => '实例创建时间。', 'type' => 'string', 'required' => false, 'example' => '2021-01-30T12:51:33.028Z'], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => '排序方式的字符串列表，支持排序的字段包括：GmtCreateTime、Name。排序方式包括DESC和ASC，默认为ASC。支持多个字段，用半角逗号","分隔。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime DESC,Name ASC'], + ], + [ + 'name' => 'PageToken', + 'in' => 'query', + 'schema' => ['description' => '分页token，从0开始，默认为0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '请求的最大结果数，默认为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页数。 取值范围：大于0。 默认值：1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页显示的记录数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => '用于排序的字段名，取值如下：'."\n" + .'- Name：Run名称。'."\n" + .'- GmtCreateTime（默认值）：Run创建时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'default' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。'."\n" + .'- ASC：升序。'."\n" + .'- DESC（默认值）：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '请求体。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], + 'Runs' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => ['description' => '运行实例详情。', '$ref' => '#/components/schemas/Run'], ], + 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'NextPageToken' => ['description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为0时表示全部查完。可通过查询结果中的**NextPageToken**字段获取下一页token。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', - 'title' => '删除数据集版本', - ], - 'DeleteDatasetVersionLabels' => [ - 'summary' => '删除数据集版本的标签。', - 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}/labels', - 'methods' => [ - 'delete', + 'title' => '获取运行列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListRuns'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiexperiment:ListRuns', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"Runs\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"SourceId\\": \\"train9s0afvjkf\\",\\n \\"SourceType\\": \\"TrainingService\\",\\n \\"WorkspaceId\\": \\"145883\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Name\\": \\"testrun\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"163104*****3440\\",\\n \\"ExperimentId\\": \\"exp-1zpfthdx******\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"run-1qJhzJ2YXgX****\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', + ], + 'ListUserConfigs' => [ + 'path' => '/api/v1/userconfigs', + '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' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232577', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '194785', + 'abilityTreeNodes' => ['FEATURElearnDVAH75'], ], 'parameters' => [ [ - 'name' => 'DatasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集版本ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5*****jhc9ks92', - ], - ], - [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'name' => 'ConfigKeys', + 'in' => 'query', + 'schema' => ['title' => '配置键', 'description' => '配置键的集合，目前只支持customizePAIAssumedRole。', 'type' => 'string', 'required' => false, 'example' => 'customizePAIAssumedRole'], ], [ - 'name' => 'Keys', + 'name' => 'CategoryNames', 'in' => 'query', - 'schema' => [ - 'description' => '版本标签key, 多个标签key用英文逗号分隔。', - 'type' => 'string', - 'required' => true, - 'example' => 'key1,key2', - ], + 'schema' => ['description' => '分类，目前只支持DataPrivacyConfig。', 'type' => 'string', 'required' => false, 'example' => 'DataPrivacyConfig'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '响应。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'B2E89D7E-74F8-5656-A5D6-81D83403F9A8', + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'sdjksdk-******-dsfds'], + 'Configs' => [ + 'title' => '配置列表', + 'description' => '配置列表', + 'type' => 'array', + 'items' => [ + 'description' => '配置', + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => ['title' => '配置键', 'description' => '配置键', 'type' => 'string', 'example' => 'customizePAIAssumedRole'], + 'ConfigValue' => ['title' => '配置值', 'description' => '配置值', 'type' => 'string', 'example' => 'role'], + 'CategoryName' => ['description' => '分类，目前只支持DataPrivacyConfig。', 'type' => 'string', 'example' => 'DataPrivacyConfig'], + 'Scope' => ['description' => '范围，目前支持subUser、owner。', 'type' => 'string', 'example' => 'subUser'], + ], + ], ], + 'TotalCount' => ['title' => '返回数量', 'description' => '返回数量', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2E89D7E-74F8-5656-A5D6-81D83403F9A8\\"\\n}","type":"json"}]', - 'title' => '删除数据集版本标签', - ], - 'CreateDatasetVersionLabels' => [ - 'summary' => '创建数据集版本的标签。', - 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}/labels', - 'methods' => [ - 'put', + 'title' => '获取用户配置', + 'summary' => '获取用户配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserConfigs'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListUserConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"sdjksdk-******-dsfds\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigKey\\": \\"customizePAIAssumedRole\\",\\n \\"ConfigValue\\": \\"role\\",\\n \\"CategoryName\\": \\"DataPrivacyConfig\\",\\n \\"Scope\\": \\"subUser\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', + ], + 'ListWorkspaceRoles' => [ + 'summary' => '列举工作空间角色', + 'path' => '/api/v1/workspaces/{WorkspaceId}/roles', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232578', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', - ], + 'abilityTreeCode' => '221945', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-rbvg5wzlj****9ks92', - ], + 'schema' => ['title' => '工作空间ID', 'description' => '工作空间ID。可通过 [ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => true, 'example' => '87***'], ], [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集版本名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页编号，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'RoleIds', + 'in' => 'query', + 'schema' => ['description' => '角色ID列表，英文逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'role-dhg*******'], + ], + [ + 'name' => 'RoleName', + 'in' => 'query', + 'schema' => ['description' => '角色名称。', 'type' => 'string', 'required' => false, 'example' => 'dev-test'."\n"], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => ['description' => '角色类型。'."\n" + .'- custom：自定义角色。', 'type' => 'string', 'required' => false, 'example' => 'custom'], + ], + [ + 'name' => 'VerboseFields', + 'in' => 'query', + 'schema' => ['description' => '逗号分隔的集合，表明要返回的字段。目前支持ModulePermissions，代表是否返回角色的权限配置。', 'type' => 'string', 'required' => false, 'example' => 'ModulePermissions'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '分页查询时的排序字段。取值如下：'."\n" + ."\n" + .'- GmtCreateTime（默认值）：按创建时间。'."\n" + .'- GmtModifiedTime：按修改时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，对指定的排序字段进行升序或降序。取值如下：'."\n" + ."\n" + .'- ASC（默认值）：升序。'."\n" + .'- DESC ：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '状态。（废弃字段）', 'type' => 'string', 'required' => false, 'example' => 'Succeeded'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体。', + 'title' => 'Schema of Response', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'Labels' => [ - 'description' => '标签列表。', + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => ' '."\n" + .'A519F77D-28A0-52F5-AB82-5********8'], + 'Roles' => [ + 'description' => '自定义角色列表。', 'type' => 'array', 'items' => [ - 'description' => '为数据集版本添加的标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', + 'description' => '角色对象。', + 'type' => 'object', + 'properties' => [ + 'RoleName' => ['description' => '角色名称。', 'type' => 'string', 'example' => 'dev-test'], + 'RoleId' => ['description' => '自定义角色ID。', 'type' => 'string', 'example' => 'role-dhg*******'], + 'GmtCreateTime' => ['description' => '创建时间。ISO8601 格式的 UTC 时间。', 'type' => 'string', 'example' => '2025-09-14T07:40:01.000Z'], + 'GmtModifiedTime' => ['description' => '修改时间。ISO8601 格式的 UTC 时间。', 'type' => 'string', 'example' => '2026-04-15T02:29:52Z'], + 'Creator' => ['description' => '创建者的阿里云账号UID。', 'type' => 'string', 'example' => '2680******4103'], + 'ModulePermissions' => ['description' => '角色权限配置。', '$ref' => '#/components/schemas/ModulePermissions'], + ], ], - 'required' => true, ], + 'TotalCount' => ['title' => '返回数量', 'description' => '总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], - 'required' => false, ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', - ], + 'title' => '获取工作空间角色列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListWorkspaceRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', - 'title' => '创建数据集版本标签', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\\\t\\\\nA519F77D-28A0-52F5-AB82-5********8\\",\\n \\"Roles\\": [\\n {\\n \\"RoleName\\": \\"dev-test\\",\\n \\"RoleId\\": \\"role-dhg*******\\",\\n \\"GmtCreateTime\\": \\"2025-09-14T07:40:01.000Z\\",\\n \\"GmtModifiedTime\\": \\"2026-04-15T02:29:52Z\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"ModulePermissions\\": [\\n {\\n \\"ModuleName\\": \\"PaiDesigner\\",\\n \\"PermissionType\\": \\"ReadOnly\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionCodes\\": [\\n \\"PaiDLC:GetTensorboard\\"\\n ],\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', ], - 'CreateConnection' => [ - 'summary' => '创建连接。用于LangStudio、数据集多模态检索服务等场景中连接PAI云端到客户的模型、数据库等服务。', - 'path' => '/api/v1/connections', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkspaceUsers' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/users', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '267606', - 'abilityTreeNodes' => [ - 'FEATURElearnIUXWCQ', - ], + 'abilityTreeCode' => '14222', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。创建连接所需要的参数信息。', - 'type' => 'object', - 'properties' => [ - 'Accessibility' => [ - 'description' => '工作空间可见度，取值如下。'."\n" - .'- PRIVATE（默认值）：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], - 'example' => 'PRIVATE', - 'default' => 'PRIVATE', - ], - 'Configs' => [ - 'description' => '连接的配置信息。以key-valued的形式配置，不同的连接类型对应的Config配置的key不相同。具体参见请求参数补充说明。', - 'type' => 'object', - 'required' => true, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '6379', - 'description' => '连接配置的value值。', - ], - ], - 'ConnectionName' => [ - 'description' => '连接的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-connection', - ], - 'ConnectionType' => [ - 'description' => '连接的类型，可选值：'."\n" - .'- DashScopeConnection：百炼服务连接。'."\n" - .'- OpenLLMConnection：开源模型连接。'."\n" - .'- MilvusConnection：Milvus连接。'."\n" - .'- OpenSearchConnection：OpenSearch连接。'."\n" - .'- LindormConnection：Lindorm连接。'."\n" - .'- ElasticsearchConnection：Elasticsearch连接。'."\n" - .'- HologresConnection：Hologres连接。'."\n" - .'- RDSConnection：RDS连接。'."\n" - .'- CustomConnection：自定义连接。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ElasticsearchConnection' => 'ElasticsearchConnection', - 'MilvusConnection' => 'MilvusConnection', - 'OpenSearchConnection' => 'OpenSearchConnection', - 'HologresConnection' => 'HologresConnection', - 'DashScopeConnection' => 'DashScopeConnection', - 'LindormConnection' => 'LindormConnection', - 'RDSConnection' => 'RDSConnection', - 'OpenLLMConnection' => 'OpenLLMConnection', - 'CustomConnection' => 'CustomConnection', - ], - 'example' => 'DashScopeConnection', - ], - 'Description' => [ - 'description' => '连接的描述。', - 'type' => 'string', - 'required' => false, - 'example' => '开源大模型服务连接。', - ], - 'Secrets' => [ - 'description' => '需要加密的连接配置信息。比如数据库的账密信息，模型服务的key等。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '加密连接配置的value值。', - 'example' => 'Dsjk***hsl01', - ], - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID，可从接口[ListWorkspaces](~~449124~~)获取。', - 'type' => 'string', - 'required' => false, - 'example' => '123**45', - ], - 'ResourceMeta' => [ - 'description' => '连接的资源信息。一般适用于数据库类型的连接配置。', - 'type' => 'object', - 'properties' => [ - 'InstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => '测试实例。', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ld-uf69****9nqjjes', - ], - 'Extra' => [ - 'description' => '额外配置信息。', - 'type' => 'string', - 'required' => false, - 'example' => '{"vpcId":"vpc-xxxx"}', - ], - ], - 'required' => false, - ], - 'Models' => [ - 'description' => '模型列表。适用于模型服务类型的连接。', + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '12345'], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => '支持添加为工作空间成员的用户显示名称。', 'type' => 'string', 'required' => false, 'example' => 'doctest****'], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde'], + 'TotalCount' => ['title' => '符合过滤条件的用户数量', 'description' => '符合过滤条件的用户数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Users' => [ + 'title' => '用户列表', + 'description' => '用户列表。', 'type' => 'array', 'items' => [ - 'description' => '模型。', + 'description' => '用户。', 'type' => 'object', 'properties' => [ - 'Model' => [ - 'description' => '模型标识符。', - 'type' => 'string', - 'required' => false, - 'example' => 'model_001', - ], - 'DisplayName' => [ - 'description' => '模型的显示名称。', - 'type' => 'string', - 'required' => false, - 'example' => '语言模型。', - ], - 'ModelType' => [ - 'description' => '模型类型。可选值：'."\n" - .'- LLM：大语言模型'."\n" - .'- Embedding：Embedding模型'."\n" - .'- ReRank：ReRank模型', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Embedding' => 'Embedding', - 'LLM' => 'LLM', - 'ReRank' => 'ReRank', - ], - 'example' => 'LLM', - ], - 'ToolCall' => [ - 'description' => '是否支持ToolCall工具调用。可取值：'."\n" - .'- true：支持'."\n" - .'- false：不支持', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'UserId' => ['title' => '用户 id', 'description' => '用户ID。', 'type' => 'string', 'example' => '1611******3000'], + 'UserName' => ['title' => '用户名', 'description' => '用户名。', 'type' => 'string', 'example' => 'she******mo'], ], - 'required' => false, ], - 'required' => false, ], ], - 'required' => false, ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回信息。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求唯一ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'ConnectionId' => [ - 'description' => '连接ID。', - 'type' => 'string', - 'example' => 'conn-pai9m***mi47', - ], + 'title' => '获取可被添加至工作空间的用户列表', + 'summary' => '列出未加入工作空间的用户列表，这些用户可被加入工作空间成为成员。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaceUsers'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListWorkspaceUsers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\"\\n}","type":"json"}]', - 'title' => '创建连接', - 'requestParamsDescription' => '各种连接类型（ConnectionType）对应的Configs和Secrets配置格式：'."\n" - .'- **DashScopeConnection/OpenLLMConnection**'."\n" - .'```'."\n" - .'{'."\n" - .' "Secrets": {'."\n" - .' "api_key": "xxx"'."\n" - .' },'."\n" - .' "Configs": {'."\n" - .' "base_url": "cn-hangzhou.aigc.aliyuncs.com/api/v1/services/xxx"'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- **OpenSearchConnection/LindormConnection/ElasticsearchConnection**'."\n" - .'```'."\n" - ."\n" - .'{'."\n" - .' "Secrets": {'."\n" - .' "password": "xxx"'."\n" - .' },'."\n" - .' "Confgs": {'."\n" - .' "uri": "xxx",'."\n" - .' "username": "xxx"'."\n" - .' }'."\n" - .'}'."\n" - ."\n" - .'```'."\n" - ."\n" - .'- **MilvusConnection**'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "Secrets": {'."\n" - .' "password": "xxx"'."\n" - .' },'."\n" - .' "Confgs": {'."\n" - .' "uri": "xxx",'."\n" - .' "username": "xxx"'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- **HologresConnection**'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "Secrets": {'."\n" - .' "password": "xxx"'."\n" - .' },'."\n" - .' "Configs": {'."\n" - .' "database": "xx",'."\n" - .' "port": "xx",'."\n" - .' "host": "xx",'."\n" - .' "user": "xx"'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- **RDSConnection**'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "Secrets": {'."\n" - .' "password": "xxx"'."\n" - .' },'."\n" - .' "Configs": {'."\n" - .' "database": "xxx",'."\n" - .' "port": "xxx",'."\n" - .' "host": "xxx",'."\n" - .' "type": "db_type",'."\n" - .' "username": "xxx"'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'- **CustomConnection**'."\n" - ."\n" - .'自定义格式', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"TotalCount\\": 2,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"1611******3000\\",\\n \\"UserName\\": \\"she******mo\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetConnection' => [ - 'summary' => '获取连接详情。', - 'path' => '/api/v1/connections/{ConnectionId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkspaces' => [ + 'path' => '/api/v1/workspaces', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '267615', - 'abilityTreeNodes' => [ - 'FEATURElearnIUXWCQ', - ], + 'abilityTreeCode' => '14203', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ - 'name' => 'ConnectionId', - 'in' => 'path', - 'schema' => [ - 'description' => '连接ID。如何获取连接 ID，详情请参见 [ListConnections](url)。', - 'type' => 'string', - 'required' => true, - 'example' => 'conn-pai9m***mi47'."\n", - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '分页，从1开始，默认1', 'description' => '工作空间列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'EncryptOption', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '加密设置。可取值：'."\n" - .'- PlainText：明文。'."\n" - .'- Secret：密文。', - 'type' => 'string', - 'required' => false, - 'example' => 'PlainText', - ], + 'schema' => ['title' => '页大小，默认20', 'description' => '分页查询时设置的每页行数，默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['title' => '排序字段：CreateTime', 'description' => '分页查询时的排序字段，默认使用GmtCreateTime。取值如下。'."\n" + .'* GmtCreateTime（默认值）：按创建时间。'."\n" + .'* GmtModifiedTime：按修改时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '排序方向： ASC - 升序 DESC - 降序', 'description' => '分页查询时，对指定的排序字段进行升序或降序。取值如下：'."\n" + .'* ASC（默认值）：升序。'."\n" + .'* DESC ：降序。', 'type' => 'string', 'required' => false, 'example' => 'ASC'], + ], + [ + 'name' => 'WorkspaceName', + 'in' => 'query', + 'schema' => ['title' => '工作空间名字', 'description' => '工作空间名称。', 'type' => 'string', 'required' => false, 'example' => 'abc'], + ], + [ + 'name' => 'ModuleList', + 'in' => 'query', + 'schema' => ['title' => '逗号分割的模块列表，目前填入PAI', 'description' => '逗号分割的模块列表。默认值：PAI。', 'type' => 'string', 'required' => false, 'example' => 'PAI'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '状态', 'description' => '工作空间状态，目前支持如下值：'."\n" + ."\n" + .'- ENABLED：正常。'."\n" + .'- INITIALIZING：初始化中。'."\n" + .'- FAILURE：失败。'."\n" + .'- DISABLED：手动禁用。'."\n" + .'- FROZEN：欠费冻结。'."\n" + .'- UPDATING：项目更新中。', 'type' => 'string', 'required' => false, 'example' => 'ENABLED'], + ], + [ + 'name' => 'Option', + 'in' => 'query', + 'schema' => ['title' => '逗号分隔的选项', 'description' => '选项，取值如下：'."\n" + .'* GetWorkspaces（默认值）：获取工作空间列表，会返回Workspaces。'."\n" + .'* GetResourceLimits：获取资源限制，会返回ResourceLimits。', 'type' => 'string', 'required' => false, 'example' => 'GetWorkspaces'], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['title' => '是否显示详细信息，默认true', 'description' => '是否显示工作空间详细信息。取值如下：'."\n" + .'- false（默认值）：不显示。'."\n" + .'- true：显示。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => ['title' => 'GetWorkspaceFields的Field字段', 'description' => '工作空间详情的返回字段列表。用于限定返回结果中的工作空间属性。'."\n" + .'多个属性用半角逗号（,）分隔。目前只支持Id，表示工作空间ID。', 'type' => 'string', 'required' => false, 'example' => 'Id'], + ], + [ + 'name' => 'WorkspaceIds', + 'in' => 'query', + 'schema' => ['title' => '工作空间id列表', 'description' => '工作空间ID列表。多个工作空间ID用半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '123,234'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。如何查看资源组ID，请参见[查看资源组基本信息](~~151181~~)。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmwp7rky****'], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应信息。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求唯一ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '11**43', - ], - 'Accessibility' => [ - 'description' => '资源可见性，取值如下：'."\n" - ."\n" - .'- PUBLIC：当前工作空间所有成员都可以访问。'."\n" - .'- PRIVATE：只有创建者可以访问。', - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'ConnectionId' => [ - 'description' => '连接ID。', - 'type' => 'string', - 'example' => 'conn-pai9m***mi47', - ], - 'ConnectionType' => [ - 'description' => '连接的类型。可能值：'."\n" - ."\n" - .'- DashScopeConnection：百炼服务连接。'."\n" - .'- OpenLLMConnection：开源模型连接。'."\n" - .'- MilvusConnection：Milvus连接。'."\n" - .'- OpenSearchConnection：OpenSearch连接。'."\n" - .'- LindormConnection：Lindorm连接。'."\n" - .'- ElasticsearchConnection：Elasticsearch连接。'."\n" - .'- HologresConnection：Hologres连接。'."\n" - .'- RDSConnection：RDS连接。'."\n" - .'- CustomConnection：自定义连接。', - 'type' => 'string', - 'example' => 'OpenSearchConnection', - ], - 'ConnectionName' => [ - 'description' => '连接的名称。', - 'type' => 'string', - 'example' => '数据库连接', - ], - 'Description' => [ - 'description' => '连接的描述。', - 'type' => 'string', - 'example' => '用于数据集检索。', - ], - 'Configs' => [ - 'description' => '连接的配置信息。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '12345', - 'description' => '连接配置的value值。', - ], - ], - 'Secrets' => [ - 'description' => '需要加密的Key-Value配置。如数据库登录密码，模型连接的Key等。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'Dsjk***hsl01', - 'description' => '加密连接配置的value值。', - ], - ], - 'GmtCreateTime' => [ - 'description' => '创建连接的UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2025-03-07T07:54:56Z', - ], - 'GmtModifiedTime' => [ - 'description' => '修改连接的UTC时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2025-03-07T07:54:56Z', - ], - 'Creator' => [ - 'description' => '连接的创建者。', - 'type' => 'string', - 'example' => '28632***898231', - ], - 'ResourceMeta' => [ - 'description' => '连接的实例资源信息。一般适用于数据库类型的连接。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ld-2vc1***v1zaqgzol', - ], - 'InstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => '测试实例。', - ], - 'Extra' => [ - 'description' => '额外配置信息。', - 'type' => 'string', - 'example' => '{"vpcId":"vpc-xxxx"}', - ], - ], - ], - 'Models' => [ - 'description' => '模型列表。适用于模型服务类型的连接。', + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], + 'Workspaces' => [ + 'title' => '工作空间列表', + 'description' => '工作空间详情列表，当Option为GetWorkspaces时会返回该列表。', 'type' => 'array', 'items' => [ - 'description' => '模型信息。', + 'description' => '工作空间详情。', 'type' => 'object', 'properties' => [ - 'Model' => [ - 'description' => '模型标识符。', - 'type' => 'string', - 'example' => 'model_001', - ], - 'DisplayName' => [ - 'description' => '模型的显示名称。', - 'type' => 'string', - 'example' => '测试语言模型。', - ], - 'ModelType' => [ - 'description' => '模型类型，取值为：'."\n" - .'- LLM：大语言模型。'."\n" - .'- Embedding：Embedding模型。'."\n" - .'- ReRank：ReRank模型。', - 'type' => 'string', - 'example' => 'LLM', + 'WorkspaceId' => ['title' => '工作空间 id', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '123'], + 'WorkspaceName' => ['title' => '工作空间名字', 'description' => '工作空间名称。', 'type' => 'string', 'example' => 'workspace-example'], + 'GmtCreateTime' => ['title' => '创建 UTC 时间，日期格式 iso8601', 'description' => '工作空间创建时间。以ISO8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'GmtModifiedTime' => ['title' => '修改 UTC 时间，日期格式 iso8601', 'description' => '工作空间修改时间。以ISO8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mmZ。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], + 'Description' => ['title' => '描述', 'description' => '工作空间描述。', 'type' => 'string', 'example' => 'workspace description example'], + 'Creator' => ['title' => '创建人', 'description' => '创建者用户ID。', 'type' => 'string', 'example' => '122424353535'], + 'EnvTypes' => [ + 'title' => '环境，用作判断简单模式还是标准模式', + 'description' => '工作空间包含的环境列表。', + 'type' => 'array', + 'items' => ['description' => '工作空间包含的环境，可能值：'."\n" + ."\n" + .'- 简单模式只有生产环境（prod）。'."\n" + .'- 标准模式包含开发环境（dev）和生产环境（prod）。', 'type' => 'string', 'example' => 'prod'], ], - 'ToolCall' => [ - 'description' => '是否支持ToolCall工具调用。可取值：'."\n" - .'- true：支持'."\n" - .'- false：不支持', - 'type' => 'boolean', - 'example' => 'true', + 'Status' => ['title' => '工作空间状态', 'description' => '工作空间状态。', 'type' => 'string', 'example' => 'ENABLED'], + 'AdminNames' => [ + 'title' => '管理员名字', + 'description' => '管理员账户名称列表。', + 'type' => 'array', + 'items' => ['description' => '管理员账户名称。', 'type' => 'string', 'example' => 'demo_test@***.aliyunid.com'], ], + 'IsDefault' => ['title' => '是否为默认工作空间', 'description' => '是否为默认工作空间。', 'type' => 'boolean', 'example' => 'false'], + 'ExtraInfos' => ['title' => '附加信息', 'description' => '扩展信息，目前包含TenantId，代表租户ID。', 'type' => 'object', 'example' => '{"TenantId": "4286******98"}'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfmwp7rky****'], + 'DisplayName' => ['type' => 'string'], ], ], ], + 'TotalCount' => ['title' => '符合过滤条件的作业数量', 'description' => '符合查询条件的工作空间总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ResourceLimits' => ['title' => '资源限制', 'description' => '用户在一个工作空间内允许开通的资源类型和数量限制，当Option为GetResourceLimits时会返回该列表。'."\n" + .'目前支持的资源类型包括：'."\n" + .'* MaxCompute_share：MaxCompute后付费。'."\n" + .'* MaxCompute_isolate：MaxCompute预付费。'."\n" + .'* DLC_share：DLC后付费。'."\n" + .'* PAI_isolate：PAI预付费。'."\n" + .'* PAI_share：PAI后付费。'."\n" + .'* DataWorks_isolate：Dataworks预付费。'."\n" + .'* DataWorks_share：Dataworks后付费。'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "MaxCompute_share": 1,'."\n" + .' "MaxCompute_isolate": 1,'."\n" + .' "DLC_share": 1'."\n" + .'}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"WorkspaceId\\": \\"11**43\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\",\\n \\"ConnectionType\\": \\"OpenSearchConnection\\",\\n \\"ConnectionName\\": \\"数据库连接\\",\\n \\"Description\\": \\"用于数据集检索。\\",\\n \\"Configs\\": {\\n \\"key\\": \\"12345\\"\\n },\\n \\"Secrets\\": {\\n \\"key\\": \\"Dsjk***hsl01\\"\\n },\\n \\"GmtCreateTime\\": \\"2025-03-07T07:54:56Z\\",\\n \\"GmtModifiedTime\\": \\"2025-03-07T07:54:56Z\\",\\n \\"Creator\\": \\"28632***898231\\",\\n \\"ResourceMeta\\": {\\n \\"InstanceId\\": \\"ld-2vc1***v1zaqgzol\\",\\n \\"InstanceName\\": \\"测试实例。\\",\\n \\"Extra\\": \\"{\\\\\\"vpcId\\\\\\":\\\\\\"vpc-xxxx\\\\\\"}\\"\\n },\\n \\"Models\\": [\\n {\\n \\"Model\\": \\"model_001\\",\\n \\"DisplayName\\": \\"测试语言模型。\\",\\n \\"ModelType\\": \\"LLM\\",\\n \\"ToolCall\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询连接', - ], - 'UpdateConnection' => [ - 'summary' => '更新连接配置。', - 'path' => '/api/v1/connections/{ConnectionId}', - 'methods' => [ - 'put', + 'title' => '获取工作空间列表', + 'summary' => '获取某个地域下的工作空间列表。', + 'description' => '您可以通过option参数指定不同的查询选项，来获取不同的工作空间相关信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListWorkspaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\",\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"123\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"Creator\\": \\"122424353535\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Status\\": \\"ENABLED\\",\\n \\"AdminNames\\": [\\n \\"demo_test@***.aliyunid.com\\"\\n ],\\n \\"IsDefault\\": false,\\n \\"ExtraInfos\\": {\\n \\"TenantId\\": \\"4286******98\\"\\n },\\n \\"resourceGroupId\\": \\"rg-acfmwp7rky****\\",\\n \\"DisplayName\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"ResourceLimits\\": {\\n \\"MaxCompute_share\\": 1,\\n \\"MaxCompute_isolate\\": 1,\\n \\"DLC_share\\": 1\\n }\\n}","type":"json"}]', + ], + 'LogRunMetrics' => [ + 'path' => '/api/v1/runs/{RunId}/metrics/action/log', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '267622', - 'abilityTreeNodes' => [ - 'FEATURElearnIUXWCQ', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '237449', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'ConnectionId', + 'name' => 'RunId', 'in' => 'path', - 'schema' => [ - 'description' => '连接ID。如何获取连接 ID，详情请参见 [ListConnections](url)。', - 'type' => 'string', - 'required' => true, - 'example' => 'conn-pai9m***mi47', - ], + 'schema' => ['description' => '运行ID', 'type' => 'string', 'required' => true, 'example' => 'run-1qJhzJ2YXgX****'], ], [ 'name' => 'body', @@ -15631,71 +12138,10 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'Configs' => [ - 'description' => '连接的配置信息。以key-valued的形式配置，不同的连接类型对应的Config配置的key不相同。具体参见CreateConnection接口的请求参数补充说明。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '6379', - 'description' => '连接配置的value值。', - ], - ], - 'Description' => [ - 'description' => '连接的描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => '用于标注的连接。'."\n", - ], - 'Secrets' => [ - 'description' => '需要加密的Key-Value配置。如数据库登录密码，模型连接的Key等。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'Dakbjas**aljksdn', - 'description' => '加密连接配置的value值。', - ], - ], - 'Models' => [ - 'description' => '模型信息列表。', + 'Metrics' => [ + 'description' => '指标列表', 'type' => 'array', - 'items' => [ - 'description' => '模型信息。', - 'type' => 'object', - 'properties' => [ - 'Model' => [ - 'description' => '模型标识符。', - 'type' => 'string', - 'required' => false, - 'example' => 'model_001', - ], - 'DisplayName' => [ - 'description' => '模型显示名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'car_tag', - ], - 'ModelType' => [ - 'description' => '模型类型。可选值：'."\n" - .'- LLM'."\n" - .'- Embedding'."\n" - .'- ReRank', - 'type' => 'string', - 'required' => false, - 'example' => 'LLM', - ], - 'ToolCall' => [ - 'description' => '是否支持ToolCall工具调用。可取值：'."\n" - .'- true：支持'."\n" - .'- false：不支持', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], + 'items' => ['description' => '指标详细信息', 'required' => false, '$ref' => '#/components/schemas/RunMetric'], 'required' => false, ], ], @@ -15707,863 +12153,552 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应信息。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求唯一ID。', - 'type' => 'string', - 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', - 'title' => '更新连接', - ], - 'ListConnections' => [ - 'summary' => '获取连接列表。', - 'path' => '/api/v1/connections', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '批量记录Run的指标', + 'summary' => '批量记录Run的指标', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'LogRunMetrics'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + ], + 'PublishCodeSource' => [ + 'summary' => '发布私有的代码配置到工作空间公开可见。', + 'path' => '/api/v1/codesources/{CodeSourceId}/publish', + 'methods' => ['put'], + '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' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '267625', - 'abilityTreeNodes' => [ - 'FEATURElearnIUXWCQ', - ], + 'abilityTreeCode' => '55459', + 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '478**', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '分页游标的标识。用于标记下一页查询的起始位置。', - 'type' => 'string', - 'required' => false, - 'example' => '15', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '每页的最大数据条数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时的排序字段，默认使用GmtCreateTime。取值如下。'."\n" - .'- GmtCreateTime（默认值）：按创建时间。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，对指定的排序字段进行升序或降序，与SortBy结合使用。'."\n" - .'- ASC：升序。'."\n" - .'- DESC（默认值）：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], - ], - [ - 'name' => 'ConnectionIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '连接ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '连接ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'conn-ljasd***jsx', - ], - 'required' => false, - ], - ], - [ - 'name' => 'ConnectionName', - 'in' => 'query', - 'schema' => [ - 'description' => '连接的名称。', - 'type' => 'string', - 'required' => false, - 'example' => '数据库连接', - ], + 'name' => 'CodeSourceId', + 'in' => 'path', + 'schema' => ['title' => '待删除的代码源配置', 'description' => '待发布的代码源配置ID。如何获取代码配置ID，请参见[ListCodeSources](~~459922~~)。', 'type' => 'string', 'required' => true, 'example' => 'code-a797*******'], ], - [ - 'name' => 'ConnectionTypes', - 'in' => 'query', - 'style' => 'simple', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '连接类型列表。', - 'type' => 'array', - 'items' => [ - 'description' => '连接类型。可选值：'."\n" - .'- DashScopeConnection：百炼服务连接。'."\n" - .'- OpenLLMConnection：开源模型连接。'."\n" - .'- MilvusConnection：Milvus连接。'."\n" - .'- OpenSearchConnection：OpenSearch连接。'."\n" - .'- LindormConnection：Lindorm连接。'."\n" - .'- ElasticsearchConnection：Elasticsearch连接。'."\n" - .'- HologresConnection：Hologres连接。'."\n" - .'- RDSConnection：RDS连接。'."\n" - .'- CustomConnection：自定义连接。', - 'type' => 'string', - 'required' => false, - 'example' => 'OpenLLMConnection', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'CodeSourceId' => ['title' => '被删除的代码源配置ID', 'description' => '发布成功的代码源配置ID。', 'type' => 'string', 'example' => 'code-a797*******'], + 'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], - 'required' => false, - ], - ], - [ - 'name' => 'EncryptOption', - 'in' => 'query', - 'schema' => [ - 'description' => '加密设置。可取值：'."\n" - .'- PlainText（明文）'."\n" - .'- Secret（密文）', - 'type' => 'string', - 'required' => false, - 'example' => 'PlainText', ], ], - [ - 'name' => 'Model', - 'in' => 'query', - 'schema' => [ - 'description' => '模型标识符。', - 'type' => 'string', - 'required' => false, - 'example' => 'model_001', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '发布代码配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishCodeSource'], ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'ModelTypes', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '模型类型列表。', - 'type' => 'array', - 'items' => [ - 'description' => '模型类型。可取值：'."\n" - .'- LLM'."\n" - .'- Embedding'."\n" - .'- ReRank', - 'type' => 'string', - 'required' => false, - 'example' => 'LLM', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paicodesource:PublishCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-a797*******\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'PublishDataset' => [ + 'summary' => '将私有数据集在工作空间内公开。', + 'path' => '/api/v1/datasets/{DatasetId}/publish', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ToolCall', - 'in' => 'query', - 'schema' => [ - 'description' => '是否支持ToolCall工具调用。可取值：'."\n" - .'- true：支持'."\n" - .'- false：不支持', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '48571', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], + 'parameters' => [ [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'description' => '创建者。', - 'type' => 'string', - 'required' => false, - 'example' => '12908*******3242', - ], + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5w****c9ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应信息。', + 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'Connections' => [ - 'description' => '连接列表信息。', - 'type' => 'array', - 'items' => [ - 'description' => '连接信息。', - '$ref' => '#/components/schemas/Connection', - ], - ], - 'MaxResults' => [ - 'description' => '每页的最大数据条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '分页游标的标识。用于标记下一页查询的起始位置。', - 'type' => 'string', - 'example' => '15', - ], - 'TotalCount' => [ - 'description' => '符合过滤条件的连接总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '27', - ], - 'RequestId' => [ - 'description' => '请求唯一ID。', - 'type' => 'string', - 'example' => 'B2C51F93-1C07-5477-9705-5FDB****F19F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Connections\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"ConnectionType\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"Secrets\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"WorkspaceId\\": \\"\\",\\n \\"Creator\\": \\"\\",\\n \\"ResourceMeta\\": {\\n \\"InstanceName\\": \\"\\",\\n \\"Extra\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n },\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"ConnectionName\\": \\"\\",\\n \\"ConnectionId\\": \\"\\",\\n \\"Configs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Models\\": [\\n {\\n \\"ToolCall\\": true,\\n \\"Model\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"ModelType\\": \\"\\"\\n }\\n ],\\n \\"GmtCreateTime\\": \\"\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"15\\",\\n \\"TotalCount\\": 27,\\n \\"RequestId\\": \\"B2C51F93-1C07-5477-9705-5FDB****F19F\\"\\n}","type":"json"}]', - 'title' => '获取连接列表', - ], - 'DeleteConnection' => [ - 'summary' => '删除连接。', - 'path' => '/api/v1/connections/{ConnectionId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '发布数据集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishDataset'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:PublishDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', + ], + 'PublishImage' => [ + 'path' => '/api/v1/images/{ImageId}/publish', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '267624', - 'abilityTreeNodes' => [ - 'FEATURElearnIUXWCQ', - ], + 'abilityTreeCode' => '72192', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ - 'name' => 'ConnectionId', + 'name' => 'ImageId', 'in' => 'path', - 'schema' => [ - 'description' => '连接ID。如何获取连接 ID，详情请参见 [ListConnections](url)。', - 'type' => 'string', - 'required' => true, - 'example' => 'conn-pai9m***mi47', - ], + 'schema' => ['title' => '镜像Id', 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', 'type' => 'string', 'required' => true, 'example' => 'image-dk******fa'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回信息。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求唯一ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], + 'ImageId' => ['title' => '镜像 id', 'description' => '镜像ID。', 'type' => 'string', 'example' => 'image-dk******fa'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除连接', - ], - 'ValidateConnection' => [ - 'summary' => '验证连接。', - 'path' => '/api/v1/connections/validate', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '发布镜像', + 'summary' => '发布镜像，把镜像的可见性从PRIVATE变为PUBLIC。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishImage'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiimage:PublishImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\",\\n \\"ImageId\\": \\"image-dk******fa\\"\\n}","type":"json"}]', + ], + 'RemoveImage' => [ + 'summary' => '删除镜像。', + 'path' => '/api/v1/images/{ImageId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnIUXWCQ', - ], + 'abilityTreeCode' => '61615', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'Configs' => [ - 'description' => '连接的配置信息。以key-value的形式配置，不同的连接类型对应的Config配置的key不相同。具体参见CreateConnection接口的请求参数补充说明。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '连接的配置信息。以key-value的形式配置，不同的连接类型对应的Config配置的key不相同。具体参见请求参数补充说明。', - 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1', - ], - ], - 'ConnectionId' => [ - 'description' => '连接ID。如何获取连接 ID，详情请参见 [ListConnections](url)。', - 'type' => 'string', - 'required' => false, - 'example' => 'conn-x2wz5zvvbyf2420fi9', - ], - 'ConnectionType' => [ - 'description' => '连接的类型，当前支持填写可公网访问的连接类型：'."\n" - .'- DashScopeConnection：百炼服务连接。'."\n" - .'- DeepSeekConnection：DeepSeek服务连接。'."\n" - .'- FunctionAIMCPConnection：Function AI MCP连接。'."\n" - .'- CustomMCPConnection：自定义MCP连接。', - 'type' => 'string', - 'required' => false, - 'example' => 'DashScopeConnection', - ], - 'Secrets' => [ - 'description' => '需要加密的key-value配置。如数据库登录密码，模型连接的key等。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '需要加密的连接配置信息。比如数据库的账密信息，模型服务的key等。', - 'example' => 'ZGJiZWQ2ZDY3MTMyYjJk****************NjE2NDg1NzM0YzlkZg==', - ], - ], - 'ValidateType' => [ - 'description' => '验证类型。可设置为：'."\n" - .'- Connectivity：连通性测试', - 'type' => 'string', - 'required' => false, - 'example' => 'Connectivity', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID，可从接口[ListWorkspaces](~~449124~~)获取。', - 'type' => 'string', - 'required' => true, - 'example' => '1234', - ], - ], - 'required' => false, - ], + 'name' => 'ImageId', + 'in' => 'path', + 'schema' => ['title' => '镜像 id', 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', 'type' => 'string', 'required' => true, 'example' => 'image-rbv******c9ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回结构体。'."\n" + ."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '本次验证的结果状态。'."\n" - .'- success：成功'."\n" - .'- failed：失败', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'Message' => [ - 'description' => '验证结果描述。', - 'type' => 'string', - 'example' => 'The connection is reachable.', - ], - 'Code' => [ - 'description' => '请求失败时返回的错误代码。', - 'type' => 'string', - 'example' => '403', - ], - 'Details' => [ - 'description' => '验证结果详情。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '验证结果的详细信息，如LatencyMs，表示测试延迟（毫秒）。', - 'example' => '100', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"success\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Message\\": \\"The connection is reachable.\\",\\n \\"Code\\": \\"403\\",\\n \\"Details\\": {\\n \\"key\\": \\"100\\"\\n }\\n}","type":"json"}]', - 'title' => '验证连接', - ], - 'CreateCodeSource' => [ - 'summary' => '创建代码配置到PAI，支持配置Git的代码分支与CommitId。创建完成后，可以在DLC作业中引用。', - 'path' => '/api/v1/codesources', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除镜像', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveImage'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiimage:RemoveImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'RemoveImageLabels' => [ + 'path' => '/api/v1/images/{ImageId}/labels/{LabelKey}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55315', - 'abilityTreeNodes' => [ - 'FEATURElearnFOSXQT', - ], + 'abilityTreeCode' => '61614', + 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构。', - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '1234', - ], - 'DisplayName' => [ - 'title' => '代码源配置名称', - 'description' => '代码配置名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'MyCodeSource1', - ], - 'Description' => [ - 'title' => '代码源详细描述', - 'description' => '代码配置的描述信息，便于区分不同的代码配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'code source of dlc examples', - ], - 'CodeRepo' => [ - 'title' => '代码仓库地址', - 'description' => '代码仓库地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://code.aliyun.com/******', - ], - 'CodeRepoUserName' => [ - 'title' => '代码仓库的用户名', - 'description' => '代码仓库的用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'use***', - ], - 'CodeRepoAccessToken' => [ - 'title' => '代码仓库访问Token', - 'description' => '代码仓库访问Token。', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - 'CodeBranch' => [ - 'title' => '代码分支', - 'description' => '代码分支。', - 'type' => 'string', - 'required' => false, - 'example' => 'master', - ], - 'MountPath' => [ - 'title' => '代码本地挂载目录，默认挂载到/root/code/下', - 'description' => '代码本地挂载目录，默认挂载到/root/code/下。', - 'type' => 'string', - 'required' => false, - 'example' => '/root/code/code-source-1', - ], - 'Accessibility' => [ - 'title' => '代码是否是本工作空间内公开的，可选值PRIVATE、PUBLIC', - 'description' => '代码配置的可见性，取值如下。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], - 'example' => 'PRIVATE', - ], - 'CodeCommit' => [ - 'title' => '代码的CommitID。CodeCommit的优先级大于CodeBranch，即如果您填写了CodeCommit，则CodeBranch不会生效。', - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'ImageId', + 'in' => 'path', + 'schema' => ['title' => '镜像 Id', 'description' => '镜像ID。如何获取镜像ID，请参见[ListImages](~~449118~~) 。', 'type' => 'string', 'required' => true, 'example' => 'image-d8df******dsjfd'], + ], + [ + 'name' => 'LabelKey', + 'in' => 'path', + 'schema' => ['title' => 'label 的 key', 'description' => 'label 的 key', 'type' => 'string', 'required' => true, 'example' => 'key1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '返回结构体。'."\n" + ."\n", 'type' => 'object', 'properties' => [ - 'CodeSourceId' => [ - 'title' => '创建的代码源配置的ID', - 'description' => '创建的代码配置的ID。', - 'type' => 'string', - 'example' => 'code-20********', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3**********', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-20********\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3**********\\"\\n}","type":"json"}]', - 'title' => '创建代码配置', - ], - 'DeleteCodeSource' => [ - 'summary' => '指定ID，删除一个代码配置。', - 'path' => '/api/v1/codesources/{CodeSourceId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '移除镜像标签', + 'summary' => '移除镜像标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveImageLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiimage:RemoveImageLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'RemoveMemberRole' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/members/{MemberId}/roles/{RoleName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '55455', - 'abilityTreeNodes' => [ - 'FEATURElearnTXMM8C', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。可通过 [ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => true, 'example' => '145883'], + ], + [ + 'name' => 'MemberId', + 'in' => 'path', + 'schema' => ['title' => '成员 id', 'description' => '成员ID。如何获取成员ID，请参见[ListMembers](~~449135~~)。', 'type' => 'string', 'required' => true, 'example' => '145883-21513926******88039'], ], - ], - 'parameters' => [ [ - 'name' => 'CodeSourceId', + 'name' => 'RoleName', 'in' => 'path', - 'schema' => [ - 'title' => '待删除的代码源配置', - 'description' => '待删除的代码配置ID。如何获取代码配置ID，请参见[ListCodeSources](~~459922~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'code-20210111103721-85qz78ia96lu', - ], + 'schema' => ['title' => '角色', 'description' => '要删除的角色，支持官方角色与自定义角色：'."\n" + ."\n" + .'- 官方角色：取值如下所示，各角色权限请参见[附录：角色及权限列表](~~2840449~~) 。'."\n" + .' - PAI.AlgoDeveloper：算法开发。'."\n" + .' - PAI.AlgoOperator：算法运维。'."\n" + .' - PAI.LabelManager：标注管理员。'."\n" + .' - PAI.MaxComputeDeveloper：MaxCompute开发。'."\n" + .' - PAI.WorkspaceAdmin：管理员。'."\n" + .' - PAI.WorkspaceGuest：访客。'."\n" + .' - PAI.WorkspaceOwner：负责人。'."\n" + .'- 自定义角色：填写角色 ID。格式为 role-开头，例如 role-sw******2tij。', 'type' => 'string', 'required' => true, 'example' => 'PAI.AlgoDeveloper'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'CodeSourceId' => [ - 'title' => '被删除的代码源配置ID', - 'description' => '被删除的代码源配置ID。', - 'type' => 'string', - 'example' => 'code-20210111103721-85qz78ia96lu', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-20210111103721-85qz78ia96lu\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除代码配置', - ], - 'PublishCodeSource' => [ - 'summary' => '发布私有的代码配置到工作空间公开可见。', - 'path' => '/api/v1/codesources/{CodeSourceId}/publish', - 'methods' => [ - 'put', + 'title' => '删除成员角色 ', + 'summary' => '删除成员角色。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMemberRole'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:RemoveMemberRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'SetExperimentLabels' => [ + 'path' => '/api/v1/experiments/{ExperimentId}/labels', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '55459', - 'abilityTreeNodes' => [ - 'FEATURElearnFOSXQT', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '207071', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'CodeSourceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '待删除的代码源配置', - 'description' => '待发布的代码源配置ID。如何获取代码配置ID，请参见[ListCodeSources](~~459922~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'code-a797*******', + 'title' => 'body参数', + 'description' => 'body参数', + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => ['description' => '标签详细信息，包括Key、Value。', 'required' => false, '$ref' => '#/components/schemas/LabelInfo'], + 'required' => false, + ], + ], + 'required' => false, ], ], + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => '实验ID', 'type' => 'string', 'required' => true, 'example' => 'exp-1zpfthdx******'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回结构体。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'CodeSourceId' => [ - 'title' => '被删除的代码源配置ID', - 'description' => '发布成功的代码源配置ID。', - 'type' => 'string', - 'example' => 'code-a797*******', - ], - 'RequestId' => [ - 'description' => '请求的ID。用于定位日志，排查问题。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-a797*******\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '发布代码配置', - ], - 'UpdateCodeSource' => [ - 'summary' => '更新代码配置。', - 'path' => '/api/v1/codesources/{CodeSourceId}', - 'methods' => [ - 'put', + 'title' => 'SetExperimentLabels', + 'summary' => '更新实验标签', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'SetExperimentLabels'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiexperiment:SetExperimentLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'SetUserConfigs' => [ + 'path' => '/api/v1/userconfigs', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '246302', - 'abilityTreeNodes' => [ - 'FEATURElearnFOSXQT', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '194786', + 'abilityTreeNodes' => ['FEATURElearnDVAH75'], ], 'parameters' => [ - [ - 'name' => 'CodeSourceId', - 'in' => 'path', - 'schema' => [ - 'title' => '代码配置的ID', - 'description' => '代码配置的ID。可以通过 CreateCodeSource、GetCodeSource 或者 ListCodeSources 这些接口获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'code-202**********', - ], - ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求结构体。', + 'description' => '配置。', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'title' => '代码配置的名称', - 'description' => '代码配置的名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'MyCodeSource1', - ], - 'Description' => [ - 'title' => '代码配置的描述', - 'description' => '代码配置的描述。', - 'type' => 'string', - 'required' => false, - 'example' => '用于XX的训练代码', - ], - 'CodeRepo' => [ - 'title' => '代码仓库地址', - 'description' => '代码仓库地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://code.aliyun.com/******', - ], - 'CodeBranch' => [ - 'title' => '代码分支', - 'description' => '代码的分支名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'dev', - ], - 'CodeCommit' => [ - 'title' => '代码的CommitID', - 'description' => '代码的CommitID。', - 'type' => 'string', - 'required' => false, - 'example' => '3a6*****', - ], - 'CodeRepoUserName' => [ - 'title' => '用于访问代码仓库的用户名', - 'description' => '用于访问代码仓库的用户名。', - 'type' => 'string', - 'required' => false, - 'example' => 'demo-user', - ], - 'CodeRepoAccessToken' => [ - 'title' => '用户名对应的访问Token', - 'description' => '用户名对应的访问Token。', - 'type' => 'string', - 'required' => false, - 'example' => '***', - ], - 'MountPath' => [ - 'title' => '默认的挂载路径', - 'description' => '默认的挂载路径。', - 'type' => 'string', + 'Configs' => [ + 'title' => '配置列表', + 'description' => '配置列表', + 'type' => 'array', + 'items' => [ + 'description' => '配置', + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => ['title' => '配置键', 'description' => '配置键', 'type' => 'string', 'required' => true, 'example' => 'customizePAIAssumedRole'], + 'ConfigValue' => ['title' => '配置值', 'description' => '配置值', 'type' => 'string', 'required' => true, 'example' => 'role'], + 'CategoryName' => ['description' => '分类，目前只支持DataPrivacyConfig。', 'type' => 'string', 'required' => true, 'example' => 'DataPrivacyConfig'], + 'Scope' => ['description' => '范围，目前支持subUser、owner。', 'type' => 'string', 'required' => true, 'example' => 'owner'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '/root/code/code-source-1', ], ], 'required' => false, @@ -16574,490 +12709,497 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回的结构体。', + 'description' => '响应。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID，阿里云为该请求生成的标识符。', - 'type' => 'string', - 'example' => '40325405-579C-4D82****', - ], - 'CodeSourceId' => [ - 'title' => '代码配置的ID', - 'description' => '代码配置的ID。', - 'type' => 'string', - 'example' => 'code-20********', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'dsjk****dfjksdf'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"CodeSourceId\\": \\"code-20********\\"\\n}","type":"json"}]', - 'title' => '更新代码配置', - ], - 'GetCodeSource' => [ - 'summary' => '获取一个代码配置的详细信息。', - 'path' => '/api/v1/codesources/{CodeSourceId}', - 'methods' => [ - 'get', + 'title' => '更新用户配置', + 'summary' => '更新用户配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserConfigs'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:SetUserConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dsjk****dfjksdf\\"\\n}","type":"json"}]', + ], + 'StopDatasetJob' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}/action/stop', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260528', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'CodeSourceId', + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集版本ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], + ], + [ + 'name' => 'DatasetJobId', 'in' => 'path', + 'schema' => ['description' => '数据集任务ID', 'type' => 'string', 'required' => true, 'example' => 'dsjob-9jx1*****uj9e'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '代码源配置ID', - 'description' => '代码源配置ID。如何获取代码配置ID，请参见[ListCodeSources](~~459922~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'code-202**********', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'DatasetVersion' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], + ], + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'CodeSourceId' => [ - 'title' => '代码源配置ID', - 'description' => '代码源配置ID。', - 'type' => 'string', - 'example' => 'code-202**********', - ], - 'DisplayName' => [ - 'title' => '代码源配置名字', - 'description' => '代码源配置名字。', - 'type' => 'string', - 'example' => 'MyCodeSource1', - ], - 'Description' => [ - 'title' => '详细描述', - 'description' => '代码配置的详细描述。', - 'type' => 'string', - 'example' => 'This is my data source 1.', - ], - 'CodeRepo' => [ - 'title' => '代码仓库地址', - 'description' => '代码仓库地址。', - 'type' => 'string', - 'example' => 'https://code.aliyun.com/pai-dlc/examples.git', - ], - 'CodeBranch' => [ - 'title' => '代码仓库分支', - 'description' => '代码仓库分支。', - 'type' => 'string', - 'example' => 'master', - ], - 'CodeCommit' => [ - 'title' => '代码Commit', - 'description' => '代码CommitId。', - 'type' => 'string', - 'example' => '44da10***********', - ], - 'CodeRepoUserName' => [ - 'title' => '代码仓库的用户名', - 'description' => '代码仓库的用户名。', - 'type' => 'string', - 'example' => 'user1', - ], - 'CodeRepoAccessToken' => [ - 'title' => '访问代码仓库的token', - 'description' => '访问代码仓库的Token。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'MountPath' => [ - 'title' => '代码本地挂载目录，默认挂载到/root/code/下', - 'description' => '代码的本地挂载目录。', - 'type' => 'string', - 'example' => '/root/code', - ], - 'Accessibility' => [ - 'title' => '代码是否是本工作空间内公开的，可选值PRIVATE、PUBLIC', - 'description' => '代码配置的可见性，可能值：'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC： 在此工作空间中，对所有人可见。', - 'type' => 'string', - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', - ], - 'example' => 'PRIVATE', - ], - 'UserId' => [ - 'title' => '代码配置源的创建者ID', - 'description' => '代码配置源的创建者ID。', - 'type' => 'string', - 'example' => '1722********', - ], - 'WorkspaceId' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '1234', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '代码配置创建时间，时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-12T23:36:01.123Z', - ], - 'GmtModifyTime' => [ - 'title' => '修改时间', - 'description' => '代码配置修改时间。时间格式为ISO8601。', - 'type' => 'string', - 'example' => '2021-01-12T23:36:01.123Z', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F620FFD3-FFDC-5873-A70C-6971CC45F467'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-202**********\\",\\n \\"DisplayName\\": \\"MyCodeSource1\\",\\n \\"Description\\": \\"This is my data source 1.\\",\\n \\"CodeRepo\\": \\"https://code.aliyun.com/pai-dlc/examples.git\\",\\n \\"CodeBranch\\": \\"master\\",\\n \\"CodeCommit\\": \\"44da10***********\\",\\n \\"CodeRepoUserName\\": \\"user1\\",\\n \\"CodeRepoAccessToken\\": \\"xxxx\\",\\n \\"MountPath\\": \\"/root/code\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"UserId\\": \\"1722********\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T23:36:01.123Z\\",\\n \\"GmtModifyTime\\": \\"2021-01-12T23:36:01.123Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '获取代码配置', - ], - 'ListCodeSources' => [ - 'summary' => '查询代码配置列表，支持分页、排序和按条件过滤。', - 'path' => '/api/v1/codesources', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止数据集任务', + 'summary' => '停止数据集任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDatasetJob'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paidataset:StopDatasetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F620FFD3-FFDC-5873-A70C-6971CC45F467\\"\\n}","type":"json"}]', + ], + 'UpdateCodeSource' => [ + 'summary' => '更新代码配置。', + 'path' => '/api/v1/codesources/{CodeSourceId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '55462', - 'abilityTreeNodes' => [ - 'FEATURElearnFOSXQT', - ], + 'abilityTreeCode' => '246302', + 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DisplayName', - 'in' => 'query', - 'schema' => [ - 'title' => '代码源显示名称，支持模糊匹配', - 'description' => '代码配置的显示名称，支持模糊匹配。', - 'type' => 'string', - 'required' => false, - 'example' => 'MyDataSource', - ], + 'name' => 'CodeSourceId', + 'in' => 'path', + 'schema' => ['title' => '代码配置的ID', 'description' => '代码配置的ID。可以通过 CreateCodeSource、GetCodeSource 或者 ListCodeSources 这些接口获取。', 'type' => 'string', 'required' => true, 'example' => 'code-202**********'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '取第几页的数据', - 'description' => '代码配置列表的页码。起始值为1，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['title' => '代码配置的名称', 'description' => '代码配置的名称。', 'type' => 'string', 'required' => false, 'example' => 'MyCodeSource1'], + 'Description' => ['title' => '代码配置的描述', 'description' => '代码配置的描述。', 'type' => 'string', 'required' => false, 'example' => '用于XX的训练代码'], + 'CodeRepo' => ['title' => '代码仓库地址', 'description' => '代码仓库地址。', 'type' => 'string', 'required' => false, 'example' => 'https://code.aliyun.com/******'], + 'CodeBranch' => ['title' => '代码分支', 'description' => '代码的分支名称。', 'type' => 'string', 'required' => false, 'example' => 'dev'], + 'CodeCommit' => ['title' => '代码的CommitID', 'description' => '代码的CommitID。', 'type' => 'string', 'required' => false, 'example' => '3a6*****'], + 'CodeRepoUserName' => ['title' => '用于访问代码仓库的用户名', 'description' => '用于访问代码仓库的用户名。', 'type' => 'string', 'required' => false, 'example' => 'demo-user'], + 'CodeRepoAccessToken' => ['title' => '用户名对应的访问Token', 'description' => '用户名对应的访问Token。', 'type' => 'string', 'required' => false, 'example' => '***'], + 'MountPath' => ['title' => '默认的挂载路径', 'description' => '默认的挂载路径。', 'type' => 'string', 'required' => false, 'example' => '/root/code/code-source-1'], + 'CloneType' => ['description' => '克隆模式。取值如下：'."\n" + .'- 0（默认值）：新建子目录。'."\n" + .'- 1：平铺到当前目录。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], 'required' => false, - 'example' => '1', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '分页大小', - 'description' => '分页查询时设置的每页行数。默认为20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => 'Schema of Response', + 'description' => '返回的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID，阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => '40325405-579C-4D82****'], + 'CodeSourceId' => ['title' => '代码配置的ID', 'description' => '代码配置的ID。', 'type' => 'string', 'example' => 'code-20********'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"CodeSourceId\\": \\"code-20********\\"\\n}","type":"json"}]', + 'title' => '更新代码配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCodeSource'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '用于排序的字段名，可选字段名："DisplayName" "GmtCreateTime" "GmtModifyTime"', - 'description' => '用于排序的字段名，取值如下：'."\n" - .'- GmtModifyTime：代码源修改时间。'."\n" - .'- DisplayName：展示名称。'."\n" - .'- CodeSourceId：代码源ID。'."\n" - .'- GmtCreateTime（默认值）：代码源创建时间。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'GmtModifyTime', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paicodesource:UpdateCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateConfig' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/config', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序顺序, 枚举值 desc 或者 asc', - 'description' => '分页查询时，对指定的排序字段进行升序或降序。取值：'."\n" - .'- ASC（默认值）：升序。'."\n" - .'- DESC：降序', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'desc', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '234915', + 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], + ], + 'parameters' => [ [ 'name' => 'WorkspaceId', - 'in' => 'query', + 'in' => 'path', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '1234******2'."\n"], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => ['description' => '配置项的键。目前支持如下键：'."\n" + ."\n" + .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" + .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" + .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" + .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" + .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', 'type' => 'string', 'required' => false, 'example' => 'tempStoragePath'], + 'ConfigValue' => ['description' => '配置项的值。', 'type' => 'string', 'required' => false, 'example' => 'oss://***'."\n"], + 'CategoryName' => ['description' => '配置项的分类。目前支持如下分类'."\n" + ."\n" + .'- CommonResourceConfig 通用资源配置'."\n" + .'- DLCAutoRecycle DLC自动回收'."\n" + .'- DLCPriorityConfig DLC 优先级设置'."\n" + .'- DSWPriorityConfig DSW优先级设置'."\n" + .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" + .'- CommonTagConfig 标签设置', 'type' => 'string', 'required' => false, 'example' => 'CommonResourceConfig'], + 'Labels' => [ + 'description' => '配置项的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置项的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], 'required' => false, - 'example' => '1234', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回结构体。', + 'title' => 'Schema of Response', + 'description' => '响应。', 'type' => 'object', 'properties' => [ - 'CodeSources' => [ - 'title' => '代码源配置列表', - 'description' => '代码源配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '代码配置详情。', - '$ref' => '#/components/schemas/CodeSourceItem', - ], - ], - 'TotalCount' => [ - 'title' => '符合过滤条件的代码源配置的总数量', - 'description' => '符合过滤条件的代码源配置的总数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n"], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSources\\": [\\n {\\n \\"CodeSourceId\\": \\"code-20210111103721-85qz78ia96lu\\",\\n \\"DisplayName\\": \\"MyCodeSourceName1\\",\\n \\"Description\\": \\"code source of dlc examples\\",\\n \\"CodeRepo\\": \\"https://code.aliyun.com/pai-dlc/examples.git\\",\\n \\"CodeBranch\\": \\"master\\",\\n \\"CodeCommit\\": \\"44da109b59f8596152987eaa8f3b2487bb72ea63\\",\\n \\"CodeRepoUserName\\": \\"user\\",\\n \\"CodeRepoAccessToken\\": \\"\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"UserId\\": \\"1157290171663117\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"GmtCreateTime\\": \\"2021-01-18T12:52:15Z\\",\\n \\"GmtModifyTime\\": \\"2021-01-18T12:52:15Z\\",\\n \\"MountPath\\": \\"/root/code/\\"\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '获取代码配置列表', - ], - 'CreateModel' => [ - 'summary' => '创建模型。模型是模型版本的集合，创建模型时需要指定模型名称，描述等信息。', - 'path' => '/api/v1/models', - 'methods' => [ - 'post', + 'title' => '更新或新增工作空间配置', + 'summary' => '更新或新增工作空间配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfig'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', + ], + 'UpdateConfigs' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/configs', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133752', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '117760', + 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '83***'], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体。', + 'description' => '请求。', 'type' => 'object', 'properties' => [ - 'ModelName' => [ - 'title' => 'ModelName', - 'description' => '模型名称，长度为1~127个字符。', - 'type' => 'string', - 'required' => true, - 'example' => '新闻分类', - ], - 'Labels' => [ - 'title' => 'Labels', - 'description' => '标签列表。将废弃，由Tag字段取代。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - 'Tag' => [ - 'title' => 'Tag', - 'description' => '标签列表。', + 'Configs' => [ + 'title' => '配置列表', + 'description' => '要更新或者新增的工作空间配置列表。', 'type' => 'array', 'items' => [ - 'description' => '标签。与Label一致。', + 'description' => '要更新或者新增的工作空间配置。', + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => ['title' => '配置键', 'description' => '配置项的键。目前支持如下键：'."\n" + ."\n" + .'- tempStoragePath 临时存储路径，只有CategoryName为CommonResourceConfig时才允许使用该ConfigKey'."\n" + .'- isAutoRecycle 自动回收配置，只有CategoryName为DLCAutoRecycle时才允许使用该ConfigKey'."\n" + .'- priorityConfig 优先级配置，只有CategoryName为DLCPriorityConfig或者DSWPriorityConfig时才允许使用该ConfigKey'."\n" + .'- quotaMaximumDuration Quota的DLC任务最大运行时长配置，只有CategoryName为QuotaMaximumDuration时才允许使用该ConfigKey'."\n" + .'- predefinedTags 工作空间预置标签，创建的资源必须带上标签', 'type' => 'string', 'required' => false, 'example' => 'tempStoragePath'], + 'ConfigValue' => ['title' => '配置值', 'description' => '配置值'."\n" + ."\n" + .'- 对于ConfigKey为predefinedTags，ConfigValue格式为[{"Type":"Tag","Key":"Key1","Value":"{\\"Products\\":\\"DLC,DSW,EAS\\",\\"Values\\":\\"value1,value2,value3\\"}"}]，Products代表哪些产品使用预置标签。', 'type' => 'string', 'required' => false, 'example' => 'oss://test/s/'], + 'CategoryName' => ['description' => '配置项的分类。目前支持如下分类'."\n" + ."\n" + .'- CommonResourceConfig 通用资源配置'."\n" + .'- DLCAutoRecycle DLC自动回收'."\n" + .'- DLCPriorityConfig DLC 优先级设置'."\n" + .'- DSWPriorityConfig DSW优先级设置'."\n" + .'- QuotaMaximumDuration Quota的DLC任务最大运行时长配置'."\n" + .'- CommonTagConfig 标签设置', 'type' => 'string', 'required' => false, 'example' => 'CommonResourceConfig'], + 'Labels' => [ + 'description' => '配置项的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置项的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - 'ModelDescription' => [ - 'title' => 'ModelDescription', - 'description' => '模型描述，用于区分不同的模型。', - 'type' => 'string', - 'required' => false, - 'example' => '新闻分类。', - ], - 'WorkspaceId' => [ - 'title' => 'WorkspaceId', - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '796**', - ], - 'Accessibility' => [ - 'title' => 'Accessibility', - 'description' => '工作空间可见度，取值如下。'."\n" - .'- PRIVATE（默认值）：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PUBLIC' => 'PUBLIC', - 'PRIVATE' => 'PRIVATE', ], - 'example' => 'PRIVATE', - ], - 'Origin' => [ - 'title' => '模型源', - 'description' => '模型源。描述源模型所属社区或组织，如ModelScope，HuggingFace等。', - 'type' => 'string', - 'required' => false, - 'example' => 'ModelScope', - ], - 'Domain' => [ - 'title' => '领域', - 'description' => '领域。描述模型解决问题所属领域。例如：nlp（自然语言处理）、cv（计算机视觉）等。', - 'type' => 'string', - 'required' => false, - 'example' => 'nlp', - ], - 'Task' => [ - 'title' => '模型任务', - 'description' => '任务。描述模型解决的具体问题。例如：text-classification（文本分类）等。', - 'type' => 'string', 'required' => false, - 'example' => 'text-classification', ], - 'ModelDoc' => [ - 'title' => '模型介绍文档', - 'description' => '模型文档。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://*.md', - ], - 'OrderNumber' => [ - 'title' => '序号', - 'description' => '模型序号。可用于自定义排序。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'ModelType' => [ - 'title' => '模型类型', - 'description' => '模型类型。如Checkpoint，LoRA等。', - 'type' => 'string', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n"], + ], + ], + ], + ], + 'title' => '批量更新或新增工作空间配置', + 'summary' => '批量更新或新增工作空间配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigs'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', + ], + 'UpdateConnection' => [ + 'path' => '/api/v1/connections/{ConnectionId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267622', + 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], + ], + 'parameters' => [ + [ + 'name' => 'ConnectionId', + 'in' => 'path', + 'schema' => ['description' => '连接ID。如何获取连接 ID，详情请参见 [ListConnections](url)。', 'type' => 'string', 'required' => true, 'example' => 'conn-pai9m***mi47'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'Configs' => [ + 'description' => '连接的配置信息。以key-valued的形式配置，不同的连接类型对应的Config配置的key不相同。具体参见CreateConnection接口的请求参数补充说明。', + 'type' => 'object', 'required' => false, - 'example' => 'Checkpoint', + 'additionalProperties' => ['type' => 'string', 'example' => '6379', 'description' => '连接配置的value值。'], ], - 'ExtraInfo' => [ - 'title' => '其它信息', - 'description' => '模型的其它信息。', + 'Description' => ['description' => '连接的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Connection for data labeling.'], + 'Secrets' => [ + 'description' => '需要加密的Key-Value配置。如数据库登录密码，模型连接的Key等。', 'type' => 'object', 'required' => false, - 'example' => '{'."\n" - .' "RatingCount": 2866,'."\n" - .' "Rating": 4.94,'."\n" - .' "FavoriteCount": 34992,'."\n" - .' "CommentCount": 754,'."\n" - .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" - .' "TippedAmountCount": 32,'."\n" - .' "DownloadCount": 606056'."\n" - .'}', + 'additionalProperties' => ['type' => 'string', 'example' => 'Dakbjas**aljksdn', 'description' => '加密连接配置的value值。'], ], - 'ParameterSize' => [ - 'description' => '参数量，单位M。', - 'type' => 'integer', - 'format' => 'int64', + 'Models' => [ + 'description' => '模型信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模型信息。', + 'type' => 'object', + 'properties' => [ + 'Model' => ['description' => '模型标识符。', 'type' => 'string', 'required' => false, 'example' => 'model_001'], + 'DisplayName' => ['description' => '模型显示名称。', 'type' => 'string', 'required' => false, 'example' => 'car_tag'], + 'ModelType' => ['description' => '模型类型。可选值：'."\n" + .'- LLM'."\n" + .'- Embedding'."\n" + .'- ReRank', 'type' => 'string', 'required' => false, 'example' => 'LLM'], + 'ToolCall' => ['description' => '是否支持ToolCall工具调用。可取值：'."\n" + .'- true：支持'."\n" + .'- false：不支持', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '3000', ], ], 'required' => false, @@ -17068,70 +13210,61 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '响应信息。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9DAD3112-AE22-5563-9A02-5C7E8****E35', - ], - 'ModelId' => [ - 'description' => '模型ID。', - 'type' => 'string', - 'example' => 'model-rbvg5wzljz****ks92', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一ID。', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DAD3112-AE22-5563-9A02-5C7E8****E35\\",\\n \\"ModelId\\": \\"model-rbvg5wzljz****ks92\\"\\n}","type":"json"}]', - 'title' => '创建模型', - ], - 'UpdateModel' => [ - 'summary' => '更新模型的基本配置信息。', - 'path' => '/api/v1/models/{ModelId}', - 'methods' => [ - 'put', + 'title' => '更新连接', + 'summary' => '更新连接配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', + ], + 'UpdateDataset' => [ + 'path' => '/api/v1/datasets/{DatasetId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '133763', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], + 'abilityTreeCode' => '48566', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'ModelId', + 'name' => 'DatasetId', 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-rbvg5wz******ks92', - ], + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], ], [ 'name' => 'body', @@ -17141,93 +13274,50 @@ 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'ModelName' => [ - 'title' => '模型名称', - 'description' => '模型名称，长度为1~127个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '新闻分类', - ], - 'ModelDescription' => [ - 'title' => '模型描述', - 'description' => '模型描述。', - 'type' => 'string', - 'required' => false, - 'example' => '新闻分类。', - ], - 'Accessibility' => [ - 'title' => '可见度', - 'description' => '工作空间可见度，取值如下。'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - ], - 'Origin' => [ - 'title' => '模型源', - 'description' => '模型源。描述源模型所属社区或组织，如ModelScope，HuggingFace等。', - 'type' => 'string', - 'required' => false, - 'example' => 'ModelScope', - ], - 'Domain' => [ - 'title' => '领域', - 'description' => '领域。描述模型解决问题所属领域。例如：nlp（自然语言处理）、cv（计算机视觉）等。', - 'type' => 'string', - 'required' => false, - 'example' => 'nlp', - ], - 'Task' => [ - 'title' => '模型任务', - 'description' => '任务。描述模型解决的具体问题。例如：text-classification（文本分类）等。', - 'type' => 'string', - 'required' => false, - 'example' => 'text-classification', - ], - 'ModelDoc' => [ - 'title' => '模型介绍文档', - 'description' => '模型文档。', + 'Name' => ['description' => '数据集名称。如何获取数据集名称，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => false, 'example' => 'myName'], + 'Description' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the dataset.'], + 'Options' => ['description' => '扩展字段，JsonString类型。'."\n" + .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}'], + 'Edition' => [ + 'description' => '数据集类型。支持从BASIC（基础型）升级为ADVANCED（高级型）。', 'type' => 'string', 'required' => false, - 'example' => 'https://*.md', - ], - 'OrderNumber' => [ - 'title' => '序号', - 'description' => '模型序号。可用于自定义排序。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', + 'enumValueTitles' => [], + 'example' => 'ADVANCED', ], - 'ModelType' => [ - 'title' => '模型类型', - 'description' => '模型类型。如Checkpoint，LoRA等。', - 'type' => 'string', + 'MountAccessReadWriteRoleIdList' => [ + 'description' => '指定该数据集被挂载时具有读写权限的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。'."\n" + .'- 指定角色下的账号： ["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"]'."\n" + .'- 全部账号：["*"]'."\n" + .'- 指定为数据集创建者: []', + 'type' => 'array', + 'items' => ['description' => '工作空间角色ID。', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoOperator'."\n"], 'required' => false, - 'example' => 'Checkpoint', ], - 'ExtraInfo' => [ - 'title' => '其它信息', - 'description' => '模型的其它信息。', + 'SharingConfig' => [ + 'description' => '当前数据集的分享配置信息。', 'type' => 'object', + 'properties' => [ + 'SharedTo' => [ + 'description' => '该数据集被分享的分享配置关系。', + 'type' => 'array', + 'items' => ['description' => '分享配置关系。', 'required' => false, '$ref' => '#/components/schemas/DatasetShareRelationship'], + 'required' => false, + ], + ], 'required' => false, - 'example' => '{'."\n" - .' "RatingCount": 2866,'."\n" - .' "Rating": 4.94,'."\n" - .' "FavoriteCount": 34992,'."\n" - .' "CommentCount": 754,'."\n" - .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" - .' "TippedAmountCount": 32,'."\n" - .' "DownloadCount": 606056'."\n" - .'}', ], - 'ParameterSize' => [ - 'description' => '参数量，单位M。', - 'type' => 'integer', - 'format' => 'int64', + 'Accessibility' => ['description' => '工作空间可见度。支持以下取值：'."\n" + .'- PRIVATE（默认值）：表示工作空间内自己以及管理员可见。'."\n" + .'- PUBLIC：工作空间所有用户可见。'."\n" + .'- ROLE_PUBLIC：指定工作空间角色可见，角色列表参考：AccessibleRoleIdList。该条件下数据集所有者及管理员始终具备可见性。', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE'], + 'AccessibleRoleIdList' => [ + 'description' => '在Accessibility为ROLE_PUBLIC时生效。该数据集可见的工作空间角色名列表，PAI开头的为基础角色ID，role-开头的为自定义角色ID。', + 'type' => 'array', + 'items' => ['description' => '工作空间角色ID。', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoOperator'], 'required' => false, - 'example' => '3000', ], ], 'required' => false, @@ -17241,64 +13331,81 @@ 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', - 'title' => '更新模型', - ], - 'GetModel' => [ - 'summary' => '获取指定模型详情信息。', - 'path' => '/api/v1/models/{ModelId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新数据集', + 'summary' => '更新数据集，支持更新名称，描述等。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataset'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:UpdateDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'UpdateDatasetFileMetas' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '133753', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], + 'abilityTreeCode' => '260629', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'ModelId', + 'name' => 'DatasetId', 'in' => 'path', + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-lfd60v0p****ujtsdx'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Model Id', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-rbvg5****c9ks92', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'DatasetVersion' => ['description' => '数据集版本名。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'WorkspaceId' => ['description' => '数据集所在工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '796**'], + 'DatasetFileMetas' => [ + 'description' => '待更新的数据集文件元数据列表。', + 'type' => 'array', + 'items' => ['description' => '待更新的文件元数据详情。', 'required' => false, '$ref' => '#/components/schemas/DatasetFileMetaConentUpdate'], + 'required' => true, + ], + 'TagJobId' => ['description' => '更新数据集文件元数据标签相关联的打标任务ID。', 'type' => 'string', 'required' => false, 'example' => 'dsjob-hv0b1****u8taig3y'], + ], + 'required' => false, ], ], ], @@ -17306,499 +13413,520 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '请求结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'ModelId' => [ - 'title' => '模型ID', - 'description' => '模型ID。', - 'type' => 'string', - 'example' => 'model-rbvg5wzljz****ks92', - ], - 'ModelName' => [ - 'title' => '模型名称', - 'description' => '模型名称。', - 'type' => 'string', - 'example' => '情感分析', - ], - 'ModelDescription' => [ - 'title' => '模型描述', - 'description' => '模型描述。', - 'type' => 'string', - 'example' => '通用情感分析。', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建模型UTC时间，格式ISO8601。', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'GmtModifiedTime' => [ - 'title' => '最后更新时间', - 'description' => '最后更新模型UTC时间，格式ISO8601。', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'UserId' => [ - 'title' => '创建模型的用户ID', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1234567890******', - ], - 'OwnerId' => [ - 'title' => '云账号ID', - 'description' => '阿里云账号ID。', - 'type' => 'string', - 'example' => '1234567890******', - ], - 'Origin' => [ - 'title' => '模型源', - 'description' => '模型源。描述源模型所属社区或组织，例如：ModelScope，HuggingFace等。', - 'type' => 'string', - 'example' => 'ModelScope', - ], - 'Provider' => [ - 'title' => '提供者', - 'description' => '提供者。', - 'type' => 'string', - 'example' => 'pai', - ], - 'Domain' => [ - 'title' => '领域', - 'description' => '领域。描述模型解决问题所属领域。例如：nlp（自然语言处理）、cv（计算机视觉）等。', - 'type' => 'string', - 'example' => 'cv', - ], - 'Task' => [ - 'title' => '任务', - 'description' => '任务。描述模型解决的具体问题，例如：text-classification（文本分类）等。', - 'type' => 'string', - 'example' => 'text-classification', - ], - 'ModelDoc' => [ - 'title' => '模型文档', - 'description' => '模型文档。', - 'type' => 'string', - 'example' => 'https://***.md', - ], - 'Labels' => [ - 'title' => '模型的标签', - 'description' => '模型的标签列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'Status' => ['description' => '本批元数据更新结果的状态。全部成功为true，如果为false，需要查看FailedDetails。', 'type' => 'boolean', 'example' => 'true'], + 'FailedDetails' => [ + 'description' => '更新失败的文件元数据列表。', 'type' => 'array', - 'items' => [ - 'description' => '标签。', - '$ref' => '#/components/schemas/Label', - ], - ], - 'WorkspaceId' => [ - 'title' => '工作空间ID', - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '234**', - ], - 'Accessibility' => [ - 'title' => '可见性', - 'description' => '工作空间可见性，可能值为：'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'LatestVersion' => [ - 'title' => '模型的最新版本', - 'description' => '模型的最新版本。', - '$ref' => '#/components/schemas/ModelVersion', - ], - 'ModelType' => [ - 'title' => '模型类型', - 'description' => '模型类型。', - 'type' => 'string', - 'example' => 'Checkpoint', - ], - 'ExtraInfo' => [ - 'title' => '其它信息', - 'description' => '模型的其它信息。', - 'type' => 'object', - 'example' => '{'."\n" - .' "RatingCount": 2866,'."\n" - .' "Rating": 4.94,'."\n" - .' "FavoriteCount": 34992,'."\n" - .' "CommentCount": 754,'."\n" - .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" - .' "TippedAmountCount": 32,'."\n" - .' "DownloadCount": 606056'."\n" - .'}', - ], - 'OrderNumber' => [ - 'title' => '序号', - 'description' => '序号。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ParameterSize' => [ - 'description' => '参数量，单位M。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000', - ], - 'GmtLatestVersionModifiedTime' => [ - 'description' => '最后版本的更新时间。', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', + 'items' => ['description' => '更新失败的文件元数据详情。', '$ref' => '#/components/schemas/DatasetFileMetaResponse'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ModelId\\": \\"model-rbvg5wzljz****ks92\\",\\n \\"ModelName\\": \\"情感分析\\",\\n \\"ModelDescription\\": \\"通用情感分析。\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"1234567890******\\",\\n \\"OwnerId\\": \\"1234567890******\\",\\n \\"Origin\\": \\"ModelScope\\",\\n \\"Provider\\": \\"pai\\",\\n \\"Domain\\": \\"cv\\",\\n \\"Task\\": \\"text-classification\\",\\n \\"ModelDoc\\": \\"https://***.md\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"WorkspaceId\\": \\"234**\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"1.0.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://bucket/path-to-model\\",\\n \\"VersionDescription\\": \\"\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"ApprovalStatus\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TrainingSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"InferenceSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EvaluationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"CompressionSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DistillationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"ModelType\\": \\"Checkpoint\\",\\n \\"ExtraInfo\\": {\\n \\"RatingCount\\": 2866,\\n \\"Rating\\": 4.94,\\n \\"FavoriteCount\\": 34992,\\n \\"CommentCount\\": 754,\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png\\"\\n ],\\n \\"TippedAmountCount\\": 32,\\n \\"DownloadCount\\": 606056\\n },\\n \\"OrderNumber\\": 1,\\n \\"ParameterSize\\": 3000,\\n \\"GmtLatestVersionModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\"\\n}","type":"json"}]', - 'title' => '获取模型', - ], - 'ListModels' => [ - 'summary' => '获取模型列表。', - 'path' => '/api/v1/models', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '批量更新数据集文件元数据', + 'summary' => '批量更新数据集下的文件元数据记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetFileMetas'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:UpdateDatasetFileMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6\\",\\n \\"Result\\": \\"Not Found\\",\\n \\"Uri\\": \\"oss://l*****-test/dataset/1653421.jpg\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'UpdateDatasetJob' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260531', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集版本ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], + ], + [ + 'name' => 'DatasetJobId', + 'in' => 'path', + 'schema' => ['description' => '数据集任务ID', 'type' => 'string', 'required' => true, 'example' => 'dsjob-9jx1*****uj9e'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'DatasetVersion' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'WorkspaceId' => ['description' => '工作空间ID，可从接口[ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => false, 'example' => '478**'], + 'Description' => ['description' => '数据集任务描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a job description of a dataset.'], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新数据集任务', + 'summary' => '更新数据集任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetJob'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'UpdateDatasetJobConfig' => [ + 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '133768', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], + 'abilityTreeCode' => '260467', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => '模型列表的页码。起始值为1，默认为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集Id', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页大小', - 'description' => '分页查询时设置的每页显示的模型数量，默认为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'DatasetJobConfigId', + 'in' => 'path', + 'schema' => ['description' => '配置id', 'type' => 'string', 'required' => true, 'example' => 'dscfg-xxxxxxxxxxxx'], ], [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '顺序', - 'description' => '分页查询时，对指定的排序字段进行升序或降序。默认ASC。'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => '167497'], + 'ConfigType' => [ + 'description' => '配置类型'."\n" + ."\n" + .'- MultimodalIntelligentTag'."\n" + ."\n" + .'- MultimodalSemanticIndex', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['MultimodalIntelligentTag' => 'MultimodalIntelligentTag', 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex'], + 'example' => 'MultimodalSemanticIndex', + ], + 'Config' => ['description' => '配置内容'."\n" + .'其中配置格式如下：'."\n" + ."\n" + .'- MultimodalIntelligentTag'."\n" + ."\n" + .'{'."\n" + .' "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" + .'}'."\n" + ."\n" + .'- MultimodalSemanticIndex'."\n" + ."\n" + .'{'."\n" + .' "defaultModelId": "xxx"'."\n" + .' "defaultModelVersion":"1.0.0"'."\n" + .'}', 'type' => 'string', 'required' => false, 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'], + ], 'required' => false, - 'example' => 'DESC', ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '排序依据', - 'description' => '分页查询时的排序字段。目前使用GmtCreateTime字段用于排序。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9'], + ], ], ], + ], + 'title' => '更新数据集任务配置', + 'summary' => '更新数据集任务配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetJobConfig'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '工作空间ID', - 'description' => '配置工作空间ID，返回列表中只获取该工作空间内的模型列表。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '324**', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:UpdateDatasetJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\"\\n}","type":"json"}]', + ], + 'UpdateDatasetVersion' => [ + 'summary' => '更新指定版本的数据集信息。', + 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ModelName', - 'in' => 'query', - 'schema' => [ - 'title' => '模型名称', - 'description' => '配置模型名称，用来过滤获取的模型列表。', - 'type' => 'string', - 'required' => false, - 'example' => '情感分析', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232571', + 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], + ], + 'parameters' => [ [ - 'name' => 'Label', - 'in' => 'query', - 'schema' => [ - 'title' => '标签', - 'description' => '标签串。用于列表过滤，标签中key或value中，有指定字符串的，都会被过滤出来。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], + 'name' => 'DatasetId', + 'in' => 'path', + 'schema' => ['description' => '数据集ID。如何获取数据集ID，详情请参见[ListDatasets](~~457222~~)。', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5****jhc9ks92'], ], [ - 'name' => 'Provider', - 'in' => 'query', - 'schema' => [ - 'title' => '模型提供者', - 'description' => '提供者。指定提供者，则只返回该提供者公开的模型。不填则返回用户自己的模型。', - 'type' => 'string', - 'required' => false, - 'example' => 'pai', - ], + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['description' => '数据集版本名称。', 'type' => 'string', 'required' => true, 'example' => 'v1'], ], [ - 'name' => 'Domain', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '领域', - 'description' => '配置领域来过滤该领域内的模型列表。例如：nlp（自然语言处理）、cv（计算机视觉）等。', - 'type' => 'string', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'Options' => ['description' => '扩展字段，JsonString类型。'."\n" + .'当DLC使用数据集时，可通过配置mountPath字段指定数据集默认挂载路径。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}'], + 'Description' => ['description' => '对数据集进行自定义描述，以区分不同的数据集。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of a dataset version.'], + 'DataSize' => ['description' => '数据集文件占据空间的大小。单位Byte 。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000'], + 'DataCount' => ['description' => '数据集文件数量，单位个。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + ], 'required' => false, - 'example' => 'nlp', ], ], - [ - 'name' => 'Task', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '模型任务', - 'description' => '配置任务来过滤属于该任务类型的模型列表。例如：text-classification（文本分类）等。', - 'type' => 'string', - 'required' => false, - 'example' => 'text-classification', + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新数据集版本', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetVersion'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'Origin', - 'in' => 'query', - 'schema' => [ - 'title' => '模型源', - 'description' => '配置模型源，来过滤属于该社区或组织的模型列表。例如ModelScope，HuggingFace等。', - 'type' => 'string', - 'required' => false, - 'example' => 'ModelScope', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:UpdateDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', + ], + 'UpdateDefaultWorkspace' => [ + 'path' => '/api/v1/defaultWorkspaces', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Query', - 'in' => 'query', - 'schema' => [ - 'title' => '筛选请求串', - 'description' => '配置查询条件。ModelName、Domain、Task、LabelKey、LabelValue相似匹配。'."\n" - .'例如输入为nlp，则ModelName、Domain、Task、LabelKey、LabelValue中匹配的模型都会返回。', - 'type' => 'string', - 'required' => false, - 'example' => 'nlp', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'ModelType', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '模型类型', - 'description' => '模型类型', - 'type' => 'string', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['title' => '显示名称', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '12345'], + ], 'required' => false, - 'example' => 'Endpoint', ], ], - [ - 'name' => 'Collections', - 'in' => 'query', - 'allowEmptyValue' => false, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '模型所在Collection，支持填写多个，用英文逗号分割', - 'description' => '模型所在Collection，支持填写多个，用英文逗号分割', - 'type' => 'string', - 'required' => false, - 'example' => 'AI4D,QuickStart', + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '17915******4216'], + ], ], ], + ], + 'title' => '指定默认工作空间', + 'summary' => '将某个工作空间指定为默认工作空间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDefaultWorkspace'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签信息。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签的key。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => '标签的value。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateDefaultWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, - 'example' => 'Endpoint', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17915******4216\\"\\n}","type":"json"}]', + ], + 'UpdateExperiment' => [ + 'path' => '/api/v1/experiments/{ExperimentId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '206975', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, + ], + 'parameters' => [ [ - 'name' => 'Conditions', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '条件。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Column' => [ - 'description' => '参数名。如：ParameterSize。', - 'type' => 'string', - 'required' => false, - 'example' => 'ParameterSize', - ], - 'Operator' => [ - 'description' => '操作符。如：LessThan。', - 'type' => 'string', - 'required' => false, - 'example' => 'LessThan', - ], - 'Value' => [ - 'description' => '值，如3000。', - 'type' => 'string', - 'required' => false, - 'example' => '3000', - ], + 'title' => 'body参数', + 'description' => 'body参数', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '名称', 'description' => '实验（Experiment）的名称。命名规则如下：'."\n" + ."\n" + .'- 以小写字母、大写字母开头。'."\n" + .'- 可以包含大小写字母、数字、下划线（_）或短划线（-）。'."\n" + .'- 长度为1~63个字符。', 'type' => 'string', 'required' => false, 'example' => 'myName'], + 'Accessibility' => [ + 'description' => '工作空间可见度，取值如下。'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', + 'type' => 'string', + 'required' => false, + 'example' => 'PRIVATE', + 'enum' => ['PRIVATE', 'PUBLIC'], ], - 'required' => false, ], 'required' => false, ], ], + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => ['description' => '实验ID', 'type' => 'string', 'required' => true, 'example' => 'exp-1zpfthdx******'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'Models' => [ - 'title' => '模型列表', - 'description' => '模型列表。', - 'type' => 'array', - 'items' => [ - 'description' => '模型。', - '$ref' => '#/components/schemas/Model', - ], - ], - 'TotalCount' => [ - 'title' => '总数', - 'description' => '模型总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Models\\": [\\n {\\n \\"ModelId\\": \\"model-1123*****\\",\\n \\"ModelName\\": \\"\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"WorkspaceId\\": \\"234**\\",\\n \\"UserId\\": \\"1557702098******\\",\\n \\"OwnerId\\": \\"1557702098******\\",\\n \\"ModelDescription\\": \\"\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"1.0.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://bucket/path-to-model\\",\\n \\"VersionDescription\\": \\"\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"ApprovalStatus\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TrainingSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"InferenceSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EvaluationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"CompressionSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DistillationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"OrderNumber\\": 101,\\n \\"Origin\\": \\"ModelScope\\",\\n \\"Domain\\": \\"cv\\",\\n \\"Task\\": \\"text-classifiaction\\",\\n \\"ModelDoc\\": \\"https://***.md\\",\\n \\"Provider\\": \\"pai\\",\\n \\"ModelType\\": \\"Checkpoint\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ParameterSize\\": 1024,\\n \\"GmtLatestVersionModifiedTime\\": \\"2021-01-21T17:12:35Z\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', - 'title' => '获取模型列表', - ], - 'DeleteModel' => [ - 'summary' => '删除模型。', - 'path' => '/api/v1/models/{ModelId}', - 'methods' => [ - 'delete', + 'title' => '更新实验信息', + 'summary' => '更新实验', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'UpdateExperiment'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiexperiment:UpdateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'UpdateModel' => [ + 'path' => '/api/v1/models/{ModelId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '133765', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], + 'abilityTreeCode' => '133763', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wz******ks92'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-rbvg5wzl****ks92', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'ModelName' => ['title' => '模型名称', 'description' => '模型名称，长度为1~127个字符。', 'type' => 'string', 'required' => false, 'example' => 'News classification'], + 'ModelDescription' => ['title' => '模型描述', 'description' => '模型描述。', 'type' => 'string', 'required' => false, 'example' => 'News classification.'], + 'Accessibility' => ['title' => '可见度', 'description' => '工作空间可见度，取值如下。'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], + 'Origin' => ['title' => '模型源', 'description' => '模型源。描述源模型所属社区或组织，如ModelScope，HuggingFace等。', 'type' => 'string', 'required' => false, 'example' => 'ModelScope'], + 'Domain' => ['title' => '领域', 'description' => '领域。描述模型解决问题所属领域。例如：nlp（自然语言处理）、cv（计算机视觉）等。', 'type' => 'string', 'required' => false, 'example' => 'nlp'], + 'Task' => ['title' => '模型任务', 'description' => '任务。描述模型解决的具体问题。例如：text-classification（文本分类）等。', 'type' => 'string', 'required' => false, 'example' => 'text-classification'], + 'ModelDoc' => ['title' => '模型介绍文档', 'description' => '模型文档。', 'type' => 'string', 'required' => false, 'example' => 'https://*.md'], + 'OrderNumber' => ['title' => '序号', 'description' => '模型序号。可用于自定义排序。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + 'ModelType' => ['title' => '模型类型', 'description' => '模型类型。如Checkpoint，LoRA等。', 'type' => 'string', 'required' => false, 'example' => 'Checkpoint'], + 'ExtraInfo' => ['title' => '其它信息', 'description' => '模型的其它信息。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "RatingCount": 2866,'."\n" + .' "Rating": 4.94,'."\n" + .' "FavoriteCount": 34992,'."\n" + .' "CommentCount": 754,'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" + .' "TippedAmountCount": 32,'."\n" + .' "DownloadCount": 606056'."\n" + .'}'], + 'ParameterSize' => ['description' => '参数量，单位M。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3000'], + ], + 'required' => false, ], ], ], @@ -17809,53 +13937,55 @@ 'description' => '返回体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除模型', - ], - 'CreateModelVersion' => [ - 'summary' => '为指定模型新增版本。', - 'path' => '/api/v1/models/{ModelId}/versions', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新模型', + 'summary' => '更新模型的基本配置信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModel'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paimodel:UpdateModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', + ], + 'UpdateModelVersion' => [ + 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '133771', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], + 'abilityTreeCode' => '133781', + 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ @@ -17866,143 +13996,33 @@ 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'VersionName' => [ - 'title' => '模型版本，模型下唯一。', - 'description' => '模型版本，模型下唯一。如果不填写该参数，则默认**0.1.0**为第一个版本。之后子版本号依次加1，例如：第二个版本号默认为**0.2.0**。'."\n" - .'版本号由主版本号、子版本号和阶段版本号组成，通过半角句号（.）分隔。其中：主版本号、子版本号为数字，阶段版本号以数字开头，下划线和字母组成。例如：版本号为1.1.0或2.3.4_beta。', - 'type' => 'string', - 'required' => false, - 'example' => '0.1.0', - ], - 'Uri' => [ - 'title' => '版本Uri', - 'description' => '模型版本URI，即模型存储位置。模型地址类型如下：'."\n" - .'- 模型的HTTP（S）地址，例如：`https://myweb.com/mymodel.tar.gz`。'."\n" - .'- 如果模型存储在OSS中，格式为`oss://./object`。其中endpoint配置，请参见[访问域名和数据中心](~~31837~~)，例如：`oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`。', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/', - ], - 'Labels' => [ - 'title' => '标签', - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - 'VersionDescription' => [ - 'title' => '版本描述', - 'description' => '模型版本描述。', - 'type' => 'string', - 'required' => false, - 'example' => '情感分析。', - ], - 'FormatType' => [ - 'title' => '模型类型', - 'description' => '模型格式，取值如下：'."\n" - .'- OfflineModel'."\n" - .'- SavedModel'."\n" - .'- Keras H5'."\n" - .'- Frozen Pb'."\n" - .'- Caffe Prototxt'."\n" - .'- TorchScript'."\n" - .'- XGBoost'."\n" - .'- PMML'."\n" - .'- AlinkModel'."\n" - .'- ONNX', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OfflineModel' => 'OfflineModel', - 'SavedModel' => 'SavedModel', - 'Keras H5' => 'Keras H5', - 'Frozen Pb' => 'Frozen Pb', - 'Caffe Prototxt' => 'Caffe Prototxt', - 'TorchScript' => 'TorchScript', - 'XGBoost' => 'XGBoost', - 'PMML' => 'PMML', - 'AlinkModel' => 'AlinkModel', - 'ONNX' => 'ONNX', - ], - 'example' => 'SavedModel', - ], - 'FrameworkType' => [ - 'title' => '模型框架', - 'description' => '模型框架，取值如下：'."\n" - .'- Pytorch'."\n" - .'- XGBoost'."\n" - .'- Keras'."\n" - .'- Caffe'."\n" - .'- Alink'."\n" - .'- Xflow'."\n" - .'- TensorFlow', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Pytorch' => 'Pytorch', - 'XGBoost' => 'XGBoost', - 'Keras' => 'Keras', - 'Caffe' => 'Caffe', - 'Alink' => 'Alink', - 'Xflow' => 'Xflow', - 'TensorFlow' => 'TensorFlow', - ], - 'example' => 'TensorFlow', - ], - 'Options' => [ - 'title' => '扩展字段', - 'description' => '扩展字段。JsonString类型。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'Metrics' => [ - 'title' => '指标', - 'description' => '模型指标。'."\n" - .'序列化后长度限制为8192。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "Results": [{'."\n" - .' "Dataset": {'."\n" - .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" - .' },'."\n" - .' "Metrics": {'."\n" - .' "cer": 0.175'."\n" - .' }'."\n" - .' }, {'."\n" - .' "Dataset": {'."\n" - .' "Uri": "oss://xxxx/"'."\n" - .' },'."\n" - .' "Metrics": {'."\n" - .' "cer": 0.172'."\n" - .' }'."\n" - .' }]'."\n" - .'}', - ], - 'TrainingSpec' => [ - 'title' => '训练配置', - 'description' => '训练配置。用于微调、增量训练的配置。', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - 'InferenceSpec' => [ - 'title' => '描述如何应用于下游的推理应用', - 'description' => '描述如何应用于下游的推理服务：例如描述EAS的processor、container等。例如：'."\n" - .'`{'."\n" - .' "processor": "tensorflow_gpu_1.12"'."\n" - .'}`', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "processor": "tensorflow_gpu_1.12"'."\n" - .'}', - ], + 'VersionDescription' => ['title' => '模型版本描述', 'description' => '模型版本描述。', 'type' => 'string', 'required' => false, 'example' => 'General sentiment analysis.'], + 'Metrics' => ['title' => '指标', 'description' => '模型指标。'."\n" + .'序列化后长度限制为8192。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "Results": [{'."\n" + .' "Dataset": {'."\n" + .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" + .' },'."\n" + .' "Metrics": {'."\n" + .' "cer": 0.175'."\n" + .' }'."\n" + .' }, {'."\n" + .' "Dataset": {'."\n" + .' "Uri": "oss://xxxx/"'."\n" + .' },'."\n" + .' "Metrics": {'."\n" + .' "cer": 0.172'."\n" + .' }'."\n" + .' }]'."\n" + .'}'], + 'TrainingSpec' => ['title' => '描述训练配置', 'description' => '训练配置。用于微调，增量训练的配置。', 'type' => 'object', 'required' => false, 'example' => '{}'], + 'InferenceSpec' => ['title' => '描述下游的推理应用', 'description' => '描述如何应用于下游的推理应用：例如描述EAS的processor、container等。例如：'."\n" + .'`{'."\n" + .' "processor": "tensorflow_gpu_1.12"'."\n" + .'}`。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "processor": "tensorflow_gpu_1.12"'."\n" + .'}'], + 'Options' => ['title' => '扩展字段。', 'description' => '扩展字段，JsonString类型。', 'type' => 'string', 'required' => false, 'example' => '{}'], 'SourceType' => [ 'title' => '来源类型', 'description' => '模型来源类型，取值如下：'."\n" @@ -18011,70 +14031,31 @@ .'- TrainingService：PAI训练服务。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'PAIFlow' => 'PAIFlow', - 'Custom' => 'Custom', - 'TrainingService' => 'TrainingService', - ], + 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], 'example' => 'PAIFlow', ], - 'SourceId' => [ - 'title' => '来源ID', - 'description' => '来源ID。'."\n" - .'* 来源类型为Custom时，该字段不做限制。'."\n" - .'* 来源为PAIFlow、TrainingService时，格式为 '."\n" - .'```'."\n" - .'region=,workspaceId=,kind=,id='."\n" - .'```'."\n" - .'其中：'."\n" - .'- region为阿里云区域ID。'."\n" - .'- workspaceId为工作空间ID。'."\n" - .'- kind：为类型。取值：PipelineRun（PAIFlow工作流）；ServiceJob（训练服务）。'."\n" - .'- id：为唯一标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf', - ], - 'ApprovalStatus' => [ - 'title' => '准入状态', - 'description' => '准入状态，取值如下：'."\n" - .'- Pending：待定。'."\n" - .'- Approved：允许上线。'."\n" - .'- Rejected：不允许上线。', - 'type' => 'string', - 'required' => false, - 'example' => 'Approved', - ], - 'EvaluationSpec' => [ - 'title' => '评测配置', - 'description' => '评测配置。', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - 'CompressionSpec' => [ - 'title' => '压缩配置', - 'description' => '压缩配置。', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - 'ExtraInfo' => [ - 'title' => '其它信息', - 'description' => '其它信息。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" - .' "TrainedWords": ["albedo_overlord"]'."\n" - .'}', - ], - 'DistillationSpec' => [ - 'description' => '蒸馏配置。', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], + 'SourceId' => ['title' => '来源ID', 'description' => '来源ID。'."\n" + .'* 来源类型为Custom时，该字段不做限制。'."\n" + .'* 来源为PAIFlow、TrainingService时，格式为 '."\n" + .'```'."\n" + .'region=,workspaceId=,kind=,id='."\n" + .'```'."\n" + .'其中：'."\n" + .'- region为阿里云区域ID。'."\n" + .'- workspaceId为工作空间ID。'."\n" + .'- kind：为类型。取值：PipelineRun（PAIFlow工作流）；ServiceJob（训练服务）。'."\n" + .'- id：为唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], + 'ApprovalStatus' => ['title' => '准入状态', 'description' => '准入状态，取值如下：'."\n" + .'- Pending：待定。'."\n" + .'- Approved：允许上线。'."\n" + .'- Rejected：不允许上线。', 'type' => 'string', 'required' => false, 'example' => 'Approved'], + 'EvaluationSpec' => ['title' => '评测配置', 'description' => '评测配置。', 'type' => 'object', 'required' => false, 'example' => '{}'], + 'CompressionSpec' => ['title' => '压缩配置', 'description' => '压缩配置。', 'type' => 'object', 'required' => false, 'example' => '{}'], + 'ExtraInfo' => ['title' => '其它信息', 'description' => '其它信息。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" + .' "TrainedWords": ["albedo_overlord"]'."\n" + .'}'], + 'DistillationSpec' => ['description' => '蒸馏配置。', 'type' => 'object', 'required' => false, 'example' => '{}'], ], 'required' => false, ], @@ -18082,12 +14063,99 @@ [ 'name' => 'ModelId', 'in' => 'path', + 'schema' => ['title' => '模型ID', 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', 'type' => 'string', 'required' => true, 'example' => 'model-dfs1****5c'], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => ['title' => '模型版本', 'description' => '模型版本。', 'type' => 'string', 'required' => true, 'example' => '0.1.0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-dfs1****5c', + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D5BFFEE3-6025-443F-8A03-02D61***C4B9'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新模型版本', + 'summary' => '更新模型版本。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModelVersion'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paimodel:UpdateModelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D61***C4B9\\"\\n}","type":"json"}]', + ], + 'UpdateRun' => [ + 'path' => '/api/v1/runs/{RunId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '233506', + 'abilityTreeNodes' => ['FEATURElearnP1X97H'], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'RunId', + 'in' => 'path', + 'schema' => ['description' => '运行ID', 'type' => 'string', 'required' => true, 'example' => 'run-1qJhzJ2YXgX****'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '运行（Run）的名称。命名规则如下：'."\n" + .'- 以小写字母、大写字母开头。'."\n" + .'- 可以包含大小写字母、数字、下划线（_）或短划线（-）。'."\n" + .'- 长度为1~63个字符。', 'type' => 'string', 'required' => false, 'example' => 'myName'], + 'Labels' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => ['description' => '标签详细信息', 'required' => false, '$ref' => '#/components/schemas/Label'], + 'required' => false, + ], + 'Params' => [ + 'description' => '参数列表', + 'type' => 'array', + 'items' => ['description' => '参数详细信息', 'required' => false, '$ref' => '#/components/schemas/RunParam'], + 'required' => false, + ], + ], + 'required' => false, ], ], ], @@ -18095,750 +14163,356 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '21645FCD-BAB9-5742-89AE-AEB27****B2E', - ], - 'VersionName' => [ - 'title' => '模型名称', - 'description' => '模型版本。', - 'type' => 'string', - 'example' => '0.1.0', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21645FCD-BAB9-5742-89AE-AEB27****B2E\\",\\n \\"VersionName\\": \\"0.1.0\\"\\n}","type":"json"}]', - 'title' => '创建模型版本', - ], - 'UpdateModelVersion' => [ - 'summary' => '更新模型版本。', - 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', - 'methods' => [ - 'put', + 'title' => '更新运行信息', + 'summary' => '更新运行信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'UpdateRun'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiexperiment:UpdateRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + ], + 'UpdateWorkspace' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133781', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], + 'abilityTreeCode' => '14202', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '项目空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体。', + 'description' => '请求结构。', 'type' => 'object', 'properties' => [ - 'VersionDescription' => [ - 'title' => '模型版本描述', - 'description' => '模型版本描述。', - 'type' => 'string', - 'required' => false, - 'example' => '通用情感分析。', - ], - 'Metrics' => [ - 'title' => '指标', - 'description' => '模型指标。'."\n" - .'序列化后长度限制为8192。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "Results": [{'."\n" - .' "Dataset": {'."\n" - .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" - .' },'."\n" - .' "Metrics": {'."\n" - .' "cer": 0.175'."\n" - .' }'."\n" - .' }, {'."\n" - .' "Dataset": {'."\n" - .' "Uri": "oss://xxxx/"'."\n" - .' },'."\n" - .' "Metrics": {'."\n" - .' "cer": 0.172'."\n" - .' }'."\n" - .' }]'."\n" - .'}', - ], - 'TrainingSpec' => [ - 'title' => '描述训练配置', - 'description' => '训练配置。用于微调，增量训练的配置。', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - 'InferenceSpec' => [ - 'title' => '描述下游的推理应用', - 'description' => '描述如何应用于下游的推理应用：例如描述EAS的processor、container等。例如：'."\n" - .'`{'."\n" - .' "processor": "tensorflow_gpu_1.12"'."\n" - .'}`。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "processor": "tensorflow_gpu_1.12"'."\n" - .'}', - ], - 'Options' => [ - 'title' => '扩展字段。', - 'description' => '扩展字段，JsonString类型。', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - 'SourceType' => [ - 'title' => '来源类型', - 'description' => '模型来源类型，取值如下：'."\n" - .'- Custom（默认值）：自定义。'."\n" - .'- PAIFlow：PAI工作流。'."\n" - .'- TrainingService：PAI训练服务。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PAIFlow' => 'PAIFlow', - 'Custom' => 'Custom', - 'TrainingService' => 'TrainingService', - ], - 'example' => 'PAIFlow', - ], - 'SourceId' => [ - 'title' => '来源ID', - 'description' => '来源ID。'."\n" - .'* 来源类型为Custom时，该字段不做限制。'."\n" - .'* 来源为PAIFlow、TrainingService时，格式为 '."\n" - .'```'."\n" - .'region=,workspaceId=,kind=,id='."\n" - .'```'."\n" - .'其中：'."\n" - .'- region为阿里云区域ID。'."\n" - .'- workspaceId为工作空间ID。'."\n" - .'- kind：为类型。取值：PipelineRun（PAIFlow工作流）；ServiceJob（训练服务）。'."\n" - .'- id：为唯一标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf', - ], - 'ApprovalStatus' => [ - 'title' => '准入状态', - 'description' => '准入状态，取值如下：'."\n" - .'- Pending：待定。'."\n" - .'- Approved：允许上线。'."\n" - .'- Rejected：不允许上线。', - 'type' => 'string', - 'required' => false, - 'example' => 'Approved', - ], - 'EvaluationSpec' => [ - 'title' => '评测配置', - 'description' => '评测配置。', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - 'CompressionSpec' => [ - 'title' => '压缩配置', - 'description' => '压缩配置。', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - 'ExtraInfo' => [ - 'title' => '其它信息', - 'description' => '其它信息。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" - .' "TrainedWords": ["albedo_overlord"]'."\n" - .'}', - ], - 'DistillationSpec' => [ - 'description' => '蒸馏配置。', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], + 'DisplayName' => ['title' => '显示名称', 'description' => '工作空间显示名称，格式如下。'."\n" + .'- 长度为3~23 个字符，可以包含字母、下划线或数字。'."\n" + .'- 必须以大小字母开头。'."\n" + .'- 当前地域内唯一。', 'type' => 'string', 'required' => false, 'example' => 'workspace-example'], + 'Description' => ['title' => '描述', 'description' => '工作空间描述信息。', 'type' => 'string', 'required' => false, 'example' => 'This is an example workspace.'], ], 'required' => false, ], ], - [ - 'name' => 'ModelId', - 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-dfs1****5c', - ], - ], - [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'title' => '模型版本', - 'description' => '模型版本。', - 'type' => 'string', - 'required' => true, - 'example' => '0.1.0', - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D5BFFEE3-6025-443F-8A03-02D61***C4B9', - ], + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D61***C4B9\\"\\n}","type":"json"}]', - 'title' => '更新模型版本', - ], - 'GetModelVersion' => [ - 'summary' => '获取模型版本。', - 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', - 'methods' => [ - 'get', + 'title' => '更新工作空间', + 'summary' => '更新工作空间名称和描述信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspace'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + ], + 'UpdateWorkspaceResource' => [ + 'summary' => '更新工作空间的资源。', + 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133779', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ModelId', + 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-rbvg5wzljz****ks92', - ], + 'schema' => ['title' => '工作空间 id', 'description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'title' => '模型版本', - 'description' => '模型版本。', - 'type' => 'string', - 'required' => true, - 'example' => '1.0.1', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => '请求参数。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建模型UTC时间，格式ISO8601。', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'GmtModifiedTime' => [ - 'title' => '最后更新时间', - 'description' => '最后更新模型UTC时间，格式ISO8601。', - 'type' => 'string', - 'example' => '2021-01-30T12:51:33.028Z', - ], - 'UserId' => [ - 'title' => '创建者ID', - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1234567890******', - ], - 'OwnerId' => [ - 'title' => '云账号ID', - 'description' => '阿里云账号ID。', - 'type' => 'string', - 'example' => '1234567890******', - ], - 'Uri' => [ - 'title' => '模型Uri', - 'description' => '模型版本URI，即模型存储位置。可能值为：'."\n" - .'- 模型的HTTP（S）地址，例如：`https://myweb.com/mymodel.tar.gz`。'."\n" - .'- 如果模型存储在OSS中，格式为`oss://./object`。其中endpoint配置，请参见[访问域名和数据中心](~~31837~~)，例如：`oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`。', - 'type' => 'string', - 'example' => 'oss://t***.cn-beijing.oss.aliyuncs.com/mod**/', - ], + 'IsDefault' => ['title' => '是否默认资源实例，目前只能填 true，不支持填 false', 'description' => '是否为默认资源，目前该参数只支持传入true，暂不支持false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'ProductType' => ['description' => '**该字段已废弃，将会下线，请使用ResourceType字段。**', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'], + 'GroupName' => ['description' => '分组名。', 'type' => 'string', 'required' => false, 'example' => 'group-kjds******sd'], + 'ResourceType' => ['description' => '资源类型列表。取值如下：'."\n" + ."\n" + .'- MaxCompute：大数据计算服务资源'."\n" + .'- ECS：通用计算资源'."\n" + .'- Lingjun：灵骏智算资源'."\n" + .'- ACS：ACS计算资源'."\n" + .'- FLINK：Flink资源'."\n" + .'- SelfManagedAckPro：AckPro统一管控集群资源'."\n" + .'- SelfManagedAckLingjun：AckLinjun统一管控集群资源
'."\n" + .'- SelfManagedASI：ASI统一管控集群资源（三方云）', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'], 'Labels' => [ - 'title' => '模型版本标签', - 'description' => '模型版本标签列表。', + 'description' => '资源标签集合。如果有多个标签，只有同时具备这些标签的资源才会被返回。', 'type' => 'array', 'items' => [ - 'description' => '标签。', - '$ref' => '#/components/schemas/Label', - ], - ], - 'Options' => [ - 'title' => '扩展字段', - 'description' => '扩展字段。JsonString类型。', - 'type' => 'string', - 'example' => '{}', - ], - 'VersionName' => [ - 'title' => '版本名', - 'description' => '模型版本。', - 'type' => 'string', - 'example' => '0.1.0', - ], - 'VersionDescription' => [ - 'title' => '版本描述', - 'description' => '模型版本描述。', - 'type' => 'string', - 'example' => '通用情感分析。', - ], - 'TrainingSpec' => [ - 'title' => '训练配置', - 'description' => '训练配置。用于微调，增量训练的配置。', - 'type' => 'object', - 'example' => '{}', - ], - 'InferenceSpec' => [ - 'title' => '下游部署配置', - 'description' => '描述如何应用于下游的推理服务：例如描述EAS的processor、container等。', - 'type' => 'object', - 'example' => '{'."\n" - .' "Processor": "tensorflow_gpu_1.12"'."\n" - .'}', - ], - 'FormatType' => [ - 'title' => '模型格式', - 'description' => '模型格式，可能值：'."\n" - .'- OfflineModel'."\n" - .'- SavedModel'."\n" - .'- Keras H5'."\n" - .'- Frozen Pb'."\n" - .'- Caffe Prototxt'."\n" - .'- TorchScript'."\n" - .'- XGBoost'."\n" - .'- PMML'."\n" - .'- AlinkModel'."\n" - .'- ONNX', - 'type' => 'string', - 'enumValueTitles' => [ - 'OfflineModel' => 'OfflineModel', - 'SavedModel' => 'SavedModel', - 'Keras H5' => 'Keras H5', - 'Frozen Pb' => 'Frozen Pb', - 'Caffe Prototxt' => 'Caffe Prototxt', - 'TorchScript' => 'TorchScript', - 'XGBoost' => 'XGBoost', - 'PMML' => 'PMML', - 'AlinkModel' => 'AlinkModel', - 'ONNX' => 'ONNX', - ], - 'example' => 'SavedModel', - ], - 'FrameworkType' => [ - 'title' => '模型框架', - 'description' => '模型框架，可能值：'."\n" - .'- Pytorch'."\n" - .'-XGBoost'."\n" - .'- Keras'."\n" - .'- Caffe'."\n" - .'- Alink'."\n" - .'- Xflow'."\n" - .'- TensorFlow', - 'type' => 'string', - 'enumValueTitles' => [ - 'Pytorch' => 'Pytorch', - 'XGBoost' => 'XGBoost', - 'Keras' => 'Keras', - 'Caffe' => 'Caffe', - 'Alink' => 'Alink', - 'Xflow' => 'Xflow', - 'TensorFlow' => 'TensorFlow', - ], - 'example' => 'TensorFlow', - ], - 'SourceType' => [ - 'title' => '来源类型', - 'description' => '模型来源类型，可能值：'."\n" - .'- Custom：自定义。'."\n" - .'- PAIFlow：PAI工作流。'."\n" - .'- TrainingService：PAI训练服务。', - 'type' => 'string', - 'enumValueTitles' => [ - 'PAIFlow' => 'PAIFlow', - 'Custom' => 'Custom', - 'TrainingService' => 'TrainingService', + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'system.******'], + 'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'True'], + ], + 'required' => false, ], - 'example' => 'PAIFlow', - ], - 'SourceId' => [ - 'title' => '来源ID', - 'description' => '来源ID。'."\n" - .'* 来源类型为Custom时，该字段不做限制。'."\n" - .'* 来源为PAIFlow、TrainingService时，格式为 '."\n" - .'```'."\n" - .'region=,workspaceId=,kind=,id='."\n" - .'```'."\n" - .'其中：'."\n" - .'- region为阿里云区域ID。'."\n" - .'- workspaceId为工作空间ID。'."\n" - .'- kind：为类型。取值：PipelineRun（PAIFlow工作流）；ServiceJob（训练服务）。'."\n" - .'- id：为唯一标识。', - 'type' => 'string', - 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf', - ], - 'ApprovalStatus' => [ - 'title' => '准入状态', - 'description' => '准入状态，取值如下：'."\n" - .'- Pending：待定。'."\n" - .'- Approved：允许上线。'."\n" - .'- Rejected：不允许上线。', - 'type' => 'string', - 'example' => 'Approved', - ], - 'EvaluationSpec' => [ - 'title' => '评测配置', - 'description' => '评测配置', - 'type' => 'object', - 'example' => '{}', - ], - 'CompressionSpec' => [ - 'title' => '压缩配置', - 'description' => '压缩配置', - 'type' => 'object', - 'example' => '{}', - ], - 'ExtraInfo' => [ - 'title' => '其它信息', - 'description' => '其它信息。', - 'type' => 'object', - 'example' => '{'."\n" - .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" - .' "TrainedWords": ["albedo_overlord"]'."\n" - .'}', + 'required' => false, ], - 'Metrics' => [ - 'title' => '指标', - 'description' => '指标', - 'type' => 'object', - 'example' => '{}', + 'ResourceIds' => [ + 'description' => '资源ID集合。'."\n" + ."\n" + .'GroupName与ResourceIds不能都为空，但可以都不为空；如果都不为空，集合内每个资源ID的GroupName必须一致。', + 'type' => 'array', + 'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'Resource-dks******jkf'], + 'required' => false, ], - 'DistillationSpec' => [ - 'description' => '蒸馏配置。', - 'type' => 'object', - 'example' => '{}', + 'Spec' => ['description' => '资源的规格。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "clusterType": "share"'."\n" + .'}'], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 id', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'ResourceIds' => [ + 'description' => '本次更新的资源ID集合。', + 'type' => 'array', + 'items' => ['description' => '这次更新的资源ID。', 'type' => 'string', 'example' => 'Resource-dks******jkf'."\n"], + 'example' => 'Resource-dks******jkf', ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"1234567890******\\",\\n \\"OwnerId\\": \\"1234567890******\\",\\n \\"Uri\\": \\"oss://t***.cn-beijing.oss.aliyuncs.com/mod**/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"{}\\",\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"VersionDescription\\": \\"通用情感分析。\\",\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"Processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"Metrics\\": {},\\n \\"DistillationSpec\\": {}\\n}","type":"json"}]', - 'title' => '获取模型版本', - ], - 'ListModelVersions' => [ - 'summary' => '获取模型版本列表。', - 'path' => '/api/v1/models/{ModelId}/versions', - 'methods' => [ - 'get', + 'title' => '更新工作空间的资源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspaceResource'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateWorkspaceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ResourceIds\\": [\\n \\"Resource-dks******jkf\\\\n\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1e195c5116124202371861018d5bde\\n","errorExample":""}]', + ], + 'UpdateWorkspaceRole' => [ + 'path' => '/api/v1/workspaces/{WorkspaceId}/roles/{RoleId}', + 'methods' => ['put'], + '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' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '133782', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', - ], + 'abilityTreeCode' => '221937', + 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => '模型版本列表的页码。起始值为1，默认为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页大小', - 'description' => '分页查询时设置的每页行数。默认为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '顺序', - 'description' => '分页查询时，对指定的排序字段进行升序或降序。默认ASC。'."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序依据', - 'description' => '分页查询时的排序字段。目前GmtCreateTime字段用于排序。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], - ], - [ - 'name' => 'VersionName', - 'in' => 'query', - 'schema' => [ - 'title' => '模型版本名称', - 'description' => '配置模型版本名称，来过滤模型版本列表。', - 'type' => 'string', - 'required' => false, - 'example' => '1.0.1', - ], + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => ['title' => '工作空间ID', 'description' => '工作空间ID。可通过 [ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => true, 'example' => '83***'], ], [ - 'name' => 'FormatType', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '模型格式类型', - 'description' => '配置模型格式，来过滤模型版本列表。取值如下：'."\n" - .'- OfflineModel'."\n" - .'- SavedModel'."\n" - .'- Keras H5'."\n" - .'- Frozen Pb'."\n" - .'- Caffe Prototxt'."\n" - .'- TorchScript'."\n" - .'- XGBoost'."\n" - .'- PMML'."\n" - .'- AlinkModel'."\n" - .'- ONNX', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OfflineModel' => 'OfflineModel', - 'SavedModel' => 'SavedModel', - 'Keras H5' => 'Keras H5', - 'Frozen Pb' => 'Frozen Pb', - 'Caffe Prototxt' => 'Caffe Prototxt', - 'TorchScript' => 'TorchScript', - 'XGBoost' => 'XGBoost', - 'PMML' => 'PMML', - 'AlinkModel' => 'AlinkModel', - 'ONNX' => 'ONNX', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'RoleName' => ['description' => '自定义角色名称。同一个工作空间名字不允许重复。支持字母、数字、下划线_、中划线-，长度不超过 64 个字符。', 'type' => 'string', 'required' => false, 'example' => 'dev-test'], + 'ModulePermissions' => ['description' => '角色权限配置。', 'required' => false, '$ref' => '#/components/schemas/ModulePermissions'], ], - 'example' => 'SavedModel', - ], - ], - [ - 'name' => 'FrameworkType', - 'in' => 'query', - 'schema' => [ - 'title' => '模型框架', - 'description' => '配置模型框架，来过滤模型版本列表，取值如下：'."\n" - .'- Pytorch'."\n" - .'-XGBoost'."\n" - .'- Keras'."\n" - .'- Caffe'."\n" - .'- Alink'."\n" - .'- Xflow'."\n" - .'- TensorFlow', - 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Pytorch' => 'Pytorch', - 'XGBoost' => 'XGBoost', - 'Keras' => 'Keras', - 'Caffe' => 'Caffe', - 'Alink' => 'Alink', - 'Xflow' => 'Xflow', - 'TensorFlow' => 'TensorFlow', - ], - 'example' => 'TensorFlow', ], ], [ - 'name' => 'ModelId', + 'name' => 'RoleId', 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-dajbueh******', - ], + 'schema' => ['description' => '角色ID。', 'type' => 'string', 'required' => true, 'example' => 'role-dhg*******'], ], - [ - 'name' => 'SourceType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '来源类型', - 'description' => '根据模型来源类型，来过滤模型版本列表。取值如下：'."\n" - .'- Custom（默认值）：自定义。'."\n" - .'- PAIFlow：PAI工作流。'."\n" - .'- TrainingService：PAI训练服务。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PAIFlow' => 'PAIFlow', - 'Custom' => 'Custom', - 'TrainingService' => 'TrainingService', + 'title' => 'Schema of Response', + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A519F77D-28A0-52F5-AB82-5********8'."\n"], + 'InstanceJobId' => ['description' => '请求对应的任务id。', 'type' => 'string', 'example' => 'UpdateWorkspaceCustomRole-role-***abc*******'], ], - 'example' => 'PAIFlow', ], ], + ], + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'AIWorkSpace::2021-02-04::GetInstanceJob', 'callbackInterval' => 2000, 'maxCallbackTimes' => 10], + 'title' => '更新自定义角色', + 'summary' => '更新工作空间角色', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ramActions' => [ [ - 'name' => 'SourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '来源ID', - 'description' => '来源ID。'."\n" - .'* 来源类型为Custom时，该字段不做限制。'."\n" - .'* 来源为PAIFlow、TrainingService时，格式为 '."\n" - .'```'."\n" - .'region=,workspaceId=,kind=,id='."\n" - .'```'."\n" - .'其中：'."\n" - .'- region为阿里云区域ID。'."\n" - .'- workspacceId为工作空间ID。'."\n" - .'- kind：为类型。取值：PipelineRun（PAIFlow工作流）；ServiceJob（训练服务）。'."\n" - .'- id：为唯一标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateWorkspaceRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A519F77D-28A0-52F5-AB82-5********8\\\\n\\",\\n \\"InstanceJobId\\": \\"UpdateWorkspaceCustomRole-role-***abc*******\\"\\n}","type":"json"}]', + ], + 'ValidateConnection' => [ + 'path' => '/api/v1/connections/validate', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Label', - 'in' => 'query', - 'schema' => [ - 'title' => '标签串', - 'description' => '标签串。用于列表过滤，标签中Key或Value中，有指定字符串的，都会被过滤出来。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], + ], + 'parameters' => [ [ - 'name' => 'ApprovalStatus', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '准入状态', - 'description' => '根据准入状态来过滤模型版本列表，取值如下：'."\n" - .'- Pending：待定。'."\n" - .'- Approved：允许上线。'."\n" - .'- Rejected：不允许上线。', - 'type' => 'string', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'Configs' => [ + 'description' => '连接的配置信息。以key-value的形式配置，不同的连接类型对应的Config配置的key不相同。具体参见CreateConnection接口的请求参数补充说明。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => '连接的配置信息。以key-value的形式配置，不同的连接类型对应的Config配置的key不相同。具体参见请求参数补充说明。', 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1'], + ], + 'ConnectionId' => ['description' => '连接ID。如何获取连接 ID，详情请参见 [ListConnections](url)。', 'type' => 'string', 'required' => false, 'example' => 'conn-x2wz5zvvbyf2420fi9'], + 'ConnectionType' => ['description' => '连接的类型，当前支持填写可公网访问的连接类型：'."\n" + .'- DashScopeConnection：百炼服务连接。'."\n" + .'- DeepSeekConnection：DeepSeek服务连接。'."\n" + .'- FunctionAIMCPConnection：Function AI MCP连接。'."\n" + .'- CustomMCPConnection：自定义MCP连接。', 'type' => 'string', 'required' => false, 'example' => 'DashScopeConnection'], + 'Secrets' => [ + 'description' => '需要加密的key-value配置。如数据库登录密码，模型连接的key等。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => '需要加密的连接配置信息。比如数据库的账密信息，模型服务的key等。', 'example' => 'ZGJiZWQ2ZDY3MTMyYjJk****************NjE2NDg1NzM0YzlkZg=='], + ], + 'ValidateType' => ['description' => '验证类型。可设置为：'."\n" + .'- Connectivity：连通性测试', 'type' => 'string', 'required' => false, 'example' => 'Connectivity'], + 'WorkspaceId' => ['description' => '工作空间ID，可从接口[ListWorkspaces](~~449124~~)获取。', 'type' => 'string', 'required' => true, 'example' => '1234'], + ], 'required' => false, - 'example' => 'Approved', ], ], ], @@ -18846,1468 +14520,1736 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回体。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC***3C83E', - ], - 'Versions' => [ - 'title' => '模型版本列表', - 'description' => '模型版本列表。', - 'type' => 'array', - 'items' => [ - 'description' => '模型版本。', - '$ref' => '#/components/schemas/ModelVersion', - ], - ], - 'TotalCount' => [ - 'title' => '总数', - 'description' => '模型版本列表总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', + 'Status' => ['description' => '本次验证的结果状态。'."\n" + .'- success：成功'."\n" + .'- failed：失败', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], + 'Message' => ['description' => '验证结果描述。', 'type' => 'string', 'example' => 'The connection is reachable.'], + 'Code' => ['description' => '请求失败时返回的错误代码。', 'type' => 'string', 'example' => '403'], + 'Details' => [ + 'description' => '验证结果详情。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '验证结果的详细信息，如LatencyMs，表示测试延迟（毫秒）。', 'example' => '100'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '验证连接', + 'summary' => '验证连接', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'learn', 'title' => '机器学习'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC***3C83E\\",\\n \\"Versions\\": [\\n {\\n \\"VersionName\\": \\"1.0.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://bucket/path-to-model\\",\\n \\"VersionDescription\\": \\"\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"ApprovalStatus\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TrainingSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"InferenceSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EvaluationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"CompressionSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DistillationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', - 'title' => '获取模型版本列表', - ], - 'DeleteModelVersion' => [ - 'summary' => '删除模型版本。', - 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', - 'methods' => [ - 'delete', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiworkspace:ValidateConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"success\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Message\\": \\"The connection is reachable.\\",\\n \\"Code\\": \\"403\\",\\n \\"Details\\": {\\n \\"key\\": \\"100\\"\\n }\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-wulanchabu.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.cn-beijing.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-beijing.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.cn-shanghai.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-shanghai.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.cn-hongkong.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-hongkong.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => '华南2（河源）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.cn-heyuan.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-heyuan.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.cn-shenzhen.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-shenzhen.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.ap-northeast-1.aliyuncs.com ', 'endpoint' => 'aiworkspace.ap-northeast-1.aliyuncs.com ', 'vpc' => 'aiworkspace-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.cn-guangzhou.aliyuncs.com ', 'endpoint' => 'aiworkspace.cn-guangzhou.aliyuncs.com ', 'vpc' => 'aiworkspace-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.ap-southeast-1.aliyuncs.com', 'endpoint' => 'aiworkspace.ap-southeast-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.ap-southeast-3.aliyuncs.com', 'endpoint' => 'aiworkspace.ap-southeast-3.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.ap-southeast-5.aliyuncs.com', 'endpoint' => 'aiworkspace.ap-southeast-5.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiworkspace.cn-hangzhou.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-hangzhou.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'aiworkspace.us-east-1.aliyuncs.com', 'endpoint' => 'aiworkspace.us-east-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'aiworkspace.us-west-1.aliyuncs.com', 'endpoint' => 'aiworkspace.us-west-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'aiworkspace.eu-central-1.aliyuncs.com', 'endpoint' => 'aiworkspace.eu-central-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'aiworkspace.ap-south-1.aliyuncs.com', 'endpoint' => 'aiworkspace.ap-south-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'aiworkspace.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => '100400027', 'message' => 'Workspace not exists.', 'http_code' => 404, 'description' => '工作空间不存在'], + ['code' => '100600006', 'message' => 'Workspace member not found error.', 'http_code' => 404, 'description' => '工作空间成员不存在'], + ['code' => '100700008', 'message' => 'No permission.', 'http_code' => 404, 'description' => '没有权限'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelLabels'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResources'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConfig'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImageLabels'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFeatures'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnection'], + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageLabels'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'GetExperiment'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserConfigs'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnections'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCodeSources'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCodeSource'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListRuns'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetLabels'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetJobConfig'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteExperiment'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDefaultWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataset'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMembers'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMember'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnection'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AcceptDataworksEvent'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'CreateExperiment'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'LogRunMetrics'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMemberRole'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetJobConfig'], + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDefaultWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelVersion'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCodeSource'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetFileMetas'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProductOrders'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigs'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetFileMeta'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteRunLabel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigs'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotas'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetJobConfig'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMemberRole'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserConfig'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModelVersion'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelVersion'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspaceResource'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetVersionLabels'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetFileMetas'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetVersions'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspaceResource'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaceUsers'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCodeSource'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetFileMetas'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModel'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMember'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPermissions'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'GetRun'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetVersionLabels'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'SetExperimentLabels'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPermission'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfig'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'UpdateRun'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelVersionLabels'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspaceResource'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveImage'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetLabels'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetFileMetasStatistics'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetJobConfigs'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserConfigs'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetVersion'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteExperimentLabel'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetJobConfig'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetImage'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetVersion'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModelVersions'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelVersionLabels'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModels'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCodeSource'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetVersion'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataset'], + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishDataset'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasets'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelLabels'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteRun'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConfig'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishImage'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'CreateRun'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListRunMetrics'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishCodeSource'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveImageLabels'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListExperiment'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetFileMetas'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetVersion'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMembers'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModelVersion'], + ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'UpdateExperiment'], + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDatasetJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetJobs'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModel'], + ], + 'product' => ['code' => 'learn', 'title' => '机器学习'], + ], + 'ram' => [ + 'productCode' => 'PAIWorkspace', + 'productName' => '人工智能平台 PAI', + 'ramCodes' => ['paiworkspace', 'pai', 'paiimage', 'paicodesource', 'paidataset', 'paimodel', 'paiexperiment', 'paiservicetemplate', 'paiconnection'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CreateWorkspaceRole', + 'description' => '创建自定义角色', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiworkspace:AddWorkspaceRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListResources', + 'description' => '获取工作空间的资源列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '更改资源组', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListWorkspaces', + 'description' => '获取工作空间列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListWorkspaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133784', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', + [ + 'apiName' => 'AddMemberRole', + 'description' => '成员添加角色', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:AddMemberRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ModelId', - 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-rbvg5wzljz****ks92', + [ + 'apiName' => 'UpdateDefaultWorkspace', + 'description' => '指定默认工作空间', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateDefaultWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'title' => '模型版本', - 'description' => '模型版本。', - 'type' => 'string', - 'required' => true, - 'example' => '0.1.1', + ], + [ + 'apiName' => 'GetMember', + 'description' => '获取工作空间的成员', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - ], + [ + 'apiName' => 'ListWorkspaceUsers', + 'description' => '获取可被添加至工作空间的用户列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListWorkspaceUsers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除模型版本', - ], - 'CreateModelLabels' => [ - 'summary' => '为模型创建标签。', - 'path' => '/api/v1/models/{ModelId}/labels', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetInstanceJob', + 'description' => '获取任务结果', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetInstanceJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ValidateConnection', + 'description' => '验证连接', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiworkspace:ValidateConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteConfig', + 'description' => '删除工作空间配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListConnections', + 'description' => '获取连接列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListConnections', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListMembers', + 'description' => '获取工作空间的成员列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133787', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', + [ + 'apiName' => 'ListPermissions', + 'description' => '获取工作空间的权限列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListPermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ModelId', - 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-1dkasjfhds23dft', + [ + 'apiName' => 'UpdateWorkspaceResource', + 'description' => '更新工作空间的资源', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateWorkspaceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'Labels' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'CreateConnection', + 'description' => '创建连接', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiworkspace:CreateConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F81D9EC0-1872-50F5-A96C-A0647D****1D', - ], - ], + [ + 'apiName' => 'DeleteWorkspace', + 'description' => '删除工作空间', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DeleteWorkspaceResource', + 'description' => '删除工作空间的资源', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteWorkspaceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F81D9EC0-1872-50F5-A96C-A0647D****1D\\"\\n}","type":"json"}]', - 'title' => '创建模型标签', - ], - 'DeleteModelLabels' => [ - 'summary' => '删除模型标签。', - 'path' => '/api/v1/models/{ModelId}/labels', - 'methods' => [ - 'delete', + [ + 'apiName' => 'DeleteMembers', + 'description' => '工作空间删除成员 ', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteWorkspaceRoles', + 'description' => '删除自定义角色', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiworkspace:RemoveWorkspaceRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListWorkspaceRoles', + 'description' => '获取工作空间角色列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListWorkspaceRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'UpdateWorkspaceRole', + 'description' => '更新自定义角色', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateWorkspaceRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListConfigs', + 'description' => '获取工作空间配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiworkspace:ListConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteConnection', + 'description' => '删除连接', 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133789', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', + 'ramAction' => [ + 'action' => 'paiworkspace:DeleteConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ModelId', - 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-d8dfd****sjfd', + [ + 'apiName' => 'CreateWorkspaceResource', + 'description' => '创建工作空间的资源', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiworkspace:CreateWorkspaceResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'LabelKeys', - 'in' => 'query', - 'schema' => [ - 'title' => '需要删除的标签Keys', - 'description' => '需要删除的标签键。多项之间使用半角逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1,key2', + ], + [ + 'apiName' => 'GetWorkspaceRole', + 'description' => '获取自定义角色详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetWorkspaceRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - ], + [ + 'apiName' => 'RemoveMemberRole', + 'description' => '删除成员角色 ', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:RemoveMemberRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetConnection', + 'description' => '查询连接', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除模型标签', - ], - 'CreateModelVersionLabels' => [ - 'summary' => '为模型版本创建标签。', - 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}/labels', - 'methods' => [ - 'post', + [ + 'apiName' => 'UpdateConfig', + 'description' => '更新或新增工作空间配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetConfig', + 'description' => '获取工作空间配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetWorkspace', + 'description' => '获取工作空间', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'GetDefaultWorkspace', + 'description' => '获取默认工作空间', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiworkspace:GetDefaultWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'UpdateWorkspace', + 'description' => '更新工作空间', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateWorkspace', + 'description' => '创建工作空间', 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133790', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', + 'ramAction' => [ + 'action' => 'paiworkspace:CreateWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'Labels' => [ - 'title' => '版本标签', - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'required' => false, - '$ref' => '#/components/schemas/Label', - ], - 'required' => false, - ], - ], - 'required' => false, + [ + 'apiName' => 'UpdateConnection', + 'description' => '更新连接', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ModelId', - 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-rbvg5wzljz****ks92', + ], + [ + 'apiName' => 'UpdateConfigs', + 'description' => '批量更新或新增工作空间配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiworkspace:UpdateConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'title' => '模型版本', - 'description' => '模型版本。', - 'type' => 'string', - 'required' => true, - 'example' => '0.1.1', + ], + [ + 'apiName' => 'CreateMember', + 'description' => '工作空间添加成员', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'paiworkspace:CreateMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - ], + [ + 'apiName' => 'GetPermission', + 'description' => '获取工作空间的权限', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pai:AdministratePAI', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListProducts', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListProducts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '创建模型版本标签', - ], - 'DeleteModelVersionLabels' => [ - 'summary' => '删除模型版本标签。', - 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}/labels', - 'methods' => [ - 'delete', + [ + 'apiName' => 'ListUserConfigs', + 'description' => '获取用户配置', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListUserConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListFeatures', + 'description' => '列举客户特性', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListFeatures', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SetUserConfigs', + 'description' => '更新用户配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:SetUserConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'DeleteUserConfig', + 'description' => '删除用户配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pai:DeleteUserConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListQuotas', + 'description' => '获取MaxCompute GPU资源组的资源配额列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pai:ListQuotas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133792', - 'abilityTreeNodes' => [ - 'FEATURElearnN5P2NR', + [ + 'apiName' => 'CreateProductOrders', + 'description' => '购买产品', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pai:CreateOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ModelId', - 'in' => 'path', - 'schema' => [ - 'title' => '模型ID', - 'description' => '模型ID。如何获取模型ID，请参见[ListModels](~~461944~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'model-d8dfd****sjfd', + [ + 'apiName' => 'GetImage', + 'description' => '获取镜像', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiimage:GetImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'VersionName', - 'in' => 'path', - 'schema' => [ - 'title' => '模型版本', - 'description' => '模型版本。', - 'type' => 'string', - 'required' => true, - 'example' => '0.1.1', + ], + [ + 'apiName' => 'AddImageLabels', + 'description' => '添加镜像标签', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiimage:AddImageLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'LabelKeys', - 'in' => 'query', - 'schema' => [ - 'title' => '版本标签Keys', - 'description' => '需要删除的标签键。多项之间使用半角逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1,key2', + ], + [ + 'apiName' => 'AddImage', + 'description' => '添加镜像', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiimage:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - ], + [ + 'apiName' => 'PublishImage', + 'description' => '发布镜像', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiimage:PublishImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', - 'title' => '删除模型版本标签', - ], - 'SetUserConfigs' => [ - 'summary' => '更新用户配置。', - 'path' => '/api/v1/userconfigs', - 'methods' => [ - 'put', + [ + 'apiName' => 'CreateImageBuild', + 'description' => '构建自定义镜像', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiimage:CreateImageBuild', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListImageLabels', + 'description' => '获取镜像标签列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiimage:ListImageLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'RemoveImage', + 'description' => '删除镜像', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiimage:RemoveImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListImages', + 'description' => '获取镜像列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paiimage:ListImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'RemoveImageLabels', + 'description' => '移除镜像标签', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiimage:RemoveImageLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateCodeSource', + 'description' => '创建代码配置', 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '194786', - 'abilityTreeNodes' => [ - 'FEATURElearnDVAH75', + 'ramAction' => [ + 'action' => 'paicodesource:CreateCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '配置。', - 'type' => 'object', - 'properties' => [ - 'Configs' => [ - 'title' => '配置列表', - 'description' => '配置列表', - 'type' => 'array', - 'items' => [ - 'description' => '配置', - 'type' => 'object', - 'properties' => [ - 'ConfigKey' => [ - 'title' => '配置键', - 'description' => '配置键', - 'type' => 'string', - 'required' => true, - 'example' => 'customizePAIAssumedRole', - ], - 'ConfigValue' => [ - 'title' => '配置值', - 'description' => '配置值', - 'type' => 'string', - 'required' => true, - 'example' => 'role', - ], - 'CategoryName' => [ - 'description' => '分类，目前只支持DataPrivacyConfig。', - 'type' => 'string', - 'required' => true, - 'example' => 'DataPrivacyConfig', - ], - 'Scope' => [ - 'description' => '范围，目前支持subUser、owner。', - 'type' => 'string', - 'required' => true, - 'example' => 'owner', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, + [ + 'apiName' => 'DeleteCodeSource', + 'description' => '删除代码配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paicodesource:DeleteCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'dsjk****dfjksdf', - ], - ], + [ + 'apiName' => 'UpdateCodeSource', + 'description' => '更新代码配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paicodesource:UpdateCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dsjk****dfjksdf\\"\\n}","type":"json"}]', - 'title' => '更新用户配置', - ], - 'DeleteUserConfig' => [ - 'summary' => '删除用户配置。', - 'path' => '/api/v1/userconfigs/{CategoryName}', - 'methods' => [ - 'delete', + [ + 'apiName' => 'PublishCodeSource', + 'description' => '发布代码配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paicodesource:PublishCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetCodeSource', + 'description' => '获取代码配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paicodesource:GetCodeSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListCodeSources', + 'description' => '获取代码配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paicodesource:ListCodeSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '194787', - 'abilityTreeNodes' => [ - 'FEATURElearn1N0SUT', + [ + 'apiName' => 'GetDatasetVersion', + 'description' => '获取数据集版本', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ConfigKey', - 'in' => 'query', - 'schema' => [ - 'title' => '配置键', - 'description' => '配置键，目前只支持customizePAIAssumedRole。', - 'type' => 'string', - 'required' => false, - 'example' => 'tempStoragePath', + [ + 'apiName' => 'CreateDataset', + 'description' => '创建数据集', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'CategoryName', - 'in' => 'path', - 'schema' => [ - 'description' => '分类，目前只支持DataPrivacyConfig。', - 'type' => 'string', - 'required' => true, - 'example' => 'DataPrivacyConfig', + ], + [ + 'apiName' => 'CreateDatasetLabels', + 'description' => '创建数据集标签', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Scope', - 'in' => 'query', - 'schema' => [ - 'description' => '范围，目前支持subUser、owner。', - 'type' => 'string', - 'required' => false, - 'example' => 'subUser', + ], + [ + 'apiName' => 'GetDatasetFileMeta', + 'description' => '获取数据集文件元数据详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetFileMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'dsjk****dfjksdf', - ], - ], + [ + 'apiName' => 'ListDatasetJobs', + 'description' => '获取数据集任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasetJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dsjk****dfjksdf\\"\\n}","type":"json"}]', - 'title' => '删除用户配置', - ], - 'ListUserConfigs' => [ - 'summary' => '获取用户配置。', - 'path' => '/api/v1/userconfigs', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListDatasetFileMetas', + 'description' => '获取数据集文件元数据列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasetFileMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDatasetFileMetas', + 'description' => '批量创建数据集文件元数据', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetFileMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetDatasetFileMetasStatistics', + 'description' => '获取数据集下文件元数据的统计信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetFileMetasStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteDatasetLabels', + 'description' => '删除数据集标签', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListDatasetJobConfigs', + 'description' => '获取数据集任务配置列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasetJobConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'UpdateDataset', + 'description' => '更新数据集', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:UpdateDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '194785', - 'abilityTreeNodes' => [ - 'FEATURElearnDVAH75', + [ + 'apiName' => 'DeleteDatasetJobConfig', + 'description' => '删除数据集任务配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ConfigKeys', - 'in' => 'query', - 'schema' => [ - 'title' => '配置键', - 'description' => '配置键的集合，目前只支持customizePAIAssumedRole。', - 'type' => 'string', - 'required' => false, - 'example' => 'customizePAIAssumedRole', + [ + 'apiName' => 'DeleteDatasetFileMetas', + 'description' => '批量删除数据集文件元数据', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetFileMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'CategoryNames', - 'in' => 'query', - 'schema' => [ - 'description' => '分类，目前只支持DataPrivacyConfig。', - 'type' => 'string', - 'required' => false, - 'example' => 'DataPrivacyConfig', + ], + [ + 'apiName' => 'ListDatasetVersions', + 'description' => '获取数据集版本列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasetVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'sdjksdk-******-dsfds', - ], - 'Configs' => [ - 'title' => '配置列表', - 'description' => '配置列表', - 'type' => 'array', - 'items' => [ - 'description' => '配置', - 'type' => 'object', - 'properties' => [ - 'ConfigKey' => [ - 'title' => '配置键', - 'description' => '配置键', - 'type' => 'string', - 'example' => 'customizePAIAssumedRole', - ], - 'ConfigValue' => [ - 'title' => '配置值', - 'description' => '配置值', - 'type' => 'string', - 'example' => 'role', - ], - 'CategoryName' => [ - 'description' => '分类，目前只支持DataPrivacyConfig。', - 'type' => 'string', - 'example' => 'DataPrivacyConfig', - ], - 'Scope' => [ - 'description' => '范围，目前支持subUser、owner。', - 'type' => 'string', - 'example' => 'subUser', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '返回数量', - 'description' => '返回数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - ], + [ + 'apiName' => 'DeleteDatasetVersion', + 'description' => '删除数据集版本', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"sdjksdk-******-dsfds\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigKey\\": \\"customizePAIAssumedRole\\",\\n \\"ConfigValue\\": \\"role\\",\\n \\"CategoryName\\": \\"DataPrivacyConfig\\",\\n \\"Scope\\": \\"subUser\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', - 'title' => '获取用户配置', - ], - 'ListProducts' => [ - 'summary' => '列举产品', - 'path' => '/api/v1/products', - 'methods' => [ - 'get', + [ + 'apiName' => 'DeleteDatasetVersionLabels', + 'description' => '删除数据集版本标签', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDatasetVersionLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListDatasets', + 'description' => '获取数据集列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paidataset:ListDatasets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateDatasetVersion', + 'description' => '更新数据集版本', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:UpdateDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '14207', - 'abilityTreeNodes' => [ - 'FEATURElearnOTS2AE', + [ + 'apiName' => 'PublishDataset', + 'description' => '发布数据集', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:PublishDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ProductCodes', - 'in' => 'query', - 'schema' => [ - 'title' => '逗号分割的商品 code', - 'type' => 'string', - 'required' => false, - 'example' => 'PAI_isolate', + [ + 'apiName' => 'UpdateDatasetJobConfig', + 'description' => '更新数据集任务配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:UpdateDatasetJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ServiceCodes', - 'in' => 'query', - 'schema' => [ - 'title' => '逗号分割的服务 code', - 'type' => 'string', - 'example' => 'oss', + ], + [ + 'apiName' => 'CreateDatasetVersion', + 'description' => '创建数据集版本', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Verbose', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'default' => 'false', + ], + [ + 'apiName' => 'UpdateDatasetFileMetas', + 'description' => '批量更新数据集文件元数据', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paidataset:UpdateDatasetFileMetas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求 id', - 'type' => 'string', - 'example' => '1e195c5116124202371861018d5bde', - ], - 'Products' => [ - 'title' => '产品列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PurchaseUrl' => [ - 'title' => '购买链接', - 'type' => 'string', - 'example' => 'https://common-buy.aliy', - ], - 'ProductCode' => [ - 'title' => '商品 code', - 'type' => 'string', - 'example' => 'DataWorks_isolate', - ], - 'IsPurchased' => [ - 'title' => '是否已购买', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HasPermissionToPurchase' => [ - 'title' => 'Whether user has permission to purchase', - 'type' => 'boolean', - ], - 'ProductId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Services' => [ - 'title' => '服务列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'IsOpen' => [ - 'title' => '是否开通', - 'type' => 'boolean', - 'example' => 'true', - ], - 'OpenUrl' => [ - 'title' => '开通链接', - 'type' => 'string', - ], - 'ServiceCode' => [ - 'title' => '服务Code', - 'type' => 'string', - 'example' => 'oss', - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateDatasetVersionLabels', + 'description' => '创建数据集版本标签', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetVersionLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '', - ], - 'CreateProductOrders' => [ - 'summary' => '购买产品，目前只支持购买DataWorks后付费、OSS后付费、PAI后付费、MaxCompute后付费。', - 'path' => '/api/v1/productorders', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateDatasetJobConfig', + 'description' => '创建数据集任务配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetDataset', + 'description' => '获取数据集', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'StopDatasetJob', + 'description' => '停止数据集任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paidataset:StopDatasetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'DeleteDataset', + 'description' => '删除数据集', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paidataset:DeleteDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetDatasetJob', + 'description' => '获取数据集任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateDatasetJob', + 'description' => '创建数据集任务', 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '75124', - 'abilityTreeNodes' => [ - 'FEATURElearnOTS2AE', + 'ramAction' => [ + 'action' => 'paidataset:CreateDatasetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '购买请求', - 'type' => 'object', - 'properties' => [ - 'AutoPay' => [ - 'title' => '是否自动购买所有产品', - 'description' => '是否自动购买（支付）Products参数中传入的所有产品。'."\n" - .'- true：自动支付。'."\n" - .'- false：不自动支付。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Products' => [ - 'description' => '需要购买的产品列表，使用逗号分割。', - 'type' => 'array', - 'items' => [ - 'description' => '需要购买的产品。', - 'type' => 'object', - 'properties' => [ - 'AutoRenew' => [ - 'description' => '是否自动续费。'."\n" - .'- true：自动续费。'."\n" - .'- false：不自动续费。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], - 'ProductCode' => [ - 'description' => '产品code，目前支持的如下code：'."\n" - ."\n" - .'- DataWorks_share：Dataworks后付费商品。'."\n" - .'- MaxCompute_share：MaxCompute后付费商品。'."\n" - .'- PAI_share：PAI后付费商品。'."\n" - .'- OSS_share：OSS后付费商品。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'MaxCompute_share' => 'MaxCompute_share', - 'OSS_share' => 'OSS_share', - 'DataWorks_share' => 'DataWorks_share', - 'PAI_share' => 'PAI_share', - ], - 'example' => 'DataWorks_share', - ], - 'ChargeType' => [ - 'description' => '付费类型，目前支持POSTPAY。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'POSTPAY' => 'POSTPAY', - ], - 'example' => 'POSTPAY', - ], - 'OrderType' => [ - 'description' => '订单类型，目前只支持BUY。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'BUY' => 'BUY', - ], - 'example' => 'BUY', - ], - 'PricingCycle' => [ - 'description' => '计价单位，目前支持如下值'."\n" - .'- Month：按月计价，DataWorks_share只支持Month。'."\n" - .'- Hour：按小时计价，OSS_share、MaxCompute_share只支持Hour。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Month' => 'Month', - 'Hour' => 'Hour', - ], - 'example' => 'Month', - ], - 'Duration' => [ - 'description' => '购买时长，与pricingCycle配合使用，目前只支持1。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'InstanceProperties' => [ - 'description' => '实例属性信息列表。'."\n" - .'- DataWorks_share：'."\n" - .'[ {'."\n" - .'"Code": "region",'."\n" - .'"Value": "cn-shanghai"'."\n" - .'}'."\n" - .']'."\n" - .'- OSS_share：'."\n" - .'[ {'."\n" - .'"Code": "commodity_type",'."\n" - .'"Value": "oss",'."\n" - .'"Name": "对象存储OSS"'."\n" - .'},'."\n" - .'{'."\n" - .'"Code": "ord_time",'."\n" - .'"Value": "1:Hour",'."\n" - .'"Name": "1小时"'."\n" - .'}'."\n" - .']'."\n" - .'- PAI_share: 无'."\n" - .'- 国内bid MaxCompute_share：'."\n" - .'['."\n" - .'{'."\n" - .'"Code": "region",'."\n" - .'"Value": "cn-hangzhou"'."\n" - .'},'."\n" - .'{'."\n" - .'"Code": "odps_specification_type",'."\n" - .'"Value": "OdpsStandard"'."\n" - .'},'."\n" - .'{'."\n" - .'"Code": "ord_time",'."\n" - .'"Value": "1:Hour"'."\n" - .'}'."\n" - .']'."\n" - .'- 国际bid MaxCompute_share：'."\n" - .'['."\n" - .'{'."\n" - .'"Code": "region",'."\n" - .'"Value": "cn-hangzhou"'."\n" - .'},'."\n" - .'{'."\n" - .'"Code": "ord_time",'."\n" - .'"Value": "1:Hour"'."\n" - .'}'."\n" - .']', - 'type' => 'array', - 'items' => [ - 'description' => '实例属性信息。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '实例属性Code。', - 'type' => 'string', - 'required' => false, - 'example' => 'commodity_type', - ], - 'Name' => [ - 'description' => '实例属性Name。', - 'type' => 'string', - 'required' => false, - 'example' => '对象存储OSS', - ], - 'Value' => [ - 'description' => '实例属性Value。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, + [ + 'apiName' => 'GetDatasetJobConfig', + 'description' => '获取数据集任务配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paidataset:GetDatasetJobConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetModel', + 'description' => '获取模型', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paimodel:GetModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构体。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => 'ksdjf-jksd-*****slkdjf', - ], - 'OrderId' => [ - 'title' => '订单id', - 'description' => '购买订单ID。', - 'type' => 'string', - 'example' => '210292536260646', - ], - 'Message' => [ - 'title' => '消息', - 'description' => '购买返回消息。', - 'type' => 'string', - 'example' => '正常', - ], - 'BuyProductRequestId' => [ - 'title' => '产品购买请求id', - 'description' => '产品购买请求ID。', - 'type' => 'string', - 'example' => '3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb', - ], - 'ProductIds' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], + [ + 'apiName' => 'DeleteModelVersionLabels', + 'description' => '删除模型版本标签', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paimodel:DeleteModelVersionLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ksdjf-jksd-*****slkdjf\\",\\n \\"OrderId\\": \\"210292536260646\\",\\n \\"Message\\": \\"正常\\",\\n \\"BuyProductRequestId\\": \\"3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb\\",\\n \\"ProductIds\\": [\\n \\"\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n 210292536260646\\n 正常\\n 3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb\\n","errorExample":""}]', - 'title' => '购买产品', - ], - 'AcceptDataworksEvent' => [ - 'summary' => 'PAI系统用于接收并处理DataWorks发送的系统事件消息。', - 'path' => '/api/v1/workspaces/action/acceptdataworksevent', - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteModelVersion', + 'description' => '删除模型版本', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paimodel:DeleteModelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetModelVersion', + 'description' => '获取模型版本', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paimodel:GetModelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListModels', + 'description' => '获取模型列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paimodel:ListModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'CreateModel', + 'description' => '创建模型', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paimodel:CreateModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'UpdateModelVersion', + 'description' => '更新模型版本', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paimodel:UpdateModelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '259201', - 'abilityTreeNodes' => [ - 'FEATURElearn8QX455', + [ + 'apiName' => 'UpdateModel', + 'description' => '更新模型', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paimodel:UpdateModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'MessageId' => [ - 'description' => 'DataWorks 开放消息的消息 ID。当触发扩展点事件后，可以从接收到的事件消息中获取消息 ID。消息格式，请参见[消息格式](~~436911~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '539306ba-*****-41a0-****-6dc81060985c', - ], - 'Data' => [ - 'description' => '消息对应的事件内容。', - 'type' => 'object', - 'required' => false, - 'example' => '{"eventCode":"d****ct","projectId":"8***6","tenantId":4*******8,"operator":"115*****901"}', - ], - ], - 'required' => false, + [ + 'apiName' => 'ListModelVersions', + 'description' => '获取模型版本列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'paimodel:ListModelVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回结构体。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'ADF6D849-*****-7E7030F0CE53', - ], - ], + [ + 'apiName' => 'DeleteModelLabels', + 'description' => '删除模型标签', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paimodel:DeleteModelLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', - 'title' => '接收并处理DataWorks系统事件', - 'description' => '此接口仅限于内部系统调用，外部用户无法使用', - ], - 'ChangeResourceGroup' => [ - 'summary' => '更改资源ID对应的资源组。', - 'path' => '/resourcegroups/action/changeresourcegroup', - 'methods' => [ - 'put', + [ + 'apiName' => 'CreateModelLabels', + 'description' => '创建模型标签', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paimodel:CreateModelLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateModelVersionLabels', + 'description' => '创建模型版本标签', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paimodel:CreateModelVersionLabels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteModel', + 'description' => '删除模型', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paimodel:DeleteModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '249844', - 'abilityTreeNodes' => [ - 'FEATURElearnZBMZHZ', + [ + 'apiName' => 'CreateModelVersion', + 'description' => '创建模型版本', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paimodel:CreateModelVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => '资源ID。这里的资源ID等于工作空间ID，如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '12**56', - ], - 'NewResourceGroupId' => [ - 'description' => '新的资源组ID。如何获取资源组ID，请参见[查看资源组基本信息](~~151181~~)', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-df********534dy', - ], - 'ResourceType' => [ - 'description' => '资源组类型：必须填workspace。', - 'type' => 'string', - 'required' => false, - 'example' => 'workspace', - ], - ], - 'required' => false, + [ + 'apiName' => 'ListRunMetrics', + 'description' => '获取Run的指标记录列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiexperiment:ListRunMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '对象。', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6****27E-****-5144-A002-89C****8660F', - ], - ], + [ + 'apiName' => 'UpdateExperiment', + 'description' => '更新实验信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiexperiment:UpdateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetRun', + 'description' => '获取Run详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiexperiment:GetRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6****27E-****-5144-A002-89C****8660F\\"\\n}","type":"json"}]', - 'title' => '更改资源组', - ], - 'ListFeatures' => [ - 'summary' => '列举特性', - 'path' => '/api/v1/features', - 'methods' => [ - 'get', + [ + 'apiName' => 'GetExperiment', + 'description' => '获取实验详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'paiexperiment:GetExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListRuns', + 'description' => '获取运行列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'paiexperiment:ListRuns', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteExperiment', + 'description' => '删除实验', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiexperiment:DeleteExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListExperiment', + 'description' => '获取实验列表', 'operationType' => 'list', - 'abilityTreeCode' => '101118', - 'abilityTreeNodes' => [ - 'FEATURElearnZO51AS', + 'ramAction' => [ + 'action' => 'paiexperiment:ListExperiments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Names', - 'in' => 'query', - 'schema' => [ - 'title' => '特性名称，以逗号分隔', - 'description' => '特性名称，以逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'PaiConsole:IntegrateWithWorkspace', + [ + 'apiName' => 'DeleteRunLabel', + 'description' => '删除Run标签', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiexperiment:DeleteRunLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A14FA81-DD4E-******-6343FE44B941', - ], - 'TotalCount' => [ - 'title' => '特性总数', - 'description' => '特性总数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Features' => [ - 'title' => '特性列表', - 'description' => '特性列表', - 'type' => 'array', - 'items' => [ - 'description' => '特性。', - 'type' => 'string', - 'example' => 'PaiConsole:IntegrateWithWorkspace'."\n", - ], - ], - ], + [ + 'apiName' => 'DeleteRun', + 'description' => '删除Run', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiexperiment:DeleteRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateExperiment', + 'description' => '创建实验', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiexperiment:CreateExperiment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetExperimentLabels', + 'description' => 'SetExperimentLabels', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiexperiment:SetExperimentLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRun', + 'description' => '更新运行信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'paiexperiment:UpdateRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteExperimentLabel', + 'description' => '删除实验的标签', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'paiexperiment:DeleteExperimentLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRun', + 'description' => '创建运行', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'paiexperiment:CreateRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 2,\\n \\"Features\\": [\\n \\"PaiConsole:IntegrateWithWorkspace\\\\n\\"\\n ]\\n}","type":"json"}]', - 'title' => '列举客户特性', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'aiworkspace.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'aiworkspace.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'aiworkspace.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'aiworkspace.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'aiworkspace.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'aiworkspace.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'aiworkspace.cn-heyuan.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'aiworkspace.cn-guangzhou.aliyuncs.com ', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'aiworkspace.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'aiworkspace.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'aiworkspace.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'aiworkspace.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'aiworkspace.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'aiworkspace.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'aiworkspace.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'aiworkspace.ap-south-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'aiworkspace.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'aiworkspace.ap-northeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'us-southeast-1', - 'endpoint' => 'aiworkspace.us-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'aiworkspace.ap-southeast-7.aliyuncs.com', ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'aiworkspace.me-east-1.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], + ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#Region}:{#AccountId}:workspace/{#WorkspaceId}'], + ['validationType' => 'always', 'resourceType' => 'Connection', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:connection/*'], ], ], ]; -- cgit v1.2.3