'1.0',
'info' => ['style' => 'ROA', 'product' => 'PaiStudio', 'version' => '2022-01-12'],
'directories' => [
[
'children' => ['GetResourceGroupTotal', 'GetResourceGroupRequest', 'DeleteResourceGroupMachineGroup', 'GetNodeMetrics', 'ListResourceGroupMachineGroups', 'GetUserViewMetrics', 'GetResourceGroupMachineGroup'],
'type' => 'directory',
'title' => '资源组',
'id' => 289468,
],
[
'children' => ['CreateAlgorithm', 'CreateAlgorithmVersion', 'DeleteAlgorithm', 'DeleteAlgorithmVersion', 'GetAlgorithm', 'GetAlgorithmVersion', 'ListAlgorithms', 'ListAlgorithmVersions', 'UpdateAlgorithm', 'UpdateAlgorithmVersion'],
'type' => 'directory',
'title' => '训练算法',
'id' => 289457,
],
[
'children' => ['CreateTrainingJob', 'CreateInstanceWebTerminal', 'CheckInstanceWebTerminal', 'DeleteTrainingJob', 'DeleteTrainingJobLabels', 'GetTrainingJob', 'GetTrainingJobErrorInfo', 'GetTrainingJobLatestMetrics', 'ListTrainingJobs', 'ListTrainingJobEvents', 'ListTrainingJobInstanceEvents', 'ListTrainingJobInstanceMetrics', 'ListTrainingJobLogs', 'ListTrainingJobMetrics', 'ListTrainingJobOutputModels', 'StopTrainingJob', 'UpdateTrainingJobLabels'],
'type' => 'directory',
'title' => '训练任务',
'id' => 289438,
],
[
'children' => ['ScaleQuota', 'ListQuotaWorkloads', 'ListQuotaActiveUserUsages'],
'type' => 'directory',
'title' => '资源配额',
'id' => 289430,
],
[
'children' => ['GetSpotPriceHistory', 'ListNodeTypes', 'OperateNode', 'CreateQuota', 'CreateResourceGroup', 'DeleteMachineGroup', 'DeleteQuota', 'DeleteResourceGroup', 'GetMachineGroup', 'GetQuota', 'GetResourceGroup', 'GetToken', 'ListNodes', 'ListQuotas', 'ListResourceGroups', 'ListTagResources', 'TagResources', 'UntagResources', 'UpdateQuota', 'UpdateResourceGroup'],
'type' => 'directory',
'title' => '其他',
'id' => 289483,
],
],
'components' => [
'schemas' => [
'ACS' => [
'title' => 'ACS Quota Related Configuration',
'description' => 'ACS相关配置。',
'type' => 'object',
'properties' => [
'ACSQuotaId' => ['title' => 'ACS Identifier', 'description' => 'ACS资源ID。', 'type' => 'string', 'example' => 'rq-3kbt2gtimmyw7fgfgothocvh'],
'AssociatedProducts' => [
'title' => 'Products that can use ACS Quota',
'description' => '可使用ACS Quota的产品码。'."\n"
."\n"
.'约束:'."\n"
.'可以选多个子产品,但有些子产品之间存在互斥关系。可同时选择:'."\n"
.'- PAI-DLC、PAI-DSW'."\n"
.'- PAI-EAS',
'type' => 'array',
'items' => ['description' => '使用ACS资源的产品码。', 'type' => 'string', 'example' => 'PAI-DLC'],
],
],
],
'Action' => [
'title' => '任务操作配置',
'description' => '操作配置',
'type' => 'object',
'properties' => [
'ActionType' => ['title' => '操作类型', 'type' => 'string'],
],
],
'AlgorithmSpec' => [
'title' => 'Defines how the training job of the algorithm run.',
'description' => '算法定义。',
'type' => 'object',
'properties' => [
'OutputChannels' => [
'title' => 'The outputs of the algorithm.',
'description' => '算法输出通道列表。',
'type' => 'array',
'items' => ['description' => '算法输出通道。', '$ref' => '#/components/schemas/Channel'],
],
'HyperParameters' => [
'title' => 'The hype parameter used by the algorithm.',
'description' => '超参数定义列表。',
'type' => 'array',
'items' => ['description' => '超参数定义。', '$ref' => '#/components/schemas/HyperParameterDefinition'],
],
'JobType' => [
'title' => 'Job type of the training job while running the algorithm.',
'description' => '任务类型。',
'type' => 'string',
'required' => true,
'example' => 'TFJob',
'enum' => ['TFJob', 'PyTorchJob', 'XGBoostJob', 'ElasticBatchJob'],
],
'Command' => [
'title' => 'The command used for submit the job.',
'description' => '训练任务运行命令列表。',
'type' => 'array',
'items' => ['description' => '训练任务运行命令。', 'type' => 'string', 'example' => 'python train.py'],
'required' => true,
],
'MetricDefinitions' => [
'title' => 'The output metrics of the algorithm.',
'description' => '训练任务指标采集定义列表。',
'type' => 'array',
'items' => ['description' => '训练任务指标采集定义。', '$ref' => '#/components/schemas/MetricDefinition'],
],
'InputChannels' => [
'title' => 'The input for the algorithm.',
'description' => '算法输入通道列表。',
'type' => 'array',
'items' => ['description' => '算法输入通道。', '$ref' => '#/components/schemas/Channel'],
'required' => false,
],
'SupportsDistributedTraining' => ['title' => 'Indicates whether the algorithm support distributed training.', 'description' => '是否支持分布式训练。', 'type' => 'boolean', 'example' => 'true'],
'Image' => ['title' => 'The docker image used by the job of this algorithm.', 'description' => '训练镜像。', 'type' => 'string', 'required' => true, 'example' => 'registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0'],
'SupportedInstanceTypes' => [
'title' => 'A list of ECS instances that the algorithm can use to submit training job.',
'description' => '训练支持的弹性计算实例列表。',
'type' => 'array',
'items' => ['description' => '训练支持的弹性计算实例。', 'type' => 'string', 'example' => 'ecs.g6.2xlarge'],
'deprecated' => false,
],
'ComputeResource' => [
'title' => 'Compute resource',
'description' => '计算资源定义。',
'type' => 'object',
'properties' => [
'Policy' => [
'title' => 'Policy',
'description' => '算法的计算资源配置策略。',
'type' => 'object',
'properties' => [
'Version' => ['title' => 'Policy Version', 'description' => '配置策略版本。', 'type' => 'string', 'required' => true, 'example' => 'V1'],
'Value' => ['title' => 'Policy Value', 'description' => '策略内容,由json数组序列化而成。', 'type' => 'string', 'required' => true, 'example' => '[{\\"MinTotalCount\\":1,\\"MaxTotalCount\\":4,\\"RolePolicies\\":{\\"chief\\":{\\"Count\\":1},\\"ps\\":{\\"Count\\":1},\\"worker\\":{\\"Percentage\\":100}}},{\\"MinTotalCount\\":5,\\"MaxTotalCount\\":10,\\"RolePolicies\\":{\\"chief\\":{\\"Count\\":1},\\"ps\\":{\\"Percentage\\":20},\\"worker\\":{\\"Percentage\\":80}}},{\\"MinTotalCount\\":11,\\"RolePolicies\\":{\\"chief\\":{\\"Count\\":1},\\"ps\\":{\\"Percentage\\":40},\\"worker\\":{\\"Percentage\\":60}}}]'],
],
'required' => true,
],
],
],
'CodeDir' => ['description' => '自定义代码配置。', '$ref' => '#/components/schemas/Location'],
'Customization' => [
'title' => 'Customization',
'description' => '自定义配置。',
'type' => 'object',
'properties' => [
'CodeDir' => ['title' => 'CodeDir', 'description' => '是否使用自定义挂载的代码。', 'type' => 'boolean', 'example' => 'true'],
],
],
'ResourceRequirements' => [
'title' => 'Resource requirements.',
'description' => '资源需求。',
'type' => 'array',
'items' => ['description' => '资源需求表达式。', '$ref' => '#/components/schemas/ConditionExpression'],
],
'ProgressDefinitions' => [
'title' => 'ProgressDefinitions',
'description' => '训练进度监控。',
'type' => 'object',
'properties' => [
'OverallProgress' => [
'title' => 'OverallProgress',
'description' => '训练进度监控。',
'type' => 'object',
'properties' => [
'Description' => ['title' => 'Description', 'description' => '监控描述。', 'type' => 'string', 'example' => 'training progress'],
'Regex' => ['title' => 'Regex', 'description' => '监控正则表达式。', 'type' => 'string', 'example' => '^[0-9]+([.][0-9]+){0,1}$'],
],
],
'RemainingTime' => [
'title' => 'RemainingTime',
'description' => '训练剩余时间监控。',
'type' => 'object',
'properties' => [
'Description' => ['title' => 'Description', 'description' => '监控描述。', 'type' => 'string', 'example' => 'training remaining time'],
'Regex' => ['title' => 'Regex', 'description' => '监控正则表达式。', 'type' => 'string', 'example' => '^[0-9]+([.][0-9]+){0,1}$'],
],
],
],
],
],
],
'AllocatedHyperNodeDetail' => [
'type' => 'object',
'properties' => [
'HyperNodeName' => ['title' => '超节点名', 'type' => 'string'],
'AllocatedNodeNum' => ['title' => '已分配节点数', 'type' => 'integer', 'format' => 'int64'],
'TotalNodeNum' => ['title' => '全部', 'type' => 'integer', 'format' => 'int64'],
'EmptyNodeNum' => ['title' => '空闲节点数', 'type' => 'integer', 'format' => 'int64'],
],
],
'AssignNodeSpec' => [
'type' => 'object',
'properties' => [
'EnableAssignNode' => ['type' => 'boolean'],
'NodeNames' => ['type' => 'string'],
'AntiAffinityNodeNames' => ['type' => 'string'],
],
],
'BindingPolicy' => [
'title' => '绑定节点规则',
'description' => '绑定节点规则',
'type' => 'object',
'properties' => [
'NodeSpecCount' => ['title' => '由调度器选择节点数量', 'description' => '由调度器选择节点数量', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'IncludeNodes' => [
'title' => '必须包含的节点名称列表',
'description' => '必须包含的节点名称列表',
'type' => 'array',
'items' => ['description' => '强制添加的节点id', 'type' => 'string', 'example' => 'lrnabc'],
],
'ExcludeNodes' => [
'title' => '不可包含的节点名称列表',
'description' => '不可包含的节点名称列表',
'type' => 'array',
'items' => ['description' => '强制不包含的节点id', 'type' => 'string', 'example' => 'lrndef'],
],
],
],
'CacheInfo' => [
'type' => 'object',
'properties' => [
'MountPoint' => ['type' => 'string'],
'Port' => ['type' => 'string'],
],
],
'CacheService' => [
'type' => 'object',
'properties' => [
'CacheServiceId' => ['type' => 'string'],
'QuotaId' => ['type' => 'string'],
'UserVpc' => ['$ref' => '#/components/schemas/UserVpc'],
'CacheInfos' => [
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/CacheInfo'],
],
'SupportedClientQuotaIds' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
'TenantId' => ['type' => 'string'],
'UserId' => ['type' => 'string'],
'CreatedBy' => ['type' => 'string'],
'GmtCreated' => ['type' => 'string'],
'Status' => ['type' => 'string'],
'SupportRDMA' => ['type' => 'string'],
'NetworkType' => ['type' => 'string'],
'ClusterId' => ['type' => 'string'],
'IsSharded' => ['type' => 'boolean'],
],
],
'CapacityLock' => [
'type' => 'object',
'properties' => [
'id' => ['type' => 'string'],
'gmtCreated' => ['type' => 'string'],
'gmtModified' => ['type' => 'string'],
'lockProvider' => ['type' => 'string'],
'privatePoolId' => ['type' => 'string'],
'tenantId' => ['type' => 'string'],
'instanceType' => ['type' => 'string'],
'zoneId' => ['type' => 'string'],
'paymentType' => ['type' => 'string'],
'status' => ['type' => 'string'],
'lastSyncTime' => ['type' => 'string'],
'lastReconcileAttemptTime' => ['type' => 'string'],
'crsReservationId' => ['type' => 'string'],
'expireTime' => ['type' => 'string'],
'operator' => ['type' => 'string'],
'description' => ['type' => 'string'],
'requestedCount' => ['type' => 'integer', 'format' => 'int32'],
'lockedCount' => ['type' => 'integer', 'format' => 'int32'],
'usedCount' => ['type' => 'integer', 'format' => 'int32'],
'availableCount' => ['type' => 'integer', 'format' => 'int32'],
],
],
'Channel' => [
'title' => 'A named input/output for the algorithm.',
'description' => '输入/输出通道定义。',
'type' => 'object',
'properties' => [
'Description' => ['title' => 'A brief description for the channel.', 'description' => '通道描述。', 'type' => 'string', 'example' => '模型输出。'],
'Required' => ['title' => 'Indicates whethe the channels is required.', 'description' => '通道是否必须配置。', 'type' => 'boolean', 'example' => 'true'],
'Properties' => ['title' => 'The properties of channel.', 'description' => '通道的存储配置。', 'type' => 'object', 'example' => '{}'],
'Name' => ['title' => 'The name of channel.', 'description' => '通道名。', 'type' => 'string', 'required' => true, 'example' => 'Model'],
'SupportedChannelTypes' => [
'title' => 'Supported Channel Types',
'description' => '通道支持的存储类型列表。',
'type' => 'array',
'items' => ['description' => '存储类型。', 'type' => 'string', 'example' => 'oss'],
'required' => false,
],
],
],
'ClusterSpec' => [
'type' => 'object',
'properties' => [
'ClusterType' => ['type' => 'string'],
'Image' => ['type' => 'string'],
'DataSources' => [
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/DataSource'],
],
],
],
'ComponentSpec' => [
'title' => 'Defines how the training job of the algorithm run.',
'type' => 'object',
'properties' => [
'OutputChannels' => [
'title' => 'The outputs of the algorithm.',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/Channel'],
],
'HyperParameters' => [
'title' => 'The hype parameter used by the algorithm.',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/HyperParameterDefinition'],
],
'JobType' => ['title' => 'Job type of the training job while running the algorithm.', 'type' => 'string', 'required' => true],
'Command' => ['title' => 'The command used for submit the job.', 'type' => 'string', 'required' => true],
'MetricDefinitions' => [
'title' => 'The output metrics of the algorithm.',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/MetricDefinition'],
],
'InputChannels' => [
'title' => 'The input for the algorithm.',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/Channel'],
'required' => false,
],
'Image' => ['title' => 'The docker image used by the job of this algorithm.', 'type' => 'string', 'required' => true],
'CodeDir' => ['$ref' => '#/components/schemas/Location'],
'ResourceRequirements' => [
'title' => 'Resource requirements.',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/ConditionExpression'],
],
],
],
'ConditionExpression' => [
'title' => 'A short description of struct',
'description' => '资源需求配置。',
'type' => 'object',
'properties' => [
'Key' => ['title' => 'The key of the conditional expression.', 'description' => '需要资源的种类。', 'type' => 'string', 'required' => true, 'example' => 'SupportedMachineTypes'],
'Operator' => ['title' => 'The operator of the conditional expression', 'description' => '判断标准。', 'type' => 'string', 'required' => true, 'example' => 'in'],
'Values' => [
'title' => 'The values of the conditional expression.',
'description' => '资源值列表。',
'type' => 'array',
'items' => ['description' => '资源值。', 'type' => 'string', 'example' => 'ecs.gn5-c4g1.xlarge'],
'required' => true,
],
],
],
'DataSource' => [
'type' => 'object',
'properties' => [
'DataSourceId' => ['type' => 'string'],
'MountPath' => ['type' => 'string'],
'Uri' => ['type' => 'string'],
],
],
'EcsSpec' => [
'type' => 'object',
'properties' => [
'InstanceType' => ['type' => 'string'],
'Cpu' => ['type' => 'integer', 'format' => 'int32'],
'Gpu' => ['type' => 'integer', 'format' => 'int32'],
'GpuType' => ['type' => 'string'],
'GpuTypeAlias' => ['type' => 'string'],
'Memory' => ['type' => 'integer', 'format' => 'int32'],
'SupportRDMA' => ['type' => 'boolean'],
'EriQuantity' => ['type' => 'integer', 'format' => 'int32'],
'SupportSetNetworkCardIndex' => ['type' => 'boolean'],
'AcceleratorType' => ['type' => 'string'],
'PlannedCpu' => ['type' => 'integer', 'format' => 'int32'],
'PlannedMemory' => ['type' => 'integer', 'format' => 'int32'],
'ResourceType' => ['type' => 'string'],
'EcsImageId' => ['type' => 'string'],
'GpuGUSpec' => ['type' => 'string'],
'GpuMemory' => ['type' => 'integer', 'format' => 'int32'],
'MachineModel' => ['type' => 'string'],
'SupportGPUShare' => ['type' => 'boolean'],
'NetworkMode' => ['type' => 'string'],
],
],
'EniCacheConfig' => [
'type' => 'object',
'properties' => [
'Enabled' => ['type' => 'boolean'],
'CachePoolSize' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '255'],
],
],
'Event' => [
'type' => 'object',
'properties' => [
'ObjectId' => ['type' => 'string'],
'TriggeredBy' => ['type' => 'string'],
'TriggerUserId' => ['type' => 'string'],
'EventId' => ['type' => 'string'],
'EventType' => ['type' => 'string'],
'ObjectType' => ['type' => 'string'],
'TriggerTenantId' => ['type' => 'string'],
'TriggerTime' => ['type' => 'string'],
'IsTruncated' => ['type' => 'boolean'],
'Content' => ['type' => 'string'],
'Function' => ['type' => 'string'],
],
],
'Features' => [
'title' => '灰度功能',
'description' => '灰度功能',
'type' => 'object',
'properties' => [
'Quota' => [
'title' => 'Quota功能',
'type' => 'object',
'properties' => [
'IsEnabled' => ['title' => '是否开启', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'ForwardInfo' => [
'title' => 'User VPC Forward Info',
'description' => '用户 VPC 转发信息',
'type' => 'object',
'properties' => [
'NatGatewayId' => ['title' => 'NAT Gateway ID', 'description' => 'NAT 网关 ID', 'type' => 'string', 'example' => 'nat-7j4mka9wguxj'],
'EipAllocationId' => ['title' => 'EIP Allocation ID', 'description' => 'EIP 分配 ID', 'type' => 'string', 'example' => 'eip-h29r78ieufbih'],
],
],
'GPUInfo' => [
'title' => 'A short description of struct',
'description' => 'pai resource group ecs spec',
'type' => 'object',
'properties' => [
'count' => ['title' => '数量', 'description' => '数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'type' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'example' => 'T4'],
],
],
'GPUMetric' => [
'title' => 'A short description of struct',
'description' => 'GPU指标',
'type' => 'object',
'properties' => [
'Index' => ['title' => 'GPU编号', 'type' => 'integer', 'format' => 'int64'],
'Model' => ['title' => '显卡型号', 'type' => 'string'],
'UsageRate' => ['title' => 'GPU使用率', 'type' => 'number', 'format' => 'float'],
'Status' => ['title' => '卡状态', 'type' => 'integer', 'format' => 'int64', 'example' => '0:异常;1:正常'],
],
],
'HyperParameterDefinition' => [
'title' => 'Definition of the input hyper parameter for the algorithm.',
'description' => '超参数定义。',
'type' => 'object',
'properties' => [
'DefaultValue' => ['title' => 'Default value for the parameter.', 'description' => '超参数默认值。', 'type' => 'string', 'example' => '0'],
'Type' => ['title' => 'Type of the parameter.', 'description' => '超参数类型。', 'type' => 'string', 'required' => true, 'example' => 'Integer'],
'Description' => ['title' => 'Description for the parameter.', 'description' => '超参数描述。', 'type' => 'string', 'example' => '参数定义了训练的batch_size。'],
'Required' => ['title' => 'Indicates whether the parameter is required', 'description' => '参数是否为必须参数。', 'type' => 'boolean', 'example' => 'true'],
'Name' => ['title' => 'Name of the parameter.', 'description' => '参数名。', 'type' => 'string', 'required' => true, 'example' => 'batch_size'],
'Range' => ['description' => '参数取值范围。', '$ref' => '#/components/schemas/HyperParameterRange'],
'DisplayName' => ['title' => 'Display name of parameter.', 'description' => '参数展示名。', 'type' => 'string', 'example' => 'Batch Size'],
],
],
'HyperParameterRange' => [
'title' => 'A short description of struct',
'description' => '超参数取值范围。',
'type' => 'object',
'properties' => [
'Enum' => [
'title' => 'Enumerated values for hyperparameters.',
'description' => '超参数枚举列表。',
'type' => 'array',
'items' => ['description' => '枚举值。', 'type' => 'string', 'example' => '0'],
'required' => false,
],
'MinLength' => ['title' => 'Minimum length of string.', 'description' => '最小长度。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'MaxLength' => ['title' => 'Maximum length of string.', 'description' => '最大长度。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'Minimum' => ['title' => 'Minimum value.', 'description' => '最小值。', 'type' => 'string', 'example' => '0'],
'Maximum' => ['title' => 'Maximum value.', 'description' => '最大值。', 'type' => 'string', 'example' => '10'],
'ExclusiveMinimum' => ['title' => 'Whether to exclude minimum values.', 'description' => '取值范围是否排除最小值。', 'type' => 'boolean', 'example' => 'true'],
'ExclusiveMaximum' => ['title' => 'Whether to exclude maximum values', 'description' => '取值范围是否排除最大值。', 'type' => 'boolean', 'example' => 'true'],
'Pattern' => ['title' => 'Value Regex Pattern.', 'description' => '正则表达式。', 'type' => 'string', 'example' => '^\\+?[1-9][0-9]*$'],
],
],
'JobSettings' => [
'title' => '作业额外参数配置',
'description' => '作业额外参数配置。',
'type' => 'object',
'properties' => [
'BusinessUserId' => ['title' => '作业关联用户ID', 'description' => '作业关联用户ID。', 'type' => 'string', 'example' => '166924'],
'Caller' => ['title' => '调用方', 'description' => '调用方。', 'type' => 'string', 'example' => 'SilkFlow'],
'Tags' => [
'title' => '自定义标签',
'description' => '自定义标签。',
'type' => 'object',
'additionalProperties' => ['description' => '自定义标签。', 'type' => 'string'],
],
'PipelineId' => ['title' => '工作流ID', 'description' => '工作流ID。', 'type' => 'string', 'example' => 'pid-123456'],
'EnableTideResource' => ['title' => '允许作业使用潮汐资源', 'description' => '允许作业使用潮汐资源。', 'type' => 'boolean', 'example' => 'true'],
'EnableErrorMonitoringInAIMaster' => ['title' => '允许打开作业容错监控', 'description' => '允许打开作业容错监控。', 'type' => 'boolean', 'example' => 'false'],
'ErrorMonitoringArgs' => ['title' => '用户指定容错监控的配置参数,比如指定是否启动基于log hang的检测', 'description' => '用户指定容错监控的配置参数,比如指定是否启动基于log hang的检测。', 'type' => 'string', 'example' => '--enable-log-hang-detection true'],
'EnableRDMA' => ['title' => '允许作业使用RDMA', 'description' => '允许作业使用RDMA。', 'type' => 'boolean', 'example' => 'true'],
'EnableOssAppend' => ['title' => '运行oss追加写', 'description' => '运行OSS追加写。', 'type' => 'boolean', 'example' => 'true'],
'OversoldType' => ['title' => '作业的超卖资源使用方式(不接受/可接受/只接受)', 'description' => '作业的超卖资源使用方式(不接受/可接受/只接受)。', 'type' => 'string', 'example' => 'AcceptQuotaOverSold'],
'AdvancedSettings' => ['title' => '额外高级参数配置', 'description' => '额外高级参数配置。', 'type' => 'object'],
'Driver' => ['title' => 'NVIDAI驱动配置', 'description' => 'NVIDAI驱动配置。', 'type' => 'string', 'example' => '535.54.03'],
'EnableSanityCheck' => ['title' => '允许作业开启算力健康检测', 'description' => '允许作业开启算力健康检测。', 'type' => 'boolean', 'example' => 'true'],
'SanityCheckArgs' => ['title' => '算力健康检测的配置参数', 'description' => '算力健康检测的配置参数。', 'type' => 'string', 'example' => '--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFai'],
'JobReservedMinutes' => ['title' => '作业结束后保留的时长,单位分钟', 'description' => '作业结束后保留的时长,单位分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'JobReservedPolicy' => [
'title' => '作业结束后保留的策略',
'description' => '作业结束后保留的策略。',
'type' => 'string',
'example' => 'Always',
'enum' => ['Always', 'OnFailure', 'OnSucceed'],
],
],
],
'JobViewMetric' => [
'title' => 'A short description of struct',
'description' => 'resource group metric',
'type' => 'object',
'properties' => [
'ResourceGroupID' => ['title' => '资源组ID', 'type' => 'string', 'example' => 'rg17tmvwiokhzaxg'],
'TotalCPU' => ['title' => '总的CPU核心数', 'type' => 'integer', 'format' => 'int32'],
'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'],
'GPUUsageRate' => ['title' => 'GPU使用率', 'type' => 'string'],
'TotalMemory' => ['title' => '总内存kb', 'type' => 'integer', 'format' => 'int64'],
'TotalGPU' => ['title' => '总的GPU卡数', 'type' => 'integer', 'format' => 'int32'],
'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'],
'RequestCPU' => ['title' => '占用的CPU核心数', 'type' => 'integer', 'format' => 'int32'],
'RequestGPU' => ['title' => '占用的GPU核心数', 'type' => 'integer', 'format' => 'int32'],
'RequestMemory' => ['title' => '占用的内存kb', 'type' => 'integer', 'format' => 'int64'],
'NetworkInputRate' => ['title' => '网络写入速率', 'type' => 'string'],
'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'],
'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'],
'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'],
'JobType' => ['title' => '任务类型dlc,dsw /etc', 'type' => 'string'],
'UserId' => ['title' => '用户ID', 'type' => 'string'],
'NodeNames' => [
'title' => '节点列表',
'type' => 'array',
'items' => ['type' => 'string'],
],
'JobId' => ['title' => '任务ID', 'type' => 'string'],
],
],
'Label' => [
'title' => 'A short description of struct',
'description' => 'label 结构体',
'type' => 'object',
'properties' => [
'Key' => ['title' => 'Key of label.', 'description' => 'label的key', 'type' => 'string', 'example' => 'testAccTag'],
'Value' => ['title' => 'Value of label.', 'description' => 'label的值.', 'type' => 'string', 'example' => 'nihao'],
],
],
'Location' => [
'title' => 'A short description of struct',
'description' => '代码配置。',
'type' => 'object',
'properties' => [
'LocationType' => ['title' => 'Location type, such as OSS,Git.', 'description' => '代码地址类型,可选:OSS,NAS。', 'type' => 'string', 'example' => 'OSS'],
'LocationValue' => ['title' => 'Location value.', 'description' => '代码路径。', 'type' => 'object', 'example' => 'oss://${bucket_name}.oss-${region}.aliyuncs.com/oss/location/path/'],
],
],
'MachineGroup' => [
'description' => '机器组信息',
'type' => 'object',
'properties' => [
'Status' => ['title' => '机器组状态', 'description' => '机器组状态', 'type' => 'string', 'example' => 'Success'],
'EcsCount' => ['title' => '资源数量', 'description' => '资源数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'GmtStartedTime' => ['title' => '启动时间', 'description' => '启动时间', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'ResourceGroupID' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'],
'GmtCreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'CreatorID' => ['title' => '机器组创建者ID', 'description' => '机器组创建者ID', 'type' => 'string', 'example' => '1612285282502324'],
'ReasonMessage' => ['title' => '机器组错误消息', 'description' => '机器组错误消息', 'type' => 'string', 'example' => '“”'],
'PaymentDurationUnit' => ['title' => 'region ID', 'description' => 'region ID', 'type' => 'string', 'example' => 'Monthly'],
'EcsSpec' => ['title' => 'ecs规格', 'description' => 'ecs规格', 'type' => 'string', 'example' => 'ecs.c6.large'],
'SupportedDrivers' => [
'title' => '机器组可支持的NVIDIA GPU驱动版本列表',
'description' => '机器组可支持的NVIDIA GPU驱动版本列表',
'type' => 'array',
'items' => ['description' => '驱动版本号', 'type' => 'string', 'example' => '470.199.02'],
],
'PaymentDuration' => ['title' => '持续时长', 'description' => '持续时长', 'type' => 'string', 'example' => '2'],
'ReasonCode' => ['title' => '机器组错误码', 'description' => '机器组错误码', 'type' => 'string', 'example' => '“”'],
'GmtModifiedTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'DiskCapacity' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'GmtExpiredTime' => ['title' => '过期时间', 'description' => '过期时间', 'type' => 'string', 'example' => '2023-08-22T00:00:00Z'."\n"],
'OrderInstanceId' => ['title' => '订单ID', 'description' => '订单ID', 'type' => 'string', 'example' => '“”'],
'DefaultDriver' => ['title' => '机器组支持的默认驱动', 'description' => '机器组支持的默认驱动', 'type' => 'string', 'example' => '470.199.02'],
'MachineGroupID' => ['title' => '机器组ID', 'description' => '机器组ID', 'type' => 'string', 'example' => 'mg1'],
'PaymentType' => ['title' => '付费类型', 'description' => '付费类型', 'type' => 'string', 'example' => 'PREPAY'],
'DiskPL' => ['type' => 'string', 'description' => ''],
'Cpu' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'Gpu' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'GpuMemory' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'GpuType' => ['type' => 'string', 'description' => ''],
'Memory' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'ResourceType' => ['type' => 'string', 'description' => ''],
'AllocatableCpu' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'AllocatableMemory' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'SystemReservedCpu' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'SystemReservedMemory' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
],
],
'Metric' => [
'title' => '指标',
'description' => '资源组指标数据。',
'type' => 'object',
'properties' => [
'Time' => ['title' => '时间戳', 'description' => '时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => 'rg17tmvwiokh****'],
'Value' => ['title' => '指标值', 'description' => '指标值。', 'type' => 'string', 'example' => '23000'],
],
],
'MetricDefinition' => [
'title' => 'Describe the output metric of the algorithm.',
'description' => '训练指标采集定义。',
'type' => 'object',
'properties' => [
'Description' => ['title' => 'A brief description for the metric.', 'description' => '指标描述。', 'type' => 'string', 'example' => '训练损失函数。'],
'Regex' => ['title' => 'Regex use to match the metrics from job log.', 'description' => '日志中采集指标的正则表达式。', 'type' => 'string', 'required' => true, 'example' => '.*train:loss=([-+]?[0-9]*\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*'],
'Name' => ['title' => 'The name of the metric.', 'description' => '指标名。', 'type' => 'string', 'required' => true, 'example' => 'loss'],
],
],
'Node' => [
'title' => '资源节点',
'description' => '资源节点',
'type' => 'object',
'properties' => [
'CreatorId' => ['title' => '资源节点创建人', 'description' => '资源节点创建人', 'type' => 'string', 'example' => '281044699048527748'],
'NodeName' => ['title' => '资源节点名称', 'description' => '资源节点名称', 'type' => 'string', 'example' => 'lingjxxxx'],
'NodeType' => ['title' => '资源节点规格类型', 'description' => '资源节点规格类型', 'type' => 'string', 'example' => 'ecs.c8i.xlarge'],
'AcceleratorType' => ['title' => '资源节点规格加速器类型(CPU/GPU)', 'description' => '资源节点规格加速器类型(CPU/GPU)', 'type' => 'string', 'example' => 'CPU'],
'CPU' => ['title' => 'CPU核数', 'description' => 'CPU核数', 'type' => 'string', 'example' => '4'],
'Memory' => ['title' => '内存大小', 'description' => '内存大小', 'type' => 'string', 'example' => '8'],
'GPU' => ['title' => 'GPU卡数', 'description' => 'GPU卡数', 'type' => 'string', 'example' => '0'],
'GPUType' => ['title' => 'GPU卡型号', 'description' => 'GPU卡型号', 'type' => 'string', 'example' => '""'],
'GPUMemory' => ['title' => 'GPU显存', 'description' => 'GPU显存', 'type' => 'string'],
'NodeStatus' => ['title' => '资源节点状态', 'description' => '资源节点状态', 'type' => 'string', 'example' => 'Ready'],
'ReasonCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '""'],
'ReasonMessage' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '""'],
'OrderStatus' => ['title' => '资源节点订单状态', 'description' => '资源节点订单状态', 'type' => 'string', 'example' => 'Ready'],
'ResourceGroupId' => ['title' => '资源节点所属资源组Id', 'description' => '资源节点所属资源组Id', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'],
'ResourceGroupName' => ['title' => '资源节点所属资源组名称', 'description' => '资源节点所属资源组名称', 'type' => 'string', 'example' => 'test'],
'MachineGroupId' => ['title' => '资源节点所属机器组Id', 'description' => '资源节点所属机器组Id', 'type' => 'string', 'example' => 'mg1234456'],
'GmtCreateTime' => ['title' => '资源节点创建时间', 'description' => '资源节点创建时间', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z', 'deprecated' => true],
'GmtCreatedTime' => ['title' => '资源节点创建时间', 'type' => 'string'],
'GmtModifiedTime' => ['title' => '资源节点更新时间', 'description' => '资源节点更新时间', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'GmtExpiredTime' => ['title' => '资源节点过期时间', 'description' => '资源节点过期时间', 'type' => 'string', 'example' => '2025-06-22T00:00:00Z'."\n"],
'IsBound' => ['title' => '是否已经绑定了Quota', 'description' => '是否已经绑定了Quota', 'type' => 'boolean', 'example' => 'false'],
'BoundQuotas' => [
'title' => '绑定的Quota列表',
'description' => '绑定的Quota列表',
'type' => 'array',
'items' => ['description' => '所绑定的Quota信息。', '$ref' => '#/components/schemas/QuotaIdName'],
],
'RequestCPU' => ['title' => '申请CPU核数', 'description' => '申请CPU核数', 'type' => 'string', 'example' => '4'],
'RequestMemory' => ['title' => '申请内存大小', 'description' => '申请内存大小', 'type' => 'string', 'example' => '8'],
'RequestGPU' => ['title' => '申请GPU核数', 'description' => '申请GPU核数', 'type' => 'string', 'example' => '0'],
'LimitCPU' => ['title' => '限制CPU核数', 'description' => '限制CPU核数', 'type' => 'string', 'example' => '4'],
'LimitMemory' => ['title' => '限制内存大小', 'description' => '限制内存大小', 'type' => 'string', 'example' => '8'],
'LimitGPU' => ['title' => '限制GPU核数', 'description' => '限制GPU核数', 'type' => 'string', 'example' => '0'],
'PodNum' => ['title' => '节点上Pod数量', 'description' => '节点上Pod数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'WorkloadNum' => ['title' => '节点上Workload数量', 'description' => '节点上Workload数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Users' => [
'title' => '用户信息',
'description' => '用户信息',
'type' => 'array',
'items' => ['description' => '在该节点上运行workload的用户信息。', '$ref' => '#/components/schemas/UserInfo'],
],
'HyperZone' => ['type' => 'string', 'description' => ''],
'AvailabilityZone' => ['type' => 'string', 'description' => ''],
'AllocatableCPU' => ['title' => '用户可分配CPU核数', 'description' => '用户可分配CPU核数', 'type' => 'string'],
'AllocatableMemory' => ['title' => '用户可分配内存大小', 'description' => '用户可分配内存大小', 'type' => 'string'],
'SystemReservedCPU' => ['title' => '系统预留CPU核数', 'description' => '系统预留CPU核数', 'type' => 'string'],
'SystemReservedMemory' => ['title' => '系统预留内存大小', 'description' => '系统预留内存大小', 'type' => 'string'],
'AncestorQuotaWorkloadNum' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'SelfQuotaWorkloadNum' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'DescendantQuotaWorkloadNum' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'DiskPL' => ['type' => 'string', 'description' => ''],
'DiskCapacity' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'SubNodes' => [
'title' => '子节点名称',
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'NodeCordonParameters' => [
'description' => '节点禁止调度参数配置',
'type' => 'object',
'properties' => [
'QuotaId' => ['title' => 'Quota Id,在工作空间禁止节点调度时使用', 'description' => 'Quota Id,在工作空间禁止节点调度时使用', 'type' => 'string', 'example' => 'quota1dkoutl3tj1'],
'WorkspaceId' => ['title' => 'Workspace Id,在工作空间禁止节点调度时使用', 'description' => 'Workspace Id,在工作空间禁止节点调度时使用', 'type' => 'string', 'example' => '12345'],
'Comment' => ['title' => '用户可配置禁止调度原因', 'description' => '用户可配置禁止调度原因', 'type' => 'string', 'example' => 'this is a comment'],
],
],
'NodeDrainParameters' => [
'description' => '清空节点操作参数',
'type' => 'object',
'properties' => [
'PodNames' => [
'title' => '清空指定Pod',
'description' => '清空指定Pod',
'type' => 'array',
'items' => ['title' => 'Pod名称', 'description' => 'Pod名称', 'type' => 'string', 'example' => 'dlcxxxx-master-0'],
],
'PodFromSubProducts' => [
'title' => '清空指定任务类型的Pod',
'description' => '清空指定任务类型的Pod',
'type' => 'array',
'items' => ['title' => '任务类型:dlc/dsw/eas/tensorboard', 'description' => '任务类型:dlc/dsw/eas/tensorboard', 'type' => 'string', 'example' => 'dlc'],
],
'Force' => ['type' => 'boolean'],
],
],
'NodeGPUMetric' => [
'title' => '节点GPU指标',
'description' => '节点GPU指标',
'type' => 'object',
'properties' => [
'NodeId' => ['title' => '节点ID', 'type' => 'string'],
'NodeType' => ['title' => '节点类型', 'type' => 'string'],
'GPUType' => ['title' => 'GPU类型', 'type' => 'string'],
'GPUCount' => ['title' => 'GPU数量', 'type' => 'integer', 'format' => 'int32'],
'AcceleratorType' => ['title' => '显卡类型', 'type' => 'string'],
'TotalMemory' => ['title' => '总内存', 'type' => 'number', 'format' => 'float'],
'UsedMemory' => ['title' => '已用内存', 'type' => 'number', 'format' => 'float'],
'MemoryUtil' => ['title' => '内存使用率', 'type' => 'number', 'format' => 'float'],
'GPUMetrics' => [
'title' => 'GPU指标',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/GPUMetric'],
],
],
],
'NodeMetric' => [
'title' => '资源节点维度历史指标',
'description' => '资源组节点指标。',
'type' => 'object',
'properties' => [
'NodeID' => ['title' => '节点ID', 'description' => '节点ID。', 'type' => 'string', 'example' => '-i12****node'],
'Metrics' => [
'title' => '性能指标',
'description' => '性能指标。',
'type' => 'array',
'items' => ['description' => '指标信息。', '$ref' => '#/components/schemas/Metric'],
'example' => '23000',
],
'GPUType' => ['title' => '显卡的类型', 'description' => '显卡的类型。', 'type' => 'string', 'example' => 'GU108'],
],
],
'NodeOperationParameters' => [
'description' => '节点操作参数配置',
'type' => 'object',
'properties' => [
'CordonParameters' => ['description' => '节点禁止调度参数配置', '$ref' => '#/components/schemas/NodeCordonParameters'],
'UncordonParameters' => ['description' => '节点启动调度参数配置', '$ref' => '#/components/schemas/NodeUncordonParameters'],
'DrainParameters' => ['description' => '节点驱逐任务实例参数配置', '$ref' => '#/components/schemas/NodeDrainParameters'],
],
],
'NodeOperationResult' => [
'title' => '节点操作结果',
'description' => '节点操作结果',
'type' => 'object',
'properties' => [
'NodeName' => ['title' => '节点名称', 'type' => 'string'],
'Status' => ['title' => '节点操作状态', 'type' => 'string'],
'Message' => ['title' => '节点操作状态信息', 'type' => 'string'],
],
],
'NodePodInfo' => [
'title' => '节点上的Pod信息',
'type' => 'object',
'properties' => [
'PodName' => ['title' => 'Pod名称', 'type' => 'string', 'required' => false, 'example' => 'test'],
'Phase' => ['title' => 'Pod状态', 'type' => 'string', 'required' => false, 'example' => 'Running'],
'PodNamespace' => ['title' => 'Pod所在namespace', 'type' => 'string', 'required' => false, 'example' => 'test'],
'PodIP' => ['title' => 'Pod ip地址', 'type' => 'string', 'example' => '192.168.2.2'],
'ResourceSpec' => ['$ref' => '#/components/schemas/ResourceAmount'],
'WorkloadType' => ['title' => 'Pod属于子产品', 'type' => 'string', 'example' => 'dlc'],
'WorkloadId' => ['title' => '任务id/服务id', 'type' => 'string', 'example' => 'dlc19de9s6vn3acr'],
],
],
'NodeSnapshot' => [
'title' => '节点快照',
'description' => '节点快照',
'type' => 'object',
'properties' => [
'NodeName' => ['title' => '节点名称', 'type' => 'string'],
'RequestCPU' => ['title' => 'CPU用量', 'type' => 'string'],
'RequestMemory' => ['title' => 'Memory用量', 'type' => 'string'],
'RequestGPU' => ['title' => 'GPU用量', 'type' => 'string'],
'Workloads' => [
'title' => '节点任务快照',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'WorkloadId' => ['title' => '任务ID', 'type' => 'string'],
'WorkloadType' => ['title' => '任务类型', 'type' => 'string'],
'Name' => ['title' => '对应排队单元名称', 'type' => 'string'],
],
],
],
'WorkloadNum' => ['title' => '节点workload数量', 'type' => 'integer', 'format' => 'int32'],
'AncestorQuotaWorkloadNum' => ['title' => '使用祖先Quota的workload数量', 'type' => 'integer', 'format' => 'int32'],
'SelfQuotaWorkloadNum' => ['title' => '使用本Quota的Workload数量', 'type' => 'integer', 'format' => 'int32'],
'DescendantQuotaWorkloadNum' => ['title' => '使用子Quota的workload数量', 'type' => 'integer', 'format' => 'int32'],
],
],
'NodeSpec' => [
'title' => '资源节点规格数量',
'description' => '单资源规格信息。',
'type' => 'object',
'properties' => [
'Type' => ['title' => '资源节点规格类型', 'description' => '资源节点规格类型。', 'type' => 'string', 'example' => 'ecs.g6.4xlarge'],
'Count' => ['title' => '资源节点规格数量', 'description' => '资源节点规格数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'BindingPolicy' => ['title' => '资源节点绑定规则', 'description' => '资源节点绑定规则', '$ref' => '#/components/schemas/BindingPolicy'],
'HyperType' => ['title' => '使用的超节点规格。指定规格时,节点规格与超节点不可同时指定。', 'description' => '使用的超节点规格。指定规格时,节点规格与超节点不可同时指定。', 'type' => 'string'],
],
],
'NodeStatistics' => [
'type' => 'object',
'properties' => [
'ActualMinResources' => ['title' => '全部资源量', '$ref' => '#/components/schemas/StatisticsResources'],
'SchedulableResources' => ['title' => '可调度资源量', '$ref' => '#/components/schemas/StatisticsResources'],
'IdleResources' => ['title' => '空闲资源量', '$ref' => '#/components/schemas/StatisticsResources'],
'SystemReservedResources' => ['title' => '系统预留资源量', '$ref' => '#/components/schemas/StatisticsResources'],
'HyperNodeDetails' => [
'title' => '超节点空闲统计',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IdleNum' => ['type' => 'integer', 'format' => 'int64'],
'Count' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
'GPUDetails' => [
'title' => 'GPU空闲统计',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IdleNum' => ['type' => 'integer', 'format' => 'int64'],
'Count' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
],
],
'NodeType' => [
'title' => '资源节点规格详情',
'description' => '资源节点规格',
'type' => 'object',
'properties' => [
'NodeType' => ['title' => '资源节点规格类型', 'type' => 'string', 'example' => 'ecs.g6.4xlarge'],
'AcceleratorType' => ['title' => '资源节点规格加速器类型(CPU/GPU)', 'type' => 'string', 'example' => 'CPU'],
'CPU' => ['title' => 'CPU核数', 'type' => 'string', 'example' => '16'],
'Memory' => ['title' => '内存大小', 'type' => 'string', 'example' => '64Gi'],
'GPU' => ['title' => 'GPU卡数', 'type' => 'string', 'example' => '0'],
'GPUType' => ['title' => 'GPU卡类型', 'type' => 'string'],
'GPUMemory' => ['title' => 'GPU显存', 'type' => 'string', 'example' => '80G'],
'AllocatableCPU' => ['title' => '用户可分配CPU核数', 'type' => 'string'],
'AllocatableMemory' => ['title' => '用户可分配内存大小', 'type' => 'string'],
'SystemReservedCPU' => ['title' => '系统预留CPU核数', 'type' => 'string'],
'SystemReservedMemory' => ['title' => '系统预留内存大小', 'type' => 'string'],
],
],
'NodeTypeStatistic' => [
'title' => '资源节点规格统计信息',
'description' => '资源节点规格统计',
'type' => 'object',
'properties' => [
'NodeType' => ['title' => '资源节点规格', 'type' => 'string', 'example' => 'ecs.g6.4xlarge'],
'TotalCount' => ['title' => '该规格的资源节点总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'CanBeBoundCount' => ['title' => '该规格可被绑定的资源节点数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
],
],
'NodeUncordonParameters' => [
'description' => '节点启动调度参数配置',
'type' => 'object',
'properties' => [
'QuotaId' => ['title' => 'Quota Id,启动工作空间禁止调度节点时使用', 'description' => 'Quota Id,启动工作空间禁止调度节点时使用', 'type' => 'string', 'example' => 'quota1ci8g793pgm'],
'WorkspaceId' => ['title' => 'Workspace Id,启动在工作空间禁止调度的节点时使用', 'description' => 'Workspace Id,启动在工作空间禁止调度的节点时使用', 'type' => 'string', 'example' => '12345'],
],
],
'NodeViewMetric' => [
'title' => '资源节点维度实时指标',
'description' => 'resource group metric',
'type' => 'object',
'properties' => [
'NodeID' => ['title' => '节点ID', 'type' => 'string', 'example' => '-i121212node'],
'NodeType' => ['title' => '显卡的类型', 'type' => 'string'],
'MachineGroupID' => ['title' => '机器组ID', 'type' => 'string'],
'CreatedTime' => ['title' => '节点导入时间', 'type' => 'string'],
'RequestCPU' => ['title' => '已经使用的CPU', 'type' => 'integer', 'format' => 'int64'],
'RequestMemory' => ['title' => '已经使用的内存', 'type' => 'integer', 'format' => 'int64'],
'RequestGPU' => ['title' => '使用的GPU', 'type' => 'integer', 'format' => 'int64'],
'NetworkInputRate' => ['title' => '网络输入速率', 'type' => 'string'],
'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'],
'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'],
'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'],
'TotalCPU' => ['title' => '总的CPU', 'type' => 'integer', 'format' => 'int64'],
'TotalGPU' => ['title' => '总的GPU', 'type' => 'integer', 'format' => 'int64'],
'TotalMemory' => ['title' => '总的内存', 'type' => 'integer', 'format' => 'int64'],
'GPUType' => ['title' => '卡型', 'type' => 'string'],
'UserNumber' => ['title' => '用户总数', 'type' => 'string'],
'UserIDs' => [
'title' => '用户列表',
'type' => 'array',
'items' => ['type' => 'string'],
],
'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'],
'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'],
'NodeStatus' => ['title' => '节点状态', 'type' => 'string'],
'TotalTasks' => ['title' => '节点任务总数', 'type' => 'integer', 'format' => 'int64'],
'TaskIdMap' => ['title' => '节点任务', 'type' => 'object'],
],
],
'OversoldUsageConfig' => [
'type' => 'object',
'properties' => [
'DisabledBy' => ['type' => 'string'],
'Disabled' => ['type' => 'boolean'],
],
],
'Permission' => [
'title' => 'A short description of struct',
'type' => 'object',
'properties' => [
'ResourceType' => ['title' => 'ResourceType', 'type' => 'string'],
'IsEnabled' => ['title' => 'IsEnabled', 'type' => 'boolean'],
],
],
'QueueInfo' => [
'title' => '任务排队信息',
'description' => '队列信息',
'type' => 'object',
'properties' => [
'Status' => ['title' => '状态', 'type' => 'string', 'example' => 'Enqueued'],
'QuotaId' => ['title' => '任务使用的Quota', 'type' => 'string', 'example' => '“quotamtl37ge7gkvdz”'],
'UserName' => ['title' => '用户名', 'type' => 'string'],
'WorkloadId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'dlcxxxx'],
'Position' => ['title' => '队列位置', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'GmtEnqueuedTime' => ['title' => '入队时间', 'type' => 'string', 'example' => '“2023-06-22T00:00:00Z”'],
'Priority' => ['title' => '任务优先级', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'GmtCreatedTime' => ['title' => '任务创建时间', 'type' => 'string'],
'WorkloadType' => ['title' => '任务类型', 'type' => 'string', 'example' => 'dlc'],
'WorkspaceId' => ['title' => '任务所在的工作空间', 'type' => 'string', 'example' => '“432524”'],
'Resource' => ['title' => '使用资源情况', '$ref' => '#/components/schemas/ResourceAmount'],
'Code' => ['title' => '错误码', 'type' => 'string', 'example' => 'roleMaximumResource'],
'Reason' => ['title' => '错误消息', 'type' => 'string', 'example' => 'Current GPU Limit is 5, limited by Role PAI.AlgoDeveloper'],
'UseOversoldResource' => ['type' => 'boolean'],
'Name' => ['title' => '底层QueueUnit名称', 'type' => 'string', 'example' => 'test-label-79f5498dd-9qrzs'],
'WorkloadStatus' => ['title' => 'dlc/dsw/eas 具体状态', 'type' => 'string', 'example' => 'PreAllocation'],
'WorkloadName' => ['title' => '任务名称', 'type' => 'string'],
'UserId' => ['title' => '创建者信息', 'type' => 'string'],
'GmtPositionModifiedTime' => ['title' => '排队位置变化时间', 'type' => 'string', 'example' => '"2023-06-22T00:00:00Z"'],
'CodeType' => ['title' => '错误类型', 'type' => 'string', 'example' => 'ConfigRule'],
'GmtDequeuedTime' => ['title' => '出队列时间', 'type' => 'string', 'example' => '"2023-06-22T00:00:00Z"'],
'WorkspaceName' => ['type' => 'string'],
'QueueStrategy' => ['title' => '所在队列的出队策略', 'type' => 'string', 'example' => 'PaiStrategyIntelligent'],
],
],
'QueueMeta' => [
'type' => 'object',
'properties' => [
'Name' => ['title' => '任务在队列中的名称', 'type' => 'string'],
'QuotaId' => ['title' => '任务所在资源配额队列', 'type' => 'string'],
'Position' => ['title' => '任务在队列中的位置信息(只在排队时生效)', 'type' => 'string'],
'GmtEnqueuedTime' => ['title' => '任务入队时间', 'type' => 'string'],
'GmtPositionModifiedTime' => ['title' => '任务在队列中位置变化时间', 'type' => 'string'],
'GmtDequeuedTime' => ['title' => '任务出队时间', 'type' => 'string'],
'QueueStrategy' => ['title' => '出队策略', 'type' => 'string'],
'Resource' => ['title' => '任务在队列中占用资源信息', '$ref' => '#/components/schemas/ResourceAmount'],
'ScheduledResource' => ['title' => '任务在队列中已占用资源信息', 'type' => 'string'],
'Status' => ['title' => '任务在队列中的状态(入队/出队)', 'type' => 'string'],
'UseOversoldResource' => ['title' => '任务是否使用了闲时资源', 'type' => 'boolean'],
],
],
'Quota' => [
'title' => '资源配额',
'description' => 'Quota信息。',
'type' => 'object',
'properties' => [
'QuotaId' => ['title' => '资源配额ID', 'description' => '资源配额ID。', 'type' => 'string', 'example' => 'quota12345'],
'QuotaName' => ['title' => '资源配额名称', 'description' => '资源配额名称。', 'type' => 'string', 'example' => 'dlc-quota'],
'ResourceType' => ['title' => '资源类型', 'description' => '资源类型,支持:'."\n"
.'- Lingjun'."\n"
.'- ECS(默认值)'."\n"
.'- ACS', 'type' => 'string', 'example' => 'ECS'],
'ParentQuotaId' => ['title' => '父资源配额ID', 'description' => '父资源配额ID。', 'type' => 'string', 'example' => '""'],
'ResourceGroupIds' => [
'title' => '资源组列表',
'description' => '资源组列表。',
'type' => 'array',
'items' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg69rj0leslw****'],
],
'AllocateStrategy' => ['title' => '资源分配策略', 'description' => '资源分配策略。目前仅支持ByNodeSpecs。', 'type' => 'string', 'example' => 'ByNodeSpec'],
'Min' => ['title' => '保障资源', 'description' => '保障资源。', '$ref' => '#/components/schemas/ResourceSpec'],
'Description' => ['title' => '资源配额描述', 'description' => '资源配额描述。', 'type' => 'string', 'example' => 'this is a test quota'],
'Labels' => [
'title' => '资源配额标签',
'description' => '资源配额标签。',
'type' => 'array',
'items' => ['description' => 'Label key value对。', '$ref' => '#/components/schemas/Label'],
],
'CreatorId' => ['title' => '资源配额创建人Id', 'description' => '资源配额创建人ID。', 'type' => 'string', 'example' => '1884692****'],
'LatestOperationId' => ['title' => '资源配额最近变更Id', 'description' => '资源配额最近变更ID。', 'type' => 'string', 'example' => 'operation****'],
'Status' => ['title' => '资源配额状态', 'description' => '资源配额状态。', 'type' => 'string', 'example' => 'Ready'],
'ReasonCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => '“”'],
'ReasonMessage' => ['title' => '错误原因', 'description' => '错误原因。', 'type' => 'string', 'example' => '“”'],
'GmtCreatedTime' => ['title' => '资源配额创建时间', 'description' => '资源配额创建时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'GmtModifiedTime' => ['title' => '资源配额修改时间', 'description' => '资源配额修改时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'QuotaDetails' => ['title' => '资源配额详情', 'description' => '资源配额详情。', '$ref' => '#/components/schemas/QuotaDetails'],
'QuotaConfig' => ['title' => '资源配额配置', 'description' => '资源配额配置。', '$ref' => '#/components/schemas/QuotaConfig'],
'Workspaces' => [
'title' => '资源配额关联的工作空间',
'description' => '资源配额关联的工作空间。',
'type' => 'array',
'items' => ['description' => '所关联的工作空间信息。', '$ref' => '#/components/schemas/WorkspaceIdName'],
],
'SubQuotas' => [
'title' => '资源配额的子Quota列表',
'description' => '资源配额的子Quota列表。',
'type' => 'array',
'items' => ['description' => '包含的子Quota的ID。', '$ref' => '#/components/schemas/QuotaIdName'],
],
'QueueStrategy' => ['title' => '该Quota上的排队策略', 'description' => '该Quota上的排队策略,支持:'."\n"
.'- PaiStrategyIntelligent:智能策略。'."\n"
.'- PaiStrategyBalance:均衡策略。'."\n"
.'- PaiStrategyRoundRobin:资源优先策略。'."\n"
.'- PaiStrategyStrictFIFO:FIFO策略。', 'type' => 'string', 'example' => 'PaiStrategyIntelligent'],
'Version' => ['description' => '版本', 'type' => 'string'],
'QuotaCluster' => ['$ref' => '#/components/schemas/QuotaCluster', 'description' => ''],
'HyperZones' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'description' => '',
],
'GPUType' => ['title' => 'GPU卡型', 'type' => 'string'],
],
],
'QuotaCluster' => [
'type' => 'object',
'properties' => [
'ClusterType' => ['type' => 'string'],
'Image' => ['type' => 'string'],
'DataSources' => [
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/DataSource'],
],
'Endpoints' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
'Status' => ['type' => 'string'],
],
],
'QuotaConfig' => [
'title' => '资源配额配置',
'description' => '资源配额配置。',
'type' => 'object',
'properties' => [
'SupportRDMA' => ['title' => '是否支持RDMA', 'description' => '是否支持RDMA。', 'type' => 'boolean', 'example' => 'false'],
'ClusterId' => ['title' => 'Quota所在集群Id', 'description' => 'Quota所在集群ID。', 'type' => 'string', 'example' => 'ceeb3724255364***'],
'UserVpc' => ['description' => '用户VPC信息。', '$ref' => '#/components/schemas/UserVpc'],
'SupportGPUDrivers' => [
'title' => '资源配额支持的驱动版本',
'description' => '资源配额支持的驱动版本。',
'type' => 'array',
'items' => ['description' => '驱动版本号。', 'type' => 'string', 'example' => '470.199.02'],
],
'DefaultGPUDriver' => ['title' => '资源配额默认的驱动版本', 'description' => '资源配额默认的驱动版本。', 'type' => 'string', 'example' => '470.199.02'],
'ACS' => ['title' => 'ACS conf'."\n"
.'(Deprecated)', 'description' => 'ACS相关配置。', '$ref' => '#/components/schemas/ACS'],
'ResourceSpecs' => [
'title' => '资源规格模板',
'description' => '资源规格模板。',
'type' => 'array',
'items' => ['description' => '资源规格模板列表。', '$ref' => '#/components/schemas/WorkspaceSpecs'],
],
'EnablePreemptSubquotaWorkloads' => ['title' => '是否能够抢占子Quota资源(Deprecating,请使用EnableSubQuotaPreemption)', 'description' => '是否能够抢占子Quota资源。', 'type' => 'boolean', 'deprecated' => false, 'example' => 'false'],
'EnableSubQuotaPreemption' => ['title' => '是否能够抢占子Quota资源', 'description' => '是否能够抢占子Quota资源。', 'type' => 'boolean'],
'SubQuotaPreemptionConfig' => ['title' => '抢占子Quota任务配置', 'description' => '抢占子Quota任务配置', '$ref' => '#/components/schemas/SubQuotaPreemptionConfig'],
'EnableGPUShare' => ['type' => 'boolean', 'description' => ''],
'OversoldUsageConfig' => ['$ref' => '#/components/schemas/OversoldUsageConfig', 'description' => ''],
'SelfQuotaPreemptionConfig' => ['$ref' => '#/components/schemas/SelfQuotaPreemptionConfig', 'description' => ''],
'EniCacheConfig' => ['$ref' => '#/components/schemas/EniCacheConfig', 'description' => ''],
'SandboxCacheConfig' => ['$ref' => '#/components/schemas/SandboxCacheConfig', 'description' => ''],
'UseCase' => ['type' => 'string', 'description' => ''],
'EnableSelfQuotaPreemption' => ['title' => '开启本Quota保障资源抢占', 'description' => '开启本Quota保障资源抢占', 'type' => 'boolean'],
'ControlPlaneClusterId' => ['type' => 'string', 'description' => ''],
'IsEncryptedResource' => ['type' => 'boolean'],
'WorkloadTypes' => [
'title' => 'Quota支持的任务类型',
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'QuotaDetails' => [
'title' => '资源配额详情',
'description' => 'Quota详情',
'type' => 'object',
'properties' => [
'DesiredMinQuota' => ['title' => '用户所需的MinQuota总量', 'description' => '用户所需的MinQuota总量', '$ref' => '#/components/schemas/ResourceAmount'],
'ActualMinQuota' => ['title' => '实际分配的MinQuota总量', 'description' => '实际分配的MinQuota总量,例如用户配置了10个节点,实际上绑定了8个节点,此处返回8个节点的资源总和。', '$ref' => '#/components/schemas/ResourceAmount'],
'RequestedQuota' => ['title' => 'Quota请求量(Deprecating)', 'description' => 'Quota请求量,即队列出队后的Workload占用的资源总量。', '$ref' => '#/components/schemas/ResourceAmount'],
'UsedQuota' => ['title' => 'Quota使用量(Deprecating)', 'description' => 'Quota使用量,Deprecating中,使用AllocatedQuota替代。', '$ref' => '#/components/schemas/ResourceAmount'],
'AllocatedQuota' => ['title' => 'Quota总共用量信息', 'description' => 'Quota总共用量信息:指调度到节点的Workload占用的资源总和。', '$ref' => '#/components/schemas/ResourceAmount'],
'SelfAllocatedQuota' => ['title' => '本级Quota用量信息', 'description' => '本级Quota用量信息:使用本Quota提交的Workload,调度到节点后的资源总和。', '$ref' => '#/components/schemas/ResourceAmount'],
'AncestorsAllocatedQuota' => ['title' => '祖先Quota用量信息', 'description' => '祖先Quota用量信息:使用祖先Quota到Workload,调度到节点后的资源总和。', '$ref' => '#/components/schemas/ResourceAmount'],
'DescendantsAllocatedQuota' => ['title' => '子孙Quota用量信息', 'description' => '子孙Quota用量信息:使用子孙Quota,调度到节点后的资源总和。', '$ref' => '#/components/schemas/ResourceAmount'],
'SelfSubmittedQuota' => ['description' => '本Quota提交量:提交到本Quota的Workload资源总和,包括排队中的Workload。', '$ref' => '#/components/schemas/ResourceAmount'],
'AllocatableQuota' => ['title' => '用户可分配Quota量', 'description' => '用户可分配Quota量:针对通用计算资源,每个节点存在系统预留,此处表示用户Workload可占用的Quota资源量。'."\n"
.'ActualMin = AllocatableQuota + SystemReservedQuota', '$ref' => '#/components/schemas/ResourceAmount'],
'SystemReservedQuota' => ['title' => '系统预留Quota量', 'description' => '系统预留Quota量', '$ref' => '#/components/schemas/ResourceAmount'],
'NodeStatistics' => ['description' => 'Quota内节点的统计信息', '$ref' => '#/components/schemas/QuotaNodeStatistics'],
],
],
'QuotaIdName' => [
'title' => '资源配额ID&名称',
'description' => '资源配额Id&Name',
'type' => 'object',
'properties' => [
'QuotaId' => ['title' => '资源配额ID', 'description' => '资源配额ID', 'type' => 'string', 'example' => 'quota12345'],
'QuotaName' => ['title' => '资源配额名称', 'description' => '资源配额名称', 'type' => 'string', 'example' => 'dlc-quota'],
],
],
'QuotaJobViewMetric' => [
'title' => '资源配额作业维度指标',
'description' => 'quota job view metric',
'type' => 'object',
'properties' => [
'TotalCPU' => ['title' => '总的CPU核心数', 'type' => 'integer', 'format' => 'int32'],
'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'],
'GPUUsageRate' => ['title' => 'GPU使用率', 'type' => 'string'],
'TotalMemory' => ['title' => '总内存kb', 'type' => 'integer', 'format' => 'int64'],
'TotalGPU' => ['title' => '总的GPU卡数', 'type' => 'integer', 'format' => 'int32'],
'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'],
'RequestCPU' => ['title' => '占用的CPU核心数', 'type' => 'integer', 'format' => 'int32'],
'RequestGPU' => ['title' => '占用的GPU核心数', 'type' => 'integer', 'format' => 'int32'],
'RequestMemory' => ['title' => '占用的内存kb', 'type' => 'integer', 'format' => 'int64'],
'NetworkInputRate' => ['title' => '网络写入速率', 'type' => 'string'],
'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'],
'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'],
'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'],
'JobType' => ['title' => '任务类型dlc,dsw /etc', 'type' => 'string'],
'UserId' => ['title' => '用户ID', 'type' => 'string'],
'NodeNames' => [
'title' => '节点列表',
'type' => 'array',
'items' => ['type' => 'string'],
],
'JobId' => ['title' => '任务ID', 'type' => 'string'],
],
],
'QuotaMetric' => [
'title' => '资源配额指标',
'description' => 'resource group metric',
'type' => 'object',
'properties' => [
'Metrics' => [
'title' => '性能指标',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/Metric'],
'example' => '23000',
],
'GPUType' => ['title' => '显卡的类型', 'type' => 'string'],
],
],
'QuotaNodeStatistics' => [
'type' => 'object',
'properties' => [
'ActualMinNodeNum' => ['title' => '节点数', 'type' => 'integer', 'format' => 'int64'],
'ActualMinHyperNodeNum' => ['title' => '超节点数', 'type' => 'integer', 'format' => 'int64'],
'AllocatedNodeNum' => ['title' => '已分配节点数', 'type' => 'integer', 'format' => 'int64'],
'AllocatedHyperNodeNum' => ['title' => '已分配超节点数', 'type' => 'integer', 'format' => 'int64'],
'EmptyNodeNum' => ['title' => '空闲节点数', 'type' => 'integer', 'format' => 'int64'],
'AllocatedHyperNodeDetails' => [
'title' => '超节点详情',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/AllocatedHyperNodeDetail'],
],
],
],
'QuotaNodeViewMetric' => [
'title' => 'Quota内资源节点维度实时指标',
'description' => 'quota node view metric',
'type' => 'object',
'properties' => [
'NodeID' => ['title' => '节点ID', 'type' => 'string', 'example' => '-i121212node'],
'NodeType' => ['title' => '显卡的类型', 'type' => 'string'],
'QuotaId' => ['title' => '资源配额ID', 'type' => 'string'],
'CreatedTime' => ['title' => '节点导入时间', 'type' => 'string'],
'RequestCPU' => ['title' => '已经使用的CPU', 'type' => 'integer', 'format' => 'int64'],
'RequestMemory' => ['title' => '已经使用的内存', 'type' => 'integer', 'format' => 'int64'],
'RequestGPU' => ['title' => '使用的GPU', 'type' => 'integer', 'format' => 'int64'],
'NetworkInputRate' => ['title' => '网络输入速率', 'type' => 'string'],
'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'],
'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'],
'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'],
'TotalCPU' => ['title' => '总的CPU', 'type' => 'integer', 'format' => 'int64'],
'TotalGPU' => ['title' => '总的GPU', 'type' => 'integer', 'format' => 'int64'],
'TotalMemory' => ['title' => '总的内存', 'type' => 'integer', 'format' => 'int64'],
'GPUType' => ['title' => '卡型', 'type' => 'string'],
'UserNumber' => ['title' => '用户总数', 'type' => 'string'],
'UserIDs' => [
'title' => '用户列表',
'type' => 'array',
'items' => ['type' => 'string'],
],
'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'],
'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'],
'NodeStatus' => ['title' => '节点状态', 'type' => 'string'],
'TotalTasks' => ['title' => '节点任务总数', 'type' => 'integer', 'format' => 'int64'],
'TaskIdMap' => ['title' => '节点任务', 'type' => 'object'],
],
],
'QuotaUser' => [
'title' => '资源配额用户',
'type' => 'object',
'properties' => [
'Username' => ['title' => '用户名', 'type' => 'string'],
'UserId' => ['title' => '用户ID', 'type' => 'string'],
'WorkloadCount' => ['title' => '任务负载数量', 'type' => 'integer', 'format' => 'int32'],
'Resources' => [
'title' => '资源',
'type' => 'object',
'properties' => [
'Used' => ['title' => '已使用资源', '$ref' => '#/components/schemas/ResourceAmount'],
'Submitted' => ['title' => '已提交资源', '$ref' => '#/components/schemas/ResourceAmount'],
],
],
],
],
'QuotaUserViewMetric' => [
'title' => '资源配额用户维度指标',
'description' => 'quota user view metric',
'type' => 'object',
'properties' => [
'TotalCPU' => ['title' => '总的CPU核心数', 'type' => 'integer', 'format' => 'int32'],
'CPUUsageRate' => ['title' => 'CPU使用率', 'type' => 'string'],
'GPUUsageRate' => ['title' => 'GPU使用率', 'type' => 'string'],
'TotalMemory' => ['title' => '总内存kb', 'type' => 'integer', 'format' => 'int64'],
'TotalGPU' => ['title' => '总的GPU卡数', 'type' => 'integer', 'format' => 'int32'],
'MemoryUsageRate' => ['title' => '内存使用率', 'type' => 'string'],
'RequestCPU' => ['title' => '占用的CPU核心数', 'type' => 'integer', 'format' => 'int32'],
'RequestGPU' => ['title' => '占用的GPU核心数', 'type' => 'integer', 'format' => 'int32'],
'RequestMemory' => ['title' => '占用的内存kb', 'type' => 'integer', 'format' => 'int64'],
'NetworkInputRate' => ['title' => '网络写入速率', 'type' => 'string'],
'NetworkOutputRate' => ['title' => '网络输出速率', 'type' => 'string'],
'DiskReadRate' => ['title' => '磁盘读取速率', 'type' => 'string'],
'DiskWriteRate' => ['title' => '磁盘写入速率', 'type' => 'string'],
'JobType' => ['title' => 'JOB类型', 'type' => 'string'],
'UserId' => ['title' => '用户ID', 'type' => 'string'],
'CPUNodeNumber' => ['title' => 'CPU节点的数量', 'type' => 'integer', 'format' => 'int32'],
'GPUNodeNumber' => ['title' => 'GPU节点的数量', 'type' => 'integer', 'format' => 'int32'],
'CpuJobNames' => [
'title' => 'CPU任务',
'type' => 'array',
'items' => ['type' => 'string'],
],
'GpuJobNames' => [
'title' => 'GPU任务',
'type' => 'array',
'items' => ['type' => 'string'],
],
'NodeNames' => [
'title' => '节点列表',
'type' => 'array',
'items' => ['type' => 'string'],
],
'CpuNodeNames' => [
'title' => 'CPU节点列表',
'type' => 'array',
'items' => ['type' => 'string'],
],
'GpuNodeNames' => [
'title' => 'GPU节点列表',
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'ResourceAmount' => [
'title' => '资源量',
'description' => '资源量',
'type' => 'object',
'properties' => [
'CPU' => ['title' => 'CPU总量', 'description' => 'CPU总量', 'type' => 'string', 'example' => '100'],
'Memory' => ['title' => 'Memory总量', 'description' => 'Memory总量', 'type' => 'string', 'example' => '100Gi'],
'GPU' => ['title' => 'GPU卡总量', 'description' => 'GPU卡总量', 'type' => 'string', 'example' => '16'],
'GPUType' => ['title' => 'GPU卡类型', 'description' => 'GPU卡类型', 'type' => 'string', 'example' => 'GPU'],
],
],
'ResourceDiagnosisDetail' => [
'title' => '资源诊断详情',
'description' => '资源诊断详情',
'type' => 'object',
'properties' => [
'Status' => ['title' => '诊断状态', 'type' => 'string'],
'ExceedResources' => [
'title' => '超限资源',
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'CPU'],
],
'Limit' => ['title' => '资源限额', '$ref' => '#/components/schemas/ResourceAmount'],
'Used' => ['title' => '资源用量', '$ref' => '#/components/schemas/ResourceAmount'],
'WorkloadIds' => [
'title' => '相关Workload Id',
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'dlc1234567890'],
],
],
],
'ResourceGroup' => [
'title' => 'A short description of struct',
'description' => 'PAI资源组。',
'type' => 'object',
'properties' => [
'Name' => ['title' => 'pai resource group name', 'description' => 'PAI资源组名称。', 'type' => 'string', 'example' => 'RG1'],
'ResourceGroupID' => ['title' => 'pai resource group id', 'description' => 'PAI资源组ID。', 'type' => 'string', 'example' => 'rg17tmvwiokh****'],
'WorkspaceID' => ['title' => 'pworkspace id', 'description' => '工作空间ID。', 'type' => 'string', 'example' => '23000'],
'UserVpc' => ['title' => 'UserVpc', 'description' => 'VPC配置。', '$ref' => '#/components/schemas/UserVpc'],
'GmtCreatedTime' => ['title' => 'pai resource created time', 'description' => 'PAI资源组创建时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'GmtModifiedTime' => ['title' => 'GmtModified', 'description' => 'PAI资源组更新时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'CreatorID' => ['title' => 'CreatorID', 'description' => '创建者用户ID。', 'type' => 'string', 'example' => '161228528250****'],
'NodeCount' => ['title' => 'NodeCount', 'description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'Version' => ['type' => 'string', 'description' => ''],
'Status' => ['type' => 'string'],
'ResourceType' => ['type' => 'string'],
],
],
'ResourceGroupMetric' => [
'title' => 'A short description of struct',
'description' => 'resource group metric',
'type' => 'object',
'properties' => [
'ResourceGroupID' => ['title' => '资源组ID', 'type' => 'string', 'example' => 'rg17tmvwiokhzaxg'],
'Metrics' => [
'title' => '性能指标',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/Metric'],
'example' => '23000',
],
'GpuType' => ['title' => '显卡的类型', 'type' => 'string'],
],
],
'ResourceInfos' => [
'type' => 'object',
'properties' => [
'UserName' => ['type' => 'string'],
'GpuCardType' => ['type' => 'string'],
'ClusterId' => ['type' => 'string'],
'UserId' => ['type' => 'string'],
'EcsSpec' => ['type' => 'string'],
'RegionId' => ['type' => 'string'],
'MaxQuota' => ['type' => 'integer', 'format' => 'int64'],
'UsedQuota' => ['type' => 'integer', 'format' => 'int64'],
'NetworkPodId' => ['type' => 'string'],
'MachineModel' => ['type' => 'string'],
],
],
'ResourceLimitDetails' => [
'title' => 'A short description of struct',
'description' => '资源限制细节',
'type' => 'object',
'properties' => [
'GCLevel' => ['title' => 'GC 等级', 'type' => 'string'],
'ResourceLimit' => ['title' => '资源限制详情', 'type' => 'object'],
'ShouldIgnoreResourceCheck' => ['title' => '是否忽略资源检查', 'type' => 'boolean'],
],
],
'ResourceOperation' => [
'title' => '资源变更',
'description' => '资源变更',
'type' => 'object',
'properties' => [
'OperationId' => ['title' => '资源变更Id', 'type' => 'string'],
'ObjectType' => ['title' => '资源变更对象类型', 'type' => 'string'],
'ObjectId' => ['title' => '资源变更的对象Id', 'type' => 'string'],
'OperationType' => ['title' => '资源变更类型', 'type' => 'string'],
'OperationSpecJson' => ['title' => '资源变更明细', 'type' => 'string'],
'OperationDescription' => ['title' => '资源变更描述', 'type' => 'string'],
'CreatorId' => ['title' => '资源变更发起人Id', 'type' => 'string'],
'Status' => ['title' => '资源变更状态', 'type' => 'string'],
'ReasonCode' => ['title' => '错误码', 'type' => 'string'],
'ReasonMessage' => ['title' => '错误消息', 'type' => 'string'],
'GmtCreatedTime' => ['title' => '资源变更创建时间', 'type' => 'string'],
'GmtModifiedTime' => ['title' => '资源变更更新时间', 'type' => 'string'],
'GmtStartTime' => ['title' => '资源变更开始时间', 'type' => 'string'],
'GmtEndTime' => ['title' => '资源变更结束时间', 'type' => 'string'],
],
],
'ResourceSpec' => [
'title' => '资源配额分配策略',
'description' => '分配策略:资源节点规格和数量,资源量。',
'type' => 'object',
'properties' => [
'NodeSpecs' => [
'title' => '资源节点规格',
'description' => '资源节点规格。',
'type' => 'array',
'items' => ['description' => '单资源规格信息。', '$ref' => '#/components/schemas/NodeSpec'],
],
],
],
'Rules' => [
'title' => '任务规则配置',
'description' => '规则配置',
'type' => 'object',
'properties' => [
'Scheduling' => ['title' => '任务调度规则配置', '$ref' => '#/components/schemas/SchedulingRule'],
],
],
'SandboxCacheConfig' => [
'type' => 'object',
'properties' => [
'Enabled' => ['type' => 'boolean'],
],
],
'SchedulingRule' => [
'title' => '任务调度配置',
'description' => '任务调度配置',
'type' => 'object',
'properties' => [
'StartAt' => ['title' => '任务开始生效时间', 'type' => 'string'],
'EndAt' => ['title' => '任务停止时间', 'type' => 'string'],
'ExecuteOnce' => ['title' => '是否只执行一次', 'type' => 'boolean', 'required' => false],
'CronTab' => ['title' => 'cron tab,当前只支持 分、时、日、月、周 五个配置,秒级别的配置会被丢弃', 'type' => 'string'],
],
],
'SelfQuotaPreemptionConfig' => [
'type' => 'object',
'properties' => [
'PreemptorPriorities' => [
'type' => 'array',
'items' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '9', 'minimum' => '1'],
],
'PreemptedPriorities' => [
'type' => 'array',
'items' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '9', 'minimum' => '1'],
],
'PreemptedProducts' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'SpotBidPreviewItem' => [
'type' => 'object',
'properties' => [
'name' => ['title' => '预竞价名称', 'type' => 'string'],
'jobName' => ['title' => '作业名称', 'type' => 'string'],
'instanceType' => ['title' => '实例类型', 'type' => 'string'],
'gcLevel' => ['title' => 'GC等级', 'type' => 'string'],
'replicas' => ['title' => '副本数', 'type' => 'integer', 'format' => 'int32'],
'maxDiscount' => ['title' => '最大折扣价格', 'type' => 'number', 'format' => 'double'],
'phase' => ['title' => '阶段', 'type' => 'string'],
'message' => ['title' => '消息', 'type' => 'string'],
'clusterId' => ['title' => '集群ID', 'type' => 'string'],
'allowCrossHpnZone' => ['type' => 'boolean'],
'active' => ['type' => 'boolean'],
],
],
'SpotPriceItem' => [
'title' => '抢占式实例价格',
'description' => '抢占式实例价格',
'type' => 'object',
'properties' => [
'ZoneId' => ['title' => '可用区ID', 'type' => 'string', 'example' => 'cn-wulanchabu-a'],
'InstanceType' => ['title' => '抢占式实例类型', 'type' => 'string', 'example' => 'ml.gu8xf.8xlarge-gu108'],
'SpotDiscount' => ['title' => '抢占式实例折扣', 'type' => 'number', 'format' => 'float', 'example' => '0.1'],
'Timestamp' => ['title' => '抢占式实例当前价格时间戳', 'type' => 'string', 'example' => '2024-01-17T06:00:00Z'],
],
],
'SpotStockInternalInfo' => [
'type' => 'object',
'properties' => [
'clusterId' => ['title' => '集群ID', 'type' => 'string'],
'hpnZone' => ['title' => '高性能网络可用区', 'type' => 'string'],
'totalQuantity' => ['title' => '总数量', 'type' => 'integer', 'format' => 'int32'],
'availableQuantity' => ['title' => '可用数量', 'type' => 'integer', 'format' => 'int32'],
],
],
'SpotStockItem' => [
'type' => 'object',
'properties' => [
'instanceType' => ['title' => '机型', 'type' => 'string'],
'stockStatus' => ['title' => '库存情况', 'type' => 'string'],
'internalInfo' => [
'title' => '库存详情',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/SpotStockInternalInfo'],
],
],
],
'SpotStockPreview' => [
'title' => '抢占式实例库存预览',
'type' => 'object',
'properties' => [
'InstanceType' => ['title' => '抢占式实例类型', 'type' => 'string', 'example' => 'ml.gu8xf.8xlarge-gu108'],
'StockStatus' => ['title' => '抢占式实例库存状态', 'type' => 'string', 'example' => 'WithStock'],
'SpotDiscount' => ['title' => '抢占式实例当前折扣', 'type' => 'number', 'format' => 'float', 'example' => '0.1'],
'ClusterId' => ['type' => 'string'],
'AvailableQuantity' => ['type' => 'integer', 'format' => 'int32'],
],
],
'StatisticsDetails' => [
'type' => 'object',
'properties' => [
'IdleNum' => ['type' => 'integer', 'format' => 'int64'],
'Count' => ['type' => 'integer', 'format' => 'int64'],
],
],
'StatisticsResources' => [
'type' => 'object',
'properties' => [
'NodeNum' => ['type' => 'integer', 'format' => 'int64'],
'HyperNodeNum' => ['type' => 'integer', 'format' => 'int64'],
'CPU' => ['type' => 'string'],
'Memory' => ['type' => 'string'],
'GPU' => ['type' => 'string'],
],
],
'SubQuotaPreemptionConfig' => [
'title' => 'A short description of struct',
'description' => '抢占子Quota配置',
'type' => 'object',
'properties' => [
'PreemptedPriorityUpperBound' => ['title' => '被抢占任务最高优先级', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
'PreemptedProducts' => [
'title' => '可被抢占的任务类型',
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'dlc'],
],
],
],
'Task' => [
'title' => '任务详情',
'description' => '任务信息',
'type' => 'object',
'properties' => [
'QuotaId' => ['title' => '所属Quota ID', 'type' => 'string'],
'TaskName' => ['title' => '任务名称', 'type' => 'string'],
'TaskId' => ['title' => '任务ID', 'type' => 'string'],
'Description' => ['title' => '任务描述', 'type' => 'string'],
'Rules' => ['title' => '任务执行规则', '$ref' => '#/components/schemas/Rules'],
'Actions' => [
'title' => '任务执行的操作',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/Action'],
],
'UserId' => ['title' => '用户ID', 'type' => 'string'],
'UserName' => ['title' => '用户名', 'type' => 'string'],
'Status' => ['title' => '任务状态', 'type' => 'string'],
'GmtCreatedTime' => ['title' => '任务创建时间', 'type' => 'string'],
'GmtModifiedTime' => ['title' => '任务修改时间', 'type' => 'string'],
'GmtActivatedTime' => ['title' => '任务激活时间', 'type' => 'string'],
'GmtStoppedTime' => ['title' => '任务停止时间', 'type' => 'string'],
],
],
'TaskInstance' => [
'title' => 'Quota 任务实例',
'description' => 'Quota任务实例',
'type' => 'object',
'properties' => [
'TaskId' => ['title' => '任务ID', 'type' => 'string'],
'TaskInstanceId' => ['title' => '任务实例ID', 'type' => 'string'],
'UserId' => ['title' => '创建者ID', 'type' => 'string'],
'TenantId' => ['title' => '云账号ID', 'type' => 'string'],
'Status' => ['title' => '任务实例状态', 'type' => 'string'],
'GmtCreatedTime' => ['title' => '实例创建时间', 'type' => 'string'],
'GmtEndTime' => ['title' => '实例结束时间', 'type' => 'string'],
],
],
'TaskInstanceEvent' => [
'title' => 'Quota Task Instance Event',
'description' => 'Quota 任务实例消息',
'type' => 'object',
'properties' => [
'Status' => ['title' => '状态', 'type' => 'string'],
'GmtStartTime' => ['title' => '开始运行时间', 'type' => 'string'],
'GmtEndTime' => ['title' => '结束运行时间', 'type' => 'string'],
'WorkloadType' => ['title' => '任务涉及子产品类型', 'type' => 'string'],
'PodName' => ['title' => '任务涉及Pod名称', 'type' => 'string'],
'Message' => ['title' => '消息内容', 'type' => 'string'],
],
],
'TimeRangeFilter' => [
'title' => '时间范围定义,过滤使用',
'description' => '时间范围搜索',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '开始时间', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'EndTime' => ['title' => '结束时间', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
],
],
'UnschedulableNodeDetail' => [
'title' => '节点调度失败原因',
'description' => '节点调度失败原因',
'type' => 'object',
'properties' => [
'Nodes' => [
'title' => '节点列表',
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'i-eabcsjiow'],
],
'Reason' => ['title' => '失败原因', 'type' => 'string'],
],
],
'UserInfo' => [
'title' => '用户信息',
'description' => '用户信息',
'type' => 'object',
'properties' => [
'UserId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'example' => '161222222222'],
'UserName' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'test'],
],
],
'UserQuotaPermission' => [
'title' => '用户在Quota上的权限',
'description' => '用户在Quota上的权限',
'type' => 'object',
'properties' => [
'QuotaId' => ['title' => 'Quota ID', 'type' => 'string'],
'Permissions' => [
'title' => '权限',
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'UserViewMetric' => [
'title' => 'A short description of struct',
'description' => '资源组指标数据。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg17tmvwiokh****'],
'TotalCPU' => ['title' => '总的CPU核心数', 'description' => '总的CPU核心数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'CPUUsageRate' => ['title' => 'CPU使用率', 'description' => 'CPU使用率。', 'type' => 'string', 'example' => '59'],
'GPUUsageRate' => ['title' => 'GPU使用率', 'description' => 'GPU使用率。', 'type' => 'string', 'example' => '10'],
'TotalMemory' => ['title' => '总内存kb', 'description' => '总内存kb。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240'],
'TotalGPU' => ['title' => '总的GPU卡数', 'description' => '总的GPU卡数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MemoryUsageRate' => ['title' => '内存使用率', 'description' => '内存使用率。', 'type' => 'string', 'example' => '20'],
'RequestCPU' => ['title' => '占用的CPU核心数', 'description' => '占用的CPU核心数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'RequestGPU' => ['title' => '占用的GPU核心数', 'description' => '占用的GPU核心数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'RequestMemory' => ['title' => '占用的内存kb', 'description' => '占用的内存kb。', 'type' => 'integer', 'format' => 'int64', 'example' => '102400000'],
'NetworkInputRate' => ['title' => '网络写入速率', 'description' => '网络写入速率。', 'type' => 'string', 'example' => '1'],
'NetworkOutputRate' => ['title' => '网络输出速率', 'description' => '网络输出速率。', 'type' => 'string', 'example' => '1'],
'DiskReadRate' => ['title' => '磁盘读取速率', 'description' => '磁盘读取速率。', 'type' => 'string', 'example' => '22'],
'DiskWriteRate' => ['title' => '磁盘写入速率', 'description' => '磁盘写入速率。', 'type' => 'string', 'example' => '22'],
'JobType' => ['title' => 'JOB类型', 'description' => 'JOB类型。', 'type' => 'string', 'example' => 'PyTorch'],
'UserId' => ['title' => '用户ID', 'description' => '用户ID。', 'type' => 'string', 'example' => '16111111****'],
'CPUNodeNumber' => ['title' => 'CPU节点的数量', 'description' => 'CPU节点的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'GPUNodeNumber' => ['title' => 'GPU节点的数量', 'description' => 'GPU节点的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CpuJobNames' => [
'title' => 'CPU任务',
'description' => 'CPU任务。',
'type' => 'array',
'items' => ['description' => '作业名称。', 'type' => 'string', 'example' => 'dlcxxxxx'],
],
'GpuJobNames' => [
'title' => 'GPU任务',
'description' => 'GPU任务。',
'type' => 'array',
'items' => ['description' => '作业名称。', 'type' => 'string', 'example' => 'dlcyyyyy'],
],
'NodeNames' => [
'title' => '节点列表',
'description' => '节点列表。',
'type' => 'array',
'items' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'lrnxxxxxx'],
],
'CpuNodeNames' => [
'title' => 'CPU节点列表',
'description' => 'CPU节点列表。',
'type' => 'array',
'items' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'ecixxxxxx'],
],
'GpuNodeNames' => [
'title' => 'GPU节点列表',
'description' => 'GPU节点列表。',
'type' => 'array',
'items' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'lrnxxxxxxx'],
],
],
],
'UserVpc' => [
'title' => 'A short description of struct',
'description' => 'UserVpc',
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-abcdef****'],
'SwitchId' => ['title' => 'VSW ID', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vs-abcdef****'],
'SecurityGroupId' => ['title' => 'SecurityGroupID', 'description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-abcdef****'],
'ExtendedCIDRs' => [
'title' => 'ExtendedCIDRs',
'description' => '扩展网段。',
'type' => 'array',
'items' => ['description' => '扩展网段。', 'type' => 'string', 'example' => '"192.168.0.1/24"'],
],
'RoleArn' => ['title' => 'RoleArn', 'description' => 'OSS访问授权信息。', 'type' => 'string', 'example' => 'acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole'],
'DefaultRoute' => ['title' => 'DefaultRoute', 'description' => '默认路由。取值如下:'."\n"
.'- eth0:表示使用默认网卡,通过公共网关访问外部网络。'."\n"
.'- eth1:表示使用用户弹性网卡,通过私有网关访问外部网络。', 'type' => 'string', 'example' => 'eth0'],
'DefaultForwardInfo' => ['title' => 'Default Forward Info', 'description' => '默认公网网关信息', '$ref' => '#/components/schemas/ForwardInfo'],
],
],
'WorkloadInfo' => [
'title' => '任务详情',
'type' => 'object',
'properties' => [
'WorkloadId' => ['title' => '任务id', 'type' => 'string'],
'WorkloadName' => ['title' => '任务名称', 'type' => 'string'],
'WorkloadType' => ['title' => '任务类型', 'type' => 'string'],
'WorkspaceId' => ['title' => '任务所在工作空间Id', 'type' => 'string'],
'WorkspaceName' => ['title' => '任务所在工作空间名称', 'type' => 'string'],
'WorkloadCreatedTime' => ['title' => '任务创建时间', 'type' => 'string'],
'WorkloadStatus' => ['title' => '任务状态', 'type' => 'string'],
'UserId' => ['title' => '任务创建者子账号', 'type' => 'string'],
'TenantId' => ['title' => '任务创建者主账号', 'type' => 'string'],
'UserName' => ['title' => '任务创建者用户名', 'type' => 'string'],
'Priority' => ['title' => '任务优先级', 'type' => 'integer', 'format' => 'int32'],
'IsScheduled' => ['title' => '任务是否被调度', 'type' => 'string'],
'QueueMetas' => [
'title' => '任务所在队列信息',
'type' => 'array',
'items' => ['title' => '任务所在队列信息', '$ref' => '#/components/schemas/QueueMeta'],
],
],
],
'WorkspaceIdName' => [
'title' => '工作空间ID&名称',
'description' => '工作空间ID和Name。',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['title' => '工作空间ID', 'description' => '工作空间ID。', 'type' => 'string', 'example' => 'ws123***'],
'WorkspaceName' => ['type' => 'string'],
],
],
'WorkspaceSpec' => [
'title' => 'A short description of struct',
'description' => '规格模板',
'type' => 'object',
'properties' => [
'SpecName' => ['title' => '模板名称', 'description' => '模板名称', 'type' => 'string', 'example' => 'spec_test'],
'IsGuaranteedValid' => ['title' => '使用保障资源时是否合法', 'description' => '使用保障资源时是否合法', 'type' => 'boolean', 'example' => 'true'],
'IsOverSoldValid' => ['title' => '使用超卖资源时是否合法', 'description' => '使用超卖资源时是否合法', 'type' => 'boolean', 'example' => 'true'],
'Spec' => ['title' => '规格资源信息', 'description' => '规格资源信息', '$ref' => '#/components/schemas/ResourceAmount'],
'CodeType' => ['title' => '使用保障资源时不合法情况下,不合法原因类型', 'description' => '使用保障资源时不合法情况下,不合法原因类型', 'type' => 'string', 'example' => '""'],
'Code' => ['title' => '使用保障资源时不合法情况下,不合法原因代码', 'description' => '使用保障资源时不合法情况下,不合法原因代码', 'type' => 'string', 'example' => '""'],
'Reason' => ['title' => '使用保障资源时不合法情况下,不合法原因内容', 'description' => '使用保障资源时不合法情况下,不合法原因内容', 'type' => 'string', 'example' => '""'],
],
],
'WorkspaceSpecs' => [
'title' => 'A short description of struct',
'description' => '工作空间内可用的提交workload时使用的规格模板',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['title' => '工作空间id', 'description' => '工作空间id', 'type' => 'string', 'example' => '122421'],
'Product' => ['title' => '适用产品(DLC,DSW,EAS,...)', 'description' => '适用产品(DLC,DSW,EAS,...)', 'type' => 'string', 'example' => 'DLC'],
'Specs' => [
'title' => '资源规格列表',
'description' => '资源规格列表',
'type' => 'array',
'items' => ['description' => '工作空间规格模板配置。', '$ref' => '#/components/schemas/WorkspaceSpec'],
],
],
],
],
],
'apis' => [
'CheckInstanceWebTerminal' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/webterminals/action/check',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '199680',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'traineyfz0m2hsfv'],
],
[
'name' => 'InstanceId',
'in' => 'path',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'train1oxaqdiluad-master-0'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '校验配置。',
'type' => 'object',
'properties' => [
'CheckInfo' => ['description' => '校验信息。', 'type' => 'string', 'required' => false, 'example' => 'wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'],
],
],
],
],
'title' => '校验进入实例容器链接',
'summary' => '校验进入实例容器链接。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\"\\n}","type":"json"}]',
],
'CreateAlgorithm' => [
'path' => '/api/v1/algorithms',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => [],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
[
'name' => 'AlgorithmDescription',
'in' => 'formData',
'schema' => ['description' => '算法描述。', 'type' => 'string', 'required' => false, 'example' => 'Tongyi Qwen large language model training algorithm.'],
],
[
'name' => 'AlgorithmName',
'in' => 'formData',
'schema' => ['description' => '算法名。', 'type' => 'string', 'required' => false, 'example' => 'llm_training'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['description' => '算法显示名称。', 'type' => 'string', 'required' => false, 'example' => 'Large language model training'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
'AlgorithmId' => ['description' => '训练算法ID。', 'type' => 'string', 'example' => 'algo-xsldfvu1334'],
],
'description' => '',
],
],
],
'title' => '创建算法',
'summary' => '创建算法。',
'changeSet' => [
['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-04-27T10:49:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAlgorithm'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pai:CreateAlgorithm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\"\\n}","type":"json"}]',
],
'CreateAlgorithmVersion' => [
'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/x-www-form-urlencoded'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => ['description' => '训练算法ID。', 'type' => 'string', 'required' => false, 'example' => 'algo-xsldfvu1334'],
],
[
'name' => 'AlgorithmVersion',
'in' => 'path',
'schema' => ['description' => '算法版本。', 'type' => 'string', 'required' => false, 'example' => 'v0.0.1'],
],
[
'name' => 'AlgorithmSpec',
'in' => 'formData',
'style' => 'json',
'schema' => ['description' => '算法配置。', 'required' => false, '$ref' => '#/components/schemas/AlgorithmSpec'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'AlgorithmId' => ['description' => '训练算法ID。', 'type' => 'string', 'example' => 'algo-xsldfvu1334'],
'AlgorithmVersion' => ['description' => '算法版本。', 'type' => 'string', 'example' => 'v0.0.1'],
],
],
],
],
'title' => '创建算法版本',
'summary' => '创建算法版本。',
'changeSet' => [
['createdAt' => '2022-04-27T10:50:46.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAlgorithmVersion'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pai:CreateAlgorithmVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\"\\n}","type":"json"}]',
],
'CreateInstanceWebTerminal' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/webterminals',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '199679',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'train1nc6686x36b'],
],
[
'name' => 'InstanceId',
'in' => 'path',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'train1nc6686x36b-master-0'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'WebTerminalId' => ['description' => '进入实例容器的工作台ID。', 'type' => 'string', 'example' => 'wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
],
],
],
'title' => '创建进入实例容器链接',
'summary' => '创建进入实例容器链接。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WebTerminalId\\": \\"wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'CreateQuota' => [
'summary' => '您可以通过CreateQuota接口创建一个资源配额。',
'path' => '/api/v1/quotas',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '191129',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'QuotaName' => ['title' => 'Quota名称', 'description' => 'Quota名称。', 'type' => 'string', 'required' => false, 'example' => 'test-quota'],
'ResourceType' => ['title' => 'Quota资源类型(Lingjun/ECS),默认值ECS', 'description' => 'Quota资源类型(Lingjun/ECS/ACS),默认值ECS。', 'type' => 'string', 'required' => false, 'example' => 'ECS'],
'ParentQuotaId' => ['title' => '父QuotaId'."\n"
.'1. 如果父QuotaId为空,表示创建一个根Quota,从专属资源组中分配机器'."\n"
.'2. 如果父QuotaId不为空,表示创建一个子Quota,资源从根Quota中绑定的Nodes中分配资源', 'description' => '父QuotaId:'."\n"
.'- 如果父QuotaId为空,表示创建一个根Quota,从专属资源组中分配机器。'."\n"
.'- 如果父QuotaId不为空,表示创建一个子Quota,资源从根Quota中绑定的Nodes中分配资源。', 'type' => 'string', 'required' => false, 'example' => 'quota1ci8g793pgm'],
'ResourceGroupIds' => [
'title' => '专有资源组列表'."\n"
.'约束:'."\n"
.'1. 只有根Quota允许从(父QuotaId为空)资源组划分机器'."\n"
.'2. 指定的资源组列表中的vpc配置需要一致',
'description' => '专有资源组列表。约束如下:'."\n"
.'- 只有根Quota允许从(父QuotaId为空)资源组划分机器。'."\n"
.'- 指定的资源组列表中的VPC配置需要一致。',
'type' => 'array',
'items' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rgl593id9qqwkmbr'],
'required' => false,
],
'AllocateStrategy' => ['title' => 'Quota分配策略,目前仅支持ByNodeSpecs', 'description' => 'Quota分配策略,目前仅支持ByNodeSpecs。', 'type' => 'string', 'required' => false, 'example' => 'ByNodeSpecs'],
'Min' => ['description' => 'Min Quota配置。其中:'."\n"
.'- ResourceAmount:指定CPU/Memory/GPUDetails。'."\n"
.'- NodeSpecs:指定机器规格和数量。'."\n"
."\n"
.'约束:'."\n"
.'- 若该Quota从专有资源组划分资源,只允许NodeSpec策略。'."\n"
.'- 若该Quota从父Quota划分资源,允许两种划分策略,但所有子Quota的只允许同一种划分策略。'."\n"
.'- Quota内所有GPU规格要求卡型相同。'."\n"
.'- 资源类型为ECS/Lingjun的资源配额只可以使用NodeSpecs方式。', 'required' => false, '$ref' => '#/components/schemas/ResourceSpec'],
'Description' => ['title' => 'Quota描述', 'description' => 'Quota描述。', 'type' => 'string', 'required' => false, 'example' => 'this is a test quota'],
'Labels' => [
'title' => 'Quota标签',
'description' => 'Quota标签。',
'type' => 'array',
'items' => ['description' => '标签。', 'required' => false, '$ref' => '#/components/schemas/Label'],
'required' => false,
],
'QuotaConfig' => ['description' => 'QuotaConfig 配置约束:'."\n"
.'- 使用ECS/Lingjun资源类型时,该配置不生效。'."\n"
.'- 使用ACS资源类型时,用户VPC信息以及ACS配置生效。', 'required' => false, '$ref' => '#/components/schemas/QuotaConfig'],
'QueueStrategy' => ['description' => '共支持4种Quota上的排队策略。'."\n"
."\n"
.'- PaiStrategyIntelligent:智能策略。'."\n"
.'- PaiStrategyBalance:均衡策略。'."\n"
.'- PaiStrategyRoundRobin:资源优先策略。'."\n"
.'- PaiStrategyStrictFIFO:FIFO策略。', 'type' => 'string', 'required' => false, 'example' => 'PaiStrategyIntelligent'],
'ClusterSpec' => ['title' => '资源配额原生集群的规格', 'required' => false, '$ref' => '#/components/schemas/ClusterSpec', 'description' => '资源配额原生集群的规格'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'CBF05F13-B24C-5129-9048-4FA684DCD579'],
'QuotaId' => ['title' => 'Quota Id', 'description' => '资源配额ID。', 'type' => 'string', 'example' => 'quotad2kd8ljpsno'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建资源配额',
'changeSet' => [
['createdAt' => '2025-11-06T13:03:33.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:CreateQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF05F13-B24C-5129-9048-4FA684DCD579\\",\\n \\"QuotaId\\": \\"quotad2kd8ljpsno\\"\\n}","errorExample":""},{"type":"xml","example":"\\n quotad2kd8ljpsno\\n","errorExample":""}]',
],
'CreateResourceGroup' => [
'path' => '/api/v1/resources',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '125287',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求结构体。',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'ResourceGroup名称。', 'type' => 'string', 'required' => false, 'example' => 'testResourceGroup'],
'Description' => ['description' => 'ResourceGroup描述', 'type' => 'string', 'required' => false, 'example' => 'test_api_report'],
'UserVpc' => ['description' => 'ResourceGroup的VPC打通信息。', 'required' => false, '$ref' => '#/components/schemas/UserVpc'],
'ResourceType' => ['description' => '资源类型列表。取值如下:'."\n"
."\n"
.'- Ecs:通用计算资源'."\n"
.'- Lingjun:灵骏智算资源', 'type' => 'string', 'required' => false, 'example' => 'Ecs'],
'ComputingResourceProvider' => ['description' => 'ResourceGroup的计算资源类型。', 'type' => 'string', 'required' => false, 'example' => 'Ecs'],
'Tag' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '对应新增标签列表,最多包含20个子项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '实例的标签键。N 的取值范围为 1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['title' => '标签值', 'description' => '实例的标签值。N 的取值范围为 1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'Version' => ['title' => '资源组版本,当前只在resource type为ECS时生效。', 'type' => 'string', 'required' => false, 'example' => '1.0', 'description' => ''],
],
'required' => false,
],
],
],
'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' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'."\n"],
'ResourceGroupID' => ['description' => 'ResourceGroup ID。', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'],
],
],
],
],
'title' => '创建资源组',
'summary' => '您可以使用CreateResourceGroup创建ResourceGroup。',
'changeSet' => [
['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-01-04T03:16:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-05-11T03:07:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-04T06:45:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-29T07:14:56.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResourceGroup'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pai:CreateResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\\\n\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\"\\n}","type":"json"}]',
],
'CreateTrainingJob' => [
'path' => '/api/v1/trainingjobs',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '132535',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body参数。',
'type' => 'object',
'properties' => [
'AlgorithmName' => ['description' => '算法名称。', 'type' => 'string', 'required' => false, 'example' => 'ev_classification'],
'AlgorithmProvider' => ['description' => '算法提供方。', 'type' => 'string', 'required' => false, 'example' => 'pai'],
'AlgorithmVersion' => ['description' => '算法版本。', 'type' => 'string', 'required' => false, 'example' => 'v1.0.0'],
'ComputeResource' => [
'description' => '计算资源配置。',
'type' => 'object',
'properties' => [
'EcsCount' => ['description' => 'Ecs实例数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'EcsSpec' => ['description' => 'Ecs型号。', 'type' => 'string', 'required' => false, 'example' => 'ecs.gn5-c8g1.2xlarge'],
'ResourceId' => ['description' => '资源配额(Quota)ID。', 'type' => 'string', 'required' => false, 'example' => 'quotam670lixikcs'],
'InstanceCount' => ['description' => '资源配额使用实例数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'InstanceSpec' => [
'description' => '资源配额实例配置。',
'type' => 'object',
'properties' => [
'CPU' => ['description' => '实例CPU核数。', 'type' => 'string', 'required' => false, 'example' => '8'],
'Memory' => ['description' => '实例内存大小,单位为GiB。', 'type' => 'string', 'required' => false, 'example' => '32'],
'SharedMemory' => ['description' => '实例共享内存大小,单位GB。', 'type' => 'string', 'required' => false, 'example' => '32'],
'GPU' => ['description' => '实例GPU显卡数量。', 'type' => 'string', 'required' => false, 'example' => '1'],
'GPUType' => ['description' => '实例GPU显卡型号。', 'type' => 'string', 'required' => false, 'example' => 'V100'],
],
'required' => false,
],
'SpotSpec' => [
'description' => '抢占式实例配置。',
'type' => 'object',
'properties' => [
'SpotStrategy' => ['description' => 'SpotStrategy: 实例的抢占策略,取值范围:'."\n"
.'- SpotWithPriceLimit:设置上限价格的抢占式实例。'."\n"
.'- SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。', 'type' => 'string', 'required' => false, 'example' => 'SpotWithPriceLimit'],
'SpotDiscountLimit' => ['description' => '设置实例的每小时最高价格折扣,参数SpotStrategy取值为SpotWithPriceLimit时生效。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '9'],
],
'required' => false,
],
'UseSpotInstance' => ['description' => '是否使用抢占式实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
],
'HyperParameters' => [
'description' => '训练超参数配置。',
'type' => 'array',
'items' => [
'description' => '训练超参数配置。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '参数名。', 'type' => 'string', 'required' => false, 'example' => 'learning_rate'],
'Value' => ['description' => '参数值。', 'type' => 'string', 'required' => false, 'example' => '0.0001'],
],
'required' => false,
],
'required' => false,
],
'InputChannels' => [
'description' => '训练输入数据配置。',
'type' => 'array',
'items' => [
'description' => '训练输入数据配置。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '输入数据名称。', 'type' => 'string', 'required' => false, 'example' => 'model'],
'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'required' => false, 'example' => 'd-475megosidivjfgfq6'],
'VersionName' => ['type' => 'string', 'required' => false, 'description' => ''],
'InputUri' => ['description' => '输入数据链接。', 'type' => 'string', 'required' => false, 'example' => 'oss://pai-quickstart-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/modelscope/models/qwen2-0.5b/main/'],
'Options' => ['description' => '输入数据参数配置。', 'type' => 'string', 'required' => false, 'example' => '{"appendable": true}'],
],
'required' => false,
],
'required' => false,
],
'Labels' => [
'description' => '训练任务标签。',
'type' => 'array',
'items' => [
'description' => '训练任务标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'CreatedBy'],
'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'QuickStart'],
],
'required' => false,
],
'required' => false,
],
'OutputChannels' => [
'description' => '训练输出数据配置。',
'type' => 'array',
'items' => [
'description' => '训练输出数据配置。',
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'required' => false, 'example' => 'd-475megosidivjfgfq6'],
'Name' => ['description' => '输出数据名称。', 'type' => 'string', 'required' => false, 'example' => 'model'],
'OutputUri' => ['description' => '输出数据配置。', 'type' => 'string', 'required' => false, 'example' => 'oss://pai-quickstart-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/modelscope/models/qwen2-0.5b/main/'],
'VersionName' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
],
'required' => false,
],
'Scheduler' => [
'description' => '训练任务调度配置。',
'type' => 'object',
'properties' => [
'MaxRunningTimeInSeconds' => ['description' => '最大训练运行时长,单位为秒。数值为0时不限制最大运行时常。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
'MaxRunningTimeInMinutes' => ['description' => '最大训练运行时长,单位为分钟。数值为0时不限制最大运行时常。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
'required' => false,
],
'TrainingJobDescription' => ['description' => '训练任务描述。', 'type' => 'string', 'required' => false, 'example' => 'qwen large language model training'],
'TrainingJobName' => ['description' => '训练任务名称。', 'type' => 'string', 'required' => true, 'example' => 'qwen_llm'],
'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '12345'],
'AlgorithmSpec' => ['description' => '训练任务算法配置。', 'required' => false, '$ref' => '#/components/schemas/AlgorithmSpec'],
'CodeDir' => ['description' => '训练任务代码配置。', 'required' => false, '$ref' => '#/components/schemas/Location'],
'RoleArn' => ['description' => '指定角色的ARN。格式:acs:ram::$accountID:role/$roleName。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1157703270994901:role/aliyunserviceroleforpaiworkspace'],
'UserVpc' => [
'description' => 'VPC配置。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-dxiflssjx978sl'],
'SwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vs-icrc813vdsfol'],
'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'required' => false, 'example' => 'sg-qdfasd13sdasf'],
'ExtendedCIDRs' => [
'description' => '扩展网段配置。',
'type' => 'array',
'items' => ['description' => '扩展网段配置。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1/24'],
'required' => false,
],
'DefaultRoute' => ['description' => '默认路由接口,eth0表示默认路由走pai的vpc,eht1表示默认路由走用户vpc,默认为eth0。', 'type' => 'string', 'required' => false, 'example' => 'eth0'],
],
'required' => false,
],
'Settings' => ['description' => '训练任务额外参数配置。', 'required' => false, '$ref' => '#/components/schemas/JobSettings'],
'ExperimentConfig' => [
'description' => '训练任务关联实验配置。',
'type' => 'object',
'properties' => [
'ExperimentId' => ['description' => '训练任务关联实验ID。', 'type' => 'string', 'required' => false, 'example' => 'exp-ds9aefia90v'],
],
'required' => false,
],
'Environments' => [
'description' => '训练任务环境变量。',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'string', 'description' => '训练任务环境变量。', 'example' => 'debug=true'],
],
'PythonRequirements' => [
'description' => '训练任务Python包配置。',
'type' => 'array',
'items' => ['description' => '训练任务Python包配置。', 'type' => 'string', 'required' => false, 'example' => 'numpy'],
'required' => false,
],
'Priority' => ['description' => '训练任务优先级', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'AssignNodeSpec' => ['required' => false, '$ref' => '#/components/schemas/AssignNodeSpec', 'description' => ''],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'TrainingJobId' => ['description' => '训练任务ID。', 'type' => 'string', 'example' => 'traineyfz0m2hsfv'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
],
],
],
],
'title' => '创建训练任务',
'summary' => '创建训练任务。',
'changeSet' => [
['createdAt' => '2025-11-25T06:20:13.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-11-18T02:48:43.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-09-23T07:12:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-03T03:12:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-05-09T10:31:23.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-02-29T07:27:54.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-12-26T10:28:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-12-15T03:13:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-09-12T03:19:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-09-01T11:22:25.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-08-22T03:17:17.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-20T02:19:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-12-06T12:12:13.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-04-27T10:49:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrainingJob'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrainingJobId\\": \\"traineyfz0m2hsfv\\",\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]',
],
'DeleteAlgorithm' => [
'summary' => '删除算法。',
'path' => '/api/v1/algorithms/{AlgorithmId}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '146690',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => ['title' => '算法Id', 'description' => '算法ID。', 'type' => 'string', 'required' => false, 'example' => 'algo-sidjc8134hv'],
],
],
'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' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7'],
],
],
],
],
'title' => '删除算法',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlgorithm'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pai:DeleteAlgorithm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\"\\n}","type":"json"}]',
],
'DeleteAlgorithmVersion' => [
'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/x-www-form-urlencoded'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '146338',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => ['description' => '算法ID。', 'type' => 'string', 'required' => true, 'example' => 'algo-xsldfvu1334'],
],
[
'name' => 'AlgorithmVersion',
'in' => 'path',
'schema' => ['description' => '算法版本。', 'type' => 'string', 'required' => true, 'example' => 'v0.0.1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '删除算法版本',
'summary' => '删除算法版本。',
'changeSet' => [
['createdAt' => '2024-09-25T02:19:16.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlgorithmVersion'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pai:DeleteAlgorithmVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]',
],
'DeleteMachineGroup' => [
'summary' => 'delete machine group',
'path' => '/api/v1/resources/machinegroups/{MachineGroupID}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => true,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '124429',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'],
],
'parameters' => [
[
'name' => 'MachineGroupID',
'in' => 'path',
'schema' => ['type' => 'string', 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroupID' => ['type' => 'string', 'description' => ''],
'RequestId' => ['type' => 'string', 'description' => ''],
],
'description' => 'Schema of Response',
],
],
],
'staticInfo' => [
'substitutions' => ['PaiStudio::2022-01-12::DeleteMachineGroup'],
],
'changeSet' => [
['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMachineGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
],
'DeleteQuota' => [
'summary' => '您可以通过DeleteQuota删除一个资源配额。',
'path' => '/api/v1/quotas/{QuotaId}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '191219',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'QuotaId',
'in' => 'path',
'schema' => ['description' => '需要删除的Quota identifier。', 'type' => 'string', 'required' => false, 'example' => 'quota1ci8g793pgm'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'QuotaId' => ['title' => 'Quota Id', 'description' => 'Quota ID。', 'type' => 'string', 'example' => 'quotamtl37ge7gkvdz'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除资源配额',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:DeleteQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"QuotaId\\": \\"quotamtl37ge7gkvdz\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n quotamtl37ge7gkvdz\\n","errorExample":""}]',
],
'DeleteResourceGroup' => [
'path' => '/api/v1/resources/{ResourceGroupID}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '125213',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => ['title' => 'A short description of struct', 'description' => 'ResourceGroup的ID。', 'type' => 'string', 'required' => false, 'example' => 'rgvl9d6utwcscukh'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
'ResourceGroupID' => ['description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'example' => 'rgvl9d6utwcscukh'],
],
],
],
],
'title' => '删除资源组',
'summary' => '您可以使用DeleteResourceGroup删除资源组。',
'changeSet' => [
['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceGroup'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pai:DeleteResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"ResourceGroupID\\": \\"rgvl9d6utwcscukh\\"\\n}","type":"json"}]',
],
'DeleteResourceGroupMachineGroup' => [
'summary' => 'delete machine group',
'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups/{MachineGroupID}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => true,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '125207',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'MachineGroupID',
'in' => 'path',
'schema' => ['type' => 'string', 'description' => ''],
],
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => ['type' => 'string', 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroupID' => ['type' => 'string', 'description' => ''],
'RequestId' => ['type' => 'string', 'description' => ''],
],
'description' => 'Schema of Response',
],
],
],
'staticInfo' => [
'substitutions' => ['PaiStudio::2022-01-12::DeleteResourceGroupMachineGroup'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceGroupMachineGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
],
'DeleteTrainingJob' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '132982',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => false, 'example' => 'train76rcaupa2cz'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4cc83062-9bcb-4ab3-979e-2e571a35834f'],
],
],
],
],
'title' => '删除训练任务',
'summary' => '删除一个训练任务。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJob'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4cc83062-9bcb-4ab3-979e-2e571a35834f\\"\\n}","type":"json"}]',
],
'DeleteTrainingJobLabels' => [
'summary' => '删除训练任务的标签。',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/labels',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '132984',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'trainw52bqlfjbjc'],
],
[
'name' => 'Keys',
'in' => 'query',
'schema' => ['description' => '标签的键。', 'type' => 'string', 'required' => true, 'example' => 'RootModelID'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
],
],
],
'title' => '删除训练任务标签',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJobLabels'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'GetAlgorithm' => [
'summary' => '获取算法详情。',
'path' => '/api/v1/algorithms/{AlgorithmId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => ['description' => '算法ID。', 'type' => 'string', 'required' => false, 'example' => 'algo-xsldfvu1334'],
],
],
'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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'AlgorithmDescription' => ['description' => '算法描述。', 'type' => 'string', 'example' => 'Large language model training.'],
'AlgorithmId' => ['description' => '算法ID。', 'type' => 'string', 'example' => 'algo-xsldfvu1334'],
'AlgorithmName' => ['description' => '算法名。', 'type' => 'string', 'example' => 'llm_training'],
'AlgorithmProvider' => ['description' => '算法提供方。', 'type' => 'string', 'example' => 'pai'],
'GmtCreateTime' => ['description' => '算法创建时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'GmtModifiedTime' => ['description' => '算法更新时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '12345'],
'UserId' => ['description' => '算法归属用户ID。', 'type' => 'string', 'example' => '123456789'],
'TenantId' => ['description' => '算法归属租户ID。', 'type' => 'string', 'example' => '123456789'],
'DisplayName' => ['description' => '算法展示名。', 'type' => 'string', 'example' => 'llm_training'],
],
],
],
],
'title' => '获取算法详情',
'changeSet' => [
['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-04-27T10:49:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithm'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pai:GetAlgorithm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AlgorithmDescription\\": \\"Large language model training.\\",\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"TenantId\\": \\"123456789\\",\\n \\"DisplayName\\": \\"llm_training\\"\\n}","type":"json"}]',
],
'GetAlgorithmVersion' => [
'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => ['description' => '算法ID。', 'type' => 'string', 'required' => false, 'example' => 'algo-xsldfvu1334'],
],
[
'name' => 'AlgorithmVersion',
'in' => 'path',
'schema' => ['description' => '算法版本。', 'type' => 'string', 'required' => false, 'example' => 'v0.0.1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求返回数据。',
'type' => 'object',
'properties' => [
'AlgorithmSpec' => ['description' => '算法详情。', '$ref' => '#/components/schemas/AlgorithmSpec'],
'AlgorithmId' => ['description' => '算法ID。', 'type' => 'string', 'example' => 'algo-xsldfvu1334'],
'AlgorithmName' => ['description' => '算法名。', 'type' => 'string', 'example' => 'llm_training'],
'AlgorithmProvider' => ['description' => '算法提供方。', 'type' => 'string', 'example' => 'pai'],
'AlgorithmVersion' => ['description' => '算法版本。', 'type' => 'string', 'example' => 'v0.0.1'],
'GmtCreateTime' => ['description' => '算法创建时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'GmtModifiedTime' => ['description' => '算法更新时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'UserId' => ['description' => '算法归属用户ID。', 'type' => 'string', 'example' => '123456789'],
'TenantId' => ['description' => '算法归属租户ID。', 'type' => 'string', 'example' => '123456789'],
],
],
],
],
'title' => '获取算法版本详情',
'summary' => '获取算法版本详情。',
'changeSet' => [
['createdAt' => '2022-04-27T10:50:46.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmVersion'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pai:GetAlgorithmVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmSpec\\": {\\n \\"OutputChannels\\": [\\n {\\n \\"Description\\": \\"模型输出。\\",\\n \\"Required\\": true,\\n \\"Properties\\": {},\\n \\"Name\\": \\"Model\\",\\n \\"SupportedChannelTypes\\": [\\n \\"oss\\"\\n ]\\n }\\n ],\\n \\"HyperParameters\\": [\\n {\\n \\"DefaultValue\\": \\"0\\",\\n \\"Type\\": \\"Integer\\",\\n \\"Description\\": \\"参数定义了训练的batch_size。\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"batch_size\\",\\n \\"Range\\": {\\n \\"Enum\\": [\\n \\"0\\"\\n ],\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": \\"0\\",\\n \\"Maximum\\": \\"10\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"ExclusiveMaximum\\": true,\\n \\"Pattern\\": \\"^\\\\\\\\+?[1-9][0-9]*$\\"\\n },\\n \\"DisplayName\\": \\"Batch Size\\"\\n }\\n ],\\n \\"JobType\\": \\"TFJob\\",\\n \\"Command\\": [\\n \\"python train.py\\"\\n ],\\n \\"MetricDefinitions\\": [\\n {\\n \\"Description\\": \\"训练损失函数。\\",\\n \\"Regex\\": \\".*train:loss=([-+]?[0-9]*\\\\\\\\\\\\\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*\\",\\n \\"Name\\": \\"loss\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"Description\\": \\"模型输出。\\",\\n \\"Required\\": true,\\n \\"Properties\\": {},\\n \\"Name\\": \\"Model\\",\\n \\"SupportedChannelTypes\\": [\\n \\"oss\\"\\n ]\\n }\\n ],\\n \\"SupportsDistributedTraining\\": true,\\n \\"Image\\": \\"registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0\\",\\n \\"SupportedInstanceTypes\\": [\\n \\"ecs.g6.2xlarge\\"\\n ],\\n \\"ComputeResource\\": {\\n \\"Policy\\": {\\n \\"Version\\": \\"V1\\",\\n \\"Value\\": \\"[{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"MaxTotalCount\\\\\\\\\\\\\\":4,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":100}}},{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":5,\\\\\\\\\\\\\\"MaxTotalCount\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":20},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":80}}},{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":11,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":40},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":60}}}]\\"\\n }\\n },\\n \\"CodeDir\\": {\\n \\"LocationType\\": \\"OSS\\",\\n \\"LocationValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Customization\\": {\\n \\"CodeDir\\": true\\n },\\n \\"ResourceRequirements\\": [\\n {\\n \\"Key\\": \\"SupportedMachineTypes\\",\\n \\"Operator\\": \\"in\\",\\n \\"Values\\": [\\n \\"ecs.gn5-c4g1.xlarge\\"\\n ]\\n }\\n ],\\n \\"ProgressDefinitions\\": {\\n \\"OverallProgress\\": {\\n \\"Description\\": \\"training progress\\",\\n \\"Regex\\": \\"^[0-9]+([.][0-9]+){0,1}$\\"\\n },\\n \\"RemainingTime\\": {\\n \\"Description\\": \\"training remaining time\\",\\n \\"Regex\\": \\"^[0-9]+([.][0-9]+){0,1}$\\"\\n }\\n }\\n },\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"TenantId\\": \\"123456789\\"\\n}","type":"json"}]',
],
'GetMachineGroup' => [
'path' => '/api/v1/resources/machinegroups/{MachineGroupID}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '124271',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'],
],
'parameters' => [
[
'name' => 'MachineGroupID',
'in' => 'path',
'schema' => ['type' => 'string', 'required' => true, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroupID' => ['type' => 'string', 'description' => ''],
'OrderID' => ['type' => 'string', 'description' => ''],
'PAIResourceID' => ['type' => 'string', 'description' => ''],
'Status' => ['type' => 'string', 'description' => ''],
'PayType' => ['type' => 'string', 'description' => ''],
'PricingCycle' => ['type' => 'string', 'description' => ''],
'Duration' => ['type' => 'string', 'description' => ''],
'EcsType' => ['type' => 'string', 'description' => ''],
'Count' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'RegionID' => ['type' => 'string', 'description' => ''],
'GmtCreated' => ['type' => 'string', 'description' => ''],
'GmtModified' => ['type' => 'string', 'description' => ''],
'GmtStarted' => ['type' => 'string', 'description' => ''],
'GmtExpired' => ['type' => 'string', 'description' => ''],
'RequestId' => ['type' => 'string', 'description' => ''],
'SupportedDrivers' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'description' => '',
],
'DefaultDriver' => ['type' => 'string', 'description' => ''],
'OrderInstanceId' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['PaiStudio::2022-01-12::GetMachineGroup'],
],
'summary' => 'get machine group',
'changeSet' => [
['createdAt' => '2024-05-23T02:15:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-08-30T07:22:54.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMachineGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"\\",\\n \\"OrderID\\": \\"\\",\\n \\"PAIResourceID\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"PayType\\": \\"\\",\\n \\"PricingCycle\\": \\"\\",\\n \\"Duration\\": \\"\\",\\n \\"EcsType\\": \\"\\",\\n \\"Count\\": 0,\\n \\"RegionID\\": \\"\\",\\n \\"GmtCreated\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"GmtStarted\\": \\"\\",\\n \\"GmtExpired\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"SupportedDrivers\\": [\\n \\"\\"\\n ],\\n \\"DefaultDriver\\": \\"\\",\\n \\"OrderInstanceId\\": \\"\\"\\n}","type":"json"}]',
],
'GetNodeMetrics' => [
'path' => '/api/v1/resources/{ResourceGroupID}/nodemetrics/{MetricType}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '151753',
'abilityTreeNodes' => ['FEATURElearn8Y18OQ'],
],
'parameters' => [
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => ['description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'required' => true, 'example' => 'rgf0zhfqn1d4ity2'],
],
[
'name' => 'GPUType',
'in' => 'query',
'schema' => ['description' => '显卡类型。可能值:'."\n"
.'- V100'."\n"
.'- A100'."\n"
.'- A10'."\n"
.'- T4'."\n"
.'- P100', 'type' => 'string', 'required' => false, 'example' => 'V100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '2024-07-08T02:23:30.292Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-07-10T10:17:06'],
],
[
'name' => 'TimeStep',
'in' => 'query',
'schema' => ['description' => '时间步长,默认值:5m。支持的时长单位的取值范围:'."\n"
."\n"
.'- h:小时。'."\n"
."\n"
.'- m:分钟。'."\n"
."\n"
.'- s:秒。'."\n"
."\n"
.'当值不带单位时,默认使用单位:s(秒)。', 'type' => 'string', 'required' => false, 'example' => '1h'],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => ['description' => '是否显示非必要信息,非必要信息目前包含Labels'."\n"
.'目前值支持:'."\n"
."\n"
.'false:不显示非必要信息(默认值)'."\n"
.'true:显示非必要信息'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'MetricType',
'in' => 'path',
'schema' => ['description' => '查询的指标名', 'type' => 'string', 'required' => true, 'example' => 'CpuUsageRate'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'NodesMetrics' => [
'description' => '节点metric信息。',
'type' => 'array',
'items' => ['description' => '节点metric信息。', '$ref' => '#/components/schemas/NodeMetric'],
],
'ResourceGroupID' => ['description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'],
'MetricType' => ['description' => '查询的指标名。', 'type' => 'string', 'example' => 'DiskWriteRate'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['Cms::2019-01-01::DescribeMetricList'],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '获取节点维度的指标数据',
'summary' => '您可以通过GetNodeMetrics获取资源组节点的指标信息。',
'changeSet' => [
['createdAt' => '2022-08-29T02:34:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeMetrics'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NodesMetrics\\": [\\n {\\n \\"NodeID\\": \\"-i12****node\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": 0,\\n \\"Value\\": \\"23000\\"\\n }\\n ],\\n \\"GPUType\\": \\"GU108\\"\\n }\\n ],\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"MetricType\\": \\"DiskWriteRate\\"\\n}","type":"json"}]',
],
'GetQuota' => [
'path' => '/api/v1/quotas/{QuotaId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '191160',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'QuotaId',
'in' => 'path',
'schema' => ['description' => '获取详细信息的Quota identifier。', 'type' => 'string', 'required' => false, 'example' => 'quota1ci8g79****'],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => ['description' => '是否显示详细信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'WithNodeMeta',
'in' => 'query',
'schema' => ['title' => '是否返回绑定到Quota的节点meta信息', 'description' => '是否返回绑定到Quota的节点meta信息', 'type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回内容。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
'QuotaId' => ['title' => 'Quota Id', 'description' => '资源配额ID。', 'type' => 'string', 'example' => 'quotajradxh4****'],
'QuotaName' => ['title' => 'Quota名称', 'description' => '资源配额名称。', 'type' => 'string', 'example' => 'test-quota'],
'ResourceType' => ['title' => 'Quota资源类型', 'description' => 'Quota资源类型。', 'type' => 'string', 'example' => 'ECS'],
'ParentQuotaId' => ['title' => '父Quota Id', 'description' => '父Quota ID。', 'type' => 'string', 'example' => 'quota1ci8g79****'],
'ResourceGroupIds' => [
'description' => '资源配额对应的资源组信息。',
'type' => 'array',
'items' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg69rj0leslw****'],
],
'AllocateStrategy' => ['title' => '资源分配策略', 'description' => '资源分配策略。', 'type' => 'string', 'example' => 'ByNodeSpec'],
'Min' => ['description' => 'Min Quota配置。', '$ref' => '#/components/schemas/ResourceSpec'],
'Description' => ['title' => 'Quota描述', 'description' => 'Quota描述。', 'type' => 'string', 'example' => 'this is a test quota'],
'Labels' => [
'title' => 'Quota标签',
'description' => 'Quota标签。',
'type' => 'array',
'items' => ['description' => 'label key value对。', '$ref' => '#/components/schemas/Label'],
],
'CreatorId' => ['title' => 'Quota创建人Id', 'description' => 'Quota创建人ID。', 'type' => 'string', 'example' => '1884692****'],
'LatestOperationId' => ['title' => 'Quota最近变更Id', 'description' => 'Quota最近变更ID。', 'type' => 'string', 'example' => 'operation****'],
'Status' => ['title' => 'Quota状态', 'description' => 'Quota状态。', 'type' => 'string', 'example' => 'Ready'],
'ReasonCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => '“”'],
'ReasonMessage' => ['title' => '错误原因', 'description' => '错误原因。', 'type' => 'string', 'example' => '“”'],
'GmtCreatedTime' => ['title' => 'Quota创建时间', 'description' => 'Quota创建时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'GmtModifiedTime' => ['title' => 'Quota修改时间', 'description' => 'Quota修改时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'QuotaDetails' => ['title' => 'Quota详情', 'description' => 'Quota的详情。', '$ref' => '#/components/schemas/QuotaDetails'],
'QuotaConfig' => ['description' => 'Quota对应配置:'."\n"
."\n"
.'- VPC信息'."\n"
."\n"
.'- 是否支持RDMA'."\n"
."\n"
.'- ACS对应配置(若资源类型为ACS生效)', '$ref' => '#/components/schemas/QuotaConfig'],
'Workspaces' => [
'title' => 'Quota关联的工作空间',
'description' => 'Quota关联的工作空间。',
'type' => 'array',
'items' => ['description' => '所关联的工作空间信息。', '$ref' => '#/components/schemas/WorkspaceIdName'],
],
'SubQuotas' => [
'title' => 'Quota的子Quota列表',
'description' => 'Quota的子Quota列表。',
'type' => 'array',
'items' => ['description' => '包含的子Quota的ID。', '$ref' => '#/components/schemas/QuotaIdName'],
],
'QueueStrategy' => ['description' => 'Quota上任务的排队策略。', 'type' => 'string', 'example' => 'PaiStrategyIntelligent'],
'Version' => ['title' => '版本信息。当resource type为ECS时生效。', 'description' => '版本信息。当resource type为ECS时生效。', 'type' => 'string', 'example' => '1.0'],
'HyperZones' => [
'title' => '高性能网络区列表',
'description' => '高性能网络区列表',
'type' => 'array',
'items' => ['title' => '高性能网络区ID', 'description' => '高性能网络区ID', 'type' => 'string', 'example' => 'A3'],
],
'QuotaCluster' => ['title' => '由配额内资源组成的集群规格与状态', 'description' => '由配额内资源组成的集群规格与状态', '$ref' => '#/components/schemas/QuotaCluster'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取资源配额详情',
'summary' => '您可以通过GetQuota获取一个资源配额详情,以了解当前资源使用情况,方便进行资源管理和规划。',
'changeSet' => [
['createdAt' => '2025-11-12T09:21:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-11-06T13:03:33.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-05-09T05:27:33.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:GetQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"QuotaId\\": \\"quotajradxh4****\\",\\n \\"QuotaName\\": \\"test-quota\\",\\n \\"ResourceType\\": \\"ECS\\",\\n \\"ParentQuotaId\\": \\"quota1ci8g79****\\",\\n \\"ResourceGroupIds\\": [\\n \\"rg69rj0leslw****\\"\\n ],\\n \\"AllocateStrategy\\": \\"ByNodeSpec\\",\\n \\"Min\\": {\\n \\"NodeSpecs\\": [\\n {\\n \\"Type\\": \\"ecs.g6.4xlarge\\",\\n \\"Count\\": 10,\\n \\"BindingPolicy\\": {\\n \\"NodeSpecCount\\": 5,\\n \\"IncludeNodes\\": [\\n \\"lrnabc\\"\\n ],\\n \\"ExcludeNodes\\": [\\n \\"lrndef\\"\\n ]\\n },\\n \\"HyperType\\": \\"\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"this is a test quota\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"testAccTag\\",\\n \\"Value\\": \\"nihao\\"\\n }\\n ],\\n \\"CreatorId\\": \\"1884692****\\",\\n \\"LatestOperationId\\": \\"operation****\\",\\n \\"Status\\": \\"Ready\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"QuotaDetails\\": {\\n \\"DesiredMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"ActualMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"RequestedQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"NodeStatistics\\": {\\n \\"ActualMinNodeNum\\": 0,\\n \\"ActualMinHyperNodeNum\\": 0,\\n \\"AllocatedNodeNum\\": 0,\\n \\"AllocatedHyperNodeNum\\": 0,\\n \\"EmptyNodeNum\\": 0,\\n \\"AllocatedHyperNodeDetails\\": [\\n {\\n \\"HyperNodeName\\": \\"\\",\\n \\"AllocatedNodeNum\\": 0,\\n \\"TotalNodeNum\\": 0,\\n \\"EmptyNodeNum\\": 0\\n }\\n ]\\n }\\n },\\n \\"QuotaConfig\\": {\\n \\"SupportRDMA\\": false,\\n \\"ClusterId\\": \\"ceeb3724255364***\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"192.168.0.1/24\\\\\\"\\"\\n ],\\n \\"RoleArn\\": \\"acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"nat-7j4mka9wguxj\\",\\n \\"EipAllocationId\\": \\"eip-h29r78ieufbih\\"\\n }\\n },\\n \\"SupportGPUDrivers\\": [\\n \\"470.199.02\\"\\n ],\\n \\"DefaultGPUDriver\\": \\"470.199.02\\",\\n \\"ACS\\": {\\n \\"ACSQuotaId\\": \\"rq-3kbt2gtimmyw7fgfgothocvh\\",\\n \\"AssociatedProducts\\": [\\n \\"PAI-DLC\\"\\n ]\\n },\\n \\"ResourceSpecs\\": [\\n {\\n \\"WorkspaceId\\": \\"122421\\",\\n \\"Product\\": \\"DLC\\",\\n \\"Specs\\": [\\n {\\n \\"SpecName\\": \\"spec_test\\",\\n \\"IsGuaranteedValid\\": true,\\n \\"IsOverSoldValid\\": true,\\n \\"CodeType\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Reason\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n }\\n ],\\n \\"EnablePreemptSubquotaWorkloads\\": false,\\n \\"EnableSubQuotaPreemption\\": true,\\n \\"SubQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorityUpperBound\\": 9,\\n \\"PreemptedProducts\\": [\\n \\"dlc\\"\\n ]\\n },\\n \\"EnableGPUShare\\": true,\\n \\"OversoldUsageConfig\\": {\\n \\"DisabledBy\\": \\"\\",\\n \\"Disabled\\": true\\n },\\n \\"SelfQuotaPreemptionConfig\\": {\\n \\"PreemptorPriorities\\": [\\n 0\\n ],\\n \\"PreemptedPriorities\\": [\\n 0\\n ],\\n \\"PreemptedProducts\\": [\\n \\"\\"\\n ]\\n },\\n \\"EniCacheConfig\\": {\\n \\"Enabled\\": true,\\n \\"CachePoolSize\\": 0\\n },\\n \\"SandboxCacheConfig\\": {\\n \\"Enabled\\": true\\n },\\n \\"UseCase\\": \\"\\",\\n \\"EnableSelfQuotaPreemption\\": true,\\n \\"ControlPlaneClusterId\\": \\"\\",\\n \\"IsEncryptedResource\\": true,\\n \\"WorkloadTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"ws123***\\",\\n \\"WorkspaceName\\": \\"\\"\\n }\\n ],\\n \\"SubQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\",\\n \\"Version\\": \\"1.0\\",\\n \\"HyperZones\\": [\\n \\"A3\\"\\n ],\\n \\"QuotaCluster\\": {\\n \\"ClusterType\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"DataSourceId\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"Endpoints\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Status\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n quotajradxh43rgb\\n test-quota\\n ECS\\n quota1ci8g793pgm\\n rg69rj0leslwdnbe\\n ByNodeSpec\\n \\n \\n ecs.g6.4xlarge\\n 10\\n \\n \\n this is a test quota\\n \\n Ready\\n 2023-06-22T00:00:00Z\\n 2023-06-22T00:00:00Z\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n \\n false\\n ceeb37xxxx\\n \\n \\n 470.199.02\\n \\n \\n \\n \\n ws123456\\n \\n \\n quota12345\\n dlc-quota\\n \\n PaiStrategyIntelligent\\n","errorExample":""}]',
],
'GetResourceGroup' => [
'path' => '/api/v1/resources/{ResourceGroupID}',
'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' => '124255',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => ['title' => 'get pai resource group details by id', 'description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'required' => true, 'example' => 'rgmhpp8ib5lprq9k'],
],
[
'name' => 'IsAIWorkspaceDataEnabled',
'in' => 'query',
'schema' => ['description' => '这个参数是可选参数。默认是true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '对应新增标签列表,最多包含20个子项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '实例的标签键。N 的取值范围为 1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['title' => '标签值', 'description' => '实例的标签值。N 的取值范围:1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'GmtCreatedTime' => ['title' => 'pai resource created time', 'description' => 'ResourceGroup创建时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'."\n"],
'GmtModifiedTime' => ['title' => 'pai resource group modified time', 'description' => 'ResourceGroup更新时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'."\n"],
'RequestId' => ['title' => 'request id', 'description' => '请求ID。', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'."\n"],
'Name' => ['description' => 'ResourceGroup名称。', 'type' => 'string', 'example' => 'TestResourceGroup'],
'CreatorID' => ['description' => 'ResourceGroup创建者的UserId。', 'type' => 'string', 'example' => '1612285282502324'],
'WorkspaceID' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '35201'],
'Status' => ['description' => 'ResourceGroup的状态。', 'type' => 'string', 'example' => 'Ready'],
'UserVpc' => ['description' => 'ResourceGroup打通VPC的详细信息。', '$ref' => '#/components/schemas/UserVpc'],
'ComputingResourceProvider' => [
'description' => 'ResourceGroup的计算资源类型。',
'type' => 'string',
'enumValueTitles' => ['Ecs' => 'Ecs', 'Lingjun' => 'Lingjun'],
'example' => 'ECS',
],
'ClusterID' => ['description' => 'ResourceGroup所属的集群ID。', 'type' => 'string', 'example' => 'cb2c7bde30b774e46a329c'],
'SupportRDMA' => ['description' => 'ResourceGroup是都支持RDMA。', 'type' => 'boolean', 'example' => 'true'],
'ResourceType' => ['description' => 'ResourceGroup的计算资源类型。', 'type' => 'string', 'example' => 'Ecs'],
'Description' => ['description' => 'ResourceGroup描述信息。', 'type' => 'string', 'example' => 'testDescription'],
'Tags' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagKey' => ['title' => '标签键', 'description' => '实例的标签键。N 的取值范围为 1~20。', 'type' => 'string', 'example' => 'testKey'],
'TagValue' => ['title' => '标签值', 'description' => '实例的标签值。N 的取值范围:1~20。', 'type' => 'string', 'example' => 'testValue'],
],
'description' => '',
],
],
'Version' => ['type' => 'string', 'description' => ''],
],
],
],
],
'title' => '获取资源组详情',
'summary' => '您可以通过GetResourceGroup获取资源组的详情信息。',
'changeSet' => [
['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-01-04T03:16:22.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-05-11T03:07:02.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-10T09:57:38.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-06T05:56:43.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-04T06:45:06.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-03T03:11:36.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroup'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pai:GetResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\\\n\\",\\n \\"Name\\": \\"TestResourceGroup\\",\\n \\"CreatorID\\": \\"1612285282502324\\",\\n \\"WorkspaceID\\": \\"35201\\",\\n \\"Status\\": \\"Ready\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"192.168.0.1/24\\\\\\"\\"\\n ],\\n \\"RoleArn\\": \\"acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"nat-7j4mka9wguxj\\",\\n \\"EipAllocationId\\": \\"eip-h29r78ieufbih\\"\\n }\\n },\\n \\"ComputingResourceProvider\\": \\"ECS\\",\\n \\"ClusterID\\": \\"cb2c7bde30b774e46a329c\\",\\n \\"SupportRDMA\\": true,\\n \\"ResourceType\\": \\"Ecs\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\"\\n }\\n ],\\n \\"Version\\": \\"\\"\\n}","type":"json"}]',
],
'GetResourceGroupMachineGroup' => [
'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups/{MachineGroupID}',
'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' => '125186',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'MachineGroupID',
'in' => 'path',
'schema' => ['description' => 'MachineGroup的ID。', 'type' => 'string', 'required' => true, 'example' => 'mgmioirqjgw6c5lg'],
],
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => ['description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'required' => true, 'example' => 'rgf0zhfqn1d4ity2'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '对应新增标签列表,最多包含20个子项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '实例的标签键。N 的取值范围为 1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['title' => '标签值', 'description' => '实例的标签值。N 的取值范围为 1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroupID' => ['description' => 'MachineGroup的ID。', 'type' => 'string', 'example' => 'mgmioirqjgw6c5lg'],
'ResourceGroupID' => ['description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'],
'Status' => ['description' => '实例状态。'."\n"
.'Creating:创建中'."\n"
.'Ready:运行中'."\n"
.'Expiring: 即将过期'."\n"
.'Expired: 已过期'."\n"
.'Stopping:停止中'."\n"
.'Stopped:已停止', 'type' => 'string', 'example' => 'Ready'],
'PaymentType' => ['description' => '付费类型。', 'type' => 'string', 'example' => 'PREPAY'],
'PaymentDurationUnit' => ['description' => '机器组计费时间单位。', 'type' => 'string', 'example' => 'Month'],
'PaymentDuration' => ['description' => '付费时长。当PaymentDurationUnit取值为Month时,取值:1、2、3、4、5、6、7、8、9、12、24、36、48、60。', 'type' => 'string', 'example' => '1'],
'EcsSpec' => ['description' => 'Ecs规格。', 'type' => 'string', 'example' => 'ecs.c6.large'],
'EcsCount' => ['description' => 'Ecs实例数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'GmtCreatedTime' => ['description' => '机器组创建时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'GmtModifiedTime' => ['description' => '机器组更新时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'GmtStartedTime' => ['description' => '机器组启动时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'],
'GmtExpiredTime' => ['description' => '机器组失效时间。', 'type' => 'string', 'example' => '2023-06-22T00:00:00Z'."\n"],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
'Cpu' => ['description' => '机器组中每一台机器的CPU总核数。', 'type' => 'string', 'example' => '2'],
'Gpu' => ['description' => '机器组中每一台机器的GPU核数。', 'type' => 'string', 'example' => '8'],
'GpuType' => ['description' => '机器组中每一台机器的GPU卡型。', 'type' => 'string', 'example' => 'A100'],
'Memory' => ['description' => '机器组中每一台机器的内存数。', 'type' => 'string', 'example' => '64'],
'SupportedDrivers' => [
'description' => '机器组中节点支持的GPU显卡驱动版本。',
'type' => 'array',
'items' => ['description' => '535,550', 'type' => 'string', 'example' => '535,550'],
],
'DefaultDriver' => ['description' => '机器组中每一台机器的默认的显卡驱动的版本。', 'type' => 'string', 'example' => '535'],
'Name' => ['description' => '机器组名称。', 'type' => 'string', 'example' => 'testMachineGroup'],
'Tags' => [
'description' => '要查询的Tags列表,采用JSON字符串的形式,最多包含20个子项。',
'type' => 'array',
'items' => [
'description' => '标签数组。数组元素个数N取值范围:1~20。',
'type' => 'object',
'properties' => [
'TagKey' => ['title' => '标签键', 'description' => '实例的标签键。N 的取值范围为 1~20。', 'type' => 'string', 'example' => 'TestKey'],
'TagValue' => ['title' => '标签值', 'description' => '实例的标签值。N 的取值范围为 1~20。', 'type' => 'string', 'example' => 'TestValue'],
],
],
],
'AllocatableCpu' => ['type' => 'string', 'description' => ''],
'AllocatableMemory' => ['type' => 'string', 'description' => ''],
'SystemReservedCpu' => ['type' => 'string', 'description' => ''],
'SystemReservedMemory' => ['type' => 'string', 'description' => ''],
],
],
],
],
'title' => '获取机器组详情',
'summary' => '您可以通过GetResourceGroupMachineGroup获取机器组的详情。',
'changeSet' => [
['createdAt' => '2025-08-22T05:48:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-01-04T03:16:22.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-08-30T07:22:54.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-07-21T07:16:01.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupMachineGroup'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pai:GetResourceGroupMachineGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'MachineGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}/machinegroup/{#MachineGroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"mgmioirqjgw6c5lg\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"Status\\": \\"Ready\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"PaymentDurationUnit\\": \\"Month\\",\\n \\"PaymentDuration\\": \\"1\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"EcsCount\\": 1,\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtStartedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtExpiredTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Cpu\\": \\"2\\",\\n \\"Gpu\\": \\"8\\",\\n \\"GpuType\\": \\"A100\\",\\n \\"Memory\\": \\"64\\",\\n \\"SupportedDrivers\\": [\\n \\"535,550\\"\\n ],\\n \\"DefaultDriver\\": \\"535\\",\\n \\"Name\\": \\"testMachineGroup\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"AllocatableCpu\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCpu\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\"\\n}","type":"json"}]',
],
'GetResourceGroupRequest' => [
'summary' => '您可以通过GetResourceGroupRequest获取资源组已经被分配的资源数。',
'path' => '/api/v1/resources/data/request',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '146159',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'],
],
'parameters' => [
[
'name' => 'ResourceGroupID',
'in' => 'query',
'schema' => ['description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'required' => true, 'example' => 'rgf0zhfqn1d4ity2'],
],
[
'name' => 'PodStatus',
'in' => 'query',
'schema' => ['description' => '容器状态。包括:'."\n"
."\n"
.'- Waiting'."\n"
.'- Running'."\n"
.'- Terminated', 'type' => 'string', 'required' => false, 'example' => 'Running', 'default' => 'Running'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestCPU' => ['description' => '已经分配的cpu总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'requestMemory' => ['description' => '已经分配的内存总数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'requestGPU' => ['description' => '已经分配的gpu总数', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'requestGPUInfos' => [
'description' => '按照卡型单独统计的已经被分配的gpu资源',
'type' => 'array',
'items' => ['description' => '按照卡型单独统计的已经被分配的gpu资源', '$ref' => '#/components/schemas/GPUInfo'],
],
],
],
],
],
'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '获取资源组已经被分配的资源',
'changeSet' => [
['createdAt' => '2022-07-21T07:16:01.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupRequest'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestCPU\\": 1,\\n \\"requestMemory\\": 2,\\n \\"requestGPU\\": 8,\\n \\"requestGPUInfos\\": [\\n {\\n \\"count\\": 1,\\n \\"type\\": \\"T4\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetResourceGroupTotal' => [
'path' => '/api/v1/resources/data/total',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '145960',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'],
],
'parameters' => [
[
'name' => 'ResourceGroupID',
'in' => 'query',
'schema' => ['description' => 'Resource Group的ID。', 'type' => 'string', 'required' => false, 'example' => 'rgf0zhfqn1d4ity2'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'totalCPU' => ['description' => 'cpu总核数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'totalMemory' => ['description' => '总内存', 'type' => 'integer', 'format' => 'int32', 'example' => '300'],
'totalGPU' => ['description' => '总gpu核数', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
'totalGPUInfos' => [
'description' => 'GPU按照卡型统计的资源。',
'type' => 'array',
'items' => ['description' => '按照GPU卡型分别统计的每种卡型的资源。', '$ref' => '#/components/schemas/GPUInfo'],
],
],
],
],
],
'title' => '获取资源组资源总数',
'summary' => '您可以通过GetResourceGroupTotal获取 Resource Group资源总数。',
'changeSet' => [
['createdAt' => '2022-07-21T07:16:01.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupTotal'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCPU\\": 100,\\n \\"totalMemory\\": 300,\\n \\"totalGPU\\": 24,\\n \\"totalGPUInfos\\": [\\n {\\n \\"count\\": 1,\\n \\"type\\": \\"T4\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetSpotPriceHistory' => [
'path' => '/api/v1/spots/{InstanceType}/pricehistory',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '213678',
'abilityTreeNodes' => ['FEATURElearnZO51AS'],
],
'parameters' => [
[
'name' => 'InstanceType',
'in' => 'path',
'schema' => ['description' => '抢占式实例的实例规格。支持ECS规格和灵骏规格', 'type' => 'string', 'required' => false, 'example' => 'ml.gu7xf.8xlarge-gu108'],
],
[
'name' => 'SpotDuration',
'in' => 'query',
'schema' => ['description' => '抢占式实例的保留时长,单位为小时。 注意目前仅ECS规格支持设置抢占式实例保留时长,默认值:0。取值范围:'."\n"
.'- 1:创建后阿里云会保证实例运行1小时不会被自动释放;超过1小时后,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。'."\n"
.'- 0:创建后,阿里云不保证实例运行1小时,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询抢占式实例历史价格的起始时间,最大值不得超过指定的结束时间7天。按照ISO 8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。默认值:空,空代表结束时间前3天。', 'type' => 'string', 'required' => false, 'example' => '2024-12-26T09:36:46Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询抢占式实例历史价格的结束时间。按照ISO 8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。默认值:空,空表示当前时间。', 'type' => 'string', 'required' => false, 'example' => '2024-12-30T09:36:46Z'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数:当前页码,默认值***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' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '用于排序的字段名,默认值: GmtCreatedTime,可选字段:'."\n"
."\n"
.'- GmtCreatedTime'."\n"
."\n"
.'仅查询灵骏规格的历史价格时该参数生效',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['GmtCreatedTime' => 'GmtCreatedTime'],
'example' => 'GmtCreatedTime',
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'description' => '排序顺序。默认值:asc,取值如下:'."\n"
.'- desc:降序。'."\n"
.'- asc:升序。'."\n"
."\n"
.'仅查询灵骏规格的历史价格时该参数生效',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'],
'example' => 'asc',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '抢占式实例历史价格详情',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8BDA4440-DD3C-5F4B-BBDD-94A9CE1E75C7'],
'SpotPriceHistory' => [
'description' => '抢占式实例历史价格详情列表',
'type' => 'array',
'items' => ['description' => '抢占式实例历史价格详情', '$ref' => '#/components/schemas/SpotPriceItem'],
],
'TotalCount' => ['description' => '抢占式实例历史价格总数', 'type' => 'integer', 'format' => 'int32', 'example' => '194'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取抢占式实例历史价格',
'summary' => '获取抢占式实例历史价格',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BDA4440-DD3C-5F4B-BBDD-94A9CE1E75C7\\",\\n \\"SpotPriceHistory\\": [\\n {\\n \\"ZoneId\\": \\"cn-wulanchabu-a\\",\\n \\"InstanceType\\": \\"ml.gu8xf.8xlarge-gu108\\",\\n \\"SpotDiscount\\": 0.1,\\n \\"Timestamp\\": \\"2024-01-17T06:00:00Z\\"\\n }\\n ],\\n \\"TotalCount\\": 194\\n}","type":"json"}]',
],
'GetToken' => [
'path' => '/api/v1/tokens',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '189411',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'query',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'traincclrt205dcs'],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => ['description' => '分享链接过期时间(默认为604800秒),最小值为0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'],
'Token' => ['description' => '任务分享令牌,可作为API GetJob的参数Token,查看分享的任务的信息。', 'type' => 'string', 'example' => 'ql4OU830nJaF17LP6KTry4a9DvnjIXHP'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取训练任务分享令牌',
'summary' => '获取训练任务分享令牌。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"Token\\": \\"ql4OU830nJaF17LP6KTry4a9DvnjIXHP\\"\\n}","type":"json"}]',
],
'GetTrainingJob' => [
'summary' => '获取训练任务的详情。',
'path' => '/api/v1/trainingjobs/{TrainingJobId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132929',
'abilityTreeNodes' => ['FEATURElearnVYA4L9'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'train129f212o89d'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OutputChannels' => [
'description' => '训练输出数据配置。',
'type' => 'array',
'items' => [
'description' => '训练输出数据配置。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '输出数据名称。', 'type' => 'string', 'example' => 'model'],
'OutputUri' => ['description' => '输出数据链接地址。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/model/'],
'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'example' => 'd-8o0hh35po15ejcdq2p'],
'VersionName' => ['description' => '数据集版本。', 'type' => 'string', 'example' => 'v1'],
],
],
],
'Status' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'Running'],
'HyperParameters' => [
'description' => '训练超参数配置。',
'type' => 'array',
'items' => [
'description' => '训练超参数配置。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '参数名。', 'type' => 'string', 'example' => 'learning_rate'],
'Value' => ['description' => '参数值。', 'type' => 'string', 'example' => '0.0001'],
],
],
],
'TrainingJobName' => ['description' => '训练任务名称。', 'type' => 'string', 'example' => 'qwen_llm'],
'TrainingJobId' => ['description' => '训练任务ID。', 'type' => 'string', 'example' => 'traini6hhxiq69eo'],
'Scheduler' => [
'description' => '训练任务调度配置。',
'type' => 'object',
'properties' => [
'MaxRunningTimeInSeconds' => ['description' => '最大训练运行时长,单位为秒。数值为0时不限制最大运行时常。', 'type' => 'string', 'example' => '0'],
'MaxRunningTimeInMinutes' => ['description' => '最大运行时长(分钟)。', 'type' => 'string', 'example' => '100'],
],
],
'ReasonMessage' => ['description' => '训练任务错误原因。', 'type' => 'string', 'example' => 'None'],
'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '86995'],
'ComputeResource' => [
'description' => '计算资源配置。',
'type' => 'object',
'properties' => [
'EcsCount' => ['description' => 'Ecs实例数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'EcsSpec' => ['description' => 'Ecs型号。', 'type' => 'string', 'example' => 'ecs.gn5-c8g1.2xlarge'],
'ResourceId' => ['description' => '资源配额(Quota)ID。', 'type' => 'string', 'example' => 'quotam670lixikcl'],
'ResourceName' => ['description' => '资源配额名称。', 'type' => 'string', 'example' => 'quota'],
'InstanceCount' => ['description' => '资源配额使用实例数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'InstanceSpec' => [
'description' => '资源配额实例配置。',
'type' => 'object',
'properties' => [
'CPU' => ['description' => '实例CPU核数。', 'type' => 'string', 'example' => '8'],
'Memory' => ['description' => '实例内存大小,单位为GiB。', 'type' => 'string', 'example' => '32'],
'SharedMemory' => ['description' => '实例共享内存大小,单位为GiB。', 'type' => 'string', 'example' => '32'],
'GPU' => ['description' => '实例GPU显卡数量。', 'type' => 'string', 'example' => '1'],
'GPUType' => ['description' => '实例GPU显卡型号。', 'type' => 'string', 'example' => 'V100'],
],
],
'UseSpotInstance' => ['description' => '是否使用抢占式实例。', 'type' => 'boolean', 'example' => 'true'],
'SpotSpec' => [
'description' => '抢占式实例配置。',
'type' => 'object',
'properties' => [
'SpotStrategy' => ['description' => 'SpotStrategy: 实例的抢占策略,取值范围:'."\n"
.'- SpotWithPriceLimit:设置上限价格的抢占式实例。'."\n"
.'- SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。', 'type' => 'string', 'example' => 'SpotWithPriceLimit'],
'SpotDiscountLimit' => ['description' => '设置实例的每小时最高价格折扣,参数SpotStrategy取值为SpotWithPriceLimit时生效。', 'type' => 'number', 'format' => 'float', 'example' => '0.9'],
],
],
],
],
'Labels' => [
'description' => '训练任务标签列表。',
'type' => 'array',
'items' => [
'description' => '训练任务标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签名。', 'type' => 'string', 'example' => 'CreatedBy'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'QuickStart'],
],
],
],
'AlgorithmProvider' => ['description' => '算法提供方。', 'type' => 'string', 'example' => 'pai'],
'InputChannels' => [
'description' => '训练输入数据配置。',
'type' => 'array',
'items' => [
'description' => '训练输入数据配置。',
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'example' => 'd-475megosidivjfgfq6'],
'Name' => ['description' => '输入数据名称。', 'type' => 'string', 'example' => 'model'],
'InputUri' => ['description' => '输入数据链接。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/model/'],
'Options' => ['description' => '输入数据的文件系统参数。', 'type' => 'string', 'example' => 'ossAppendable=true'],
'VersionName' => ['description' => '数据集版本。', 'type' => 'string', 'example' => 'v1'],
],
],
],
'AlgorithmName' => ['description' => '算法名。', 'type' => 'string', 'example' => 'llm_training'],
'ReasonCode' => ['description' => '训练任务状态码。', 'type' => 'string', 'example' => 'TrainingJobSucceed'],
'GmtModifiedTime' => ['description' => '训练任务状态更新时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'StatusTransitions' => [
'description' => '训练任务状态变更列表。',
'type' => 'array',
'items' => [
'description' => '训练任务状态变更。',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => '状态结束时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'ReasonCode' => ['description' => '状态码。', 'type' => 'string', 'example' => 'TrainingJobSucceed'],
'ReasonMessage' => ['description' => '状态更新信息。', 'type' => 'string', 'example' => 'KubeDL job runs successfully'],
'StartTime' => ['description' => '状态开始时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'Status' => ['description' => '训练任务状态。', 'type' => 'string', 'example' => 'Creating'],
],
],
],
'TrainingJobDescription' => ['description' => '训练任务描述。', 'type' => 'string', 'example' => 'Qwen2 large language model training.'],
'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '123456789'],
'AlgorithmVersion' => ['description' => '算法版本。', 'type' => 'string', 'example' => 'v0.0.1'],
'LatestMetrics' => [
'description' => '训练任务指标列表。',
'type' => 'array',
'items' => [
'description' => '训练任务监控指标。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '指标名。', 'type' => 'string', 'example' => 'loss'],
'Timestamp' => ['description' => '指标收集时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'Value' => ['description' => '指标值。', 'type' => 'number', 'format' => 'double', 'example' => '0.11'],
],
],
],
'GmtCreateTime' => ['description' => '训练任务创建时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'Instances' => [
'description' => '训练任务实例列表。',
'type' => 'array',
'items' => [
'description' => '训练任务实例。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '实例名。', 'type' => 'string', 'example' => 'train1oug3yehan4-master-0'],
'Role' => ['description' => '实例角色。', 'type' => 'string', 'example' => 'master'],
'Status' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'Succeeded'],
],
],
],
'AlgorithmId' => ['description' => '训练算法ID。', 'type' => 'string', 'example' => 'algo-xsldfvu1334'],
'TrainingJobUrl' => ['description' => '训练任务详情地址。', 'type' => 'string', 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=1234#/training/jobs/train1ouyadsl8n4'],
'RoleArn' => ['description' => '代理授权使用的角色信息。', 'type' => 'string', 'example' => 'acs:ram::{accountID}:role/{roleName}'],
'AlgorithmSpec' => ['title' => '临时算法定义。', 'description' => '临时算法定义。', '$ref' => '#/components/schemas/AlgorithmSpec'],
'IsTempAlgo' => ['title' => '是否使用了临时算法。', 'description' => '是否使用了临时算法。', 'type' => 'boolean', 'example' => 'true'],
'LatestProgress' => [
'description' => '训练任务进度的最新值。',
'type' => 'object',
'properties' => [
'OverallProgress' => [
'description' => '训练任务执行的总体进度。',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '进度时间。', 'type' => 'string', 'example' => '2023-07-04T13:20:18Z'],
'Value' => ['description' => '进度值。', 'type' => 'number', 'format' => 'float', 'example' => '0.75'],
],
],
'RemainingTime' => [
'description' => '训练任务执行的预估剩余时间(单位秒)。',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '进度时间。', 'type' => 'string', 'example' => '2023-07-04T13:20:18Z'],
'Value' => ['description' => '剩余时间(单位秒)。', 'type' => 'integer', 'format' => 'int64', 'example' => '3600'],
],
],
],
],
'UserVpc' => [
'description' => '用户VPC配置。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-abcdef****'],
'SwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vs-abcdef****'],
'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-abcdef****'],
'ExtendedCIDRs' => [
'description' => '扩展网段配置。',
'type' => 'array',
'items' => ['description' => '扩展网段配置。', 'type' => 'string', 'example' => '192.168.0.1/24'],
],
],
],
'OutputModel' => [
'description' => '训练任务产出的模型。',
'type' => 'object',
'properties' => [
'Uri' => ['description' => '模型地址。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/model/output/'],
'OutputChannelName' => ['description' => '模型对应的OutputChannel名。', 'type' => 'string', 'example' => 'model'],
],
],
'Settings' => ['description' => '训练任务额外参数配置。', '$ref' => '#/components/schemas/JobSettings'],
'ExperimentConfig' => [
'description' => '训练任务关联实验配置。',
'type' => 'object',
'properties' => [
'ExperimentId' => ['description' => '训练任务关联实验ID。', 'type' => 'string', 'example' => 'exp-ds9aefia90v'],
'ExperimentName' => ['description' => '训练任务关联实验名。', 'type' => 'string', 'example' => 'large_language_model_train'],
],
],
'Duration' => ['description' => '训练任务运行时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '7200'],
'Environments' => [
'description' => '训练任务环境变量。',
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '训练任务环境变量。', 'example' => 'debug=true'],
],
'PythonRequirements' => [
'description' => '训练任务Python包配置。',
'type' => 'array',
'items' => ['description' => '训练任务Python包配置。', 'type' => 'string', 'example' => 'torch>=2.2.0'],
],
'Priority' => ['description' => '任务优先级。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AssignNodeSpec' => ['$ref' => '#/components/schemas/AssignNodeSpec', 'description' => ''],
],
'description' => '',
],
],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => '获取训练任务详情',
'changeSet' => [
['createdAt' => '2025-11-25T06:20:13.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-18T02:48:42.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-10-17T03:44:01.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-08-07T03:10:37.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-07-19T02:50:12.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-05-09T10:31:22.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-03-14T08:12:52.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-02-29T07:27:54.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-12-26T10:28:15.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-12-07T04:21:27.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-09-01T11:22:25.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-08-15T11:50:53.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-05-24T09:46:45.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-20T02:19:53.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-24T14:00:02.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-14T12:38:37.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-14T12:38:37.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-14T12:18:34.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-14T12:18:34.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJob'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutputChannels\\": [\\n {\\n \\"Name\\": \\"model\\",\\n \\"OutputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/model/\\",\\n \\"DatasetId\\": \\"d-8o0hh35po15ejcdq2p\\",\\n \\"VersionName\\": \\"v1\\"\\n }\\n ],\\n \\"Status\\": \\"Running\\",\\n \\"HyperParameters\\": [\\n {\\n \\"Name\\": \\"learning_rate\\",\\n \\"Value\\": \\"0.0001\\"\\n }\\n ],\\n \\"TrainingJobName\\": \\"qwen_llm\\",\\n \\"TrainingJobId\\": \\"traini6hhxiq69eo\\",\\n \\"Scheduler\\": {\\n \\"MaxRunningTimeInSeconds\\": \\"0\\",\\n \\"MaxRunningTimeInMinutes\\": \\"100\\"\\n },\\n \\"ReasonMessage\\": \\"None\\",\\n \\"WorkspaceId\\": \\"86995\\",\\n \\"ComputeResource\\": {\\n \\"EcsCount\\": 1,\\n \\"EcsSpec\\": \\"ecs.gn5-c8g1.2xlarge\\",\\n \\"ResourceId\\": \\"quotam670lixikcl\\",\\n \\"ResourceName\\": \\"quota\\",\\n \\"InstanceCount\\": 1,\\n \\"InstanceSpec\\": {\\n \\"CPU\\": \\"8\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"1\\",\\n \\"GPUType\\": \\"V100\\"\\n },\\n \\"UseSpotInstance\\": true,\\n \\"SpotSpec\\": {\\n \\"SpotStrategy\\": \\"SpotWithPriceLimit\\",\\n \\"SpotDiscountLimit\\": 0.9\\n }\\n },\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"CreatedBy\\",\\n \\"Value\\": \\"QuickStart\\"\\n }\\n ],\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"InputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-475megosidivjfgfq6\\",\\n \\"Name\\": \\"model\\",\\n \\"InputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/model/\\",\\n \\"Options\\": \\"ossAppendable=true\\",\\n \\"VersionName\\": \\"v1\\"\\n }\\n ],\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"StatusTransitions\\": [\\n {\\n \\"EndTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"KubeDL job runs successfully\\",\\n \\"StartTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ],\\n \\"TrainingJobDescription\\": \\"Qwen2 large language model training.\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"LatestMetrics\\": [\\n {\\n \\"Name\\": \\"loss\\",\\n \\"Timestamp\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Value\\": 0.11\\n }\\n ],\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Instances\\": [\\n {\\n \\"Name\\": \\"train1oug3yehan4-master-0\\",\\n \\"Role\\": \\"master\\",\\n \\"Status\\": \\"Succeeded\\"\\n }\\n ],\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"TrainingJobUrl\\": \\"https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=1234#/training/jobs/train1ouyadsl8n4\\",\\n \\"RoleArn\\": \\"acs:ram::{accountID}:role/{roleName}\\",\\n \\"AlgorithmSpec\\": {\\n \\"OutputChannels\\": [\\n {\\n \\"Description\\": \\"模型输出。\\",\\n \\"Required\\": true,\\n \\"Properties\\": {},\\n \\"Name\\": \\"Model\\",\\n \\"SupportedChannelTypes\\": [\\n \\"oss\\"\\n ]\\n }\\n ],\\n \\"HyperParameters\\": [\\n {\\n \\"DefaultValue\\": \\"0\\",\\n \\"Type\\": \\"Integer\\",\\n \\"Description\\": \\"参数定义了训练的batch_size。\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"batch_size\\",\\n \\"Range\\": {\\n \\"Enum\\": [\\n \\"0\\"\\n ],\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": \\"0\\",\\n \\"Maximum\\": \\"10\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"ExclusiveMaximum\\": true,\\n \\"Pattern\\": \\"^\\\\\\\\+?[1-9][0-9]*$\\"\\n },\\n \\"DisplayName\\": \\"Batch Size\\"\\n }\\n ],\\n \\"JobType\\": \\"TFJob\\",\\n \\"Command\\": [\\n \\"python train.py\\"\\n ],\\n \\"MetricDefinitions\\": [\\n {\\n \\"Description\\": \\"训练损失函数。\\",\\n \\"Regex\\": \\".*train:loss=([-+]?[0-9]*\\\\\\\\\\\\\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*\\",\\n \\"Name\\": \\"loss\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"Description\\": \\"模型输出。\\",\\n \\"Required\\": true,\\n \\"Properties\\": {},\\n \\"Name\\": \\"Model\\",\\n \\"SupportedChannelTypes\\": [\\n \\"oss\\"\\n ]\\n }\\n ],\\n \\"SupportsDistributedTraining\\": true,\\n \\"Image\\": \\"registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0\\",\\n \\"SupportedInstanceTypes\\": [\\n \\"ecs.g6.2xlarge\\"\\n ],\\n \\"ComputeResource\\": {\\n \\"Policy\\": {\\n \\"Version\\": \\"V1\\",\\n \\"Value\\": \\"[{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"MaxTotalCount\\\\\\\\\\\\\\":4,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":100}}},{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":5,\\\\\\\\\\\\\\"MaxTotalCount\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":20},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":80}}},{\\\\\\\\\\\\\\"MinTotalCount\\\\\\\\\\\\\\":11,\\\\\\\\\\\\\\"RolePolicies\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"chief\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"ps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":40},\\\\\\\\\\\\\\"worker\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Percentage\\\\\\\\\\\\\\":60}}}]\\"\\n }\\n },\\n \\"CodeDir\\": {\\n \\"LocationType\\": \\"OSS\\",\\n \\"LocationValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Customization\\": {\\n \\"CodeDir\\": true\\n },\\n \\"ResourceRequirements\\": [\\n {\\n \\"Key\\": \\"SupportedMachineTypes\\",\\n \\"Operator\\": \\"in\\",\\n \\"Values\\": [\\n \\"ecs.gn5-c4g1.xlarge\\"\\n ]\\n }\\n ],\\n \\"ProgressDefinitions\\": {\\n \\"OverallProgress\\": {\\n \\"Description\\": \\"training progress\\",\\n \\"Regex\\": \\"^[0-9]+([.][0-9]+){0,1}$\\"\\n },\\n \\"RemainingTime\\": {\\n \\"Description\\": \\"training remaining time\\",\\n \\"Regex\\": \\"^[0-9]+([.][0-9]+){0,1}$\\"\\n }\\n }\\n },\\n \\"IsTempAlgo\\": true,\\n \\"LatestProgress\\": {\\n \\"OverallProgress\\": {\\n \\"Timestamp\\": \\"2023-07-04T13:20:18Z\\",\\n \\"Value\\": 0.75\\n },\\n \\"RemainingTime\\": {\\n \\"Timestamp\\": \\"2023-07-04T13:20:18Z\\",\\n \\"Value\\": 3600\\n }\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ]\\n },\\n \\"OutputModel\\": {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/model/output/\\",\\n \\"OutputChannelName\\": \\"model\\"\\n },\\n \\"Settings\\": {\\n \\"BusinessUserId\\": \\"166924\\",\\n \\"Caller\\": \\"SilkFlow\\",\\n \\"Tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PipelineId\\": \\"pid-123456\\",\\n \\"EnableTideResource\\": true,\\n \\"EnableErrorMonitoringInAIMaster\\": false,\\n \\"ErrorMonitoringArgs\\": \\"--enable-log-hang-detection true\\",\\n \\"EnableRDMA\\": true,\\n \\"EnableOssAppend\\": true,\\n \\"OversoldType\\": \\"AcceptQuotaOverSold\\",\\n \\"AdvancedSettings\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Driver\\": \\"535.54.03\\",\\n \\"EnableSanityCheck\\": true,\\n \\"SanityCheckArgs\\": \\"--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFai\\",\\n \\"JobReservedMinutes\\": 30,\\n \\"JobReservedPolicy\\": \\"Always\\"\\n },\\n \\"ExperimentConfig\\": {\\n \\"ExperimentId\\": \\"exp-ds9aefia90v\\",\\n \\"ExperimentName\\": \\"large_language_model_train\\"\\n },\\n \\"Duration\\": 7200,\\n \\"Environments\\": {\\n \\"key\\": \\"debug=true\\"\\n },\\n \\"PythonRequirements\\": [\\n \\"torch>=2.2.0\\"\\n ],\\n \\"Priority\\": 0,\\n \\"AssignNodeSpec\\": {\\n \\"EnableAssignNode\\": true,\\n \\"NodeNames\\": \\"\\",\\n \\"AntiAffinityNodeNames\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'GetTrainingJobErrorInfo' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/errorinfo',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '195103',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'traineyfz0m2hsfv'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'ErrorInfo' => [
'description' => '错误信息。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'AdditionalInfo' => ['description' => '额外信息。', 'type' => 'string', 'example' => 'additional info'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取训练任务错误信息',
'summary' => '获取训练任务的运行错误信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"ErrorInfo\\": {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"AdditionalInfo\\": \\"additional info\\"\\n }\\n}","type":"json"}]',
],
'GetTrainingJobLatestMetrics' => [
'summary' => '获取TrainingJob最近的Metrics',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/latestmetrics',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '135852',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'train129f212o89d'],
],
[
'name' => 'Names',
'in' => 'query',
'schema' => ['description' => '指标名。', 'type' => 'string', 'required' => false, 'example' => 'loss'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'],
'Metrics' => [
'description' => '指标信息。',
'type' => 'array',
'items' => [
'description' => '指标信息。',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '指标采集的时间戳。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-04-18T22:20:55Z'],
'Value' => ['description' => '指标值。', 'type' => 'number', 'format' => 'double', 'example' => '0.97'],
'Name' => ['description' => '指标名。', 'type' => 'string', 'example' => 'loss'],
],
],
],
],
],
],
],
'title' => '获取训练任务最新指标',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJobLatestMetrics'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"2022-04-18T22:20:55Z\\",\\n \\"Value\\": 0.97,\\n \\"Name\\": \\"loss\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetUserViewMetrics' => [
'path' => '/api/v1/resources/{ResourceGroupID}/usermetrics',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '152476',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => ['description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'required' => true, 'example' => 'rgf0zhfqn1d4ity2'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '86995'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '当前页码', 'type' => 'string', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小', 'type' => 'string', 'required' => true, 'example' => '10'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '排序依据。', 'type' => 'string', 'required' => false, 'example' => 'GmtModified'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '排序方向:-asc:升序-desc:降序', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户主账号ID', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'TimeStep',
'in' => 'query',
'schema' => ['description' => '时间步长,默认值:5m。支持的时长单位的取值范围:'."\n"
."\n"
.'- h:小时。'."\n"
."\n"
.'- m:分钟。'."\n"
."\n"
.'- s:秒。'."\n"
."\n"
.'当值不带单位时,默认使用单位:s(秒)。', 'type' => 'string', 'required' => false, 'example' => '1h'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'],
'UserMetrics' => [
'description' => '按照用户维度统计的指标',
'type' => 'array',
'items' => ['description' => '按照用户维度统计的指标', '$ref' => '#/components/schemas/UserViewMetric'],
],
'Summary' => ['description' => '用户监控数据。', '$ref' => '#/components/schemas/UserViewMetric'],
'Total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['PaiStudio::2022-01-12::GetQuotaUserViewMetrics'],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '获取用户维度的指标',
'summary' => '您可以通过GetUserViewMetrics获取用户维度的指标数据。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserViewMetrics'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceGroupId\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"UserMetrics\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg17tmvwiokh****\\",\\n \\"TotalCPU\\": 1000,\\n \\"CPUUsageRate\\": \\"59\\",\\n \\"GPUUsageRate\\": \\"10\\",\\n \\"TotalMemory\\": 10240,\\n \\"TotalGPU\\": 1,\\n \\"MemoryUsageRate\\": \\"20\\",\\n \\"RequestCPU\\": 100,\\n \\"RequestGPU\\": 10,\\n \\"RequestMemory\\": 102400000,\\n \\"NetworkInputRate\\": \\"1\\",\\n \\"NetworkOutputRate\\": \\"1\\",\\n \\"DiskReadRate\\": \\"22\\",\\n \\"DiskWriteRate\\": \\"22\\",\\n \\"JobType\\": \\"PyTorch\\",\\n \\"UserId\\": \\"16111111****\\",\\n \\"CPUNodeNumber\\": 2,\\n \\"GPUNodeNumber\\": 1,\\n \\"CpuJobNames\\": [\\n \\"dlcxxxxx\\"\\n ],\\n \\"GpuJobNames\\": [\\n \\"dlcyyyyy\\"\\n ],\\n \\"NodeNames\\": [\\n \\"lrnxxxxxx\\"\\n ],\\n \\"CpuNodeNames\\": [\\n \\"ecixxxxxx\\"\\n ],\\n \\"GpuNodeNames\\": [\\n \\"lrnxxxxxxx\\"\\n ]\\n }\\n ],\\n \\"Summary\\": {\\n \\"ResourceGroupId\\": \\"rg17tmvwiokh****\\",\\n \\"TotalCPU\\": 1000,\\n \\"CPUUsageRate\\": \\"59\\",\\n \\"GPUUsageRate\\": \\"10\\",\\n \\"TotalMemory\\": 10240,\\n \\"TotalGPU\\": 1,\\n \\"MemoryUsageRate\\": \\"20\\",\\n \\"RequestCPU\\": 100,\\n \\"RequestGPU\\": 10,\\n \\"RequestMemory\\": 102400000,\\n \\"NetworkInputRate\\": \\"1\\",\\n \\"NetworkOutputRate\\": \\"1\\",\\n \\"DiskReadRate\\": \\"22\\",\\n \\"DiskWriteRate\\": \\"22\\",\\n \\"JobType\\": \\"PyTorch\\",\\n \\"UserId\\": \\"16111111****\\",\\n \\"CPUNodeNumber\\": 2,\\n \\"GPUNodeNumber\\": 1,\\n \\"CpuJobNames\\": [\\n \\"dlcxxxxx\\"\\n ],\\n \\"GpuJobNames\\": [\\n \\"dlcyyyyy\\"\\n ],\\n \\"NodeNames\\": [\\n \\"lrnxxxxxx\\"\\n ],\\n \\"CpuNodeNames\\": [\\n \\"ecixxxxxx\\"\\n ],\\n \\"GpuNodeNames\\": [\\n \\"lrnxxxxxxx\\"\\n ]\\n },\\n \\"Total\\": 2\\n}","type":"json"}]',
],
'ListAlgorithmVersions' => [
'summary' => '获取算法版本详情列表。',
'path' => '/api/v1/algorithms/{AlgorithmId}/versions',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页的大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => ['description' => '算法ID。', 'type' => 'string', 'required' => false, 'example' => 'algo-sidjc8134hv'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求返回。',
'type' => 'object',
'properties' => [
'AlgorithmVersions' => [
'description' => '算法版本详情列表。',
'type' => 'array',
'items' => [
'description' => '算法版本详情。',
'type' => 'object',
'properties' => [
'AlgorithmId' => ['description' => '算法ID。', 'type' => 'string', 'example' => 'algo-sidjc8134hv'],
'AlgorithmName' => ['description' => '算法名。', 'type' => 'string', 'example' => 'llm_train'],
'AlgorithmProvider' => ['description' => '算法提供者。', 'type' => 'string', 'example' => 'pai'],
'AlgorithmVersion' => ['description' => '算法版本。', 'type' => 'string', 'example' => 'v0.1.0'],
'GmtCreateTime' => ['description' => '算法创建时间。', 'type' => 'string', 'example' => '2024-01-19T02:00:26Z'],
'GmtModifiedTime' => ['description' => '算法更新时间。', 'type' => 'string', 'example' => '2024-01-22T02:00:59Z'],
'TenantId' => ['description' => '算法归属租户ID。', 'type' => 'string', 'example' => '123456789'],
'UserId' => ['description' => '算法归属用户ID。', 'type' => 'string', 'example' => '123456789'],
],
],
],
'TotalCount' => ['description' => '算法版本总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
],
],
],
'title' => '获取算法版本详情列表',
'changeSet' => [
['createdAt' => '2022-04-27T10:49:51.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithmVersions'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListAlgorithmVersions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmVersions\\": [\\n {\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.1.0\\",\\n \\"GmtCreateTime\\": \\"2024-01-19T02:00:26Z\\",\\n \\"GmtModifiedTime\\": \\"2024-01-22T02:00:59Z\\",\\n \\"TenantId\\": \\"123456789\\",\\n \\"UserId\\": \\"123456789\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'ListAlgorithms' => [
'path' => '/api/v1/algorithms',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'AlgorithmName',
'in' => 'query',
'schema' => ['description' => '算法名。', 'type' => 'string', 'required' => false, 'example' => 'llm_training'],
],
[
'name' => 'AlgorithmId',
'in' => 'query',
'schema' => ['description' => '算法ID。', 'type' => 'string', 'required' => false, 'example' => 'algo-xsldfvu1334'],
],
[
'name' => 'AlgorithmProvider',
'in' => 'query',
'schema' => ['description' => '算法提供方。', 'type' => 'string', 'required' => false, 'example' => 'pai'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求返回。',
'type' => 'object',
'properties' => [
'Algorithms' => [
'description' => '算法列表。',
'type' => 'array',
'items' => [
'description' => '算法详情。',
'type' => 'object',
'properties' => [
'AlgorithmDescription' => ['description' => '算法描述。', 'type' => 'string', 'example' => 'Large language model training.'],
'AlgorithmId' => ['description' => '算法ID。', 'type' => 'string', 'example' => 'algo-sidjc8134hv'],
'AlgorithmName' => ['description' => '算法名。', 'type' => 'string', 'example' => 'llm_train'],
'AlgorithmProvider' => ['description' => '算法提供方。', 'type' => 'string', 'example' => 'pai'],
'GmtCreateTime' => ['description' => '算法创建时间。', 'type' => 'string', 'example' => '2023-07-21T03:35:24Z'],
'GmtModifiedTime' => ['description' => '算法更新时间。', 'type' => 'string', 'example' => '2023-07-25T02:15:40Z'],
'UserId' => ['description' => '算法归属用户ID。', 'type' => 'string', 'example' => '123456789'],
'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '12345'],
'DisplayName' => ['description' => '算法展示名。', 'type' => 'string', 'example' => 'LLM Train'],
],
],
],
'TotalCount' => ['description' => '算法总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
],
],
],
'title' => '获取算法详情列表',
'summary' => '获取算法详情列表。',
'changeSet' => [
['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-09T09:37:28.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-04-27T10:49:51.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithms'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListAlgorithms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Algorithms\\": [\\n {\\n \\"AlgorithmDescription\\": \\"Large language model training.\\",\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"GmtCreateTime\\": \\"2023-07-21T03:35:24Z\\",\\n \\"GmtModifiedTime\\": \\"2023-07-25T02:15:40Z\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"DisplayName\\": \\"LLM Train\\"\\n }\\n ],\\n \\"TotalCount\\": 4,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'ListNodeTypes' => [
'path' => '/api/v1/nodetypes',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '191233',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'ResourceGroupIds',
'in' => 'query',
'schema' => ['description' => '指定资源组ID列表,按逗号分隔,和`QuotaIds`参数二选一必填。约束:需校验传入的`ResourceGroupId`的`UserId`和请求的`UserId`一致;传入的`ResourceGroup`列表类型需一致;传入的`ResourceGroup`列表现阶段记录的VPC需一致。'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg123,rg456'],
],
[
'name' => 'QuotaId',
'in' => 'query',
'schema' => ['description' => '指定资源配额ID,和`ResourceGroupIds` 二选一必填。'."\n", 'type' => 'string', 'required' => false, 'example' => 'quota123'],
],
[
'name' => 'NodeTypes',
'in' => 'query',
'schema' => ['description' => '资源节点规格列表,按逗号分隔,不设置会返回所有资源节点规格的机器列表。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large,ecs.gn7i-c32g1.8xlarge'],
],
[
'name' => 'AcceleratorType',
'in' => 'query',
'schema' => ['description' => '按加速器类型(CPU/GPU)。'."\n", 'type' => 'string', 'required' => false, 'example' => 'GPU'],
],
[
'name' => 'GPUType',
'in' => 'query',
'schema' => ['description' => '按卡类型,支持模糊匹配。'."\n", 'type' => 'string', 'required' => false, 'example' => 'A10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'NodeTypes' => [
'description' => '资源节点规格集合'."\n",
'type' => 'array',
'items' => ['description' => '资源节点规格信息', '$ref' => '#/components/schemas/NodeType'],
],
'Statistics' => [
'description' => '指定过滤条件下该规格对应的节点统计信息'."\n",
'type' => 'array',
'items' => ['description' => '规格节点统计信息', '$ref' => '#/components/schemas/NodeTypeStatistic'],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取节点规格列表',
'summary' => '获取节点规格列表',
'description' => '## 请求说明'."\n"
.'- 该API用于获取符合特定过滤条件的资源节点规格列表。'."\n"
.'- `ResourceGroupIds` 和 `QuotaId` 参数二选一必填,且需确保传入的资源组ID或配额ID与请求用户一致。'."\n"
.'- 支持通过多种参数进行过滤,如加速器类型、GPU类型等,以满足不同场景下的需求。'."\n"
.'- 返回结果包括资源节点规格详情及其统计信息,帮助用户更好地了解当前可用资源情况。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"NodeTypes\\": [\\n {\\n \\"NodeType\\": \\"ecs.g6.4xlarge\\",\\n \\"AcceleratorType\\": \\"CPU\\",\\n \\"CPU\\": \\"16\\",\\n \\"Memory\\": \\"64Gi\\",\\n \\"GPU\\": \\"0\\",\\n \\"GPUType\\": \\"\\",\\n \\"GPUMemory\\": \\"80G\\",\\n \\"AllocatableCPU\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCPU\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\"\\n }\\n ],\\n \\"Statistics\\": [\\n {\\n \\"NodeType\\": \\"ecs.g6.4xlarge\\",\\n \\"TotalCount\\": 10,\\n \\"CanBeBoundCount\\": 4\\n }\\n ]\\n}","type":"json"}]',
],
'ListNodes' => [
'path' => '/api/v1/nodes',
'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' => '191226',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'ResourceGroupIds',
'in' => 'query',
'schema' => ['description' => '指定资源组ID列表,按逗号分隔,和QuotaId参数二选一必填'."\n"
.'约束:'."\n"
.'1. 需校验传入的ResourceGroupId的UserId和请求的UserId一致'."\n"
.'2. 传入的ResourceGroup列表类型需一致'."\n"
.'3. 传入的ResourceGroup列表现阶段记录的VPC需一致', 'type' => 'string', 'required' => false, 'example' => 'rg69rj0leslwdnbe'],
],
[
'name' => 'QuotaId',
'in' => 'query',
'schema' => ['description' => '节点所属资源配额ID。', 'type' => 'string', 'required' => false, 'example' => 'quotamtl37ge7gkvdz'],
],
[
'name' => 'NodeTypes',
'in' => 'query',
'schema' => ['description' => '资源节点规格列表,按逗号分隔,不设置会返回所有资源节点规格的机器列表。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.xlarge'],
],
[
'name' => 'AcceleratorType',
'in' => 'query',
'schema' => ['description' => '加速器类型,枚举:'."\n"
."\n"
.'- CPU'."\n"
.'- GPU'."\n"
."\n"
.'默认为空,代表所有类型。', 'type' => 'string', 'required' => false, 'example' => 'CPU'],
],
[
'name' => 'GPUType',
'in' => 'query',
'schema' => ['description' => '按卡类型,支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'T4'],
],
[
'name' => 'NodeStatuses',
'in' => 'query',
'schema' => ['description' => '节点所处状态。按逗号分隔,不设置会返回所有状态的节点列表。', 'type' => 'string', 'required' => false, 'example' => 'Ready'],
],
[
'name' => 'OrderStatuses',
'in' => 'query',
'schema' => ['description' => '节点所在订单状态。', 'type' => 'string', 'required' => false, 'example' => 'Ready'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页页码,从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询每页数据集数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '排序依据。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '排列顺序,取值:'."\n"
.'- desc:降序。'."\n"
.'- asc:升序。', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => ['description' => '是否返回资源使用信息。只在QuotaId设置时生效。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'NodeNames',
'in' => 'query',
'schema' => ['description' => '只显示指定节点,按逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'lingjxxxx'],
],
[
'name' => 'HyperNode',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'CliqueID',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'FilterByQuotaId',
'in' => 'query',
'schema' => ['description' => '与ResourceGroupIds同时使用,展示资源组里面Quota绑定某些Quota的node。', 'type' => 'string', 'required' => false, 'example' => 'quotamtl37ge7gkvdz'],
],
[
'name' => 'FilterByResourceGroupIds',
'in' => 'query',
'schema' => ['description' => '与QuotaId同时使用,展示Quota中属于某些资源组的node。', 'type' => 'string', 'required' => false, 'example' => 'rg69rj0leslwdnbe'],
],
[
'name' => 'MachineGroupIds',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ReasonCodes',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'HyperZone',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'AvailabilityZone',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'PaymentType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'OrderInstanceIds',
'in' => 'query',
'schema' => ['title' => '订单Id信息', 'description' => '订单Id信息', 'type' => 'string', 'required' => false, 'example' => '260590501560397'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'HealthRate',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'operation' => ['type' => 'string'],
'value' => ['type' => 'integer', 'format' => 'int32'],
],
],
],
[
'name' => 'HealthCount',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'operation' => ['type' => 'string'],
'value' => ['type' => 'integer', 'format' => 'int32'],
],
],
],
[
'name' => 'LayoutMode',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'ResourceGroupName',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'DiskPL',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'WorkloadNum',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32'],
],
[
'name' => 'PodNum',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求Id', 'description' => '请求Id', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'Nodes' => [
'description' => '节点列表。',
'type' => 'array',
'items' => ['description' => '节点信息。', '$ref' => '#/components/schemas/Node'],
],
'TotalCount' => ['description' => '符合过滤条件的节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
],
],
'title' => '获取节点列表',
'summary' => '获取资源节点列表。',
'description' => '您可以通过ListNodes 获取指定过滤条件的资源节点',
'changeSet' => [
['createdAt' => '2025-11-04T03:55:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-10-13T08:27:11.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-08-06T06:21:54.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-06-18T03:04:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-16T09:52:52.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-13T10:38:20.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Nodes\\": [\\n {\\n \\"CreatorId\\": \\"281044699048527748\\",\\n \\"NodeName\\": \\"lingjxxxx\\",\\n \\"NodeType\\": \\"ecs.c8i.xlarge\\",\\n \\"AcceleratorType\\": \\"CPU\\",\\n \\"CPU\\": \\"4\\",\\n \\"Memory\\": \\"8\\",\\n \\"GPU\\": \\"0\\",\\n \\"GPUType\\": \\"\\\\\\"\\\\\\"\\",\\n \\"GPUMemory\\": \\"\\",\\n \\"NodeStatus\\": \\"Ready\\",\\n \\"ReasonCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ReasonMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"OrderStatus\\": \\"Ready\\",\\n \\"ResourceGroupId\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"MachineGroupId\\": \\"mg1234456\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtExpiredTime\\": \\"2025-06-22T00:00:00Z\\\\n\\",\\n \\"IsBound\\": false,\\n \\"BoundQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"RequestCPU\\": \\"4\\",\\n \\"RequestMemory\\": \\"8\\",\\n \\"RequestGPU\\": \\"0\\",\\n \\"LimitCPU\\": \\"4\\",\\n \\"LimitMemory\\": \\"8\\",\\n \\"LimitGPU\\": \\"0\\",\\n \\"PodNum\\": 2,\\n \\"WorkloadNum\\": 2,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"161222222222\\",\\n \\"UserName\\": \\"test\\"\\n }\\n ],\\n \\"HyperZone\\": \\"\\",\\n \\"AvailabilityZone\\": \\"\\",\\n \\"AllocatableCPU\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCPU\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\",\\n \\"AncestorQuotaWorkloadNum\\": 0,\\n \\"SelfQuotaWorkloadNum\\": 0,\\n \\"DescendantQuotaWorkloadNum\\": 0,\\n \\"DiskPL\\": \\"\\",\\n \\"DiskCapacity\\": 0,\\n \\"SubNodes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]',
],
'ListQuotaActiveUserUsages' => [
'path' => '/api/v1/quotas/{QuotaId}/activeuserusages',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '222847',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'QuotaId',
'in' => 'path',
'schema' => ['description' => '获取详细信息的Quota identifier。', 'type' => 'string', 'required' => true, 'example' => 'quotamtl37ge7gkvdz'],
],
[
'name' => 'SelfOnly',
'in' => 'query',
'schema' => ['description' => '是否只看当前Quota中资源使用情况。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数:当前页码,默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '999', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页每页数据集大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '返回结果的排序字段名,枚举值:'."\n"
.'- QuotaId'."\n"
.'- SubmittedCPU'."\n"
.'- SubmittedMemory'."\n"
.'- SubmittedGPU'."\n"
.'- UsedCPU'."\n"
.'- UsedMemory'."\n"
.'- UsedGPU'."\n"
.'- WorkloadCount', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'description' => '排列顺序,取值:'."\n"
.'- desc:降序。'."\n"
.'- asc:升序。',
'type' => 'string',
'required' => false,
'example' => 'desc',
'enum' => ['asc', 'desc'],
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '查询当前用户Id的资源使用情况。', 'type' => 'string', 'required' => false, 'example' => '200xxxxxx'],
],
[
'name' => 'Username',
'in' => 'query',
'schema' => ['description' => '查询当前用户名的资源使用情况。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
[
'name' => 'WorkloadCount',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
'QuotaUserUsages' => [
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/QuotaUser'],
],
'TotalCount' => ['description' => '符合过滤条件的实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'QuotaUserUsage' => [
'description' => '用户资源使用详情列表。',
'type' => 'array',
'items' => ['description' => '用户资源使用详情。', '$ref' => '#/components/schemas/QuotaUser'],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取资源配额上用户维度资源使用详情',
'summary' => '获取当前资源配额用户列表和其所使用的资源',
'description' => '获取指定QuotaId的用户资源使用情况',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"QuotaUserUsages\\": [\\n {\\n \\"Username\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"WorkloadCount\\": 0,\\n \\"Resources\\": {\\n \\"Used\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"Submitted\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n }\\n }\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"QuotaUserUsage\\": [\\n {\\n \\"Username\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"WorkloadCount\\": 0,\\n \\"Resources\\": {\\n \\"Used\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListQuotaWorkloads' => [
'path' => '/api/v1/quotas/{QuotaId}/workloads',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '221848',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'QuotaId',
'in' => 'path',
'schema' => ['title' => 'Quota ID', 'description' => 'Quota ID。', 'type' => 'string', 'required' => true, 'example' => 'quota1y9qarq****'],
],
[
'name' => 'WorkspaceIds',
'in' => 'query',
'schema' => ['title' => '查询指定的Workspace下的workload的排队信息', 'description' => '查询指定的Workspace下的workload的排队信息。', 'type' => 'string', 'required' => false, 'example' => '1866**'],
],
[
'name' => 'WorkloadType',
'in' => 'query',
'schema' => ['title' => '查询指定子产品的实例的排队信息', 'description' => '查询指定子产品的实例的排队信息。', 'type' => 'string', 'required' => false, 'example' => 'dlc'],
],
[
'name' => 'WorkloadIds',
'in' => 'query',
'schema' => ['title' => '查询指定workload id的排队信息', 'description' => '查询指定workload ID的排队信息。', 'type' => 'string', 'required' => false, 'example' => 'dlc123445**'],
],
[
'name' => 'BeforeWorkloadId',
'in' => 'query',
'schema' => ['title' => '查询队列中指定workload Id之前的实例的排队信息', 'description' => '查询队列中指定workload ID之前的实例的排队信息。', 'type' => 'string', 'required' => false, 'example' => 'dsw654433**'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '查询的页码', 'description' => '查询的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页查询每页的大小', 'description' => '分页查询每页的大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['title' => '返回结果的排序字段', 'description' => '返回结果的排序字段。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreatedTime'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排队顺序',
'description' => '排队顺序。',
'type' => 'string',
'required' => false,
'example' => 'desc',
'enum' => ['asc', 'desc'],
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '在队列中状态。', 'type' => 'string', 'required' => false, 'example' => 'Enqueued', 'default' => 'Enqueued'],
],
[
'name' => 'ShowOwn',
'in' => 'query',
'schema' => ['description' => '是否只看本资源配额对应Workload。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
[
'name' => 'SubQuotaIds',
'in' => 'query',
'schema' => ['description' => '子资源配额ID列表。', 'type' => 'string', 'required' => false, 'example' => 'quota123446**,quota644322**'],
],
[
'name' => 'UserIds',
'in' => 'query',
'schema' => ['description' => '用户ID列表。', 'type' => 'string', 'required' => false, 'example' => '290438938**,238290930**'],
],
[
'name' => 'NodeName',
'in' => 'query',
'schema' => ['description' => '只搜索该节点上的任务。', 'type' => 'string', 'required' => false, 'example' => 'lrn482781276**'],
],
[
'name' => 'WorkloadCreatedTimeRange',
'in' => 'query',
'schema' => ['description' => 'Workload创建时间范围搜索。', 'required' => false, '$ref' => '#/components/schemas/TimeRangeFilter'],
],
[
'name' => 'WorkloadStatuses',
'in' => 'query',
'schema' => ['description' => '按Workload状态过滤。', 'type' => 'string', 'required' => false, 'example' => 'Pending'],
],
[
'name' => 'GmtPositionModifiedTimeRange',
'in' => 'query',
'schema' => ['description' => 'Workload队列位置变化时间范围搜索。', 'required' => false, '$ref' => '#/components/schemas/TimeRangeFilter'],
],
[
'name' => 'GmtEnqueuedTimeRange',
'in' => 'query',
'schema' => ['description' => 'Workload进入队列时间范围搜索。', 'required' => false, '$ref' => '#/components/schemas/TimeRangeFilter'],
],
[
'name' => 'GmtDequeuedTimeRange',
'in' => 'query',
'schema' => ['description' => 'Workload出队时间范围搜索。', 'required' => false, '$ref' => '#/components/schemas/TimeRangeFilter'],
],
[
'name' => 'WithHistoricalData',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
[
'name' => 'WorkloadNames',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32'],
],
[
'name' => 'Position',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32'],
],
[
'name' => 'UseOversoldResource',
'in' => 'query',
'schema' => ['type' => 'boolean'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '42F23B58-3684-5443-848A-8DA81FF99712'],
'TotalCount' => ['title' => '符合过滤条件的实例数量', 'description' => '符合过滤条件的实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'],
'Workloads' => [
'description' => 'Workload信息列表。',
'type' => 'array',
'items' => ['description' => '一个Workload信息详情。', '$ref' => '#/components/schemas/QueueInfo'],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取资源配额上的任务列表',
'summary' => '您可以通过此API获取Quota上的任务信息列表。',
'changeSet' => [
['createdAt' => '2025-02-19T12:19:32.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\",\\n \\"TotalCount\\": 23,\\n \\"Workloads\\": [\\n {\\n \\"Status\\": \\"Enqueued\\",\\n \\"QuotaId\\": \\"“quotamtl37ge7gkvdz”\\",\\n \\"UserName\\": \\"\\",\\n \\"WorkloadId\\": \\"dlcxxxx\\",\\n \\"Position\\": 10,\\n \\"GmtEnqueuedTime\\": \\"“2023-06-22T00:00:00Z”\\",\\n \\"Priority\\": 2,\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"WorkloadType\\": \\"dlc\\",\\n \\"WorkspaceId\\": \\"“432524”\\",\\n \\"Resource\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"Code\\": \\"roleMaximumResource\\",\\n \\"Reason\\": \\"Current GPU Limit is 5, limited by Role PAI.AlgoDeveloper\\",\\n \\"UseOversoldResource\\": true,\\n \\"Name\\": \\"test-label-79f5498dd-9qrzs\\",\\n \\"WorkloadStatus\\": \\"PreAllocation\\",\\n \\"WorkloadName\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"GmtPositionModifiedTime\\": \\"\\\\\\"2023-06-22T00:00:00Z\\\\\\"\\",\\n \\"CodeType\\": \\"ConfigRule\\",\\n \\"GmtDequeuedTime\\": \\"\\\\\\"2023-06-22T00:00:00Z\\\\\\"\\",\\n \\"WorkspaceName\\": \\"\\",\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListQuotas' => [
'path' => '/api/v1/quotas/',
'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' => '191173',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7', 'FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'QuotaName',
'in' => 'query',
'schema' => ['description' => '按照QuotaName过滤,支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'quotajradxh43rgb'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'Quota资源类型(Lingjun/ECS/ACS),默认值ECS。', 'type' => 'string', 'required' => false, 'example' => 'ECS'],
],
[
'name' => 'LayoutMode',
'in' => 'query',
'schema' => ['description' => '展示方式,可以为树形或列表', 'type' => 'string', 'required' => false, 'example' => 'Tree'],
],
[
'name' => 'ParentQuotaId',
'in' => 'query',
'schema' => ['description' => '按ParentQuotaId过滤:'."\n"
."\n"
.'- 不传,列出租户下所有Quota,包含根Quota和子Quota。'."\n"
."\n"
.'- 传空,列出所有的根Quota。'."\n"
."\n"
.'- 传非空,列出指定ParentQuotaId的所有子Quota。', 'type' => 'string', 'required' => false, 'example' => 'quotajradxh43rgb'],
],
[
'name' => 'QuotaIds',
'in' => 'query',
'schema' => ['description' => '逗号分隔,按QuotaIds过滤,只支持精确匹配,最多同时支持100个。', 'type' => 'string', 'required' => false, 'example' => 'quota1ci8g793pgm,quotajradxh43rgb'],
],
[
'name' => 'WorkspaceIds',
'in' => 'query',
'schema' => ['description' => '逗号分隔,按WorkspaceIds过滤,只支持精确匹配,最多同时支持10个。', 'type' => 'string', 'required' => false, 'example' => '21345,38727'],
],
[
'name' => 'Statuses',
'in' => 'query',
'schema' => ['description' => '逗号分隔按照Quota Statuses过滤,只支持精确匹配。', 'type' => 'string', 'required' => false, 'example' => 'Creating'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '查询第几页数据,最小值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '设置查询的分页大小,最小值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '返回结果的排序字段名,枚举值:'."\n"
."\n"
.'- QuotaName'."\n"
."\n"
.'- Status'."\n"
."\n"
.'- CPU'."\n"
."\n"
.'- Memory'."\n"
."\n"
.'- GPU'."\n"
."\n"
.'- GmtCreatedTime'."\n"
."\n"
.'- GmtModifiedTime', 'type' => 'string', 'required' => false, 'example' => 'status'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '排列顺序:desc或者asc。', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
'name' => 'Labels',
'in' => 'query',
'schema' => ['description' => '按照Label的key和value进行过滤,多个标签使用半角逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => 'official=true,gpu=false'],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => ['description' => '是否显示详情。取值如下:'."\n"
.'- true:显示详情。'."\n"
.'- false:不显示详情。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'WorkspaceName',
'in' => 'query',
'schema' => ['description' => '所关联的工作空间名称。', 'type' => 'string', 'required' => false, 'example' => 'myshellprod'],
],
[
'name' => 'HasResource',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'Versions',
'in' => 'query',
'schema' => ['title' => '按照版本信息搜索。', 'description' => '按照版本信息搜索。', 'type' => 'string', 'required' => false, 'example' => '1.0'],
],
[
'name' => 'ClusterType',
'in' => 'query',
'schema' => ['title' => '集群类型', 'description' => '集群类型', 'type' => 'string', 'required' => false, 'example' => 'RayCluster'],
],
[
'name' => 'GPUType',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
'Quotas' => [
'description' => '资源配额列表。',
'type' => 'array',
'items' => ['description' => '单个资源配额详情。', '$ref' => '#/components/schemas/Quota'],
],
'TotalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取资源配额列表',
'summary' => '您可以通过ListQuotas获取资源配额列表。',
'changeSet' => [
['createdAt' => '2025-11-06T13:03:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-19T03:30:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-07-25T06:06:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-04T13:22:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-05-09T02:33:19.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-03-19T09:17:32.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-01-24T08:33:18.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListQuotas',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\",\\n \\"ResourceType\\": \\"ECS\\",\\n \\"ParentQuotaId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ResourceGroupIds\\": [\\n \\"rg69rj0leslw****\\"\\n ],\\n \\"AllocateStrategy\\": \\"ByNodeSpec\\",\\n \\"Min\\": {\\n \\"NodeSpecs\\": [\\n {\\n \\"Type\\": \\"ecs.g6.4xlarge\\",\\n \\"Count\\": 10,\\n \\"BindingPolicy\\": {\\n \\"NodeSpecCount\\": 5,\\n \\"IncludeNodes\\": [\\n \\"lrnabc\\"\\n ],\\n \\"ExcludeNodes\\": [\\n \\"lrndef\\"\\n ]\\n },\\n \\"HyperType\\": \\"\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"this is a test quota\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"testAccTag\\",\\n \\"Value\\": \\"nihao\\"\\n }\\n ],\\n \\"CreatorId\\": \\"1884692****\\",\\n \\"LatestOperationId\\": \\"operation****\\",\\n \\"Status\\": \\"Ready\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"QuotaDetails\\": {\\n \\"DesiredMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"ActualMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"RequestedQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"NodeStatistics\\": {\\n \\"ActualMinNodeNum\\": 0,\\n \\"ActualMinHyperNodeNum\\": 0,\\n \\"AllocatedNodeNum\\": 0,\\n \\"AllocatedHyperNodeNum\\": 0,\\n \\"EmptyNodeNum\\": 0,\\n \\"AllocatedHyperNodeDetails\\": [\\n {\\n \\"HyperNodeName\\": \\"\\",\\n \\"AllocatedNodeNum\\": 0,\\n \\"TotalNodeNum\\": 0,\\n \\"EmptyNodeNum\\": 0\\n }\\n ]\\n }\\n },\\n \\"QuotaConfig\\": {\\n \\"SupportRDMA\\": false,\\n \\"ClusterId\\": \\"ceeb3724255364***\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"192.168.0.1/24\\\\\\"\\"\\n ],\\n \\"RoleArn\\": \\"acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"nat-7j4mka9wguxj\\",\\n \\"EipAllocationId\\": \\"eip-h29r78ieufbih\\"\\n }\\n },\\n \\"SupportGPUDrivers\\": [\\n \\"470.199.02\\"\\n ],\\n \\"DefaultGPUDriver\\": \\"470.199.02\\",\\n \\"ACS\\": {\\n \\"ACSQuotaId\\": \\"rq-3kbt2gtimmyw7fgfgothocvh\\",\\n \\"AssociatedProducts\\": [\\n \\"PAI-DLC\\"\\n ]\\n },\\n \\"ResourceSpecs\\": [\\n {\\n \\"WorkspaceId\\": \\"122421\\",\\n \\"Product\\": \\"DLC\\",\\n \\"Specs\\": [\\n {\\n \\"SpecName\\": \\"spec_test\\",\\n \\"IsGuaranteedValid\\": true,\\n \\"IsOverSoldValid\\": true,\\n \\"CodeType\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Reason\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n }\\n ],\\n \\"EnablePreemptSubquotaWorkloads\\": false,\\n \\"EnableSubQuotaPreemption\\": true,\\n \\"SubQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorityUpperBound\\": 9,\\n \\"PreemptedProducts\\": [\\n \\"dlc\\"\\n ]\\n },\\n \\"EnableGPUShare\\": true,\\n \\"OversoldUsageConfig\\": {\\n \\"DisabledBy\\": \\"\\",\\n \\"Disabled\\": true\\n },\\n \\"SelfQuotaPreemptionConfig\\": {\\n \\"PreemptorPriorities\\": [\\n 0\\n ],\\n \\"PreemptedPriorities\\": [\\n 0\\n ],\\n \\"PreemptedProducts\\": [\\n \\"\\"\\n ]\\n },\\n \\"EniCacheConfig\\": {\\n \\"Enabled\\": true,\\n \\"CachePoolSize\\": 0\\n },\\n \\"SandboxCacheConfig\\": {\\n \\"Enabled\\": true\\n },\\n \\"UseCase\\": \\"\\",\\n \\"EnableSelfQuotaPreemption\\": true,\\n \\"ControlPlaneClusterId\\": \\"\\",\\n \\"IsEncryptedResource\\": true,\\n \\"WorkloadTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"ws123***\\",\\n \\"WorkspaceName\\": \\"\\"\\n }\\n ],\\n \\"SubQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\",\\n \\"Version\\": \\"\\",\\n \\"QuotaCluster\\": {\\n \\"ClusterType\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"DataSourceId\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"Endpoints\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Status\\": \\"\\"\\n },\\n \\"HyperZones\\": [\\n \\"\\"\\n ],\\n \\"GPUType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]',
],
'ListResourceGroupMachineGroups' => [
'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '125191',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '机器组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'CreatorID',
'in' => 'query',
'schema' => ['description' => '机器组创建者的UserId。', 'type' => 'string', 'required' => false, 'example' => '1612285282502326'],
],
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => ['description' => '资源组 ID,每一个资源组都有全局唯一的资源组ID。可以通过资源组ID来获取资源组的信息。', 'type' => 'string', 'required' => false, 'example' => 'rgf0zhfqn1d4ity2'],
],
[
'name' => 'PaymentType',
'in' => 'query',
'schema' => ['description' => '付费类型。', 'type' => 'string', 'required' => false, 'example' => 'PREPAY'],
],
[
'name' => 'PaymentDurationUnit',
'in' => 'query',
'schema' => ['description' => '机器组计费时间单位。', 'type' => 'string', 'required' => false, 'example' => 'Month'],
],
[
'name' => 'PaymentDuration',
'in' => 'query',
'schema' => ['description' => '付费时长。当PaymentDurationUnit取值为Month时,取值:1、2、3、4、5、6、7、8、9、12、24、36、48、60。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'EcsSpec',
'in' => 'query',
'schema' => ['description' => 'Ecs规格。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '排序方式。'."\n"
."\n"
.'- Asc - 升序排列。'."\n"
."\n"
.'- Desc - 降序排列。', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'GmtCreatedTime'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '实例状态。'."\n"
.'Creating:创建中'."\n"
.'Ready:运行中'."\n"
.'Expiring: 即将过期'."\n"
.'Expired: 已过期'."\n"
.'Stopping:停止中'."\n"
.'Stopped:已停止', 'type' => 'string', 'required' => false, 'example' => 'Ready'],
],
[
'name' => 'OrderInstanceId',
'in' => 'query',
'schema' => ['description' => '购买的实例ID。', 'type' => 'string', 'required' => false, 'example' => '236553689400333'],
],
[
'name' => 'MachineGroupIDs',
'in' => 'query',
'schema' => ['description' => '机器组ID,多个ID通过逗号隔开。', 'type' => 'string', 'required' => false, 'example' => 'mg105ecqwfe49hwb'],
],
[
'name' => 'DiskPL',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroups' => [
'description' => '机器组列表。',
'type' => 'array',
'items' => ['description' => '机器组。', '$ref' => '#/components/schemas/MachineGroup'],
],
'TotalCount' => ['description' => '机器组总数。', 'type' => 'string', 'example' => '4'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
],
],
],
],
'title' => '获取机器组列表',
'summary' => '您可以通过ListResourceGroupMachineGroups获取指定Resource Group下面的机器组列表',
'changeSet' => [
['createdAt' => '2025-03-19T07:07:04.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-05-23T02:15:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-02-25T03:43:31.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroupMachineGroups'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListResourceGroupMachineGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroups\\": [\\n {\\n \\"Status\\": \\"Success\\",\\n \\"EcsCount\\": 1,\\n \\"GmtStartedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"CreatorID\\": \\"1612285282502324\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"PaymentDurationUnit\\": \\"Monthly\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"SupportedDrivers\\": [\\n \\"470.199.02\\"\\n ],\\n \\"PaymentDuration\\": \\"2\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"DiskCapacity\\": 0,\\n \\"GmtExpiredTime\\": \\"2023-08-22T00:00:00Z\\\\n\\",\\n \\"OrderInstanceId\\": \\"“”\\",\\n \\"DefaultDriver\\": \\"470.199.02\\",\\n \\"MachineGroupID\\": \\"mg1\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"DiskPL\\": \\"\\",\\n \\"Cpu\\": 0,\\n \\"Gpu\\": 0,\\n \\"GpuMemory\\": 0,\\n \\"GpuType\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"ResourceType\\": \\"\\",\\n \\"AllocatableCpu\\": 0,\\n \\"AllocatableMemory\\": 0,\\n \\"SystemReservedCpu\\": 0,\\n \\"SystemReservedMemory\\": 0\\n }\\n ],\\n \\"TotalCount\\": \\"4\\",\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]',
],
'ListResourceGroups' => [
'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' => '124250',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => 'pai resource group display name', 'description' => 'Resource Group名称。', 'type' => 'string', 'required' => false, 'example' => 'rgf0zhfqn1d4ity2'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页数', 'description' => '分页数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '页面容量', 'description' => '页面容量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['title' => '排序顺序, 枚举值 desc 或者 asc', 'description' => '排序顺序。取值如下:'."\n"
.'- desc:降序。'."\n"
.'- asc:升序。', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['title' => '用于排序的字段名,可选字段名:DisplayName, GmtCreated, GmtModified,RegionID Duration PricingCycle PayType', 'description' => '用于排序的字段名,可选字段名:DisplayName、GmtCreated、GmtModified、RegionID、Duration、PricingCycle、PayType。', 'type' => 'string', 'required' => false, 'example' => 'DisplayName'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['title' => 'resource group的状态', 'description' => 'Resource Group的状态。', 'type' => 'string', 'required' => false, 'example' => 'Creating'],
],
[
'name' => 'ShowAll',
'in' => 'query',
'schema' => ['description' => '是否全部返回。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'ComputingResourceProvider',
'in' => 'query',
'schema' => ['description' => 'Resource Group的计算资源类型。', 'type' => 'string', 'required' => false, 'example' => 'Ecs'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型列表。取值如下:'."\n"
."\n"
.'- ECS:通用计算资源。'."\n"
.'- Lingjun:灵骏智算资源。', 'type' => 'string', 'required' => false, 'example' => 'Lingjun'],
],
[
'name' => 'ResourceGroupIDs',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'HasResource',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
[
'name' => 'Versions',
'in' => 'query',
'schema' => ['title' => '按照版本搜索。', 'description' => '按照版本搜索。', 'type' => 'string', 'required' => false, 'example' => '1.0'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'ResourceGroups' => [
'title' => 'pai resource groups',
'description' => '资源组列表。',
'type' => 'array',
'items' => ['description' => '资源组。', '$ref' => '#/components/schemas/ResourceGroup'],
'example' => 'RG1',
],
'TotalCount' => ['title' => 'list到的资源组的数量', 'description' => '查询到的资源组的数量。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '9CFA2665-1FFE-5929-8468-C14C25890486'],
],
],
],
],
'title' => '获取资源组列表',
'summary' => '您可以通过该接口获取通用计算资源或灵骏智算资源的资源组列表。',
'description' => '目前,AI计算资源组(包括通用计算资源和灵骏智算资源)仅在部分地域提供服务。具体支持的地域列表,请参见[AI计算资源管理](~~143986~~)。',
'changeSet' => [
['createdAt' => '2025-09-19T03:30:04.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-07-25T06:06:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-06-30T06:48:39.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-05-11T03:07:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-26T12:56:59.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroups'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListResourceGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceGroups\\": [\\n {\\n \\"Name\\": \\"RG1\\",\\n \\"ResourceGroupID\\": \\"rg17tmvwiokh****\\",\\n \\"WorkspaceID\\": \\"23000\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"192.168.0.1/24\\\\\\"\\"\\n ],\\n \\"RoleArn\\": \\"acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"nat-7j4mka9wguxj\\",\\n \\"EipAllocationId\\": \\"eip-h29r78ieufbih\\"\\n }\\n },\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"CreatorID\\": \\"161228528250****\\",\\n \\"NodeCount\\": 3,\\n \\"Version\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"ResourceType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"9CFA2665-1FFE-5929-8468-C14C25890486\\"\\n}","type":"json"}]',
],
'ListTagResources' => [
'path' => '/api/v1/tags',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '205684',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '资源类型',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['MachineGroup' => 'MachineGroup', 'ResourceGroup' => 'ResourceGroup'],
'example' => 'ResourceGroup',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '资源ID,最多 50个子项',
'type' => 'array',
'items' => ['description' => '资源ID。一次调用最多支持添加50个资源ID。', 'type' => 'string', 'required' => false, 'example' => '[\\"rgrk6hhjpvio3wvj\\"]'],
'required' => false,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '对应新增标签列表,最多包含20个子项',
'type' => 'array',
'items' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '下一个查询开始Token', 'description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'example' => 'ad31d453a1f3f23ce0b5e8707e68181f'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'CE22EE94-8AFE-53B5-9C2C-B36207B1CBF9'],
'NextToken' => ['title' => '下一个查询开始Token', 'description' => '下一个查询开始Token', 'type' => 'string', 'example' => '3iEiu84Yk3TwHLzJV.usagf1Ain49xYKGoB6zffsDqPYZQQ5'],
'TagResources' => [
'title' => '资源列表',
'description' => '资源列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagKey' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'example' => 'tagKey'],
'TagValue' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'example' => 'tagValue'],
'ResourceId' => ['title' => '资源ID', 'description' => '资源ID', 'type' => 'string', 'example' => 'rgqssemfn6vjqqev'],
'ResourceType' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'example' => 'ResourceGroup'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'title' => '查询标签列表',
'summary' => '查标签接口。',
'description' => '请求中至少指定以下任一参数,以确定查询对象。'."\n"
."\n"
.'- ResourceId.N'."\n"
.'- Tag.N(Tag.N.Key与Tag.N.Value)'."\n"
."\n"
.'同时指定下列参数时,返回结果中仅包含同时满足这两个条件的资源。'."\n"
.'- Tag.N和ResourceId.N',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE22EE94-8AFE-53B5-9C2C-B36207B1CBF9\\",\\n \\"NextToken\\": \\"3iEiu84Yk3TwHLzJV.usagf1Ain49xYKGoB6zffsDqPYZQQ5\\",\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"tagKey\\",\\n \\"TagValue\\": \\"tagValue\\",\\n \\"ResourceId\\": \\"rgqssemfn6vjqqev\\",\\n \\"ResourceType\\": \\"ResourceGroup\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListTrainingJobEvents' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/events',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '165613',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'traineyfz0m2****'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '页码(默认值为1)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小(默认值为100)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '2000', 'minimum' => '1', 'example' => '100', 'default' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间', 'description' => '起始UTC时间(iso8601格式),为空则为任务开始时间。', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '截止UTC时间,格式 iso8601,假如为空是当前时间', 'description' => '截止UTC时间(iso8601格式),为空则为当前时间。', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'TotalCount' => ['title' => '符合过滤条件的日志数量', 'description' => '事件总数。', 'type' => 'string', 'example' => '23'],
'Events' => [
'title' => '日志列表',
'description' => '事件列表。',
'type' => 'array',
'items' => ['title' => '', 'description' => '事件。', 'type' => 'string', 'example' => 'UserEvent'],
],
],
],
],
],
'title' => '获取训练任务事件',
'summary' => '获取指定训练任务的事件,以帮助您详细了解训练过程中的信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobEvents'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": \\"23\\",\\n \\"Events\\": [\\n \\"UserEvent\\"\\n ]\\n}","type":"json"}]',
],
'ListTrainingJobInstanceEvents' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/events',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '165612',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'train76rcaupa2cz'],
],
[
'name' => 'InstanceId',
'in' => 'path',
'allowEmptyValue' => false,
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'train76rcaupa2cz-master-0'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '2000', 'minimum' => '1', 'example' => '100', 'default' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间', 'description' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间。', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '截止UTC时间,格式 iso8601,假如为空是当前时间', 'description' => '截止UTC时间,格式 iso8601,假如为空是当前时间。', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'TotalCount' => ['title' => '符合过滤条件的日志数量', 'description' => '事件数量。', 'type' => 'string', 'example' => '1'],
'Events' => [
'title' => '日志列表',
'description' => '事件列表。',
'type' => 'array',
'items' => ['title' => '', 'description' => '事件信息。', 'type' => 'string', 'example' => 'You are using pip version 9.0.1, however version 20.2.4 is available.'],
],
],
],
],
],
'title' => '获取训练任务实例事件',
'summary' => '获取训练任务实例对应的事件。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobInstanceEvents'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"Events\\": [\\n \\"You are using pip version 9.0.1, however version 20.2.4 is available.\\"\\n ]\\n}","type":"json"}]',
],
'ListTrainingJobInstanceMetrics' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/instancemetrics',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '157749',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['title' => 'Training Job Id', 'description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'trains930928remn'],
],
[
'name' => 'MetricType',
'in' => 'query',
'schema' => ['title' => '分页,从1开始,默认1', 'description' => '指标类型:'."\n"
.'- GpuCoreUsage:POD GPU使用率'."\n"
.'- GpuMemoryUsage:POD GPU Memory使用率'."\n"
.'- CpuCoreUsage:POD CPU使用率'."\n"
.'- MemoryUsage:POD Memory使用率'."\n"
.'- NetworkInputRate:POD 网络写入速率 (TCPIP) (MB/s)'."\n"
.'- NetworkOutputRate:POD 网络写出速率 (TCPIP) (MB/s)'."\n"
.'- DiskReadRate:POD 磁盘读取速率 (MB/s)'."\n"
.'- DiskWriteRate:POD 磁盘写入速率 (MB/s)', 'type' => 'string', 'required' => true, 'example' => 'GpuCoreUsage'],
],
[
'name' => 'TimeStep',
'in' => 'query',
'schema' => ['description' => '时间间隔,可选值:'."\n"
.'1h 30m 5m 10s', 'type' => 'string', 'required' => false, 'example' => '10s'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'trains930928remn-master-0'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间', 'description' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间。', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '截止UTC时间,格式 iso8601,假如为空是当前时间', 'description' => '截止UTC时间,格式 iso8601,假如为空是当前时间。', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
'InstanceMetrics' => [
'title' => '符合过滤条件的Metrics数量',
'description' => '所有符合过滤条件的监控指标列表。',
'type' => 'array',
'items' => [
'description' => '符合过滤条件的监控指标。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'trainkxen7qjyg6y-master-0'],
'Metrics' => [
'description' => '实例监控指标列表。',
'type' => 'array',
'items' => [
'description' => '实例监控指标。',
'type' => 'object',
'properties' => [
'Time' => ['description' => 'UTC时间,格式 iso8601。', 'type' => 'string', 'example' => '2020-11-08T16:00:00Z'],
'Value' => ['description' => '指标值。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
],
],
],
'NodeName' => ['description' => '节点名称。', 'type' => 'string', 'example' => 'trains930928remn-master-0'],
],
],
],
],
],
],
],
'title' => '获取训练任务实例监控指标',
'summary' => '获取训练任务实例的监控指标。',
'changeSet' => [
['createdAt' => '2024-08-06T02:04:36.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobInstanceMetrics'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"InstanceMetrics\\": [\\n {\\n \\"InstanceId\\": \\"trainkxen7qjyg6y-master-0\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": \\"2020-11-08T16:00:00Z\\",\\n \\"Value\\": 1\\n }\\n ],\\n \\"NodeName\\": \\"trains930928remn-master-0\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListTrainingJobLogs' => [
'summary' => '获取训练任务的日志。',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/logs',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'train129f212o89d'],
],
[
'name' => 'WorkerId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '训练任务的实例ID,已废弃,用InstanceId代替。', 'type' => 'string', 'required' => false, 'example' => 'train129f212o89d-master-0'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '2000', 'minimum' => '1', 'example' => '100', 'default' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间', 'description' => '起始UTC时间,格式 iso8601,如果为空是任务开始时间', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '截止UTC时间,格式 iso8601,假如为空是当前时间', 'description' => '截止UTC时间,格式 iso8601,如果为空是当前时间', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'train129f212o89d-master-0'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'CBF05F13-B24C-5129-9048-4FA684DCD579'],
'TotalCount' => ['title' => '符合过滤条件的日志数量', 'description' => '符合过滤条件的日志数量。', 'type' => 'string', 'example' => '23'],
'Logs' => [
'title' => '日志列表',
'description' => '日志列表。',
'type' => 'array',
'items' => ['title' => '', 'description' => '日志行内容。', 'type' => 'string', 'example' => 'loss: 0.0001'],
],
],
],
],
],
'title' => '获取训练任务的日志',
'changeSet' => [
['createdAt' => '2023-10-13T09:11:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-12-05T12:21:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-04-27T10:49:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobLogs'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF05F13-B24C-5129-9048-4FA684DCD579\\",\\n \\"TotalCount\\": \\"23\\",\\n \\"Logs\\": [\\n \\"loss: 0.0001\\"\\n ]\\n}","type":"json"}]',
],
'ListTrainingJobMetrics' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/metrics',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '132913',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['title' => 'Training Job Id', 'description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'train76rcaupa2cz'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '分页,从1开始,默认1', 'description' => '指标名称。', 'type' => 'string', 'required' => false, 'example' => 'accuracy'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '每页返回的日志数量', 'description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '每页返回的日志数量', 'description' => '分页的大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'default' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间', 'description' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '截止UTC时间,格式 iso8601,假如为空是当前时间', 'description' => '截止UTC时间,格式 iso8601,假如为空是当前时间', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2020-11-08T16:00:00Z'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['title' => 'Metrics的时间顺序,有ASC和DESC', 'description' => '指标返回的时间顺序,ASC或者DESC。', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
],
],
'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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'Metrics' => [
'title' => '符合过滤条件的Metrics数量',
'description' => '指标列表。',
'type' => 'array',
'items' => [
'description' => '指标信息。',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '指标采集的时间戳。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-04-18T22:20:55Z'],
'Value' => ['description' => '指标值。', 'type' => 'number', 'format' => 'double', 'example' => '0.97'],
'Name' => ['title' => 'Metrics名称', 'description' => '指标名。', 'type' => 'string', 'example' => 'accuracy'],
],
],
],
'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
],
],
],
],
'title' => '获取训练任务指标',
'summary' => '获取训练任务的监控数据。',
'changeSet' => [
['createdAt' => '2024-11-06T02:28:37.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-04-27T10:49:51.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobMetrics'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"2022-04-18T22:20:55Z\\",\\n \\"Value\\": 0.97,\\n \\"Name\\": \\"accuracy\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n}","type":"json"}]',
],
'ListTrainingJobOutputModels' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/outputmodels',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '200236',
'abilityTreeNodes' => ['FEATURElearn9XMQIJ'],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['title' => 'A short description of struct', 'description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'traineyfz0m2hsfv'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'OutputModels' => [
'description' => '训练产出模型列表。',
'type' => 'array',
'items' => [
'description' => '训练产出模型。',
'type' => 'object',
'properties' => [
'OutputChannelName' => ['description' => '训练输出数据名。', 'type' => 'string', 'example' => 'model'],
'Uri' => ['description' => '训练输出数据链接。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/path/to/output/channel/'],
'Labels' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签名。', 'type' => 'string', 'example' => 'RootModelName'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'qwen2-0.5'],
],
],
],
'Metrics' => ['description' => '训练任务指标。', 'type' => 'object', 'example' => '{'."\n"
.' "Results": ['."\n"
.' {'."\n"
.' "Dataset": {'."\n"
.' "Train": "oss://somebucket.oss-cn-hangzhou.aliyuncs.com/datasets/Chinese-medical-dialogue-data/chinese_medical_train_sampled.json"'."\n"
.' },'."\n"
.' "Metrics": {'."\n"
.' "loss": 2.1276'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
'TrainingSpec' => ['description' => '模型训练配置。', 'type' => 'object', 'example' => '{}'],
'InferenceSpec' => ['description' => '模型推理配置。', 'type' => 'object', 'example' => '{}'],
'EvaluationSpec' => ['description' => '模型评测配置。', 'type' => 'object', 'example' => '{}'],
'SourceType' => ['description' => '来源(模型是从什么任务产生的)默认:Custom。', 'type' => 'string', 'example' => 'PAIFlow'],
'SourceId' => ['description' => '来源ID,非必填:'."\n"
.'- 来源为Custom,格式无要求。'."\n"
.'- 来源若为PAIFlow,要求格式为region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf。'."\n"
.'- 来源若为TrainingService,要求格式为region=cn-shanghai,workspaceId=1345,kind=TrainingJob,id=job-sakdbaskjdf。', 'type' => 'string', 'example' => 'region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf'],
'CompressionSpec' => ['description' => '模型压缩配置。', 'type' => 'object', 'example' => '{}'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取训练任务产出模型',
'summary' => '获取训练任务产出的模型信息。',
'changeSet' => [
['createdAt' => '2024-07-11T04:11:06.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-07-11T03:58:46.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutputModels\\": [\\n {\\n \\"OutputChannelName\\": \\"model\\",\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/path/to/output/channel/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"RootModelName\\",\\n \\"Value\\": \\"qwen2-0.5\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"Train\\": \\"oss://somebucket.oss-cn-hangzhou.aliyuncs.com/datasets/Chinese-medical-dialogue-data/chinese_medical_train_sampled.json\\"\\n },\\n \\"Metrics\\": {\\n \\"loss\\": 2.1276\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {},\\n \\"EvaluationSpec\\": {},\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf\\",\\n \\"CompressionSpec\\": {}\\n }\\n ]\\n}","type":"json"}]',
],
'ListTrainingJobs' => [
'path' => '/api/v1/trainingjobs',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132980',
'abilityTreeNodes' => ['FEATURElearnVYA4L9'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询的页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '结果排序的字段。',
'type' => 'string',
'required' => false,
'example' => 'GmtModifiedTime',
'enum' => ['GmtModifiedTime', 'GmtCreateTime', 'TrainingJobName', 'AlgorithmName', 'Status'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'description' => '排序方式,取值:'."\n"
."\n"
.'- ASC:升序。'."\n"
.'- DESC:降序。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'],
'example' => 'DESC',
'enum' => ['desc', 'asc'],
],
],
[
'name' => 'TrainingJobName',
'in' => 'query',
'schema' => ['description' => '训练作业名称。', 'type' => 'string', 'required' => false, 'example' => 'large_language_model_training'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '训练任务状态。', 'type' => 'string', 'required' => false, 'example' => 'Running'],
],
[
'name' => 'TrainingJobId',
'in' => 'query',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => false, 'example' => 'trains930928remn'],
],
[
'name' => 'Labels',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => '训练任务标签。', 'type' => 'object', 'required' => false, 'example' => '{"project": "sd-s3"}'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '设置查询的作业创建时间的区间的起始时间。默认是7天前。', 'type' => 'string', 'required' => false, 'example' => '2024-06-22T01:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '设置查询的作业创建时间的区间的截止时间。默认是当前。', 'type' => 'string', 'required' => false, 'example' => '2023-12-27T02:10:00Z'],
],
[
'name' => 'AlgorithmProvider',
'in' => 'query',
'schema' => ['description' => '算法提供者。', 'type' => 'string', 'required' => false, 'example' => 'pai'],
],
[
'name' => 'AlgorithmName',
'in' => 'query',
'schema' => ['description' => '算法名。', 'type' => 'string', 'required' => false, 'example' => 'llm_train'],
],
[
'name' => 'IsTempAlgo',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '是否为临时算法。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '训练任务总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'TrainingJobs' => [
'description' => '训练任务详情列表。',
'type' => 'array',
'items' => [
'description' => '训练任务详情。',
'type' => 'object',
'properties' => [
'AlgorithmName' => ['description' => '算法名。', 'type' => 'string', 'example' => 'llm_train'],
'AlgorithmProvider' => ['description' => '算法提供者。', 'type' => 'string', 'example' => 'pai'],
'AlgorithmVersion' => ['description' => '算法版本。', 'type' => 'string', 'example' => 'v0.0.1'],
'ComputeResource' => [
'description' => '计算资源配置。',
'type' => 'object',
'properties' => [
'EcsCount' => ['description' => 'Ecs实例数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'EcsSpec' => ['description' => 'Ecs实例型号。', 'type' => 'string', 'example' => 'ecs.gn5-c8g1.2xlarge'],
'ResourceId' => ['description' => '资源配额ID。', 'type' => 'string', 'example' => 'quotam670lixikcl'],
'ResourceName' => ['description' => '资源配额名称。', 'type' => 'string', 'example' => 'quota'],
'InstanceCount' => ['description' => '资源配额实例数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'InstanceSpec' => [
'description' => '资源配额实例配置。',
'type' => 'object',
'properties' => [
'CPU' => ['description' => '实例CPU核数。', 'type' => 'string', 'example' => '8'],
'Memory' => ['description' => '实例内存大小,单位为GiB。', 'type' => 'string', 'example' => '32'],
'SharedMemory' => ['description' => '实例共享内存大小,单位为GiB。', 'type' => 'string', 'example' => '32'],
'GPU' => ['description' => '实例GPU显卡数量。', 'type' => 'string', 'example' => '1'],
'GPUType' => ['description' => '实例GPU显卡型号。', 'type' => 'string', 'example' => 'V100'],
],
],
],
],
'GmtCreateTime' => ['description' => '训练任务创建时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'GmtModifiedTime' => ['description' => '训练任务状态更新时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'HyperParameters' => [
'description' => '训练超参数配置。',
'type' => 'array',
'items' => [
'description' => '训练超参数配置。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '参数名。', 'type' => 'string', 'example' => 'learning_rate'],
'Value' => ['description' => '参数值。', 'type' => 'string', 'example' => '0.001'],
],
],
],
'InputChannels' => [
'description' => '训练输入数据配置。',
'type' => 'array',
'items' => [
'description' => '训练输入数据配置。',
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'example' => 'd-475megosidivjfgfq6'],
'InputUri' => ['description' => '输入数据链接。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/channel/'],
'Name' => ['description' => '输入数据名。', 'type' => 'string', 'example' => 'model'],
'VersionName' => ['type' => 'string', 'description' => ''],
],
],
],
'Labels' => [
'description' => '训练任务标签。',
'type' => 'array',
'items' => [
'description' => '训练任务标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签名。', 'type' => 'string', 'example' => 'CreatedBy'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'QuickStart'],
],
],
],
'OutputChannels' => [
'description' => '训练输出数据配置。',
'type' => 'array',
'items' => [
'description' => '训练输出数据配置。',
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID。', 'type' => 'string', 'example' => 'd-8o0hh35po15ejcdq2p'],
'Name' => ['description' => '输出数据名。', 'type' => 'string', 'example' => 'model'],
'OutputUri' => ['description' => '输出数据地址。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/channel/'],
'VersionName' => ['type' => 'string', 'description' => ''],
],
],
],
'ReasonCode' => ['description' => '训练任务状态码。', 'type' => 'string', 'example' => 'TrainingJobSucceed'],
'ReasonMessage' => ['description' => '训练任务错误原因。', 'type' => 'string', 'example' => 'None'],
'Scheduler' => [
'description' => '训练任务调度配置。',
'type' => 'object',
'properties' => [
'MaxRunningTimeInSeconds' => ['description' => '最大训练运行时长,单位为秒。数值为0时不限制最大运行时常。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
'Status' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'Running'],
'StatusTransitions' => [
'description' => '训练任务状态变更列表。',
'type' => 'array',
'items' => [
'description' => '训练任务状态变更。',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => '状态结束时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'ReasonCode' => ['description' => '状态码。', 'type' => 'string', 'example' => 'TrainingJobSucceed'],
'ReasonMessage' => ['description' => '状态更新信息。', 'type' => 'string', 'example' => 'KubeDL job runs successfully'],
'StartTime' => ['description' => '状态开始时间。', 'type' => 'string', 'example' => '2024-07-10T11:49:47Z'],
'Status' => ['description' => '训练任务状态。', 'type' => 'string', 'example' => 'Creating'],
],
],
],
'TrainingJobDescription' => ['description' => '训练任务描述。', 'type' => 'string', 'example' => 'Qwen2 large language model training.'],
'TrainingJobId' => ['description' => '训练任务ID。', 'type' => 'string', 'example' => 'train1layo6js8ra'],
'TrainingJobName' => ['description' => '训练任务名。', 'type' => 'string', 'example' => 'qwen2-7b'],
'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '123456789'],
'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '1234'],
'RoleArn' => ['description' => '代理授权使用的角色信息。', 'type' => 'string', 'example' => 'acs:ram::{accountID}:role/{roleName}'],
'IsTempAlgo' => ['title' => '是否使用了临时算法。', 'description' => '是否使用了临时算法。', 'type' => 'boolean', 'example' => 'true'],
'UserVpc' => [
'description' => '用户VPC配置。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-abcdef****'],
'SwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vs-abcdef****'],
'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-abcdef****'],
'ExtendedCIDRs' => [
'description' => '扩展网段配置。',
'type' => 'array',
'items' => ['description' => '扩展网段配置。', 'type' => 'string', 'example' => '192.168.0.1/24'],
],
'DefaultRoute' => ['description' => '默认路由。', 'type' => 'string', 'example' => 'eth1'],
],
],
'ExperimentConfig' => [
'description' => '训练任务关联实验配置。',
'type' => 'object',
'properties' => [
'ExperimentId' => ['description' => '训练任务关联实验ID。', 'type' => 'string', 'example' => 'exp-ds9aefia90v'],
'ExperimentName' => ['description' => '训练任务关联实验名。', 'type' => 'string', 'example' => 'large_language_model'],
],
],
'Environments' => [
'description' => '环境变量列表。',
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '环境变量。', 'example' => 'debug=true'],
],
'PythonRequirements' => [
'description' => '训练任务Python包配置。',
'type' => 'array',
'items' => ['description' => '训练任务Python包配置。', 'type' => 'string', 'example' => 'torch>=2.2.0'],
],
'DlcJobId' => ['type' => 'string', 'description' => ''],
'AssignNodeSpec' => ['$ref' => '#/components/schemas/AssignNodeSpec', 'description' => ''],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
],
],
],
'title' => '获取训练任务列表',
'summary' => '获取训练任务列表。',
'changeSet' => [
['createdAt' => '2025-11-25T06:20:13.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-18T02:48:42.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-08-07T03:10:37.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-02-29T07:27:53.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-12-15T03:13:02.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-10-09T06:51:30.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-09-01T11:22:26.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-20T02:19:53.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
['createdAt' => '2022-09-26T11:54:38.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobs'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"TrainingJobs\\": [\\n {\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"ComputeResource\\": {\\n \\"EcsCount\\": 1,\\n \\"EcsSpec\\": \\"ecs.gn5-c8g1.2xlarge\\",\\n \\"ResourceId\\": \\"quotam670lixikcl\\",\\n \\"ResourceName\\": \\"quota\\",\\n \\"InstanceCount\\": 1,\\n \\"InstanceSpec\\": {\\n \\"CPU\\": \\"8\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"1\\",\\n \\"GPUType\\": \\"V100\\"\\n }\\n },\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"HyperParameters\\": [\\n {\\n \\"Name\\": \\"learning_rate\\",\\n \\"Value\\": \\"0.001\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-475megosidivjfgfq6\\",\\n \\"InputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/channel/\\",\\n \\"Name\\": \\"model\\",\\n \\"VersionName\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"CreatedBy\\",\\n \\"Value\\": \\"QuickStart\\"\\n }\\n ],\\n \\"OutputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-8o0hh35po15ejcdq2p\\",\\n \\"Name\\": \\"model\\",\\n \\"OutputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/channel/\\",\\n \\"VersionName\\": \\"\\"\\n }\\n ],\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"None\\",\\n \\"Scheduler\\": {\\n \\"MaxRunningTimeInSeconds\\": 0\\n },\\n \\"Status\\": \\"Running\\",\\n \\"StatusTransitions\\": [\\n {\\n \\"EndTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"KubeDL job runs successfully\\",\\n \\"StartTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ],\\n \\"TrainingJobDescription\\": \\"Qwen2 large language model training.\\",\\n \\"TrainingJobId\\": \\"train1layo6js8ra\\",\\n \\"TrainingJobName\\": \\"qwen2-7b\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"RoleArn\\": \\"acs:ram::{accountID}:role/{roleName}\\",\\n \\"IsTempAlgo\\": true,\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ],\\n \\"DefaultRoute\\": \\"eth1\\"\\n },\\n \\"ExperimentConfig\\": {\\n \\"ExperimentId\\": \\"exp-ds9aefia90v\\",\\n \\"ExperimentName\\": \\"large_language_model\\"\\n },\\n \\"Environments\\": {\\n \\"key\\": \\"debug=true\\"\\n },\\n \\"PythonRequirements\\": [\\n \\"torch>=2.2.0\\"\\n ],\\n \\"DlcJobId\\": \\"\\",\\n \\"AssignNodeSpec\\": {\\n \\"EnableAssignNode\\": true,\\n \\"NodeNames\\": \\"\\",\\n \\"AntiAffinityNodeNames\\": \\"\\"\\n }\\n }\\n ],\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'OperateNode' => [
'summary' => '您可以通过OperateNode对节点进行操作',
'path' => '/api/v1/nodes/{NodeId}',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '216521',
'abilityTreeNodes' => ['FEATURElearnZO51AS', 'FEATURElearnCMM1R7'],
],
'parameters' => [
[
'name' => 'NodeId',
'in' => 'path',
'schema' => ['description' => '节点ID。', 'type' => 'string', 'required' => true, 'example' => 'lingjunxxxx-mgxxx-xxxx'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '资源节点所属资源组Id', 'type' => 'string', 'required' => false, 'example' => 'rgaekzbrflewn6jjq'],
'Operation' => [
'description' => '操作 '."\n"
.'- Cordon:禁止调度'."\n"
.'- Uncordon:启动调度'."\n"
.'- Drain:驱逐Pod'."\n",
'type' => 'string',
'required' => true,
'example' => 'Cordon',
'enum' => ['Cordon', 'Uncordon', 'Drain'],
],
'OperationParameters' => ['title' => '节点操作参数配置'."\n", 'description' => '节点操作参数配置'."\n", 'required' => false, '$ref' => '#/components/schemas/NodeOperationParameters'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '96496E6E-00B4-5F55-80F6-1844FA9E92DC'],
'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'lingjunxxxx-mgxxx-xxxx'],
],
],
],
],
'title' => '操作节点',
'description' => '您可以通过OperateNode 操作指定的资源节点,包括 禁止调度/启动调度等 操作',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96496E6E-00B4-5F55-80F6-1844FA9E92DC\\",\\n \\"NodeId\\": \\"lingjunxxxx-mgxxx-xxxx\\"\\n}","type":"json"}]',
],
'ScaleQuota' => [
'summary' => '您可以通过ScaleQuota扩缩容资源配额。',
'path' => '/api/v1/quotas/{QuotaId}/action/scale',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '191196',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'QuotaId',
'in' => 'path',
'schema' => ['description' => 'Quota ID。', 'type' => 'string', 'required' => false, 'example' => 'quotamtl37ge7gkvdz'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body。',
'type' => 'object',
'properties' => [
'ResourceGroupIds' => [
'description' => '资源组列表。',
'type' => 'array',
'items' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2nxrabqavely'],
'required' => false,
],
'Min' => ['description' => '扩缩容Min Quota。'."\n"
.'>NodeSpecs中填写的是扩容后的规格和数量。如果NodeSpecs中Count小于当前Quota的Count,表示缩容,否则表示扩容。>', 'required' => false, '$ref' => '#/components/schemas/ResourceSpec'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6'],
'QuotaId' => ['title' => 'Quota Id', 'description' => 'Quota ID。', 'type' => 'string', 'example' => 'quotamtl37ge7gkvdz'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '扩缩容资源配额',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:ScaleQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"QuotaId\\": \\"quotamtl37ge7gkvdz\\"\\n}","type":"json"}]',
],
'StopTrainingJob' => [
'path' => '/api/v1/trainingjobs/{TrainingJobId}/stop',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => false, 'example' => 'train76rcaupa2cz'],
],
],
'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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
],
],
],
],
'title' => '停止训练任务',
'summary' => '停止一个训练任务。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTrainingJob'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'TagResources' => [
'path' => '/api/v1/tags',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '202685',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body。',
'type' => 'object',
'properties' => [
'ResourceType' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => false, 'example' => 'ResourceGroup'],
'RegionId' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'ResourceId' => [
'title' => '资源ID,最多 50个子项',
'description' => '资源ID,最多 50个子项',
'type' => 'array',
'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => '[\\"rgqssemfn6vjqqev\\"]'],
'required' => false,
],
'Tag' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '对应新增标签列表,最多包含20个子项',
'type' => 'array',
'items' => [
'description' => '标签信息。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => '42F23B58-3684-5443-848A-8DA81FF99712'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '为指定的资源列表统一创建并绑定标签',
'summary' => '打标签接口。',
'description' => '绑定标签前,阿里云会校验资源已有标签数量。超过限制值后返回报错信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\"\\n}","type":"json"}]',
],
'UntagResources' => [
'summary' => '为指定的资源列表统一解绑标签。解绑后,如果该标签没有绑定其他任何资源,会被自动删除。',
'path' => '/api/v1/tags',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '205683',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['title' => '地域', 'description' => '地域', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'ResourceGroup'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '资源ID,最多 50个子项',
'type' => 'array',
'items' => ['description' => '资源列表。'."\n", 'type' => 'string', 'required' => false, 'example' => '[\\"rga2yvifxyicn1rq\\"]'],
'required' => true,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '对应标签键列表,最多包含20个子项',
'description' => '对应标签键列表,最多包含20个子项',
'type' => 'array',
'items' => ['description' => '资源的标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'tagKey'],
'required' => false,
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['title' => '是否全部删除,只针对tags为空时有效。取值范围: true false True False 默认是 false', 'description' => '是否解绑实例上的所有标签,取值:'."\n"
."\n"
.'- **true**:解绑实例上的所有标签。'."\n"
.'- **false**:不解绑实例上的所有标签。'."\n"
."\n"
.'> - 默认值为false。'."\n"
.'- 如果同时传入TagKey和本参数,本参数不生效。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
],
'description' => '',
],
],
],
'title' => '为指定的资源列表统一解绑标签',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]',
],
'UpdateAlgorithm' => [
'path' => '/api/v1/algorithms/{AlgorithmId}',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/x-www-form-urlencoded'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'AlgorithmDescription',
'in' => 'formData',
'schema' => ['description' => '算法描述。', 'type' => 'string', 'required' => false, 'example' => 'Large language model training.'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['description' => '算法展示名。', 'type' => 'string', 'required' => false, 'example' => 'LLM Train'],
],
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => ['description' => '算法ID。', 'type' => 'string', 'required' => false, 'example' => 'algo-sidjc8134hv'],
],
],
'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' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F'],
'AlgorithmId' => ['description' => '算法ID。', 'type' => 'string', 'example' => 'algo-sidjc8134hv'],
],
],
],
],
'title' => '更新算法',
'summary' => '更新算法。',
'changeSet' => [
['createdAt' => '2023-05-24T09:46:46.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAlgorithm'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pai:UpdateAlgorithm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\"\\n}","type":"json"}]',
],
'UpdateAlgorithmVersion' => [
'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/x-www-form-urlencoded'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnP1X97H'],
],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => ['description' => '算法ID。', 'type' => 'string', 'required' => false, 'example' => 'algo-sidjc8134hv'],
],
[
'name' => 'AlgorithmVersion',
'in' => 'path',
'schema' => ['description' => '算法版本。', 'type' => 'string', 'required' => false, 'example' => 'v0.0.1'],
],
[
'name' => 'AlgorithmSpec',
'in' => 'formData',
'style' => 'json',
'schema' => ['description' => '算法详情。', 'required' => false, '$ref' => '#/components/schemas/AlgorithmSpec'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'AlgorithmId' => ['description' => '算法ID。', 'type' => 'string', 'example' => 'algo-sidjc8134hv'],
'AlgorithmVersion' => ['description' => '算法版本。', 'type' => 'string', 'example' => 'v0.1.0'],
],
],
],
],
'title' => '更新算法版本',
'summary' => '更新算法版本。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAlgorithmVersion'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pai:UpdateAlgorithmVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmVersion\\": \\"v0.1.0\\"\\n}","type":"json"}]',
],
'UpdateQuota' => [
'path' => '/api/v1/quotas/{QuotaId}',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '191208',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'QuotaId',
'in' => 'path',
'schema' => ['description' => 'Quota ID。', 'type' => 'string', 'required' => false, 'example' => 'quota-20210126170216-mtl37ge7gkvdz'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '资源配额描述。', 'type' => 'string', 'required' => false, 'example' => 'this is a test quota'],
'Labels' => [
'description' => '用户定义标签列表。'."\n"
.'此处为全量更新。',
'type' => 'array',
'items' => ['description' => '用户定义标签。', 'required' => false, '$ref' => '#/components/schemas/Label'],
'required' => false,
],
'QueueStrategy' => ['description' => 'Quota上任务的排队策略。', 'type' => 'string', 'required' => false, 'example' => 'PaiStrategyIntelligent'],
'QuotaConfig' => ['description' => '资源配额配置', 'required' => false, '$ref' => '#/components/schemas/QuotaConfig'],
'QuotaName' => ['description' => '资源配额名称', 'type' => 'string', 'required' => false, 'example' => 'test'],
'PropagateDefaultGPUDriver' => ['type' => 'boolean'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => '96496E6E-00B4-5F55-80F6-1844FA9E92DC'],
'QuotaId' => ['title' => 'Quota Id', 'description' => 'Quota ID。', 'type' => 'string', 'example' => 'quota-20210126170216-mtl37ge7gkvdz'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新资源配额配置',
'summary' => '您可以通过UpdateQuota更新一个资源配额信息。',
'changeSet' => [
['createdAt' => '2024-05-23T02:06:11.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-05-06T05:44:37.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-12-13T06:59:20.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96496E6E-00B4-5F55-80F6-1844FA9E92DC\\",\\n \\"QuotaId\\": \\"quota-20210126170216-mtl37ge7gkvdz\\"\\n}","type":"json"}]',
],
'UpdateResourceGroup' => [
'path' => '/api/v1/resources/{ResourceGroupID}',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '143268',
'abilityTreeNodes' => ['FEATURElearn1N0SUT'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body。',
'type' => 'object',
'properties' => [
'UserVpc' => ['description' => 'Resource Group打通的VPC的信息。', 'required' => false, '$ref' => '#/components/schemas/UserVpc'],
'Unbind' => ['description' => '是否解绑Resource Group和目前已经打通的VPC。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'Name' => ['description' => 'Resource Group名称。', 'type' => 'string', 'required' => false, 'example' => 'prophet'],
'Description' => ['description' => 'Resource Group描述', 'type' => 'string', 'required' => false, 'example' => 'test_new_havpn_tf'],
],
'required' => false,
],
],
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => ['description' => 'ResourceGroup的ID。', 'type' => 'string', 'required' => false, 'example' => 'rgf0zhfqn1d4ity2'],
],
],
'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' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7'],
'ResourceGroupID' => ['description' => 'ResourceGroup的ID。', 'type' => 'string', 'example' => 'rgf0zhfqn1d4ity2'],
],
],
],
],
'title' => '更新资源组',
'summary' => '您可以通过UpdateResourceGroup更新资源组信息。',
'changeSet' => [
['createdAt' => '2024-01-04T03:16:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-29T07:14:57.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceGroup'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:UpdateResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\"\\n}","type":"json"}]',
],
'UpdateTrainingJobLabels' => [
'summary' => '更新训练任务的标签。',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/labels',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body参数。',
'type' => 'object',
'properties' => [
'Labels' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'RootModelID'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'model-ad8cv770kl'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => ['description' => '训练任务ID。', 'type' => 'string', 'required' => true, 'example' => 'train76rcaupa2cz'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD'],
],
],
],
],
'title' => '更新训练任务标签',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTrainingJobLabels'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'pai.cn-wulanchabu.aliyuncs.com', 'vpc' => 'pai-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-beijing.aliyuncs.com', 'endpoint' => 'pai.cn-beijing.aliyuncs.com', 'vpc' => 'pai-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-shanghai.aliyuncs.com', 'endpoint' => 'pai.cn-shanghai.aliyuncs.com', 'vpc' => 'pai-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-hongkong.aliyuncs.com', 'endpoint' => 'pai.cn-hongkong.aliyuncs.com', 'vpc' => 'pai-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-shenzhen.aliyuncs.com', 'endpoint' => 'pai.cn-shenzhen.aliyuncs.com', 'vpc' => 'pai-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'ap-northeast-2', 'regionName' => '韩国(首尔)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-northeast-2.aliyuncs.com', 'endpoint' => 'pai.ap-northeast-2.aliyuncs.com', 'vpc' => 'pai-vpc.ap-northeast-2.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-northeast-1.aliyuncs.com', 'endpoint' => 'pai.ap-northeast-1.aliyuncs.com', 'vpc' => 'pai-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'regionName' => '华南3(广州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-guangzhou.aliyuncs.com', 'endpoint' => 'pai.cn-guangzhou.aliyuncs.com', 'vpc' => 'pai-vpc.cn-guangzhou.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-southeast-1.aliyuncs.com', 'endpoint' => 'pai.ap-southeast-1.aliyuncs.com', 'vpc' => 'pai-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-southeast-3.aliyuncs.com', 'endpoint' => 'pai.ap-southeast-3.aliyuncs.com', 'vpc' => 'pai-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-southeast-5.aliyuncs.com', 'endpoint' => 'pai.ap-southeast-5.aliyuncs.com', 'vpc' => 'pai-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.cn-hangzhou.aliyuncs.com', 'endpoint' => 'pai.cn-hangzhou.aliyuncs.com', 'vpc' => 'pai-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'ap-southeast-8', 'regionName' => '马来西亚(柔佛州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pai.ap-southeast-8.aliyuncs.com', 'endpoint' => 'pai.ap-southeast-8.aliyuncs.com', 'vpc' => 'pai-vpc.ap-southeast-8.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pai.us-east-1.aliyuncs.com', 'endpoint' => 'pai.us-east-1.aliyuncs.com', 'vpc' => 'pai-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pai.us-west-1.aliyuncs.com', 'endpoint' => 'pai.us-west-1.aliyuncs.com', 'vpc' => 'pai-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pai.eu-central-1.aliyuncs.com', 'endpoint' => 'pai.eu-central-1.aliyuncs.com', 'vpc' => 'pai-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pai.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'pai.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'pai-vpc.cn-shanghai-finance-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'DMS1000001', 'message' => 'Request failed.', 'http_code' => 500, 'description' => '请求失败'],
],
'changeSet' => [
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2025-11-25T06:20:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetQuota'],
],
'createdAt' => '2025-11-12T09:21:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateQuota'],
['description' => '响应参数发生变更', 'api' => 'GetQuota'],
['description' => '请求参数发生变更', 'api' => 'ListQuotas'],
],
'createdAt' => '2025-11-06T13:03:55.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListNodes'],
],
'createdAt' => '2025-11-04T03:55:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListNodes'],
],
'createdAt' => '2025-04-16T09:53:08.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListResourceGroupMachineGroups'],
],
'createdAt' => '2025-03-19T07:07:25.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListNodes'],
],
'createdAt' => '2025-03-13T10:38:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListQuotaWorkloads'],
],
'createdAt' => '2025-02-19T12:19:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2024-11-18T02:49:00.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobMetrics'],
],
'createdAt' => '2024-11-06T02:28:55.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2024-10-17T03:44:21.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DeleteAlgorithmVersion'],
],
'createdAt' => '2024-09-25T02:19:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
],
'createdAt' => '2024-09-23T07:12:46.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2024-08-07T03:10:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobInstanceMetrics'],
],
'createdAt' => '2024-08-06T02:04:52.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2024-07-19T02:50:28.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobOutputModels'],
],
'createdAt' => '2024-07-11T04:11:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobOutputModels'],
],
'createdAt' => '2024-07-11T03:59:08.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListQuotas'],
],
'createdAt' => '2024-07-04T13:23:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
],
'createdAt' => '2024-07-03T03:12:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetMachineGroup'],
['description' => '请求参数发生变更', 'api' => 'ListResourceGroupMachineGroups'],
],
'createdAt' => '2024-05-23T02:15:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UpdateQuota'],
],
'createdAt' => '2024-05-23T02:06:24.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2024-05-09T10:31:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetQuota'],
],
'createdAt' => '2024-05-09T05:27:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListQuotas'],
],
'createdAt' => '2024-05-09T02:33:27.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UpdateQuota'],
],
'createdAt' => '2024-05-06T05:44:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListQuotas'],
],
'createdAt' => '2024-03-19T09:18:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2024-03-14T08:13:00.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2024-02-29T07:28:02.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListQuotas'],
],
'createdAt' => '2024-01-24T08:33:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateResourceGroup'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetResourceGroup'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetResourceGroupMachineGroup'],
['description' => '请求参数发生变更', 'api' => 'UpdateResourceGroup'],
],
'createdAt' => '2024-01-04T03:16:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2023-12-26T10:28:24.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2023-12-15T03:13:16.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UpdateQuota'],
],
'createdAt' => '2023-12-13T06:59:30.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2023-12-07T04:21:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListTrainingJobLogs'],
],
'createdAt' => '2023-10-13T09:11:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2023-10-09T06:51:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
],
'createdAt' => '2023-09-12T03:19:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2023-09-01T11:22:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetMachineGroup'],
['description' => '响应参数发生变更', 'api' => 'GetResourceGroupMachineGroup'],
],
'createdAt' => '2023-08-30T07:23:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
],
'createdAt' => '2023-08-22T03:17:23.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2023-08-15T11:50:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateAlgorithm'],
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetAlgorithm'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'ListAlgorithms'],
['description' => '响应参数发生变更', 'api' => 'ListTrainingJobs'],
['description' => '请求参数发生变更', 'api' => 'UpdateAlgorithm'],
],
'createdAt' => '2023-05-24T09:46:53.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateResourceGroup'],
['description' => '响应参数发生变更', 'api' => 'GetResourceGroup'],
['description' => '请求参数发生变更', 'api' => 'ListResourceGroups'],
],
'createdAt' => '2023-05-11T03:07:06.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListResourceGroups'],
],
'createdAt' => '2023-04-26T12:57:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2023-04-20T02:19:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetResourceGroup'],
],
'createdAt' => '2023-04-10T09:57:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetResourceGroup'],
],
'createdAt' => '2023-04-06T05:56:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateResourceGroup'],
['description' => '请求参数发生变更', 'api' => 'GetResourceGroup'],
],
'createdAt' => '2023-04-04T06:45:10.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTrainingJob'],
],
'createdAt' => '2022-12-06T12:13:04.000Z',
'description' => 'Support Temporary Algorithm.',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListTrainingJobLogs'],
],
'createdAt' => '2022-12-05T12:21:21.000Z',
'description' => 'Modify ListTrainingJobLogs.',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListTrainingJobs'],
],
'createdAt' => '2022-09-26T11:55:02.000Z',
'description' => '修改OpenApi可见性',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2022-09-24T14:00:23.000Z',
'description' => 'Add Training Job Url.',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2022-09-14T12:39:10.000Z',
'description' => '增加出参Instances(job实例)',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
['description' => '响应参数发生变更', 'api' => 'GetTrainingJob'],
],
'createdAt' => '2022-09-14T12:28:39.000Z',
'description' => '添加算法id参数',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListAlgorithms'],
],
'createdAt' => '2022-09-09T09:37:46.000Z',
'description' => 'fix error.',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'GetNodeMetrics'],
],
'createdAt' => '2022-09-02T14:39:22.000Z',
'description' => 'd',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetResourceGroup'],
],
'createdAt' => '2022-08-03T03:11:58.000Z',
'description' => '更新超时threshold',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetResourceGroupMachineGroup'],
['description' => 'OpenAPI 下线', 'api' => 'GetResourceGroupRequest'],
['description' => 'OpenAPI 下线', 'api' => 'GetResourceGroupTotal'],
],
'createdAt' => '2022-07-21T07:16:25.000Z',
'description' => 'dashboard相关的API发布上线',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateResourceGroup'],
['description' => 'OpenAPI 下线', 'api' => 'UpdateResourceGroup'],
],
'createdAt' => '2022-07-01T08:14:21.000Z',
'description' => 'UpdateResourceGroup',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateAlgorithm'],
['description' => 'OpenAPI 下线', 'api' => 'CreateAlgorithmVersion'],
['description' => 'OpenAPI 下线', 'api' => 'CreateTrainingJob'],
['description' => 'OpenAPI 下线', 'api' => 'GetAlgorithm'],
['description' => 'OpenAPI 下线', 'api' => 'GetAlgorithmVersion'],
['description' => 'OpenAPI 下线', 'api' => 'ListAlgorithms'],
['description' => 'OpenAPI 下线', 'api' => 'ListAlgorithmVersions'],
['description' => 'OpenAPI 下线', 'api' => 'ListTrainingJobLogs'],
['description' => 'OpenAPI 下线', 'api' => 'ListTrainingJobMetrics'],
],
'createdAt' => '2022-04-27T11:13:17.000Z',
'description' => 'PAI基于云原生推出了全新的算法训练服务,基于此API支持用户直接调用PAI提供的内置算法,创建训练任务、查看任务的详情、运行日志、算法的Metrics等',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateResourceGroup'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteMachineGroup'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteResourceGroup'],
['description' => 'OpenAPI 下线', 'api' => 'GetMachineGroup'],
['description' => 'OpenAPI 下线', 'api' => 'GetResourceGroup'],
['description' => 'OpenAPI 下线', 'api' => 'GetResourceGroupMachineGroup'],
['description' => 'OpenAPI 下线', 'api' => 'ListResourceGroupMachineGroups'],
],
'createdAt' => '2022-02-25T03:44:54.000Z',
'description' => 'resource service openAPI第一次上线',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobInstanceMetrics'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMachineGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTrainingJob'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAlgorithmVersion'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAlgorithm'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrainingJob'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResourceGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTrainingJobLabels'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupTotal'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJob'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupMachineGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeMetrics'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithms'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroupRequest'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobInstanceEvents'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJobLatestMetrics'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithmVersion'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlgorithm'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobLogs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJobLabels'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroupMachineGroups'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceGroupMachineGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserViewMetrics'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobMetrics'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroups'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAlgorithm'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithmVersions'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithm'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobEvents'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAlgorithmVersion'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlgorithmVersion'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMachineGroup'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJob'],
],
],
'ram' => [
'productCode' => 'PaiStudio',
'productName' => '人工智能平台 PAI',
'ramCodes' => ['pai', 'paidesigner', 'paiartlab'],
'ramLevel' => '资源级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'ListQuotas',
'description' => '获取资源配额列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListQuotas',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetResourceGroup',
'description' => '获取资源组详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pai:GetResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
],
],
],
[
'apiName' => 'CreateAlgorithm',
'description' => '创建算法',
'operationType' => 'create',
'ramAction' => [
'action' => 'pai:CreateAlgorithm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateResourceGroup',
'description' => '创建资源组',
'operationType' => 'create',
'ramAction' => [
'action' => 'pai:CreateResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
],
],
],
[
'apiName' => 'ListResourceGroupMachineGroups',
'description' => '获取机器组列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListResourceGroupMachineGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAlgorithmVersion',
'description' => '获取算法版本详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pai:GetAlgorithmVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQuota',
'description' => '获取资源配额详情',
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:GetQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetResourceGroupMachineGroup',
'description' => '获取机器组详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pai:GetResourceGroupMachineGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'MachineGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}/machinegroup/{#MachineGroupId}'],
],
],
],
[
'apiName' => 'ListAlgorithms',
'description' => '获取算法详情列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListAlgorithms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteQuota',
'description' => '删除资源配额',
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:DeleteQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAlgorithm',
'description' => '获取算法详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pai:GetAlgorithm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteAlgorithmVersion',
'description' => '删除算法版本',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pai:DeleteAlgorithmVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListResourceGroups',
'description' => '获取资源组列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListResourceGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteResourceGroup',
'description' => '删除资源组',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pai:DeleteResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
],
],
],
[
'apiName' => 'UpdateResourceGroup',
'description' => '更新资源组',
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:UpdateResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
],
],
],
[
'apiName' => 'UpdateAlgorithmVersion',
'description' => '更新算法版本',
'operationType' => 'update',
'ramAction' => [
'action' => 'pai:UpdateAlgorithmVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteAlgorithm',
'description' => '删除算法',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pai:DeleteAlgorithm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateQuota',
'description' => '创建资源配额',
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:CreateQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ScaleQuota',
'description' => '扩缩容资源配额',
'operationType' => 'none',
'ramAction' => [
'action' => 'pai:ScaleQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateAlgorithm',
'description' => '更新算法',
'operationType' => 'update',
'ramAction' => [
'action' => 'pai:UpdateAlgorithm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListAlgorithmVersions',
'description' => '获取算法版本详情列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pai:ListAlgorithmVersions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAlgorithmVersion',
'description' => '创建算法版本',
'operationType' => 'create',
'ramAction' => [
'action' => 'pai:CreateAlgorithmVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PaiStudio', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'ResourceGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}'],
['validationType' => 'always', 'resourceType' => 'Quota', 'arn' => 'acs:paiplugin:{#regionId}:{#accountId}:quota/{#QuotaId}'],
['validationType' => 'always', 'resourceType' => 'MachineGroup', 'arn' => 'acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}/machinegroup/{#MachineGroupId}'],
['validationType' => 'always', 'resourceType' => 'Quota', 'arn' => 'acs:pai:{#regionId}:{#accountId}:quota'],
],
],
];