'1.0',
'info' => [
'style' => 'ROA',
'product' => 'PaiStudio',
'version' => '2022-01-12',
],
'directories' => [
[
'id' => 384361,
'title' => null,
'type' => 'directory',
'children' => [
'UpdateResourceGroup',
'GetResourceGroupTotal',
'ListResourceGroups',
'GetResourceGroupRequest',
'DeleteResourceGroupMachineGroup',
'GetNodeMetrics',
'ListResourceGroupMachineGroups',
'GetUserViewMetrics',
'GetResourceGroupMachineGroup',
'GetResourceGroup',
'DeleteMachineGroup',
'CreateResourceGroup',
'DeleteResourceGroup',
'GetMachineGroup',
],
],
[
'id' => 384376,
'title' => null,
'type' => 'directory',
'children' => [
'CreateAlgorithm',
'CreateAlgorithmVersion',
'DeleteAlgorithm',
'DeleteAlgorithmVersion',
'GetAlgorithm',
'GetAlgorithmVersion',
'ListAlgorithms',
'ListAlgorithmVersions',
'UpdateAlgorithm',
'UpdateAlgorithmVersion',
],
],
[
'id' => 384387,
'title' => null,
'type' => 'directory',
'children' => [
'CreateTrainingJob',
'CreateInstanceWebTerminal',
'CheckInstanceWebTerminal',
'DeleteTrainingJob',
'DeleteTrainingJobLabels',
'GetToken',
'GetTrainingJob',
'GetTrainingJobErrorInfo',
'GetTrainingJobLatestMetrics',
'ListTrainingJobs',
'ListTrainingJobEvents',
'ListTrainingJobInstanceEvents',
'ListTrainingJobInstanceMetrics',
'ListTrainingJobLogs',
'ListTrainingJobMetrics',
'ListTrainingJobOutputModels',
'StopTrainingJob',
'UpdateTrainingJobLabels',
],
],
[
'id' => 384406,
'title' => null,
'type' => 'directory',
'children' => [
'CreateQuota',
'ListQuotas',
'GetQuota',
'UpdateQuota',
'ScaleQuota',
'DeleteQuota',
'ListQuotaWorkloads',
],
],
[
'id' => 384414,
'title' => null,
'type' => 'directory',
'children' => [
'ListTagResources',
'TagResources',
'UntagResources',
],
],
[
'id' => 384418,
'title' => null,
'type' => 'directory',
'children' => [
'ListNodes',
'GetSpotPriceHistory',
'OperateNode',
],
],
],
'components' => [
'schemas' => [
'ACS' => [
'title' => 'ACS Quota Related Configuration',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'ACSQuotaId' => [
'title' => 'ACS Identifier',
'description' => 'ACS Identifier',
'visibility' => 'public',
'type' => 'string',
'example' => 'rq-3kbt2gtimmyw7fgfgothocvh',
'backendName' => 'ACSQuotaId',
],
'AssociatedProducts' => [
'title' => 'Products that can use ACS Quota',
'description' => '',
'visibility' => 'public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'PAI-DLC',
'extendType' => 'true',
],
'backendName' => 'AssociatedProducts',
],
],
],
'AlgorithmSpec' => [
'title' => 'Defines how the training job of the algorithm run.',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'OutputChannels' => [
'title' => 'The outputs of the algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/Channel',
],
'backendName' => 'OutputChannels',
'itemName' => 'OutputChannels',
],
'HyperParameters' => [
'title' => 'The hype parameter used by the algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/HyperParameterDefinition',
],
'backendName' => 'HyperParameters',
'itemName' => 'HyperParameters',
],
'JobType' => [
'title' => 'Job type of the training job while running the algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'TFJob',
'backendName' => 'JobType',
'enum' => [
'TFJob',
'PyTorchJob',
'XGBoostJob',
'ElasticBatchJob',
],
],
'Command' => [
'title' => 'The command used for submit the job.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'python train.py',
'extendType' => 'true',
],
'required' => true,
'backendName' => 'Command',
'itemName' => 'Command',
],
'MetricDefinitions' => [
'title' => 'The output metrics of the algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/MetricDefinition',
],
'backendName' => 'MetricDefinitions',
'itemName' => 'MetricDefinitions',
],
'InputChannels' => [
'title' => 'The input for the algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/Channel',
],
'required' => false,
'backendName' => 'InputChannels',
'itemName' => 'InputChannels',
],
'SupportsDistributedTraining' => [
'title' => 'Indicates whether the algorithm support distributed training.',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'SupportsDistributedTraining',
],
'Image' => [
'title' => 'The docker image used by the job of this algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'registry.cn-shanghai.aliyuncs.com/pai-training/kmeans:v1.0.0',
'backendName' => 'Image',
],
'SupportedInstanceTypes' => [
'title' => 'A list of ECS instances that the algorithm can use to submit training job.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'ecs.g6.2xlarge',
'extendType' => 'true',
],
'deprecated' => true,
'backendName' => 'SupportedInstanceTypes',
],
'ComputeResource' => [
'title' => 'Compute resource',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Policy' => [
'title' => 'Policy',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Version' => [
'title' => 'Policy Version',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'V1',
'backendName' => 'Version',
],
'Value' => [
'title' => 'Policy Value',
'description' => 'Policy Value',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => '0',
'backendName' => 'Value',
],
],
'required' => true,
'backendName' => 'Policy',
],
],
'backendName' => 'ComputeResource',
],
'CodeDir' => [
'description' => '',
'visibility' => 'Public',
'backendName' => 'CodeDir',
'$ref' => '#/components/schemas/Location',
],
'Customization' => [
'title' => 'Customization',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'CodeDir' => [
'title' => 'CodeDir',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'CodeDir',
],
],
'backendName' => 'Customization',
],
'ResourceRequirements' => [
'title' => 'Resource requirements.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/ConditionExpression',
],
'backendName' => 'ResourceRequirements',
],
'ProgressDefinitions' => [
'title' => 'ProgressDefinitions',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'OverallProgress' => [
'title' => 'OverallProgress',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Description' => [
'title' => 'Description',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'training progress',
'backendName' => 'Description',
],
'Regex' => [
'title' => 'Regex',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '^[0-9]+([.][0-9]+){0,1}$',
'backendName' => 'Regex',
],
],
'backendName' => 'OverallProgress',
],
'RemainingTime' => [
'title' => 'RemainingTime',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Description' => [
'title' => 'Description',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'training remaining time',
'backendName' => 'Description',
],
'Regex' => [
'title' => 'Regex',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '^[0-9]+([.][0-9]+){0,1}$',
'backendName' => 'Regex',
],
],
'backendName' => 'RemainingTime',
],
],
'backendName' => 'ProgressDefinitions',
],
],
],
'Channel' => [
'title' => 'A named input/output for the algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Description' => [
'title' => 'A brief description for the channel.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'backendName' => 'Description',
],
'Required' => [
'title' => 'Indicates whethe the channels is required.',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'Required',
],
'Properties' => [
'title' => 'The properties of channel.',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'example' => '{}',
'backendName' => 'Properties',
],
'Name' => [
'title' => 'The name of channel.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'Model',
'backendName' => 'Name',
],
'SupportedChannelTypes' => [
'title' => 'Supported Channel Types',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'oss',
'extendType' => 'true',
],
'required' => false,
'backendName' => 'SupportedChannelTypes',
],
],
],
'ConditionExpression' => [
'title' => 'A short description of struct',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Key' => [
'title' => 'The key of the conditional expression.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'SupportedMachineTypes',
'backendName' => 'Key',
],
'Operator' => [
'title' => 'The operator of the conditional expression',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'in',
'backendName' => 'Operator',
],
'Values' => [
'title' => 'The values of the conditional expression.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'ecs.gn5-c4g1.xlarge',
'extendType' => 'true',
],
'required' => true,
'backendName' => 'Values',
],
],
],
'ForwardInfo' => [
'title' => 'User VPC Forward Info',
'description' => 'VPC Forward Info',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'NatGatewayId' => [
'title' => 'NAT Gateway ID',
'description' => 'NAT Gateway ID',
'visibility' => 'Public',
'type' => 'string',
'example' => 'nat-7j4mka9wguxj',
'backendName' => 'NatGatewayId',
],
'EipAllocationId' => [
'title' => 'EIP Allocation ID',
'description' => 'EIP Allocation ID',
'visibility' => 'Public',
'type' => 'string',
'example' => 'eip-h29r78ieufbih',
'backendName' => 'EipAllocationId',
],
],
],
'GPUInfo' => [
'title' => 'A short description of struct',
'description' => 'pai resource group ecs spec',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'count' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'backendName' => 'count',
],
'type' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'T4',
'backendName' => 'type',
],
],
],
'HyperParameterDefinition' => [
'title' => 'Definition of the input hyper parameter for the algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'DefaultValue' => [
'title' => 'Default value for the parameter.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'backendName' => 'DefaultValue',
],
'Type' => [
'title' => 'Type of the parameter.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'Integer',
'backendName' => 'Type',
],
'Description' => [
'title' => 'Description for the parameter.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'backendName' => 'Description',
],
'Required' => [
'title' => 'Indicates whether the parameter is required',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'Required',
],
'Name' => [
'title' => 'Name of the parameter.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'batch_size',
'backendName' => 'Name',
],
'Range' => [
'description' => '',
'visibility' => 'Public',
'backendName' => 'Range',
'$ref' => '#/components/schemas/HyperParameterRange',
],
'DisplayName' => [
'title' => 'Display name of parameter.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'Batch Size',
'backendName' => 'DisplayName',
],
],
],
'HyperParameterRange' => [
'title' => 'A short description of struct',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Enum' => [
'title' => 'Enumerated values for hyperparameters.',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'extendType' => 'true',
],
'required' => false,
'backendName' => 'Enum',
],
'MinLength' => [
'title' => 'Minimum length of string.',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'backendName' => 'MinLength',
],
'MaxLength' => [
'title' => 'Maximum length of string.',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
'backendName' => 'MaxLength',
],
'Minimum' => [
'title' => 'Minimum value.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'backendName' => 'Minimum',
],
'Maximum' => [
'title' => 'Maximum value.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '10',
'backendName' => 'Maximum',
],
'ExclusiveMinimum' => [
'title' => 'Whether to exclude minimum values.',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'ExclusiveMinimum',
],
'ExclusiveMaximum' => [
'title' => 'Whether to exclude maximum values',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'ExclusiveMaximum',
],
'Pattern' => [
'title' => 'Value Regex Pattern.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '^\\+?[1-9][0-9]*$',
'backendName' => 'Pattern',
],
],
],
'JobSettings' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'BusinessUserId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '166924',
'backendName' => 'BusinessUserId',
],
'Caller' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'SilkFlow',
'backendName' => 'Caller',
],
'Tags' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'additionalProperties' => [
'visibility' => 'Public',
'type' => 'string',
],
'backendName' => 'Tags',
],
'PipelineId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'pid-123456',
'backendName' => 'PipelineId',
],
'EnableTideResource' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'EnableTideResource',
],
'EnableErrorMonitoringInAIMaster' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'false',
'backendName' => 'EnableErrorMonitoringInAIMaster',
],
'ErrorMonitoringArgs' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '--enable-log-hang-detection true',
'backendName' => 'ErrorMonitoringArgs',
],
'EnableRDMA' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'EnableRDMA',
],
'EnableOssAppend' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'EnableOssAppend',
],
'OversoldType' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'AcceptQuotaOverSold',
'backendName' => 'OversoldType',
],
'AdvancedSettings' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'backendName' => 'AdvancedSettings',
],
'Driver' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '535.54.03',
'backendName' => 'Driver',
],
'EnableSanityCheck' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'EnableSanityCheck',
],
'SanityCheckArgs' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFai',
'backendName' => 'SanityCheckArgs',
],
'JobReservedMinutes' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
'backendName' => 'JobReservedMinutes',
],
'JobReservedPolicy' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'Always',
'backendName' => 'JobReservedPolicy',
'enum' => [
'Always',
'OnFailure',
'OnSucceed',
],
],
],
'parseType' => 'struct',
],
'Label' => [
'title' => 'A short description of struct',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'Key' => [
'title' => 'Key of label.',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'testAccTag',
'backendName' => 'Key',
],
'Value' => [
'title' => 'Value of label.',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'nihao',
'backendName' => 'Value',
],
],
],
'Location' => [
'title' => 'A short description of struct',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'LocationType' => [
'title' => 'Location type, such as OSS,Git.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'OSS',
'backendName' => 'LocationType',
],
'LocationValue' => [
'title' => 'Location value.',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'example' => 'oss://${bucket_name}.oss-${region}.aliyuncs.com/oss/location/path/',
'backendName' => 'LocationValue',
],
],
],
'MachineGroup' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'MachineGroupID' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'mg1',
'backendName' => 'MachineGroupID',
],
'ResourceGroupID' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'rgf0zhfqn1d4ity2',
'backendName' => 'ResourceGroupID',
],
'EcsCount' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'backendName' => 'EcsCount',
],
'PaymentDuration' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2',
'backendName' => 'PaymentDuration',
],
'EcsSpec' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'ecs.c6.large',
'backendName' => 'EcsSpec',
],
'GmtCreatedTime' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
'backendName' => 'GmtCreatedTime',
],
'GmtExpiredTime' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2023-08-22T00:00:00Z'."\n",
'backendName' => 'GmtExpiredTime',
],
'GmtModifiedTime' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
'backendName' => 'GmtModifiedTime',
],
'GmtStartedTime' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
'backendName' => 'GmtStartedTime',
],
'PaymentType' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'PREPAY',
'backendName' => 'PaymentType',
],
'PaymentDurationUnit' => [
'title' => 'region ID',
'description' => 'region ID',
'visibility' => 'Public',
'type' => 'string',
'example' => 'Monthly',
'backendName' => 'PaymentDurationUnit',
],
'Status' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'Success',
'backendName' => 'Status',
],
'ReasonMessage' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '“”',
'backendName' => 'ReasonMessage',
],
'ReasonCode' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '“”',
'backendName' => 'ReasonCode',
],
'CreatorID' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '1612285282502324',
'backendName' => 'CreatorID',
],
'SupportedDrivers' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '470.199.02',
'extendType' => 'true',
],
'backendName' => 'SupportedDrivers',
'itemName' => 'DriverVersions',
],
'DefaultDriver' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '470.199.02',
'backendName' => 'DefaultDriver',
],
'OrderInstanceId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '“”',
'backendName' => 'OrderInstanceId',
],
],
],
'Metric' => [
'title' => '',
'description' => 'resource group metric',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Time' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => 'rg17tmvwiokhzaxg',
'backendName' => 'Time',
],
'Value' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '23000',
'backendName' => 'Value',
],
],
],
'MetricDefinition' => [
'title' => 'Describe the output metric of the algorithm.',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Description' => [
'title' => 'A brief description for the metric.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'backendName' => 'Description',
],
'Regex' => [
'title' => 'Regex use to match the metrics from job log.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => '.*train:loss=([-+]?[0-9]*\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*',
'backendName' => 'Regex',
],
'Name' => [
'title' => 'The name of the metric.',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => true,
'example' => 'loss',
'backendName' => 'Name',
],
],
],
'Node' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'CreatorId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '281044699048527748',
'backendName' => 'CreatorId',
],
'NodeName' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'lingjxxxx',
'backendName' => 'NodeName',
],
'NodeType' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'ecs.c8i.xlarge',
'backendName' => 'NodeType',
],
'AcceleratorType' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'CPU',
'backendName' => 'AcceleratorType',
],
'CPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '4',
'backendName' => 'CPU',
],
'Memory' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '8',
'backendName' => 'Memory',
],
'GPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'backendName' => 'GPU',
],
'GPUType' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '""',
'backendName' => 'GPUType',
],
'NodeStatus' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'Ready',
'backendName' => 'NodeStatus',
],
'ReasonCode' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '""',
'backendName' => 'ReasonCode',
],
'ReasonMessage' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '""',
'backendName' => 'ReasonMessage',
],
'OrderStatus' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'Ready',
'backendName' => 'OrderStatus',
],
'ResourceGroupId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'rgf0zhfqn1d4ity2',
'backendName' => 'ResourceGroupId',
],
'ResourceGroupName' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'test',
'backendName' => 'ResourceGroupName',
],
'MachineGroupId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'mg1234456',
'backendName' => 'MachineGroupId',
],
'GmtCreateTime' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
'backendName' => 'GmtCreateTime',
],
'GmtModifiedTime' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
'backendName' => 'GmtModifiedTime',
],
'GmtExpiredTime' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2025-06-22T00:00:00Z'."\n",
'backendName' => 'GmtExpiredTime',
],
'IsBound' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'false',
'backendName' => 'IsBound',
],
'BoundQuotas' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/QuotaIdName',
],
'backendName' => 'BoundQuotas',
],
'RequestCPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '4',
'backendName' => 'RequestCPU',
],
'RequestMemory' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '8',
'backendName' => 'RequestMemory',
],
'RequestGPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'backendName' => 'RequestGPU',
],
'LimitCPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '4',
'backendName' => 'LimitCPU',
],
'LimitMemory' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '8',
'backendName' => 'LimitMemory',
],
'LimitGPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'backendName' => 'LimitGPU',
],
'PodNum' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
'backendName' => 'PodNum',
],
'WorkloadNum' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
'backendName' => 'WorkloadNum',
],
'Users' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/UserInfo',
],
'backendName' => 'Users',
],
],
],
'NodeCordonParameters' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'QuotaId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'QuotaId',
],
'WorkspaceId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'WorkspaceId',
],
'Comment' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'Comment',
],
],
],
'NodeDrainParameters' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'PodNames' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'extendType' => 'true',
],
'backendName' => 'PodNames',
],
'PodFromSubProducts' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'extendType' => 'true',
],
'backendName' => 'PodFromSubProducts',
],
],
],
'NodeMetric' => [
'title' => '',
'description' => 'resource group metric',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'NodeID' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '-i121212node',
'backendName' => 'NodeID',
],
'Metrics' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/Metric',
],
'example' => '23000',
'backendName' => 'Metrics',
],
'GPUType' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'GU108',
'backendName' => 'GPUType',
],
],
],
'NodeOperationParameters' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'CordonParameters' => [
'visibility' => 'Public',
'backendName' => 'CordonParameters',
'$ref' => '#/components/schemas/NodeCordonParameters',
],
'UncordonParameters' => [
'visibility' => 'Public',
'backendName' => 'UncordonParameters',
'$ref' => '#/components/schemas/NodeUncordonParameters',
],
'DrainParameters' => [
'visibility' => 'Public',
'backendName' => 'DrainParameters',
'$ref' => '#/components/schemas/NodeDrainParameters',
],
],
],
'NodeSpec' => [
'title' => '',
'description' => 'NodeSpec',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'ecs.g6.4xlarge',
'backendName' => 'Type',
],
'Count' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
'backendName' => 'Count',
],
],
],
'NodeUncordonParameters' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'QuotaId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'QuotaId',
],
'WorkspaceId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'WorkspaceId',
],
],
],
'Quota' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'QuotaId' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'quota12345',
'backendName' => 'QuotaId',
],
'QuotaName' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'dlc-quota',
'backendName' => 'QuotaName',
],
'ResourceType' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'ResourceType',
],
'ParentQuotaId' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'ParentQuotaId',
],
'ResourceGroupIds' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'array',
'items' => [
'visibility' => 'public',
'type' => 'string',
'extendType' => 'true',
],
'backendName' => 'ResourceGroupIds',
'itemName' => 'ResourceGroupIdItem',
],
'AllocateStrategy' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'AllocateStrategy',
],
'Min' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'backendName' => 'Min',
'$ref' => '#/components/schemas/ResourceSpec',
],
'Description' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'Description',
],
'Labels' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'array',
'items' => [
'visibility' => 'public',
'extendType' => 'true',
'$ref' => '#/components/schemas/Label',
],
'backendName' => 'Labels',
'itemName' => 'LabelItem',
],
'CreatorId' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'CreatorId',
],
'LatestOperationId' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'LatestOperationId',
],
'Status' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'Status',
],
'ReasonCode' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'ReasonCode',
],
'ReasonMessage' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'ReasonMessage',
],
'GmtCreatedTime' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'GmtCreatedTime',
],
'GmtModifiedTime' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'GmtModifiedTime',
],
'QuotaDetails' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'backendName' => 'QuotaDetails',
'$ref' => '#/components/schemas/QuotaDetails',
],
'QuotaConfig' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'backendName' => 'QuotaConfig',
'$ref' => '#/components/schemas/QuotaConfig',
],
'Workspaces' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'array',
'items' => [
'visibility' => 'public',
'extendType' => 'true',
'$ref' => '#/components/schemas/WorkspaceIdName',
],
'backendName' => 'Workspaces',
'itemName' => 'WorkspaceItem',
],
'SubQuotas' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'array',
'items' => [
'visibility' => 'public',
'extendType' => 'true',
'$ref' => '#/components/schemas/QuotaIdName',
],
'backendName' => 'SubQuotas',
'itemName' => 'SubQuotaItem',
],
'QueueStrategy' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'backendName' => 'QueueStrategy',
],
],
],
'QuotaConfig' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'SupportRDMA' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'boolean',
'example' => 'false',
'backendName' => 'SupportRDMA',
],
'ClusterId' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'ceeb3724255364664',
'backendName' => 'ClusterId',
],
'UserVpc' => [
'description' => '',
'visibility' => 'public',
'backendName' => 'UserVpc',
'$ref' => '#/components/schemas/UserVpc',
],
'SupportGPUDrivers' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => '470.199.02',
'extendType' => 'true',
],
'backendName' => 'SupportGPUDrivers',
],
'DefaultGPUDriver' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => '470.199.02',
'backendName' => 'DefaultGPUDriver',
],
'ACS' => [
'title' => 'ACS conf',
'description' => '',
'visibility' => 'public',
'backendName' => 'ACS',
'$ref' => '#/components/schemas/ACS',
],
],
],
'QuotaDetails' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'DesiredMinQuota' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'backendName' => 'DesiredMinQuota',
'$ref' => '#/components/schemas/ResourceAmount',
],
'ActualMinQuota' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'backendName' => 'ActualMinQuota',
'$ref' => '#/components/schemas/ResourceAmount',
],
'RequestedQuota' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'backendName' => 'RequestedQuota',
'$ref' => '#/components/schemas/ResourceAmount',
],
'UsedQuota' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'backendName' => 'UsedQuota',
'$ref' => '#/components/schemas/ResourceAmount',
],
],
],
'QuotaIdName' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'QuotaId' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'quota12345',
'backendName' => 'QuotaId',
],
'QuotaName' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'dlc-quota',
'backendName' => 'QuotaName',
],
],
],
'ResourceAmount' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'CPU' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => '100',
'backendName' => 'CPU',
],
'Memory' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => '100Gi',
'backendName' => 'Memory',
],
'GPU' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => '16',
'backendName' => 'GPU',
],
'GPUType' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'GPU',
'backendName' => 'GPUType',
],
],
],
'ResourceGroup' => [
'title' => 'A short description of struct',
'description' => 'pai resource group',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Name' => [
'title' => 'pai resource group name',
'description' => 'pai resource group name',
'visibility' => 'Public',
'type' => 'string',
'example' => 'RG1',
'backendName' => 'Name',
],
'ResourceGroupID' => [
'title' => 'pai resource group id',
'description' => 'pai resource group id',
'visibility' => 'Public',
'type' => 'string',
'example' => 'rg17tmvwiokhzaxg',
'backendName' => 'ResourceGroupID',
],
'WorkspaceID' => [
'title' => 'pworkspace id',
'description' => 'pworkspace id',
'visibility' => 'Public',
'type' => 'string',
'example' => '23000',
'backendName' => 'WorkspaceID',
],
'UserVpc' => [
'title' => 'UserVpc',
'description' => 'UserVpc',
'visibility' => 'Public',
'backendName' => 'UserVpc',
'$ref' => '#/components/schemas/UserVpc',
],
'GmtCreatedTime' => [
'title' => 'pai resource created time',
'description' => 'pai resource created time',
'visibility' => 'Public',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
'backendName' => 'GmtCreatedTime',
],
'GmtModifiedTime' => [
'title' => 'GmtModified',
'description' => 'GmtModified',
'visibility' => 'Public',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
'backendName' => 'GmtModifiedTime',
],
'CreatorID' => [
'title' => 'CreatorID',
'description' => 'CreatorID',
'visibility' => 'Public',
'type' => 'string',
'example' => '1612285282502324',
'backendName' => 'CreatorID',
],
'NodeCount' => [
'title' => 'NodeCount',
'description' => 'NodeCount',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
'backendName' => 'NodeCount',
],
],
],
'ResourceSpec' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'NodeSpecs' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'public',
'extendType' => 'true',
'$ref' => '#/components/schemas/NodeSpec',
],
'backendName' => 'NodeSpecs',
],
],
],
'UserInfo' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'UserId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '161222222222',
'backendName' => 'UserId',
],
'UserName' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'test',
'backendName' => 'UserName',
],
],
],
'UserViewMetric' => [
'title' => 'A short description of struct',
'description' => 'resource group metric',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'ResourceGroupId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'rg17tmvwiokhzaxg',
'backendName' => 'ResourceGroupID',
],
'TotalCPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
'backendName' => 'TotalCPU',
],
'CPUUsageRate' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'CPUUsageRate',
],
'GPUUsageRate' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'GPUUsageRate',
],
'TotalMemory' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'backendName' => 'TotalMemory',
],
'TotalGPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'backendName' => 'TotalGPU',
],
'MemoryUsageRate' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'MemoryUsageRate',
],
'RequestCPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
'backendName' => 'RequestCPU',
],
'RequestGPU' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
'backendName' => 'RequestGPU',
],
'RequestMemory' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '102400000',
'backendName' => 'RequestMemory',
],
'NetworkInputRate' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'NetworkInputRate',
],
'NetworkOutputRate' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'NetworkOutputRate',
],
'DiskReadRate' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'DiskReadRate',
],
'DiskWriteRate' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'DiskWriteRate',
],
'JobType' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'JobType',
],
'UserId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'backendName' => 'UserId',
],
'CPUNodeNumber' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'backendName' => 'CPUNodeNumber',
],
'GPUNodeNumber' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'backendName' => 'GPUNodeNumber',
],
'CpuJobNames' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'extendType' => 'true',
],
'backendName' => 'CpuJobNames',
],
'GpuJobNames' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'extendType' => 'true',
],
'backendName' => 'GpuJobNames',
],
'NodeNames' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'extendType' => 'true',
],
'backendName' => 'NodeNames',
],
'CpuNodeNames' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'extendType' => 'true',
],
'backendName' => 'CpuNodeNames',
],
'GpuNodeNames' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'extendType' => 'true',
],
'backendName' => 'GpuNodeNames',
],
],
],
'UserVpc' => [
'title' => 'A short description of struct',
'description' => 'UserVpc',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'VpcId' => [
'title' => 'VPC ID',
'description' => 'VPC ID',
'visibility' => 'public',
'type' => 'string',
'example' => 'vpc-abcdef****',
'backendName' => 'VpcId',
],
'SwitchId' => [
'title' => 'VSW ID',
'description' => 'VSW ID',
'visibility' => 'public',
'type' => 'string',
'example' => 'vs-abcdef****',
'backendName' => 'SwitchId',
],
'SecurityGroupId' => [
'title' => 'SecurityGroupID',
'description' => 'SecurityGroupID',
'visibility' => 'public',
'type' => 'string',
'example' => 'sg-abcdef****',
'backendName' => 'SecurityGroupId',
],
'ExtendedCIDRs' => [
'title' => 'ExtendedCIDRs',
'description' => 'ExtendedCIDRs',
'visibility' => 'public',
'type' => 'array',
'items' => [
'description' => 'one cidr',
'visibility' => 'public',
'type' => 'string',
'example' => '"192.168.0.1/24"',
'extendType' => 'true',
],
'backendName' => 'ExtendedCIDRs',
],
'RoleArn' => [
'title' => 'RoleArn',
'description' => 'RoleArn',
'visibility' => 'public',
'type' => 'string',
'example' => 'acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole',
'backendName' => 'RoleArn',
],
'DefaultRoute' => [
'title' => 'DefaultRoute',
'description' => 'DefaultRoute',
'visibility' => 'public',
'type' => 'string',
'example' => 'eth0',
'backendName' => 'DefaultRoute',
],
],
],
'WorkspaceIdName' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'object',
'properties' => [
'WorkspaceId' => [
'title' => '',
'description' => '',
'visibility' => 'public',
'type' => 'string',
'example' => 'ws123456',
'backendName' => 'WorkspaceId',
],
],
],
'WorkspaceSpec' => [
'title' => 'A short description of struct',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'SpecName' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'spec_test',
'backendName' => 'SpecName',
],
'IsGuaranteedValid' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'IsGuaranteedValid',
],
'IsOverSoldValid' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'IsOverSoldValid',
],
'Spec' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'backendName' => 'Spec',
'$ref' => '#/components/schemas/ResourceAmount',
],
'CodeType' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '""',
'backendName' => 'CodeType',
],
'Code' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '""',
'backendName' => 'Code',
],
'Reason' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '""',
'backendName' => 'Reason',
],
],
],
'WorkspaceSpecs' => [
'title' => 'A short description of struct',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'WorkspaceId' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '122421',
'backendName' => 'WorkspaceId',
],
'Product' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'DLC',
'backendName' => 'Product',
],
'Specs' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'extendType' => 'true',
'$ref' => '#/components/schemas/WorkspaceSpec',
],
'backendName' => 'Specs',
],
],
],
],
],
'apis' => [
'UpdateResourceGroup' => [
'summary' => '更新Resource Group',
'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' => '',
'type' => 'object',
'properties' => [
'UserVpc' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/UserVpc',
],
'Unbind' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'Name' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'prophet',
],
'Description' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test_new_havpn_tf',
],
],
'required' => false,
],
],
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7',
],
'ResourceGroupID' => [
'description' => '',
'type' => 'string',
'example' => 'rgf0zhfqn1d4ity2',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\"\\n}","type":"json"}]',
'title' => 'UpdateResourceGroup',
],
'GetResourceGroupTotal' => [
'summary' => 'get resource group total resource by group id',
'path' => '/api/v1/resources/data/total',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'rgf0zhfqn1d4ity2',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'totalCPU' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'totalMemory' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '300',
],
'totalGPU' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '24',
],
'totalGPUInfos' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/GPUInfo',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCPU\\": 100,\\n \\"totalMemory\\": 300,\\n \\"totalGPU\\": 24,\\n \\"totalGPUInfos\\": [\\n {\\n \\"count\\": 0,\\n \\"type\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'GetResourceGroupTotal',
],
'ListResourceGroups' => [
'summary' => 'list resource group',
'path' => '/api/v1/resources',
'methods' => [
'get',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'rgf0zhfqn1d4ity2',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'title' => '分页数',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '页面容量',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序顺序, 枚举值 desc 或者 asc',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'desc',
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '用于排序的字段名,可选字段名:DisplayName, GmtCreated, GmtModified,RegionID Duration PricingCycle PayType',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DisplayName',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'title' => 'resource group的状态',
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'Ecs',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Lingjun',
],
],
[
'name' => 'ResourceGroupIDs',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HasResource',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'Versions',
'in' => 'query',
'schema' => [
'title' => '按照版本搜索。',
'type' => 'string',
'example' => '1.0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'ResourceGroups' => [
'title' => 'pai resource groups',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/ResourceGroup',
],
'example' => 'RG1',
],
'TotalCount' => [
'title' => 'list到的资源组的数量',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '2',
],
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '9CFA2665-1FFE-5929-8468-C14C25890486',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceGroups\\": [\\n {\\n \\"Name\\": \\"RG1\\",\\n \\"ResourceGroupID\\": \\"rg17tmvwiokhzaxg\\",\\n \\"WorkspaceID\\": \\"23000\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\"\\n ],\\n \\"RoleArn\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"\\",\\n \\"EipAllocationId\\": \\"\\"\\n }\\n },\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"CreatorID\\": \\"\\",\\n \\"NodeCount\\": 0,\\n \\"Version\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"9CFA2665-1FFE-5929-8468-C14C25890486\\"\\n}","type":"json"}]',
'title' => 'ListResourceGroups',
],
'GetResourceGroupRequest' => [
'summary' => 'get resource group requested resource by resource group id',
'path' => '/api/v1/resources/data/request',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'rgf0zhfqn1d4ity2',
],
],
[
'name' => 'PodStatus',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Running',
'default' => 'Running',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestCPU' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'requestMemory' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'requestGPU' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'requestGPUInfos' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/GPUInfo',
],
],
],
],
],
],
'staticInfo' => [
'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestCPU\\": 1,\\n \\"requestMemory\\": 2,\\n \\"requestGPU\\": 8,\\n \\"requestGPUInfos\\": [\\n {\\n \\"count\\": 0,\\n \\"type\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'GetResourceGroupRequest',
],
'DeleteResourceGroupMachineGroup' => [
'summary' => 'delete machine group',
'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups/{MachineGroupID}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => true,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '125207',
'abilityTreeNodes' => [
'FEATURElearn1N0SUT',
],
],
'parameters' => [
[
'name' => 'MachineGroupID',
'in' => 'path',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroupID' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'PaiStudio::2022-01-12::DeleteResourceGroupMachineGroup',
],
],
'responseDemo' => null,
],
'GetNodeMetrics' => [
'summary' => 'get resource group node metrics',
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'rgf0zhfqn1d4ity2',
],
],
[
'name' => 'GPUType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'V100',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2024-07-08T02:23:30.292Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2024-07-10T10:17:06',
],
],
[
'name' => 'TimeStep',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1h',
],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/NodeMetric',
],
],
'ResourceGroupID' => [
'description' => '',
'type' => 'string',
'example' => 'rgf0zhfqn1d4ity2',
],
'MetricType' => [
'description' => '',
'type' => 'string',
'example' => 'DiskWriteRate',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'Cms::2019-01-01::DescribeMetricList',
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NodesMetrics\\": [\\n {\\n \\"NodeID\\": \\"-i121212node\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": 0,\\n \\"Value\\": \\"23000\\"\\n }\\n ],\\n \\"GPUType\\": \\"\\"\\n }\\n ],\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"MetricType\\": \\"DiskWriteRate\\"\\n}","type":"json"}]',
'title' => 'GetNodeMetrics',
],
'ListResourceGroupMachineGroups' => [
'summary' => 'list machine groups',
'path' => '/api/v1/resources/{ResourceGroupID}/machinegroups',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '125191',
'abilityTreeNodes' => [
'FEATURElearnZO51AS',
'FEATURElearnCMM1R7',
],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'CreatorID',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1612285282502326',
],
],
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rgf0zhfqn1d4ity2',
],
],
[
'name' => 'PaymentType',
'in' => 'query',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'EcsSpec',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'DESC',
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'GmtCreatedTime',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Ready',
],
],
[
'name' => 'OrderInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '236553689400333',
],
],
[
'name' => 'MachineGroupIDs',
'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' => '',
'type' => 'string',
'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroups\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"EcsCount\\": 0,\\n \\"GmtStartedTime\\": \\"\\",\\n \\"ResourceGroupID\\": \\"\\",\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"CreatorID\\": \\"\\",\\n \\"ReasonMessage\\": \\"\\",\\n \\"PaymentDurationUnit\\": \\"\\",\\n \\"EcsSpec\\": \\"\\",\\n \\"SupportedDrivers\\": [\\n \\"470.199.02\\"\\n ],\\n \\"PaymentDuration\\": \\"\\",\\n \\"ReasonCode\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"DiskCapacity\\": 0,\\n \\"GmtExpiredTime\\": \\"\\",\\n \\"OrderInstanceId\\": \\"\\",\\n \\"DefaultDriver\\": \\"470.199.02\\",\\n \\"MachineGroupID\\": \\"mg1\\",\\n \\"PaymentType\\": \\"\\",\\n \\"DiskPL\\": \\"\\",\\n \\"Cpu\\": 0,\\n \\"Gpu\\": 0,\\n \\"GpuMemory\\": 0,\\n \\"GpuType\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"ResourceType\\": \\"\\",\\n \\"AllocatableCpu\\": 0,\\n \\"AllocatableMemory\\": 0,\\n \\"SystemReservedCpu\\": 0,\\n \\"SystemReservedMemory\\": 0\\n }\\n ],\\n \\"TotalCount\\": \\"4\\",\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]',
'title' => 'ListResourceGroupMachineGroups',
],
'GetUserViewMetrics' => [
'summary' => 'get user view metrics',
'path' => '/api/v1/resources/{ResourceGroupID}/usermetrics',
'methods' => [
'get',
],
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'rgf0zhfqn1d4ity2',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'DESC',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'TimeStep',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1h',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'ResourceGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'rgf0zhfqn1d4ity2',
],
'UserMetrics' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/UserViewMetric',
],
],
'Summary' => [
'description' => '',
'$ref' => '#/components/schemas/UserViewMetric',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'PaiStudio::2022-01-12::GetQuotaUserViewMetrics',
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceGroupId\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"UserMetrics\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg17tmvwiokhzaxg\\",\\n \\"TotalCPU\\": 0,\\n \\"CPUUsageRate\\": \\"\\",\\n \\"GPUUsageRate\\": \\"\\",\\n \\"TotalMemory\\": 0,\\n \\"TotalGPU\\": 0,\\n \\"MemoryUsageRate\\": \\"\\",\\n \\"RequestCPU\\": 0,\\n \\"RequestGPU\\": 0,\\n \\"RequestMemory\\": 0,\\n \\"NetworkInputRate\\": \\"\\",\\n \\"NetworkOutputRate\\": \\"\\",\\n \\"DiskReadRate\\": \\"\\",\\n \\"DiskWriteRate\\": \\"\\",\\n \\"JobType\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"CPUNodeNumber\\": 0,\\n \\"GPUNodeNumber\\": 0,\\n \\"CpuJobNames\\": [\\n \\"\\"\\n ],\\n \\"GpuJobNames\\": [\\n \\"\\"\\n ],\\n \\"NodeNames\\": [\\n \\"\\"\\n ],\\n \\"CpuNodeNames\\": [\\n \\"\\"\\n ],\\n \\"GpuNodeNames\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Summary\\": {\\n \\"ResourceGroupId\\": \\"rg17tmvwiokhzaxg\\",\\n \\"TotalCPU\\": 0,\\n \\"CPUUsageRate\\": \\"\\",\\n \\"GPUUsageRate\\": \\"\\",\\n \\"TotalMemory\\": 0,\\n \\"TotalGPU\\": 0,\\n \\"MemoryUsageRate\\": \\"\\",\\n \\"RequestCPU\\": 0,\\n \\"RequestGPU\\": 0,\\n \\"RequestMemory\\": 0,\\n \\"NetworkInputRate\\": \\"\\",\\n \\"NetworkOutputRate\\": \\"\\",\\n \\"DiskReadRate\\": \\"\\",\\n \\"DiskWriteRate\\": \\"\\",\\n \\"JobType\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"CPUNodeNumber\\": 0,\\n \\"GPUNodeNumber\\": 0,\\n \\"CpuJobNames\\": [\\n \\"\\"\\n ],\\n \\"GpuJobNames\\": [\\n \\"\\"\\n ],\\n \\"NodeNames\\": [\\n \\"\\"\\n ],\\n \\"CpuNodeNames\\": [\\n \\"\\"\\n ],\\n \\"GpuNodeNames\\": [\\n \\"\\"\\n ]\\n },\\n \\"Total\\": 2\\n}","type":"json"}]',
'title' => 'GetUserViewMetrics',
],
'GetResourceGroupMachineGroup' => [
'summary' => 'get machine group',
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'mgmioirqjgw6c5lg',
],
],
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rgf0zhfqn1d4ity2',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestValue',
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroupID' => [
'description' => '',
'type' => 'string',
'example' => 'mgmioirqjgw6c5lg',
],
'ResourceGroupID' => [
'description' => '',
'type' => 'string',
'example' => 'rgf0zhfqn1d4ity2',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Ready',
],
'PaymentType' => [
'description' => '',
'type' => 'string',
'example' => 'PREPAY',
],
'PaymentDurationUnit' => [
'description' => '',
'type' => 'string',
'example' => 'Month',
],
'PaymentDuration' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'EcsSpec' => [
'description' => '',
'type' => 'string',
'example' => 'ecs.c6.large',
],
'EcsCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'GmtCreatedTime' => [
'description' => '',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
],
'GmtModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
],
'GmtStartedTime' => [
'description' => '',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
],
'GmtExpiredTime' => [
'description' => '',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z'."\n",
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
],
'Cpu' => [
'description' => '',
'type' => 'string',
'example' => '2',
],
'Gpu' => [
'description' => '',
'type' => 'string',
'example' => '8',
],
'GpuType' => [
'description' => '',
'type' => 'string',
'example' => 'A100',
],
'Memory' => [
'description' => '',
'type' => 'string',
'example' => '64',
],
'SupportedDrivers' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '535,550',
'type' => 'string',
'example' => '535,550',
],
],
'DefaultDriver' => [
'description' => '',
'type' => 'string',
'example' => '535',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'testMachineGroup',
],
'Tags' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'TagKey' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'example' => 'TestKey',
],
'TagValue' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'example' => 'TestValue',
],
],
],
],
'AllocatableCpu' => [
'type' => 'string',
],
'AllocatableMemory' => [
'type' => 'string',
],
'SystemReservedCpu' => [
'type' => 'string',
],
'SystemReservedMemory' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MachineGroupID\\": \\"mgmioirqjgw6c5lg\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\",\\n \\"Status\\": \\"Ready\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"PaymentDurationUnit\\": \\"Month\\",\\n \\"PaymentDuration\\": \\"1\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"EcsCount\\": 1,\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtStartedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtExpiredTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Cpu\\": \\"2\\",\\n \\"Gpu\\": \\"8\\",\\n \\"GpuType\\": \\"A100\\",\\n \\"Memory\\": \\"64\\",\\n \\"SupportedDrivers\\": [\\n \\"535,550\\"\\n ],\\n \\"DefaultDriver\\": \\"535\\",\\n \\"Name\\": \\"testMachineGroup\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"AllocatableCpu\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCpu\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\"\\n}","type":"json"}]',
'title' => 'GetResourceGroupMachineGroup',
],
'GetResourceGroup' => [
'summary' => 'get resource group by group id',
'path' => '/api/v1/resources/{ResourceGroupID}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'rgmhpp8ib5lprq9k',
],
],
[
'name' => 'IsAIWorkspaceDataEnabled',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestValue',
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'GmtCreatedTime' => [
'title' => 'pai resource created time',
'description' => '',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z'."\n",
],
'GmtModifiedTime' => [
'title' => 'pai resource group modified time',
'description' => '',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z'."\n",
],
'RequestId' => [
'title' => 'request id',
'description' => '',
'type' => 'string',
'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'."\n",
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'TestResourceGroup',
],
'CreatorID' => [
'description' => '',
'type' => 'string',
'example' => '1612285282502324',
],
'WorkspaceID' => [
'description' => '',
'type' => 'string',
'example' => '35201',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Ready',
],
'UserVpc' => [
'description' => '',
'$ref' => '#/components/schemas/UserVpc',
],
'ComputingResourceProvider' => [
'description' => '',
'type' => 'string',
'enumValueTitles' => [
'Ecs' => 'Ecs',
'Lingjun' => 'Lingjun',
],
'example' => 'ECS',
],
'ClusterID' => [
'description' => '',
'type' => 'string',
'example' => 'cb2c7bde30b774e46a329c',
],
'SupportRDMA' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ResourceType' => [
'description' => '',
'type' => 'string',
'example' => 'Ecs',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'testDescription',
],
'Tags' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagKey' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'example' => 'testKey',
],
'TagValue' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'example' => 'testValue',
],
],
],
],
'Version' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\\\n\\",\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\\\n\\",\\n \\"Name\\": \\"TestResourceGroup\\",\\n \\"CreatorID\\": \\"1612285282502324\\",\\n \\"WorkspaceID\\": \\"35201\\",\\n \\"Status\\": \\"Ready\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\"\\n ],\\n \\"RoleArn\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"\\",\\n \\"EipAllocationId\\": \\"\\"\\n }\\n },\\n \\"ComputingResourceProvider\\": \\"ECS\\",\\n \\"ClusterID\\": \\"cb2c7bde30b774e46a329c\\",\\n \\"SupportRDMA\\": true,\\n \\"ResourceType\\": \\"Ecs\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\"\\n }\\n ],\\n \\"Version\\": \\"\\"\\n}","type":"json"}]',
'title' => 'GetResourceGroup',
],
'DeleteMachineGroup' => [
'summary' => 'delete machine group',
'path' => '/api/v1/resources/machinegroups/{MachineGroupID}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroupID' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'PaiStudio::2022-01-12::DeleteMachineGroup',
],
],
'responseDemo' => null,
],
'CreateResourceGroup' => [
'summary' => '创建资源组',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'testResourceGroup',
],
'Description' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test_api_report',
],
'UserVpc' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/UserVpc',
],
'ResourceType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Ecs',
],
'ComputingResourceProvider' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Ecs',
],
'Tag' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestValue',
],
],
'required' => false,
],
'required' => false,
],
'Version' => [
'title' => '资源组版本,当前只在resource type为ECS时生效。',
'type' => 'string',
'example' => '1.0',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E'."\n",
],
'ResourceGroupID' => [
'description' => 'ResourceGroup ID。',
'type' => 'string',
'example' => 'rgf0zhfqn1d4ity2',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\\\n\\",\\n \\"ResourceGroupID\\": \\"rgf0zhfqn1d4ity2\\"\\n}","type":"json"}]',
'title' => 'CreateResourceGroup',
],
'DeleteResourceGroup' => [
'summary' => '删除资源组',
'path' => '/api/v1/resources/{ResourceGroupID}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '125213',
'abilityTreeNodes' => [
'FEATURElearn1N0SUT',
],
],
'parameters' => [
[
'name' => 'ResourceGroupID',
'in' => 'path',
'schema' => [
'title' => 'A short description of struct',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rgvl9d6utwcscukh',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
],
'ResourceGroupID' => [
'description' => '',
'type' => 'string',
'example' => 'rgvl9d6utwcscukh',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"ResourceGroupID\\": \\"rgvl9d6utwcscukh\\"\\n}","type":"json"}]',
'title' => 'DeleteResourceGroup',
],
'GetMachineGroup' => [
'summary' => 'get machine group',
'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,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'MachineGroupID' => [
'type' => 'string',
],
'OrderID' => [
'type' => 'string',
],
'PAIResourceID' => [
'type' => 'string',
],
'Status' => [
'type' => 'string',
],
'PayType' => [
'type' => 'string',
],
'PricingCycle' => [
'type' => 'string',
],
'Duration' => [
'type' => 'string',
],
'EcsType' => [
'type' => 'string',
],
'Count' => [
'type' => 'integer',
'format' => 'int64',
],
'RegionID' => [
'type' => 'string',
],
'GmtCreated' => [
'type' => 'string',
],
'GmtModified' => [
'type' => 'string',
],
'GmtStarted' => [
'type' => 'string',
],
'GmtExpired' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'SupportedDrivers' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'DefaultDriver' => [
'type' => 'string',
],
'OrderInstanceId' => [
'type' => 'string',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'PaiStudio::2022-01-12::GetMachineGroup',
],
],
],
'CreateAlgorithm' => [
'summary' => '创建新的算法',
'path' => '/api/v1/algorithms',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12345',
],
],
[
'name' => 'AlgorithmDescription',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'AlgorithmName',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'llm_training',
],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
],
'AlgorithmId' => [
'description' => '',
'type' => 'string',
'example' => 'algo-xsldfvu1334',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\"\\n}","type":"json"}]',
'title' => 'CreateAlgorithm',
],
'CreateAlgorithmVersion' => [
'summary' => '创建一个新的算法版本',
'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'algo-xsldfvu1334',
],
],
[
'name' => 'AlgorithmVersion',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'v0.0.1',
],
],
[
'name' => 'AlgorithmSpec',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/AlgorithmSpec',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'AlgorithmId' => [
'description' => '',
'type' => 'string',
'example' => 'algo-xsldfvu1334',
],
'AlgorithmVersion' => [
'description' => '',
'type' => 'string',
'example' => 'v0.0.1',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\"\\n}","type":"json"}]',
'title' => 'CreateAlgorithmVersion',
],
'DeleteAlgorithm' => [
'summary' => '删除算法',
'path' => '/api/v1/algorithms/{AlgorithmId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '146690',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => [
'title' => '算法Id',
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'FFB1D4B4-B253-540A-9B3B-AA711C48A1B7',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FFB1D4B4-B253-540A-9B3B-AA711C48A1B7\\"\\n}","type":"json"}]',
'title' => 'DeleteAlgorithm',
],
'DeleteAlgorithmVersion' => [
'summary' => '删除算法版本',
'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '146338',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]',
'title' => 'DeleteAlgorithmVersion',
],
'GetAlgorithm' => [
'summary' => '获取一个算法信息',
'path' => '/api/v1/algorithms/{AlgorithmId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'AlgorithmDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'AlgorithmId' => [
'description' => '',
'type' => 'string',
'example' => 'algo-xsldfvu1334',
],
'AlgorithmName' => [
'description' => '',
'type' => 'string',
'example' => 'llm_training',
],
'AlgorithmProvider' => [
'description' => '',
'type' => 'string',
'example' => 'pai',
],
'GmtCreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'GmtModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'WorkspaceId' => [
'description' => '',
'type' => 'string',
'example' => '12345',
],
'UserId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
'TenantId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
'DisplayName' => [
'description' => '',
'type' => 'string',
'example' => 'llm_training',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"AlgorithmDescription\\": \\"大语言模型训练。\\",\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"TenantId\\": \\"123456789\\",\\n \\"DisplayName\\": \\"llm_training\\"\\n}","type":"json"}]',
'title' => 'GetAlgorithm',
],
'GetAlgorithmVersion' => [
'summary' => '创建一个新的算法版本',
'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'algo-xsldfvu1334',
],
],
[
'name' => 'AlgorithmVersion',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'v0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'AlgorithmSpec' => [
'description' => '',
'$ref' => '#/components/schemas/AlgorithmSpec',
],
'AlgorithmId' => [
'description' => '',
'type' => 'string',
'example' => 'algo-xsldfvu1334',
],
'AlgorithmName' => [
'description' => '',
'type' => 'string',
'example' => 'llm_training',
],
'AlgorithmProvider' => [
'description' => '',
'type' => 'string',
'example' => 'pai',
],
'AlgorithmVersion' => [
'description' => '',
'type' => 'string',
'example' => 'v0.0.1',
],
'GmtCreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'GmtModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'UserId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
'TenantId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmSpec\\": {\\n \\"OutputChannels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Name\\": \\"\\",\\n \\"SupportedChannelTypes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"HyperParameters\\": [\\n {\\n \\"DefaultValue\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"\\",\\n \\"Range\\": {\\n \\"Enum\\": [\\n \\"\\"\\n ],\\n \\"MinLength\\": 0,\\n \\"MaxLength\\": 0,\\n \\"Minimum\\": \\"\\",\\n \\"Maximum\\": \\"\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"ExclusiveMaximum\\": true,\\n \\"Pattern\\": \\"\\"\\n },\\n \\"DisplayName\\": \\"\\"\\n }\\n ],\\n \\"JobType\\": \\"\\",\\n \\"Command\\": [\\n \\"\\"\\n ],\\n \\"MetricDefinitions\\": [\\n {\\n \\"Description\\": \\"train dataset oob score\\",\\n \\"Regex\\": \\".*train:oob_score=([-+]?[0-9]*\\\\\\\\\\\\\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*\\",\\n \\"Name\\": \\"train:oob_score\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Name\\": \\"\\",\\n \\"SupportedChannelTypes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SupportsDistributedTraining\\": true,\\n \\"Image\\": \\"\\",\\n \\"SupportedInstanceTypes\\": [\\n \\"\\"\\n ],\\n \\"ComputeResource\\": {\\n \\"Policy\\": {\\n \\"Version\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n },\\n \\"CodeDir\\": {\\n \\"LocationType\\": \\"\\",\\n \\"LocationValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Customization\\": {\\n \\"CodeDir\\": true\\n },\\n \\"ResourceRequirements\\": [\\n {\\n \\"Key\\": \\"SupportedMachineTypes\\",\\n \\"Operator\\": \\"in\\",\\n \\"Values\\": [\\n \\"GPU\\"\\n ]\\n }\\n ],\\n \\"ProgressDefinitions\\": {\\n \\"OverallProgress\\": {\\n \\"Description\\": \\"\\",\\n \\"Regex\\": \\"\\"\\n },\\n \\"RemainingTime\\": {\\n \\"Description\\": \\"\\",\\n \\"Regex\\": \\"\\"\\n }\\n }\\n },\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"TenantId\\": \\"123456789\\"\\n}","type":"json"}]',
'title' => 'GetAlgorithmVersion',
],
'ListAlgorithms' => [
'summary' => '获取算法列表',
'path' => '/api/v1/algorithms',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'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' => '',
'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' => '',
'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' => '',
],
'AlgorithmId' => [
'description' => '',
'type' => 'string',
'example' => 'algo-sidjc8134hv',
],
'AlgorithmName' => [
'description' => '',
'type' => 'string',
'example' => 'llm_train',
],
'AlgorithmProvider' => [
'description' => '',
'type' => 'string',
'example' => 'pai',
],
'GmtCreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-21T03:35:24Z',
],
'GmtModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-25T02:15:40Z',
],
'UserId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
'WorkspaceId' => [
'description' => '',
'type' => 'string',
'example' => '12345',
],
'DisplayName' => [
'description' => '',
'type' => 'string',
'example' => 'LLM Train',
],
],
],
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '4',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Algorithms\\": [\\n {\\n \\"AlgorithmDescription\\": \\"大语言模型训练。\\",\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"GmtCreateTime\\": \\"2023-07-21T03:35:24Z\\",\\n \\"GmtModifiedTime\\": \\"2023-07-25T02:15:40Z\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"WorkspaceId\\": \\"12345\\",\\n \\"DisplayName\\": \\"LLM Train\\"\\n }\\n ],\\n \\"TotalCount\\": 4,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
'title' => 'ListAlgorithms',
],
'ListAlgorithmVersions' => [
'summary' => '获取算法的所有版本信息',
'path' => '/api/v1/algorithms/{AlgorithmId}/versions',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [],
'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' => '',
'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' => '',
'type' => 'string',
'example' => 'algo-sidjc8134hv',
],
'AlgorithmName' => [
'description' => '',
'type' => 'string',
'example' => 'llm_train',
],
'AlgorithmProvider' => [
'description' => '',
'type' => 'string',
'example' => 'pai',
],
'AlgorithmVersion' => [
'description' => '',
'type' => 'string',
'example' => 'v0.1.0',
],
'GmtCreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-01-19T02:00:26Z',
],
'GmtModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-01-22T02:00:59Z',
],
'TenantId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
'UserId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
],
],
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmVersions\\": [\\n {\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.1.0\\",\\n \\"GmtCreateTime\\": \\"2024-01-19T02:00:26Z\\",\\n \\"GmtModifiedTime\\": \\"2024-01-22T02:00:59Z\\",\\n \\"TenantId\\": \\"123456789\\",\\n \\"UserId\\": \\"123456789\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
'title' => 'ListAlgorithmVersions',
],
'UpdateAlgorithm' => [
'summary' => '更新算法',
'path' => '/api/v1/algorithms/{AlgorithmId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AlgorithmDescription',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LLM Train',
],
],
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
],
'AlgorithmId' => [
'description' => '',
'type' => 'string',
'example' => 'algo-sidjc8134hv',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\",\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\"\\n}","type":"json"}]',
'title' => 'UpdateAlgorithm',
],
'UpdateAlgorithmVersion' => [
'summary' => '更新算法',
'path' => '/api/v1/algorithms/{AlgorithmId}/versions/{AlgorithmVersion}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/x-www-form-urlencoded',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AlgorithmId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'algo-sidjc8134hv',
],
],
[
'name' => 'AlgorithmVersion',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'v0.0.1',
],
],
[
'name' => 'AlgorithmSpec',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/AlgorithmSpec',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'AlgorithmId' => [
'description' => '',
'type' => 'string',
'example' => 'algo-sidjc8134hv',
],
'AlgorithmVersion' => [
'description' => '',
'type' => 'string',
'example' => 'v0.1.0',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AlgorithmId\\": \\"algo-sidjc8134hv\\",\\n \\"AlgorithmVersion\\": \\"v0.1.0\\"\\n}","type":"json"}]',
'title' => 'UpdateAlgorithmVersion',
],
'CreateTrainingJob' => [
'summary' => '创建TrainingJob',
'path' => '/api/v1/trainingjobs',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '132535',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'AlgorithmName' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ev_classification',
],
'AlgorithmProvider' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pai',
],
'AlgorithmVersion' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'v1.0.0',
],
'ComputeResource' => [
'description' => '',
'type' => 'object',
'properties' => [
'EcsCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'EcsSpec' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ecs.gn5-c8g1.2xlarge',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'quotam670lixikcs',
],
'InstanceCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'InstanceSpec' => [
'description' => '',
'type' => 'object',
'properties' => [
'CPU' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '8',
],
'Memory' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '32',
],
'SharedMemory' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '32',
],
'GPU' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
'GPUType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'V100',
],
],
'required' => false,
],
'SpotSpec' => [
'description' => '',
'type' => 'object',
'properties' => [
'SpotStrategy' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'SpotWithPriceLimit',
],
'SpotDiscountLimit' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'd-475megosidivjfgfq6',
],
'VersionName' => [
'type' => 'string',
],
'InputUri' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'oss://pai-quickstart-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/modelscope/models/qwen2-0.5b/main/',
],
'Options' => [
'type' => 'string',
],
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'd-475megosidivjfgfq6',
],
'Name' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'model',
],
'OutputUri' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'oss://pai-quickstart-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/modelscope/models/qwen2-0.5b/main/',
],
'VersionName' => [
'type' => 'string',
],
],
'required' => false,
],
'required' => false,
],
'Scheduler' => [
'description' => '',
'type' => 'object',
'properties' => [
'MaxRunningTimeInSeconds' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
'MaxRunningTimeInMinutes' => [
'type' => 'integer',
'format' => 'int64',
],
],
'required' => false,
],
'TrainingJobDescription' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'qwen large language model training',
],
'TrainingJobName' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'qwen_llm',
],
'WorkspaceId' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '12345',
],
'AlgorithmSpec' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/AlgorithmSpec',
],
'CodeDir' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/Location',
],
'RoleArn' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'acs:ram::1157703270994901:role/aliyunserviceroleforpaiworkspace',
],
'UserVpc' => [
'description' => '',
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => 'VPC ID。',
'type' => 'string',
'required' => false,
'example' => 'vpc-dxiflssjx978sl',
],
'SwitchId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vs-icrc813vdsfol',
],
'SecurityGroupId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'sg-qdfasd13sdasf',
],
'ExtendedCIDRs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1/24',
],
'required' => false,
],
'DefaultRoute' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'eth0',
],
],
'required' => false,
],
'Settings' => [
'description' => '',
'type' => 'object',
'properties' => [
'Priority' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'EnableErrorMonitoringInAIMaster' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'ErrorMonitoringArgs' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '--enable-log-hang-detection true',
],
'AIMasterType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ecs.c6.large',
],
],
'required' => false,
'$ref' => '#/components/schemas/JobSettings',
],
'ExperimentConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'ExperimentId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'exp-ds9aefia90v',
],
],
'required' => false,
],
'Environments' => [
'description' => '',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'type' => 'string',
'description' => '',
'example' => 'debug=true',
],
],
'PythonRequirements' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'numpy',
],
'required' => false,
],
'Priority' => [
'type' => 'integer',
'format' => 'int32',
],
'AssignNodeSpec' => [
'$ref' => '#/components/schemas/AssignNodeSpec',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'TrainingJobId' => [
'description' => '',
'type' => 'string',
'example' => 'traineyfz0m2hsfv',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E7C42CC7-2E85-508A-84F4-923B605FD10F',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrainingJobId\\": \\"traineyfz0m2hsfv\\",\\n \\"RequestId\\": \\"E7C42CC7-2E85-508A-84F4-923B605FD10F\\"\\n}","type":"json"}]',
'title' => 'CreateTrainingJob',
],
'CreateInstanceWebTerminal' => [
'summary' => '创建WebTerminal',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/webterminals',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '199679',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'train1nc6686x36b',
],
],
[
'name' => 'InstanceId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'train1nc6686x36b-master-0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'WebTerminalId' => [
'description' => '',
'type' => 'string',
'example' => 'wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WebTerminalId\\": \\"wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
'title' => 'CreateInstanceWebTerminal',
],
'CheckInstanceWebTerminal' => [
'summary' => '检查WebTerminal',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/instances/{InstanceId}/webterminals/action/check',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '199680',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'traineyfz0m2hsfv',
],
],
[
'name' => 'InstanceId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'train1oxaqdiluad-master-0',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'CheckInfo' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'wss://pai-dlc-proxy-cn-shanghai.aliyun.com/terminal/t1157703270994901/dlcmjzjt1dxbmx4h/dlcmjzjt1dxbmx4h-worker-0?Token=******',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\"\\n}","type":"json"}]',
'title' => 'CheckInstanceWebTerminal',
],
'DeleteTrainingJob' => [
'summary' => '删除一个TrainingJob',
'path' => '/api/v1/trainingjobs/{TrainingJobId}',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '132982',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'train76rcaupa2cz',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '4cc83062-9bcb-4ab3-979e-2e571a35834f',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4cc83062-9bcb-4ab3-979e-2e571a35834f\\"\\n}","type":"json"}]',
'title' => 'DeleteTrainingJob',
],
'DeleteTrainingJobLabels' => [
'summary' => '删除TrainingJob的Labels',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/labels',
'methods' => [
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '132984',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'trainw52bqlfjbjc',
],
],
[
'name' => 'Keys',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'RootModelID',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
'title' => 'DeleteTrainingJobLabels',
],
'GetToken' => [
'summary' => '调用GetToken获取临时鉴权信息',
'path' => '/api/v1/tokens',
'methods' => [
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '189411',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'traincclrt205dcs',
],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '60',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6',
],
'Token' => [
'description' => '',
'type' => 'string',
'example' => 'ql4OU830nJaF17LP6KTry4a9DvnjIXHP',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"Token\\": \\"ql4OU830nJaF17LP6KTry4a9DvnjIXHP\\"\\n}","type":"json"}]',
'title' => 'GetToken',
],
'GetTrainingJob' => [
'summary' => '获取TrainingJob的详情',
'path' => '/api/v1/trainingjobs/{TrainingJobId}',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132929',
'abilityTreeNodes' => [
'FEATURElearnVYA4L9',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'train129f212o89d',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OutputChannels' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'model',
],
'OutputUri' => [
'description' => '',
'type' => 'string',
'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/model/',
],
'DatasetId' => [
'description' => '',
'type' => 'string',
'example' => 'd-8o0hh35po15ejcdq2p',
],
'VersionName' => [
'type' => 'string',
],
],
],
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Running',
],
'HyperParameters' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'learning_rate',
],
'Value' => [
'description' => '',
'type' => 'string',
'example' => '0.0001',
],
],
],
],
'TrainingJobName' => [
'description' => '',
'type' => 'string',
'example' => 'qwen_llm',
],
'TrainingJobId' => [
'description' => '',
'type' => 'string',
'example' => 'traini6hhxiq69eo',
],
'Scheduler' => [
'description' => '',
'type' => 'object',
'properties' => [
'MaxRunningTimeInSeconds' => [
'description' => '',
'type' => 'string',
'format' => 'int64',
'example' => '0',
],
'MaxRunningTimeInMinutes' => [
'type' => 'string',
],
],
],
'ReasonMessage' => [
'description' => '',
'type' => 'string',
'example' => 'None',
],
'WorkspaceId' => [
'description' => '',
'type' => 'string',
'example' => '86995',
],
'ComputeResource' => [
'description' => '',
'type' => 'object',
'properties' => [
'EcsCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'EcsSpec' => [
'description' => '',
'type' => 'string',
'example' => 'ecs.gn5-c8g1.2xlarge',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'quotam670lixikcl',
],
'ResourceName' => [
'type' => 'string',
],
'InstanceCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'InstanceSpec' => [
'description' => '',
'type' => 'object',
'properties' => [
'CPU' => [
'description' => '',
'type' => 'string',
'example' => '8',
],
'Memory' => [
'description' => '',
'type' => 'string',
'example' => '32',
],
'SharedMemory' => [
'description' => '',
'type' => 'string',
'example' => '32',
],
'GPU' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'GPUType' => [
'description' => '',
'type' => 'string',
'example' => 'V100',
],
],
],
'UseSpotInstance' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'SpotSpec' => [
'description' => '',
'type' => 'object',
'properties' => [
'SpotStrategy' => [
'description' => '',
'type' => 'string',
'example' => 'SpotWithPriceLimit',
],
'SpotDiscountLimit' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '0.9',
],
],
],
],
],
'Labels' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '',
'type' => 'string',
'example' => 'CreatedBy',
],
'Value' => [
'description' => '',
'type' => 'string',
'example' => 'QuickStart',
],
],
],
],
'AlgorithmProvider' => [
'description' => '',
'type' => 'string',
'example' => 'pai',
],
'InputChannels' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DatasetId' => [
'description' => '',
'type' => 'string',
'example' => 'd-475megosidivjfgfq6',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'model',
],
'InputUri' => [
'description' => '',
'type' => 'string',
'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/model/',
],
'Options' => [
'type' => 'string',
],
'VersionName' => [
'type' => 'string',
],
],
],
],
'AlgorithmName' => [
'description' => '',
'type' => 'string',
'example' => 'llm_training',
],
'ReasonCode' => [
'description' => '',
'type' => 'string',
'example' => 'TrainingJobSucceed',
],
'GmtModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'StatusTransitions' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'ReasonCode' => [
'description' => '',
'type' => 'string',
'example' => 'TrainingJobSucceed',
],
'ReasonMessage' => [
'description' => '',
'type' => 'string',
'example' => 'KubeDL job runs successfully',
],
'StartTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Creating',
],
],
],
],
'TrainingJobDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'UserId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
'AlgorithmVersion' => [
'description' => '',
'type' => 'string',
'example' => 'v0.0.1',
],
'LatestMetrics' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'loss',
],
'Timestamp' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'Value' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '0.11',
],
],
],
],
'GmtCreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'Instances' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'train1oug3yehan4-master-0',
],
'Role' => [
'description' => '',
'type' => 'string',
'example' => 'master',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Succeeded',
],
],
],
],
'AlgorithmId' => [
'description' => '',
'type' => 'string',
'example' => 'algo-xsldfvu1334',
],
'TrainingJobUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=1234#/training/jobs/train1ouyadsl8n4',
],
'RoleArn' => [
'description' => '',
'type' => 'string',
'example' => 'acs:ram::{accountID}:role/{roleName}',
],
'AlgorithmSpec' => [
'title' => '临时算法定义。',
'description' => '',
'$ref' => '#/components/schemas/AlgorithmSpec',
],
'IsTempAlgo' => [
'title' => '是否使用了临时算法。',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'LatestProgress' => [
'description' => '',
'type' => 'object',
'properties' => [
'OverallProgress' => [
'description' => '',
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-04T13:20:18Z',
],
'Value' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '0.75',
],
],
],
'RemainingTime' => [
'description' => '',
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-04T13:20:18Z',
],
'Value' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '3600',
],
],
],
],
],
'UserVpc' => [
'description' => '',
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => 'VPC ID。',
'type' => 'string',
'example' => 'vpc-abcdef****',
],
'SwitchId' => [
'description' => '',
'type' => 'string',
'example' => 'vs-abcdef****',
],
'SecurityGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'sg-abcdef****',
],
'ExtendedCIDRs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '192.168.0.1/24',
],
],
],
],
'OutputModel' => [
'description' => '',
'type' => 'object',
'properties' => [
'Uri' => [
'description' => '',
'type' => 'string',
'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/model/output/',
],
'OutputChannelName' => [
'description' => '',
'type' => 'string',
'example' => 'model',
],
],
],
'Settings' => [
'description' => '',
'type' => 'object',
'properties' => [
'Priority' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'EnableErrorMonitoringInAIMaster' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ErrorMonitoringArgs' => [
'description' => '',
'type' => 'string',
'example' => '--enable-log-hang-detection true',
],
'AIMasterType' => [
'description' => '',
'type' => 'string',
'example' => 'ecs.c6.large',
],
],
'$ref' => '#/components/schemas/JobSettings',
],
'ExperimentConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'ExperimentId' => [
'description' => '',
'type' => 'string',
'example' => 'exp-ds9aefia90v',
],
'ExperimentName' => [
'description' => '',
'type' => 'string',
'example' => 'large_language_model_train',
],
],
],
'Duration' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '7200',
],
'Environments' => [
'description' => '',
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
'description' => '',
'example' => 'debug=true',
],
],
'PythonRequirements' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'torch>=2.2.0',
],
],
'Priority' => [
'type' => 'integer',
'format' => 'int32',
],
'AssignNodeSpec' => [
'$ref' => '#/components/schemas/AssignNodeSpec',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutputChannels\\": [\\n {\\n \\"Name\\": \\"model\\",\\n \\"OutputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/model/\\",\\n \\"DatasetId\\": \\"d-8o0hh35po15ejcdq2p\\",\\n \\"VersionName\\": \\"v1\\"\\n }\\n ],\\n \\"Status\\": \\"Running\\",\\n \\"HyperParameters\\": [\\n {\\n \\"Name\\": \\"learning_rate\\",\\n \\"Value\\": \\"0.0001\\"\\n }\\n ],\\n \\"TrainingJobName\\": \\"qwen_llm\\",\\n \\"TrainingJobId\\": \\"traini6hhxiq69eo\\",\\n \\"Scheduler\\": {\\n \\"MaxRunningTimeInSeconds\\": \\"0\\",\\n \\"MaxRunningTimeInMinutes\\": \\"100\\"\\n },\\n \\"ReasonMessage\\": \\"None\\",\\n \\"WorkspaceId\\": \\"86995\\",\\n \\"ComputeResource\\": {\\n \\"EcsCount\\": 1,\\n \\"EcsSpec\\": \\"ecs.gn5-c8g1.2xlarge\\",\\n \\"ResourceId\\": \\"quotam670lixikcl\\",\\n \\"ResourceName\\": \\"quota\\",\\n \\"InstanceCount\\": 1,\\n \\"InstanceSpec\\": {\\n \\"CPU\\": \\"8\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"1\\",\\n \\"GPUType\\": \\"V100\\"\\n },\\n \\"UseSpotInstance\\": true,\\n \\"SpotSpec\\": {\\n \\"SpotStrategy\\": \\"SpotWithPriceLimit\\",\\n \\"SpotDiscountLimit\\": 0.9\\n }\\n },\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"CreatedBy\\",\\n \\"Value\\": \\"QuickStart\\"\\n }\\n ],\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"InputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-475megosidivjfgfq6\\",\\n \\"Name\\": \\"model\\",\\n \\"InputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/model/\\",\\n \\"Options\\": \\"ossAppendable=true\\",\\n \\"VersionName\\": \\"v1\\"\\n }\\n ],\\n \\"AlgorithmName\\": \\"llm_training\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"StatusTransitions\\": [\\n {\\n \\"EndTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"KubeDL job runs successfully\\",\\n \\"StartTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ],\\n \\"TrainingJobDescription\\": \\"Qwen2大语言模型训练。\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"LatestMetrics\\": [\\n {\\n \\"Name\\": \\"loss\\",\\n \\"Timestamp\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Value\\": 0.11\\n }\\n ],\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Instances\\": [\\n {\\n \\"Name\\": \\"train1oug3yehan4-master-0\\",\\n \\"Role\\": \\"master\\",\\n \\"Status\\": \\"Succeeded\\"\\n }\\n ],\\n \\"AlgorithmId\\": \\"algo-xsldfvu1334\\",\\n \\"TrainingJobUrl\\": \\"https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=1234#/training/jobs/train1ouyadsl8n4\\",\\n \\"RoleArn\\": \\"acs:ram::{accountID}:role/{roleName}\\",\\n \\"AlgorithmSpec\\": {\\n \\"OutputChannels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Name\\": \\"\\",\\n \\"SupportedChannelTypes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"HyperParameters\\": [\\n {\\n \\"DefaultValue\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"\\",\\n \\"Range\\": {\\n \\"Enum\\": [\\n \\"\\"\\n ],\\n \\"MinLength\\": 0,\\n \\"MaxLength\\": 0,\\n \\"Minimum\\": \\"\\",\\n \\"Maximum\\": \\"\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"ExclusiveMaximum\\": true,\\n \\"Pattern\\": \\"\\"\\n },\\n \\"DisplayName\\": \\"\\"\\n }\\n ],\\n \\"JobType\\": \\"\\",\\n \\"Command\\": [\\n \\"\\"\\n ],\\n \\"MetricDefinitions\\": [\\n {\\n \\"Description\\": \\"train dataset oob score\\",\\n \\"Regex\\": \\".*train:oob_score=([-+]?[0-9]*\\\\\\\\\\\\\\\\.?[0-9]+(?:[eE][-+]?[0-9]+)?).*\\",\\n \\"Name\\": \\"train:oob_score\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"Required\\": true,\\n \\"Properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Name\\": \\"\\",\\n \\"SupportedChannelTypes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"SupportsDistributedTraining\\": true,\\n \\"Image\\": \\"\\",\\n \\"SupportedInstanceTypes\\": [\\n \\"\\"\\n ],\\n \\"ComputeResource\\": {\\n \\"Policy\\": {\\n \\"Version\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n },\\n \\"CodeDir\\": {\\n \\"LocationType\\": \\"\\",\\n \\"LocationValue\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Customization\\": {\\n \\"CodeDir\\": true\\n },\\n \\"ResourceRequirements\\": [\\n {\\n \\"Key\\": \\"SupportedMachineTypes\\",\\n \\"Operator\\": \\"in\\",\\n \\"Values\\": [\\n \\"GPU\\"\\n ]\\n }\\n ],\\n \\"ProgressDefinitions\\": {\\n \\"OverallProgress\\": {\\n \\"Description\\": \\"\\",\\n \\"Regex\\": \\"\\"\\n },\\n \\"RemainingTime\\": {\\n \\"Description\\": \\"\\",\\n \\"Regex\\": \\"\\"\\n }\\n }\\n },\\n \\"IsTempAlgo\\": true,\\n \\"LatestProgress\\": {\\n \\"OverallProgress\\": {\\n \\"Timestamp\\": \\"2023-07-04T13:20:18Z\\",\\n \\"Value\\": 0.75\\n },\\n \\"RemainingTime\\": {\\n \\"Timestamp\\": \\"2023-07-04T13:20:18Z\\",\\n \\"Value\\": 3600\\n }\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ]\\n },\\n \\"OutputModel\\": {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/model/output/\\",\\n \\"OutputChannelName\\": \\"model\\"\\n },\\n \\"Settings\\": {\\n \\"BusinessUserId\\": \\"166924\\",\\n \\"Caller\\": \\"SilkFlow\\",\\n \\"Tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PipelineId\\": \\"pid-123456\\",\\n \\"EnableTideResource\\": true,\\n \\"EnableErrorMonitoringInAIMaster\\": false,\\n \\"ErrorMonitoringArgs\\": \\"--enable-log-hang-detection true\\",\\n \\"EnableRDMA\\": true,\\n \\"EnableOssAppend\\": true,\\n \\"OversoldType\\": \\"AcceptQuotaOverSold\\",\\n \\"AdvancedSettings\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Driver\\": \\"535.54.03\\",\\n \\"EnableSanityCheck\\": true,\\n \\"SanityCheckArgs\\": \\"--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFai\\",\\n \\"JobReservedMinutes\\": 30,\\n \\"JobReservedPolicy\\": \\"Always\\"\\n },\\n \\"ExperimentConfig\\": {\\n \\"ExperimentId\\": \\"exp-ds9aefia90v\\",\\n \\"ExperimentName\\": \\"large_language_model_train\\"\\n },\\n \\"Duration\\": 7200,\\n \\"Environments\\": {\\n \\"key\\": \\"debug=true\\"\\n },\\n \\"PythonRequirements\\": [\\n \\"torch>=2.2.0\\"\\n ],\\n \\"Priority\\": 0,\\n \\"AssignNodeSpec\\": {\\n \\"EnableAssignNode\\": true,\\n \\"NodeNames\\": \\"\\",\\n \\"AntiAffinityNodeNames\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => 'GetTrainingJob',
],
'GetTrainingJobErrorInfo' => [
'summary' => '获取Training Job的算法错误信息',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/errorinfo',
'methods' => [
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '195103',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'traineyfz0m2hsfv',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'ErrorInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'AdditionalInfo' => [
'description' => '',
'type' => 'string',
'example' => 'additional info',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"ErrorInfo\\": {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"AdditionalInfo\\": \\"additional info\\"\\n }\\n}","type":"json"}]',
'title' => 'GetTrainingJobErrorInfo',
],
'GetTrainingJobLatestMetrics' => [
'summary' => '获取TrainingJob最近的Metrics',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/latestmetrics',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '135852',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'train129f212o89d',
],
],
[
'name' => 'Names',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'loss',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
],
'Metrics' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'example' => '2022-04-18T22:20:55Z',
],
'Value' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'example' => '0.97',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'loss',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"2022-04-18T22:20:55Z\\",\\n \\"Value\\": 0.97,\\n \\"Name\\": \\"loss\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'GetTrainingJobLatestMetrics',
],
'ListTrainingJobs' => [
'summary' => '获取TrainingJob的列表',
'path' => '/api/v1/trainingjobs',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '132980',
'abilityTreeNodes' => [
'FEATURElearnVYA4L9',
],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12345',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'GmtModifiedTime',
'enum' => [
'GmtModifiedTime',
'GmtCreateTime',
'TrainingJobName',
'AlgorithmName',
'Status',
],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'ASC' => 'ASC',
'DESC' => 'DESC',
],
'example' => 'DESC',
'enum' => [
'desc',
'asc',
],
],
],
[
'name' => 'TrainingJobName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'large_language_model_training',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Running',
],
],
[
'name' => 'TrainingJobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'trains930928remn',
],
],
[
'name' => 'Labels',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'required' => false,
'example' => '{"project": "sd-s3"}',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2024-06-22T01:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2023-12-27T02:10:00Z',
],
],
[
'name' => 'AlgorithmProvider',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pai',
],
],
[
'name' => 'AlgorithmName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'llm_train',
],
],
[
'name' => 'IsTempAlgo',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'TrainingJobs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AlgorithmName' => [
'description' => '',
'type' => 'string',
'example' => 'llm_train',
],
'AlgorithmProvider' => [
'description' => '',
'type' => 'string',
'example' => 'pai',
],
'AlgorithmVersion' => [
'description' => '',
'type' => 'string',
'example' => 'v0.0.1',
],
'ComputeResource' => [
'description' => '',
'type' => 'object',
'properties' => [
'EcsCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'EcsSpec' => [
'description' => '',
'type' => 'string',
'example' => 'ecs.gn5-c8g1.2xlarge',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'quotam670lixikcl',
],
'ResourceName' => [
'type' => 'string',
],
'InstanceCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'InstanceSpec' => [
'description' => '',
'type' => 'object',
'properties' => [
'CPU' => [
'description' => '',
'type' => 'string',
'example' => '8',
],
'Memory' => [
'description' => '',
'type' => 'string',
'example' => '32',
],
'SharedMemory' => [
'description' => '',
'type' => 'string',
'example' => '32',
],
'GPU' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'GPUType' => [
'description' => '',
'type' => 'string',
'example' => 'V100',
],
],
],
],
],
'GmtCreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'GmtModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'HyperParameters' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'learning_rate',
],
'Value' => [
'description' => '',
'type' => 'string',
'example' => '0.001',
],
],
],
],
'InputChannels' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DatasetId' => [
'description' => '',
'type' => 'string',
'example' => 'd-475megosidivjfgfq6',
],
'InputUri' => [
'description' => '',
'type' => 'string',
'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/channel/',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'model',
],
'VersionName' => [
'type' => 'string',
],
],
],
],
'Labels' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '',
'type' => 'string',
'example' => 'CreatedBy',
],
'Value' => [
'description' => '',
'type' => 'string',
'example' => 'QuickStart',
],
],
],
],
'OutputChannels' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DatasetId' => [
'description' => '',
'type' => 'string',
'example' => 'd-8o0hh35po15ejcdq2p',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'model',
],
'OutputUri' => [
'description' => '',
'type' => 'string',
'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/channel/',
],
'VersionName' => [
'type' => 'string',
],
],
],
],
'ReasonCode' => [
'description' => '',
'type' => 'string',
'example' => 'TrainingJobSucceed',
],
'ReasonMessage' => [
'description' => '',
'type' => 'string',
'example' => 'None',
],
'Scheduler' => [
'description' => '',
'type' => 'object',
'properties' => [
'MaxRunningTimeInSeconds' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Running',
],
'StatusTransitions' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'ReasonCode' => [
'description' => '',
'type' => 'string',
'example' => 'TrainingJobSucceed',
],
'ReasonMessage' => [
'description' => '',
'type' => 'string',
'example' => 'KubeDL job runs successfully',
],
'StartTime' => [
'description' => '',
'type' => 'string',
'example' => '2024-07-10T11:49:47Z',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Creating',
],
],
],
],
'TrainingJobDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TrainingJobId' => [
'description' => '',
'type' => 'string',
'example' => 'train1layo6js8ra',
],
'TrainingJobName' => [
'description' => '',
'type' => 'string',
'example' => 'qwen2-7b',
],
'UserId' => [
'description' => '',
'type' => 'string',
'example' => '123456789',
],
'WorkspaceId' => [
'description' => '',
'type' => 'string',
'example' => '1234',
],
'RoleArn' => [
'description' => '',
'type' => 'string',
'example' => 'acs:ram::{accountID}:role/{roleName}',
],
'IsTempAlgo' => [
'title' => '是否使用了临时算法。',
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'UserVpc' => [
'description' => '',
'type' => 'object',
'properties' => [
'VpcId' => [
'description' => 'VPC ID。',
'type' => 'string',
'example' => 'vpc-abcdef****',
],
'SwitchId' => [
'description' => '',
'type' => 'string',
'example' => 'vs-abcdef****',
],
'SecurityGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'sg-abcdef****',
],
'ExtendedCIDRs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '192.168.0.1/24',
],
],
'DefaultRoute' => [
'description' => '',
'type' => 'string',
'example' => 'eth1',
],
],
],
'ExperimentConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'ExperimentId' => [
'description' => '',
'type' => 'string',
'example' => 'exp-ds9aefia90v',
],
'ExperimentName' => [
'description' => '',
'type' => 'string',
'example' => 'large_language_model',
],
],
],
'Environments' => [
'description' => '',
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
'description' => '',
'example' => 'debug=true',
],
],
'PythonRequirements' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'torch>=2.2.0',
],
],
'DlcJobId' => [
'type' => 'string',
],
'AssignNodeSpec' => [
'$ref' => '#/components/schemas/AssignNodeSpec',
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"TrainingJobs\\": [\\n {\\n \\"AlgorithmName\\": \\"llm_train\\",\\n \\"AlgorithmProvider\\": \\"pai\\",\\n \\"AlgorithmVersion\\": \\"v0.0.1\\",\\n \\"ComputeResource\\": {\\n \\"EcsCount\\": 1,\\n \\"EcsSpec\\": \\"ecs.gn5-c8g1.2xlarge\\",\\n \\"ResourceId\\": \\"quotam670lixikcl\\",\\n \\"ResourceName\\": \\"quota\\",\\n \\"InstanceCount\\": 1,\\n \\"InstanceSpec\\": {\\n \\"CPU\\": \\"8\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"1\\",\\n \\"GPUType\\": \\"V100\\"\\n }\\n },\\n \\"GmtCreateTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"GmtModifiedTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"HyperParameters\\": [\\n {\\n \\"Name\\": \\"learning_rate\\",\\n \\"Value\\": \\"0.001\\"\\n }\\n ],\\n \\"InputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-475megosidivjfgfq6\\",\\n \\"InputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/input/channel/\\",\\n \\"Name\\": \\"model\\",\\n \\"VersionName\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"CreatedBy\\",\\n \\"Value\\": \\"QuickStart\\"\\n }\\n ],\\n \\"OutputChannels\\": [\\n {\\n \\"DatasetId\\": \\"d-8o0hh35po15ejcdq2p\\",\\n \\"Name\\": \\"model\\",\\n \\"OutputUri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/to/output/channel/\\",\\n \\"VersionName\\": \\"\\"\\n }\\n ],\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"None\\",\\n \\"Scheduler\\": {\\n \\"MaxRunningTimeInSeconds\\": 0\\n },\\n \\"Status\\": \\"Running\\",\\n \\"StatusTransitions\\": [\\n {\\n \\"EndTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"ReasonCode\\": \\"TrainingJobSucceed\\",\\n \\"ReasonMessage\\": \\"KubeDL job runs successfully\\",\\n \\"StartTime\\": \\"2024-07-10T11:49:47Z\\",\\n \\"Status\\": \\"Creating\\"\\n }\\n ],\\n \\"TrainingJobDescription\\": \\"Qwen2大语言模型训练。\\",\\n \\"TrainingJobId\\": \\"train1layo6js8ra\\",\\n \\"TrainingJobName\\": \\"qwen2-7b\\",\\n \\"UserId\\": \\"123456789\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"RoleArn\\": \\"acs:ram::{accountID}:role/{roleName}\\",\\n \\"IsTempAlgo\\": true,\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-abcdef****\\",\\n \\"SwitchId\\": \\"vs-abcdef****\\",\\n \\"SecurityGroupId\\": \\"sg-abcdef****\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ],\\n \\"DefaultRoute\\": \\"eth1\\"\\n },\\n \\"ExperimentConfig\\": {\\n \\"ExperimentId\\": \\"exp-ds9aefia90v\\",\\n \\"ExperimentName\\": \\"large_language_model\\"\\n },\\n \\"Environments\\": {\\n \\"key\\": \\"debug=true\\"\\n },\\n \\"PythonRequirements\\": [\\n \\"torch>=2.2.0\\"\\n ],\\n \\"DlcJobId\\": \\"\\",\\n \\"AssignNodeSpec\\": {\\n \\"EnableAssignNode\\": true,\\n \\"NodeNames\\": \\"\\",\\n \\"AntiAffinityNodeNames\\": \\"\\"\\n }\\n }\\n ],\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
'title' => 'ListTrainingJobs',
],
'ListTrainingJobEvents' => [
'summary' => '获取指定TrainingJob的事件。',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/events',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '165613',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'traineyfz0m2hsfv',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '2000',
'minimum' => '1',
'example' => '100',
'default' => '100',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'title' => '截止UTC时间,格式 iso8601,假如为空是当前时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'TotalCount' => [
'title' => '符合过滤条件的日志数量',
'description' => '',
'type' => 'string',
'example' => '23',
],
'Events' => [
'title' => '日志列表',
'description' => '',
'type' => 'array',
'items' => [
'title' => '',
'description' => '',
'type' => 'string',
'example' => 'UserEvent',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": \\"23\\",\\n \\"Events\\": [\\n \\"UserEvent\\"\\n ]\\n}","type":"json"}]',
'title' => 'ListTrainingJobEvents',
],
'ListTrainingJobInstanceEvents' => [
'summary' => '获取指定Instance(TrainingJob的运行单元)的日志。',
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'train76rcaupa2cz',
],
],
[
'name' => 'InstanceId',
'in' => 'path',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'train76rcaupa2cz-master-0',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '2000',
'minimum' => '1',
'example' => '100',
'default' => '100',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'title' => '截止UTC时间,格式 iso8601,假如为空是当前时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID',
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'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.',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"Events\\": [\\n \\"You are using pip version 9.0.1, however version 20.2.4 is available.\\"\\n ]\\n}","type":"json"}]',
'title' => 'ListTrainingJobInstanceEvents',
],
'ListTrainingJobInstanceMetrics' => [
'summary' => '获取Training Job实例的Metrics',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/instancemetrics',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '157749',
'abilityTreeNodes' => [
'FEATURElearnP1X97H',
],
],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'title' => 'Training Job Id',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'trains930928remn',
],
],
[
'name' => 'MetricType',
'in' => 'query',
'schema' => [
'title' => '分页,从1开始,默认1',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'GpuCoreUsage',
],
],
[
'name' => 'TimeStep',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '10s',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'trains930928remn-master-0',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'title' => '截止UTC时间,格式 iso8601,假如为空是当前时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
],
'InstanceMetrics' => [
'title' => '符合过滤条件的Metrics数量',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'type' => 'string',
],
'Metrics' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => [
'type' => 'string',
],
'Value' => [
'type' => 'number',
'format' => 'double',
],
],
],
],
'NodeName' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"InstanceMetrics\\": [\\n {\\n \\"InstanceId\\": \\"trainkxen7qjyg6y-master-0\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": \\"2020-11-08T16:00:00Z\\",\\n \\"Value\\": 1\\n }\\n ],\\n \\"NodeName\\": \\"trains930928remn-master-0\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListTrainingJobInstanceMetrics',
],
'ListTrainingJobLogs' => [
'summary' => '获取Training Job的日志',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/logs',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'train129f212o89d',
],
],
[
'name' => 'WorkerId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'title' => '截止UTC时间,格式 iso8601,假如为空是当前时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CBF05F13-B24C-5129-9048-4FA684DCD579\\",\\n \\"TotalCount\\": \\"23\\",\\n \\"Logs\\": [\\n \\"loss: 0.0001\\"\\n ]\\n}","type":"json"}]',
'title' => 'ListTrainingJobLogs',
],
'ListTrainingJobMetrics' => [
'summary' => '获取Training Job的Metrics',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/metrics',
'methods' => [
'get',
],
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'train76rcaupa2cz',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '分页,从1开始,默认1',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'accuracy',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'title' => '每页返回的日志数量',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '每页返回的日志数量',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '100',
'default' => '100',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'title' => '起始UTC时间,格式 iso8601,假如为空是任务开始时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'title' => '截止UTC时间,格式 iso8601,假如为空是当前时间',
'description' => '',
'type' => 'string',
'format' => 'iso8601',
'required' => false,
'example' => '2020-11-08T16:00:00Z',
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => 'Metrics的时间顺序,有ASC和DESC',
'description' => '',
'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' => '',
'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',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Metrics\\": [\\n {\\n \\"Timestamp\\": \\"2022-04-18T22:20:55Z\\",\\n \\"Value\\": 0.97,\\n \\"Name\\": \\"accuracy\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n}","type":"json"}]',
'title' => 'ListTrainingJobMetrics',
],
'ListTrainingJobOutputModels' => [
'summary' => '获取Training Job 产出的所有模型信息',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/outputmodels',
'methods' => [
'get',
],
'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' => '',
'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' => [
'type' => 'string',
],
'Value' => [
'description' => '',
'type' => 'string',
'example' => 'StableDiffusion',
],
],
],
],
'Metrics' => [
'description' => '',
'type' => 'object',
'example' => '{'."\n"
.' "lr": 0.000001,'."\n"
.' "train_loss": 2.6345'."\n"
.'}',
],
'TrainingSpec' => [
'description' => '',
'type' => 'object',
'example' => '{}',
],
'InferenceSpec' => [
'description' => '',
'type' => 'object',
'example' => '{}',
],
'EvaluationSpec' => [
'description' => '',
'type' => 'object',
'example' => '{}',
],
'SourceType' => [
'description' => '',
'type' => 'string',
'example' => 'PAIFlow',
],
'SourceId' => [
'description' => '',
'type' => 'string',
'example' => 'region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf',
],
'CompressionSpec' => [
'type' => 'object',
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OutputModels\\": [\\n {\\n \\"OutputChannelName\\": \\"model\\",\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/path/to/output/channel/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"RootModelName\\",\\n \\"Value\\": \\"qwen2-0.5\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"Train\\": \\"oss://somebucket.oss-cn-hangzhou.aliyuncs.com/datasets/Chinese-medical-dialogue-data/chinese_medical_train_sampled.json\\"\\n },\\n \\"Metrics\\": {\\n \\"loss\\": 2.1276\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {},\\n \\"EvaluationSpec\\": {},\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=1345,kind=PipelineRun,id=run-sakdbaskjdf\\",\\n \\"CompressionSpec\\": {}\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListTrainingJobOutputModels',
],
'StopTrainingJob' => [
'summary' => '停止一个TrainingJob',
'path' => '/api/v1/trainingjobs/{TrainingJobId}/stop',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'TrainingJobId',
'in' => 'path',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'train76rcaupa2cz',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]',
'title' => 'StopTrainingJob',
],
'UpdateTrainingJobLabels' => [
'summary' => '更新一个TrainingJob的Labels',
'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' => '',
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'train76rcaupa2cz',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]',
'title' => 'UpdateTrainingJobLabels',
],
'CreateQuota' => [
'summary' => '创建Quota',
'path' => '/api/v1/quotas',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'test-quota',
],
'ResourceType' => [
'title' => 'Quota资源类型(Lingjun/ECS),默认值ECS',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ECS',
],
'ParentQuotaId' => [
'title' => '父QuotaId'."\n"
.'1. 如果父QuotaId为空,表示创建一个根Quota,从专属资源组中分配机器'."\n"
.'2. 如果父QuotaId不为空,表示创建一个子Quota,资源从根Quota中绑定的Nodes中分配资源',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'quota1ci8g793pgm',
],
'ResourceGroupIds' => [
'title' => '专有资源组列表'."\n"
.'约束:'."\n"
.'1. 只有根Quota允许从(父QuotaId为空)资源组划分机器'."\n"
.'2. 指定的资源组列表中的vpc配置需要一致',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rgl593id9qqwkmbr',
],
'required' => false,
],
'AllocateStrategy' => [
'title' => 'Quota分配策略,目前仅支持ByNodeSpecs',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ByNodeSpecs',
],
'Min' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/ResourceSpec',
],
'Description' => [
'title' => 'Quota描述',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'this is a test quota',
],
'Labels' => [
'title' => 'Quota标签',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/Label',
],
'required' => false,
],
'QuotaConfig' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/QuotaConfig',
],
'QueueStrategy' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PaiStrategyIntelligent',
],
'ClusterSpec' => [
'title' => '资源配额原生集群的规格',
'$ref' => '#/components/schemas/ClusterSpec',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求Id',
'description' => '',
'type' => 'string',
'example' => 'CBF05F13-B24C-5129-9048-4FA684DCD579',
],
'QuotaId' => [
'title' => 'Quota Id',
'description' => 'Quota Id',
'type' => 'string',
'example' => 'quotad2kd8ljpsno',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CBF05F13-B24C-5129-9048-4FA684DCD579\\",\\n \\"QuotaId\\": \\"quotad2kd8ljpsno\\"\\n}","errorExample":""},{"type":"xml","example":"\\n quotad2kd8ljpsno\\n","errorExample":""}]',
'title' => 'CreateQuota',
],
'ListQuotas' => [
'summary' => '获取Quota列表',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'quotajradxh43rgb',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ECS',
],
],
[
'name' => 'LayoutMode',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ParentQuotaId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'quotajradxh43rgb',
],
],
[
'name' => 'QuotaIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'quota1ci8g793pgm,quotajradxh43rgb',
],
],
[
'name' => 'WorkspaceIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '21345,38727',
],
],
[
'name' => 'Statuses',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Creating',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'status',
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'desc',
],
],
[
'name' => 'Labels',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'official=true,gpu=false',
],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'WorkspaceName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HasResource',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Versions',
'in' => 'query',
'schema' => [
'title' => '按照版本信息搜索。',
'type' => 'string',
'example' => '1.0',
],
],
[
'name' => 'ClusterType',
'in' => 'query',
'schema' => [
'title' => '集群类型',
'type' => 'string',
'example' => 'RayCluster',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求Id',
'description' => '',
'type' => 'string',
'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
],
'Quotas' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/Quota',
],
],
'TotalCount' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\",\\n \\"ResourceType\\": \\"\\",\\n \\"ParentQuotaId\\": \\"\\",\\n \\"ResourceGroupIds\\": [\\n \\"\\"\\n ],\\n \\"AllocateStrategy\\": \\"\\",\\n \\"Min\\": {\\n \\"NodeSpecs\\": [\\n {\\n \\"Type\\": \\"ecs.g6.4xlarge\\",\\n \\"Count\\": 10,\\n \\"BindingPolicy\\": {\\n \\"NodeSpecCount\\": 5,\\n \\"IncludeNodes\\": [\\n \\"lrnabc\\"\\n ],\\n \\"ExcludeNodes\\": [\\n \\"lrndef\\"\\n ]\\n },\\n \\"HyperType\\": \\"\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"CreatorId\\": \\"\\",\\n \\"LatestOperationId\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"ReasonCode\\": \\"\\",\\n \\"ReasonMessage\\": \\"\\",\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"QuotaDetails\\": {\\n \\"DesiredMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"ActualMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"RequestedQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n }\\n },\\n \\"QuotaConfig\\": {\\n \\"SupportRDMA\\": false,\\n \\"ClusterId\\": \\"ceeb37xxxx\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\"\\n ],\\n \\"RoleArn\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"\\",\\n \\"EipAllocationId\\": \\"\\"\\n }\\n },\\n \\"SupportGPUDrivers\\": [\\n \\"\\"\\n ],\\n \\"DefaultGPUDriver\\": \\"470.199.02\\",\\n \\"ACS\\": {\\n \\"ACSQuotaId\\": \\"\\",\\n \\"AssociatedProducts\\": [\\n \\"\\"\\n ]\\n },\\n \\"ResourceSpecs\\": [\\n {\\n \\"WorkspaceId\\": \\"\\",\\n \\"Product\\": \\"\\",\\n \\"Specs\\": [\\n {\\n \\"SpecName\\": \\"\\",\\n \\"IsGuaranteedValid\\": true,\\n \\"IsOverSoldValid\\": true,\\n \\"CodeType\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Reason\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"EnablePreemptSubquotaWorkloads\\": true,\\n \\"EnableSubQuotaPreemption\\": true,\\n \\"SubQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorityUpperBound\\": 9,\\n \\"PreemptedProducts\\": [\\n \\"dlc\\"\\n ]\\n },\\n \\"EnableGPUShare\\": true,\\n \\"OversoldUsageConfig\\": {\\n \\"DisabledBy\\": \\"\\",\\n \\"Disabled\\": true\\n },\\n \\"SelfQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorities\\": [\\n 0\\n ],\\n \\"PreemptedProducts\\": [\\n \\"\\"\\n ],\\n \\"PreemptorPriorities\\": [\\n 0\\n ]\\n },\\n \\"EniCacheConfig\\": {\\n \\"Enabled\\": true,\\n \\"CachePoolSize\\": 0\\n },\\n \\"SandboxCacheConfig\\": {\\n \\"Enabled\\": true\\n },\\n \\"UseCase\\": \\"\\",\\n \\"EnableSelfQuotaPreemption\\": true,\\n \\"ControlPlaneClusterId\\": \\"\\"\\n },\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"ws123456\\"\\n }\\n ],\\n \\"SubQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"QueueStrategy\\": \\"\\",\\n \\"Version\\": \\"\\",\\n \\"HyperZones\\": [\\n \\"\\"\\n ],\\n \\"QuotaCluster\\": {\\n \\"ClusterType\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"DataSourceId\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"Endpoints\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Status\\": \\"\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]',
'title' => 'ListQuotas',
],
'GetQuota' => [
'summary' => '获取Quota',
'path' => '/api/v1/quotas/{QuotaId}',
'methods' => [
'get',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'quota1ci8g793pgm',
],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'WithNodeMeta',
'in' => 'query',
'schema' => [
'title' => '是否返回绑定到Quota的节点meta信息',
'type' => 'boolean',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求Id',
'description' => '',
'type' => 'string',
'example' => '18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E',
],
'QuotaId' => [
'title' => 'Quota Id',
'description' => 'Quota Id',
'type' => 'string',
'example' => 'quotajradxh43rgb',
],
'QuotaName' => [
'title' => 'Quota名称',
'description' => '',
'type' => 'string',
'example' => 'test-quota',
],
'ResourceType' => [
'title' => 'Quota资源类型',
'description' => '',
'type' => 'string',
'example' => 'ECS',
],
'ParentQuotaId' => [
'title' => '父Quota Id',
'description' => '',
'type' => 'string',
'example' => 'quota1ci8g793pgm',
],
'ResourceGroupIds' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'rg69rj0leslwdnbe',
],
],
'AllocateStrategy' => [
'title' => '资源分配策略',
'description' => '',
'type' => 'string',
'example' => 'ByNodeSpec',
],
'Min' => [
'description' => '',
'$ref' => '#/components/schemas/ResourceSpec',
],
'Description' => [
'title' => 'Quota描述',
'description' => '',
'type' => 'string',
'example' => 'this is a test quota',
],
'Labels' => [
'title' => 'Quota标签',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/Label',
],
],
'CreatorId' => [
'title' => 'Quota创建人Id',
'description' => '',
'type' => 'string',
'example' => '18846926616',
],
'LatestOperationId' => [
'title' => 'Quota最近变更Id',
'description' => '',
'type' => 'string',
'example' => 'operation1234',
],
'Status' => [
'title' => 'Quota状态',
'description' => '',
'type' => 'string',
'example' => 'Ready',
],
'ReasonCode' => [
'title' => '错误码',
'description' => '',
'type' => 'string',
'example' => '“”',
],
'ReasonMessage' => [
'title' => '错误原因',
'description' => '',
'type' => 'string',
'example' => '“”',
],
'GmtCreatedTime' => [
'title' => 'Quota创建时间',
'description' => '',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
],
'GmtModifiedTime' => [
'title' => 'Quota修改时间',
'description' => '',
'type' => 'string',
'example' => '2023-06-22T00:00:00Z',
],
'QuotaDetails' => [
'title' => 'Quota详情',
'description' => '',
'$ref' => '#/components/schemas/QuotaDetails',
],
'QuotaConfig' => [
'description' => '',
'$ref' => '#/components/schemas/QuotaConfig',
],
'Workspaces' => [
'title' => 'Quota关联的工作空间',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/WorkspaceIdName',
],
],
'SubQuotas' => [
'title' => 'Quota的子Quota列表',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/QuotaIdName',
],
],
'QueueStrategy' => [
'description' => '',
'type' => 'string',
'example' => 'PaiStrategyIntelligent',
],
'Version' => [
'title' => '版本信息。当resource type为ECS时生效。',
'type' => 'string',
'example' => '1.0',
],
'HyperZones' => [
'title' => '高性能网络区列表',
'type' => 'array',
'items' => [
'title' => '高性能网络区ID',
'type' => 'string',
],
],
'QuotaCluster' => [
'title' => '由配额内资源组成的集群规格与状态',
'$ref' => '#/components/schemas/QuotaCluster',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\\",\\n \\"QuotaId\\": \\"quotajradxh4****\\",\\n \\"QuotaName\\": \\"test-quota\\",\\n \\"ResourceType\\": \\"ECS\\",\\n \\"ParentQuotaId\\": \\"quota1ci8g79****\\",\\n \\"ResourceGroupIds\\": [\\n \\"rg69rj0leslw****\\"\\n ],\\n \\"AllocateStrategy\\": \\"ByNodeSpec\\",\\n \\"Min\\": {\\n \\"NodeSpecs\\": [\\n {\\n \\"Type\\": \\"ecs.g6.4xlarge\\",\\n \\"Count\\": 10,\\n \\"BindingPolicy\\": {\\n \\"NodeSpecCount\\": 5,\\n \\"IncludeNodes\\": [\\n \\"lrnabc\\"\\n ],\\n \\"ExcludeNodes\\": [\\n \\"lrndef\\"\\n ]\\n },\\n \\"HyperType\\": \\"\\"\\n }\\n ]\\n },\\n \\"Description\\": \\"this is a test quota\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"CreatorId\\": \\"1884692****\\",\\n \\"LatestOperationId\\": \\"operation****\\",\\n \\"Status\\": \\"Ready\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"GmtCreatedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2023-06-22T00:00:00Z\\",\\n \\"QuotaDetails\\": {\\n \\"DesiredMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"ActualMinQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"RequestedQuota\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n }\\n },\\n \\"QuotaConfig\\": {\\n \\"SupportRDMA\\": false,\\n \\"ClusterId\\": \\"ceeb37xxxx\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"SwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\"\\n ],\\n \\"RoleArn\\": \\"\\",\\n \\"DefaultRoute\\": \\"\\",\\n \\"DefaultForwardInfo\\": {\\n \\"NatGatewayId\\": \\"\\",\\n \\"EipAllocationId\\": \\"\\"\\n }\\n },\\n \\"SupportGPUDrivers\\": [\\n \\"\\"\\n ],\\n \\"DefaultGPUDriver\\": \\"470.199.02\\",\\n \\"ACS\\": {\\n \\"ACSQuotaId\\": \\"\\",\\n \\"AssociatedProducts\\": [\\n \\"\\"\\n ]\\n },\\n \\"ResourceSpecs\\": [\\n {\\n \\"WorkspaceId\\": \\"\\",\\n \\"Product\\": \\"\\",\\n \\"Specs\\": [\\n {\\n \\"SpecName\\": \\"\\",\\n \\"IsGuaranteedValid\\": true,\\n \\"IsOverSoldValid\\": true,\\n \\"CodeType\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Reason\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"EnablePreemptSubquotaWorkloads\\": true,\\n \\"EnableSubQuotaPreemption\\": true,\\n \\"SubQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorityUpperBound\\": 9,\\n \\"PreemptedProducts\\": [\\n \\"dlc\\"\\n ]\\n },\\n \\"EnableGPUShare\\": true,\\n \\"OversoldUsageConfig\\": {\\n \\"DisabledBy\\": \\"\\",\\n \\"Disabled\\": true\\n },\\n \\"SelfQuotaPreemptionConfig\\": {\\n \\"PreemptedPriorities\\": [\\n 0\\n ],\\n \\"PreemptedProducts\\": [\\n \\"\\"\\n ],\\n \\"PreemptorPriorities\\": [\\n 0\\n ]\\n },\\n \\"EniCacheConfig\\": {\\n \\"Enabled\\": true,\\n \\"CachePoolSize\\": 0\\n },\\n \\"SandboxCacheConfig\\": {\\n \\"Enabled\\": true\\n },\\n \\"UseCase\\": \\"\\",\\n \\"EnableSelfQuotaPreemption\\": true,\\n \\"ControlPlaneClusterId\\": \\"\\"\\n },\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"ws123456\\"\\n }\\n ],\\n \\"SubQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\",\\n \\"Version\\": \\"1.0\\",\\n \\"HyperZones\\": [\\n \\"A3\\"\\n ],\\n \\"QuotaCluster\\": {\\n \\"ClusterType\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"DataSourceId\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"Endpoints\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Status\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n quotajradxh43rgb\\n test-quota\\n ECS\\n quota1ci8g793pgm\\n rg69rj0leslwdnbe\\n ByNodeSpec\\n \\n \\n ecs.g6.4xlarge\\n 10\\n \\n \\n this is a test quota\\n \\n Ready\\n 2023-06-22T00:00:00Z\\n 2023-06-22T00:00:00Z\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n 100\\n 100Gi\\n 16\\n GPU\\n \\n \\n \\n false\\n ceeb37xxxx\\n \\n \\n 470.199.02\\n \\n \\n \\n \\n ws123456\\n \\n \\n quota12345\\n dlc-quota\\n \\n PaiStrategyIntelligent\\n","errorExample":""}]',
'title' => 'GetQuota',
],
'UpdateQuota' => [
'summary' => '更新Quota',
'path' => '/api/v1/quotas/{QuotaId}',
'methods' => [
'put',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'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' => '',
'type' => 'object',
'properties' => [
'Description' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'this is a test quota',
],
'Labels' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/Label',
],
'required' => false,
],
'QueueStrategy' => [
'type' => 'string',
],
'QuotaConfig' => [
'$ref' => '#/components/schemas/QuotaConfig',
],
'QuotaName' => [
'type' => 'string',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求Id',
'description' => '',
'type' => 'string',
'example' => '96496E6E-00B4-5F55-80F6-1844FA9E92DC',
],
'QuotaId' => [
'title' => 'Quota Id',
'description' => 'Quota Id',
'type' => 'string',
'example' => 'quota-20210126170216-mtl37ge7gkvdz',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96496E6E-00B4-5F55-80F6-1844FA9E92DC\\",\\n \\"QuotaId\\": \\"quota-20210126170216-mtl37ge7gkvdz\\"\\n}","type":"json"}]',
'title' => 'UpdateQuota',
],
'ScaleQuota' => [
'summary' => '扩缩容Quota',
'path' => '/api/v1/quotas/{QuotaId}/action/scale',
'methods' => [
'put',
],
'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' => '',
'type' => 'object',
'properties' => [
'ResourceGroupIds' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg-aek2nxrabqavely',
],
'required' => false,
],
'Min' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/ResourceSpec',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求Id',
'description' => '',
'type' => 'string',
'example' => 'F2D0392B-D749-5C48-A98A-3FAE5C9444A6',
],
'QuotaId' => [
'title' => 'Quota Id',
'description' => 'Quota Id',
'type' => 'string',
'example' => 'quotamtl37ge7gkvdz',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2D0392B-D749-5C48-A98A-3FAE5C9444A6\\",\\n \\"QuotaId\\": \\"quotamtl37ge7gkvdz\\"\\n}","type":"json"}]',
'title' => 'ScaleQuota',
],
'DeleteQuota' => [
'summary' => '删除Quota',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'quota1ci8g793pgm',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求Id',
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'QuotaId' => [
'title' => 'Quota Id',
'description' => 'Quota Id',
'type' => 'string',
'example' => 'quotamtl37ge7gkvdz',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"QuotaId\\": \\"quotamtl37ge7gkvdz\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n quotamtl37ge7gkvdz\\n","errorExample":""}]',
'title' => 'DeleteQuota',
],
'ListQuotaWorkloads' => [
'summary' => '您可以通过此API获取Quota上的任务信息列表',
'path' => '/api/v1/quotas/{QuotaId}/workloads',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '221848',
'abilityTreeNodes' => [
'FEATURElearn1N0SUT',
],
],
'parameters' => [
[
'name' => 'QuotaId',
'in' => 'path',
'schema' => [
'title' => 'Quota ID',
'description' => 'Quota ID',
'type' => 'string',
'required' => true,
'example' => 'quota1y9qarqj2i7',
],
],
[
'name' => 'WorkspaceIds',
'in' => 'query',
'schema' => [
'title' => '查询指定的Workspace下的workload的排队信息',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '186692',
],
],
[
'name' => 'WorkloadType',
'in' => 'query',
'schema' => [
'title' => '查询指定子产品的实例的排队信息',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dlc',
],
],
[
'name' => 'WorkloadIds',
'in' => 'query',
'schema' => [
'title' => '查询指定workload id的排队信息',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dlc12344556',
],
],
[
'name' => 'BeforeWorkloadId',
'in' => 'query',
'schema' => [
'title' => '查询队列中指定workload Id之前的实例的排队信息',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dsw65443322',
],
],
[
'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' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'true',
],
],
[
'name' => 'SubQuotaIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'quota12344666,quota64432233',
],
],
[
'name' => 'UserIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '29043893812,23829093093',
],
],
[
'name' => 'NodeName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'lrn48278127617',
],
],
[
'name' => 'WorkloadCreatedTimeRange',
'in' => 'query',
'schema' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/TimeRangeFilter',
],
],
[
'name' => 'WorkloadStatuses',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Pending',
],
],
[
'name' => 'GmtPositionModifiedTimeRange',
'in' => 'query',
'schema' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/TimeRangeFilter',
],
],
[
'name' => 'GmtEnqueuedTimeRange',
'in' => 'query',
'schema' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/TimeRangeFilter',
],
],
[
'name' => 'GmtDequeuedTimeRange',
'in' => 'query',
'schema' => [
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/TimeRangeFilter',
],
],
[
'name' => 'WithHistoricalData',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
],
'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' => '42F23B58-3684-5443-848A-8DA81FF99712',
],
'TotalCount' => [
'title' => '符合过滤条件的实例数量',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
'Workloads' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/QueueInfo',
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42F23B58-3684-5443-848A-8DA81FF99712\\",\\n \\"TotalCount\\": 23,\\n \\"Workloads\\": [\\n {\\n \\"Status\\": \\"Enqueued\\",\\n \\"QuotaId\\": \\"“quotamtl37ge7gkvdz”\\",\\n \\"UserName\\": \\"\\",\\n \\"WorkloadId\\": \\"dlcxxxx\\",\\n \\"Position\\": 10,\\n \\"GmtEnqueuedTime\\": \\"“2023-06-22T00:00:00Z”\\",\\n \\"Priority\\": 2,\\n \\"GmtCreatedTime\\": \\"\\",\\n \\"WorkloadType\\": \\"dlc\\",\\n \\"WorkspaceId\\": \\"“432524”\\",\\n \\"Resource\\": {\\n \\"CPU\\": \\"100\\",\\n \\"Memory\\": \\"100Gi\\",\\n \\"GPU\\": \\"16\\",\\n \\"GPUType\\": \\"GPU\\"\\n },\\n \\"Code\\": \\"roleMaximumResource\\",\\n \\"Reason\\": \\"Current GPU Limit is 5, limited by Role PAI.AlgoDeveloper\\",\\n \\"UseOversoldResource\\": true,\\n \\"Name\\": \\"test-label-79f5498dd-9qrzs\\",\\n \\"WorkloadStatus\\": \\"PreAllocation\\",\\n \\"WorkloadName\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"GmtPositionModifiedTime\\": \\"\\\\\\"2023-06-22T00:00:00Z\\\\\\"\\",\\n \\"CodeType\\": \\"ConfigRule\\",\\n \\"GmtDequeuedTime\\": \\"\\\\\\"2023-06-22T00:00:00Z\\\\\\"\\",\\n \\"WorkspaceName\\": \\"\\",\\n \\"QueueStrategy\\": \\"PaiStrategyIntelligent\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListQuotaWorkloads',
],
'ListTagResources' => [
'summary' => '查标签接口',
'path' => '/api/v1/tags',
'methods' => [
'get',
],
'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' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[\\"rgrk6hhjpvio3wvj\\"]',
],
'required' => false,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestValue',
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'title' => '下一个查询开始Token',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ad31d453a1f3f23ce0b5e8707e68181f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => 'CE22EE94-8AFE-53B5-9C2C-B36207B1CBF9',
],
'NextToken' => [
'title' => '下一个查询开始Token',
'description' => '',
'type' => 'string',
'example' => '3iEiu84Yk3TwHLzJV.usagf1Ain49xYKGoB6zffsDqPYZQQ5',
],
'TagResources' => [
'title' => '资源列表',
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagKey' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'example' => 'tagKey',
],
'TagValue' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'example' => 'tagValue',
],
'ResourceId' => [
'title' => '资源ID',
'description' => '',
'type' => 'string',
'example' => 'rgqssemfn6vjqqev',
],
'ResourceType' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'example' => 'ResourceGroup',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE22EE94-8AFE-53B5-9C2C-B36207B1CBF9\\",\\n \\"NextToken\\": \\"3iEiu84Yk3TwHLzJV.usagf1Ain49xYKGoB6zffsDqPYZQQ5\\",\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"tagKey\\",\\n \\"TagValue\\": \\"tagValue\\",\\n \\"ResourceId\\": \\"rgqssemfn6vjqqev\\",\\n \\"ResourceType\\": \\"ResourceGroup\\"\\n }\\n ]\\n}","type":"json"}]',
],
'TagResources' => [
'summary' => '打标签接口',
'path' => '/api/v1/tags',
'methods' => [
'post',
],
'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' => '',
'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' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[\\"rgqssemfn6vjqqev\\"]',
],
'required' => false,
],
'Tag' => [
'title' => '对应新增标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'key',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'value',
],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求id',
'description' => '',
'type' => 'string',
'example' => '42F23B58-3684-5443-848A-8DA81FF99712',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'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' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[\\"rga2yvifxyicn1rq\\"]',
],
'required' => true,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '对应标签键列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'tagKey',
],
'required' => false,
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'title' => '是否全部删除,只针对tags为空时有效。取值范围: true false True False 默认是 false',
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F082BD0D-21E1-5F9B-81A0-AB07485B03CD',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F082BD0D-21E1-5F9B-81A0-AB07485B03CD\\"\\n}","type":"json"}]',
],
'ListNodes' => [
'summary' => '获取资源节点列表',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'rg69rj0leslwdnbe',
],
],
[
'name' => 'QuotaId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'desc',
],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => [
'description' => '',
'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',
],
],
[
'name' => 'CliqueID',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'FilterByQuotaId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'quotamtl37ge7gkvdz',
],
],
[
'name' => 'FilterByResourceGroupIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg69rj0leslwdnbe',
],
],
[
'name' => 'MachineGroupIds',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ReasonCodes',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HyperZone',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AvailabilityZone',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'PaymentType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'OrderInstanceIds',
'in' => 'query',
'schema' => [
'title' => '订单Id信息',
'type' => 'string',
'example' => '260590501560397',
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HealthRate',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '节点的健康率(健康节点的占比)',
'type' => 'object',
'properties' => [
'operation' => [
'title' => '可选值ge, gte, eq, lte, lt',
'type' => 'string',
],
'value' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
[
'name' => 'HealthCount',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '健康的节点数',
'type' => 'object',
'properties' => [
'operation' => [
'title' => '可选值ge, gte, eq, lte, lt',
'type' => 'string',
],
'value' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
[
'name' => 'LayoutMode',
'in' => 'query',
'schema' => [
'title' => '布局模式',
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求Id',
'description' => '',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'Nodes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/Node',
],
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '23',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Nodes\\": [\\n {\\n \\"CreatorId\\": \\"\\",\\n \\"NodeName\\": \\"\\",\\n \\"NodeType\\": \\"\\",\\n \\"AcceleratorType\\": \\"\\",\\n \\"CPU\\": \\"\\",\\n \\"Memory\\": \\"\\",\\n \\"GPU\\": \\"\\",\\n \\"GPUType\\": \\"\\",\\n \\"GPUMemory\\": \\"\\",\\n \\"NodeStatus\\": \\"\\",\\n \\"ReasonCode\\": \\"\\",\\n \\"ReasonMessage\\": \\"\\",\\n \\"OrderStatus\\": \\"\\",\\n \\"ResourceGroupId\\": \\"\\",\\n \\"ResourceGroupName\\": \\"\\",\\n \\"MachineGroupId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"GmtExpiredTime\\": \\"\\",\\n \\"IsBound\\": true,\\n \\"BoundQuotas\\": [\\n {\\n \\"QuotaId\\": \\"quota12345\\",\\n \\"QuotaName\\": \\"dlc-quota\\"\\n }\\n ],\\n \\"RequestCPU\\": \\"\\",\\n \\"RequestMemory\\": \\"\\",\\n \\"RequestGPU\\": \\"\\",\\n \\"LimitCPU\\": \\"\\",\\n \\"LimitMemory\\": \\"\\",\\n \\"LimitGPU\\": \\"\\",\\n \\"PodNum\\": 0,\\n \\"WorkloadNum\\": 0,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"\\",\\n \\"UserName\\": \\"\\"\\n }\\n ],\\n \\"HyperZone\\": \\"\\",\\n \\"AvailabilityZone\\": \\"\\",\\n \\"AllocatableCPU\\": \\"\\",\\n \\"AllocatableMemory\\": \\"\\",\\n \\"SystemReservedCPU\\": \\"\\",\\n \\"SystemReservedMemory\\": \\"\\",\\n \\"AncestorQuotaWorkloadNum\\": 0,\\n \\"SelfQuotaWorkloadNum\\": 0,\\n \\"DescendantQuotaWorkloadNum\\": 0,\\n \\"DiskPL\\": \\"\\",\\n \\"DiskCapacity\\": 0,\\n \\"SubNodes\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 23\\n}","type":"json"}]',
'title' => 'ListNodes',
],
'GetSpotPriceHistory' => [
'summary' => '获取抢占式实例历史价格',
'path' => '/api/v1/spots/{InstanceType}/pricehistory',
'methods' => [
'get',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'ml.gu7xf.8xlarge-gu108',
],
],
[
'name' => 'SpotDuration',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2024-12-26T09:36:46Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2024-12-30T09:36:46Z',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'GmtCreatedTime' => 'GmtCreatedTime',
],
'example' => 'GmtCreatedTime',
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'asc' => 'asc',
'desc' => 'desc',
],
'example' => 'asc',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '8BDA4440-DD3C-5F4B-BBDD-94A9CE1E75C7',
],
'SpotPriceHistory' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'$ref' => '#/components/schemas/SpotPriceItem',
],
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '194',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'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"}]',
],
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'lingjunxxxx-mgxxx-xxxx',
],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'ResourceGroupId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rgaekzbrflewn6jjq',
],
'Operation' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Cordon',
'enum' => [
'Cordon',
'Uncordon',
'Drain',
],
],
'OperationParameters' => [
'title' => '节点操作参数配置'."\n",
'description' => '',
'required' => false,
'$ref' => '#/components/schemas/NodeOperationParameters',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '96496E6E-00B4-5F55-80F6-1844FA9E92DC',
],
'NodeId' => [
'description' => '',
'type' => 'string',
'example' => 'lingjunxxxx-mgxxx-xxxx',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96496E6E-00B4-5F55-80F6-1844FA9E92DC\\",\\n \\"NodeId\\": \\"lingjunxxxx-mgxxx-xxxx\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
[
'regionId' => 'cn-beijing',
'endpoint' => 'pai.cn-beijing.aliyuncs.com',
],
[
'regionId' => 'cn-wulanchabu',
'endpoint' => 'pai.cn-wulanchabu.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'pai.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'pai.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'pai.cn-shenzhen.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'pai.cn-hongkong.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'pai.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'pai.ap-southeast-3.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'pai.ap-southeast-5.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'pai.eu-central-1.aliyuncs.com',
],
[
'regionId' => 'cn-guangzhou',
'endpoint' => 'pai.cn-guangzhou.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'pai.ap-northeast-1.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'pai.us-east-1.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'pai.us-west-1.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2',
'endpoint' => 'pai.ap-northeast-2.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'pai.cn-shanghai-finance-1.aliyuncs.com',
],
[
'regionId' => 'us-southeast-1',
'endpoint' => 'pai.us-southeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-7',
'endpoint' => 'pai.ap-southeast-7.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'pai.me-east-1.aliyuncs.com',
],
],
];