全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

API概览列表

训练与推理 > 开发任务

接口名称Open API描述
保存开发任务镜像
SaveNotebookImage
保存开发任务镜像
修改开发任务
ModifyNotebook
修改开发任务
删除开发任务
DeleteNotebook
删除开发任务
查询开发任务
DescribeNotebooks
查询开发任务
创建开发任务
CreateNotebook
创建开发任务
停止开发任务
StopNotebook
停止开发任务
启动开发任务
StartNotebook
启动开发任务
获取开发任务连接地址
GetWebIdeUrl
获取开发任务连接地址
查询开发任务事件列表
DescribeNotebookEvents
查询开发任务事件列表
查看开发机日志
DescribeNotebookLog
查看开发机的pod日志
终止开发任务镜像保存
StopNotebookSavingImage
终止开发任务镜像保存

训练与推理 > 训练任务

接口名称Open API描述
查询训练任务事件
DescribeTrainJobEvents
查询训练任务pod事件
关停训练任务
StopTrainJob
关停训练任务
启动训练任务
StartTrainJob
启动训练任务
删除训练任务
DeleteTrainJob
删除训练任务
修改训练任务
ModifyTrainJob
修改训练任务
查询训练任务pod日志
DescribeTrainJobPodLogs
查询训练任务pod日志
查询训练任务pod列表
DescribeTrainJobPods
查询训练任务pod列表
创建训练任务 (支持多规格)
CreateTrainJob
创建训练任务
查询训练任务(新)
DescribeTrainJobs
查询训练任务
查询训练任务及Pod事件列表
DescribeTrainJobAndPodEvents
查询训练任务及Pod事件列表

训练与推理 > 模型在线服务

接口名称Open API描述
创建推理服务
CreateInference
创建推理服务
获取预定义模型列表
GetInferenceModels
获取预定义模型列表
查询推理服务日志
GetInferenceLogs
查询推理服务日志
获取推理服务自动扩缩容规则
GetInferenceAutoScaleStrategy
获取推理服务自动扩缩容规则
查询模型在线服务
DescribeInferences
查询模型在线服务
配置自动扩缩容配置
SetInferenceAutoScaleStrategy
配置自动扩缩容配置
删除模型在线服务
DeleteInference
删除模型在线服务
停止模型在线服务
StopInference
停止模型在线服务
获取模型在线服务详情
GetInferenceDetail
获取模型在线服务详情
启动模型在线服务
StartInference
启动模型在线服务
修改模型在线服务信息
ModifyInference
修改模型在线服务信息
手动扩缩容
SetInferenceReplicas
手动扩缩容
查询模型在线服务Pod列表
DescribeInferencePods
查询模型在线服务Pod列表
查询模型在线服务及Pod事件列表
DescribeInferenceAndPodEvents
查询模型在线服务及Pod事件列表

API服务管理 > API Key管理

接口名称Open API描述
启用 API Key
EnableApikeyStatus
启用 API Key
编辑API Key
ModifyApikey
编辑API Key
删除API Key
DeleteApikey
删除API Key
创建API Key
CreateApikey
创建API Key
查询API Key列表(分页)
DescribeApikeys
查询API Key列表(分页)
禁用API Key
DisableApikeyStatus
禁用API Key
创建接入点
CreateInferenceEndpoint
创建接入点
查询接入点
DescribeInferenceEndpoints
查询接入点
获取用户报价规则
GetAccountBillRules
获取用户报价规则

API服务管理 > 模型用量监控

接口名称Open API描述
查询模型API token用量
QueryTokenData
查询模型API token用量
创建查询用量任务
CreateUsageDownloadTask
创建查询用量任务
下载查询用量任务
GetUsageDownloadTask
下载查询用量任务

API服务管理 > 模型广场

接口名称Open API描述
查询模型列表(支持分页)
DescribeModels
查询模型列表(支持分页)
查询模型详情
GetModelDetail
查询模型详情
查询模型类别
DescribeModelTypes
查询模型类别

API服务管理 > 批量推理

接口名称Open API描述
查询批量推理任务最终结果下载链接
GetBatchInferenceJobsFinalResultDownloadUrl
查询批量推理任务最终结果下载链接
查询批量推理任务Ks3鉴权信息
DescribeInferenceJobsKs3AuthInfo
查询批量推理任务Ks3鉴权信息
终止批量推理任务
StopBatchInferenceJob
终止批量推理任务
创建批量推理任务
CreateBatchInferenceJob
创建批量推理任务
更新批量推理任务(修改jobName和jobDesc)
ModifyBatchInferenceJob
更新批量推理任务(修改jobName和jobDesc)
查询批量推理任务(支持分页,按创建用户过滤)
DescribeBatchInferenceJobs
查询批量推理任务(支持分页,按创建用户过滤)
删除批量推理任务
DeleteBatchInferenceJob
删除批量推理任务

API服务管理 > 额度及开通管理

接口名称Open API描述
启用对应模型
EnableModels
开通模型,支持批量
查询模型配额列表
DescribeModelQuotas
查询模型配额列表
禁用对应模型
DisableModels
禁用对应模型
开启超免额禁用
EnableOverFreeLimit
免费配额用完后禁用对应模型
禁用超免额后禁用功能
DisableOverFreeLimit
即免费配额用完后继续使用计费配额

API服务管理 > 服务状态及开通管理

接口名称Open API描述
开通API服务
ActivateApiService
开通模型API服务
查询API服务开通状态
GetApiService
查询API服务开通状态

API服务管理 > 在线推理

接口名称Open API描述
开启接入点限流
EnableEndpointRateLimit
开启接入点限流
开启接入点
StartInferenceEndpoint
开启接入点
关闭接入点
StopInferenceEndpoint
关闭接入点
删除接入点
DeleteInferenceEndpoint
删除接入点
关闭接入点限流
DisableEndpointRateLimit
关闭接入点限流
开启配额限制
EnableEndpointQuotaLimit
开启配额限制
关闭配额限制
DisableEndpointQuotaLimit
关闭配额限制

API服务管理 > 模型微调

接口名称Open API描述
查询模型微调任务及Pod事件列表
DescribeFineTuneJobAndPodEvents
查询模型微调任务及Pod事件列表

资源管理 > 资源组

接口名称Open API描述
创建资源池
CreateResourcePool
创建资源池
开启或者关闭klog服务
EnableKlog
开启或者关闭klog服务
修改资源池控件
ModifyComponents
修改资源池控件
查询资源组列表
DescribeResourcePools
查询资源组列表
查询资源组节点列表
DescribeResourcePoolInstances
查询资源组节点列表
开启安装kpfs组件
EnableKpfsComponent
开启安装kpfs组件
查询节点上运行的任务
DescribeResourcePoolInstanceTasks
查询节点上运行的任务
修改资源组
ModifyResourcePool
修改资源组

资源管理 > 队列

接口名称Open API描述
修改队列关停策略
ModifyTerminatePolicy
修改队列关停策略
查询队列关停策略
DescribeTerminatePolicy
查询队列关停策略
创建队列关停策略
CreateTerminatePolicy
创建队列关停策略
删除队列关停策略
DeleteTerminatePolicy
删除队列关停策略
查询队列列表
DescribeQueues
查询资源组队列
创建队列
CreateQueue
创建资源组队列
修改队列
ModifyQueue
修改资源组队列
删除队列
DeleteQueue
删除队列接口
添加队列成员
AddQueueAccessUser
添加队列成员
移出队列成员
RemoveQueueAccessUser
移出队列成员
查询队列子用户资源使用信息
GetQueueMember
查询队列子用户资源使用信息
查询清理策略记录列表
DescribeTerminateStopRecords
查询清理策略记录列表

公共资产管理 > 镜像

接口名称Open API描述
新建自定义镜像
CreateImage
新建自定义镜像
删除自定义镜像
DeleteImage
删除自定义镜像
修改自定义镜像
ModifyImage
修改自定义镜像
查询镜像列表
DescribeImages
查询镜像列表
配置个人版镜像仓库访问凭证
SetKcrPersonalToken
配置个人版镜像仓库访问凭证

公共资产管理 > 模型

接口名称Open API描述
更新模型访问权限
ModifyModelAccess
更新模型访问权限
创建模型及版本
CreateModelAndVersion
创建模型及版本
更新模型
ModifyModel
更新模型信息
查询模型列表
DescribeModels
查询模型列表
删除模型
DeleteModel
删除指定模型
创建模型版本
CreateModelVersion
创建推理模型版本
删除模型版本
DeleteModelVersion
删除模型版本
更新模型版本
ModifyModelVersion
更新模型版本
查询模型版本
DescribeModelVersions
查询模型版本
描述模型格式及框架
DescribeFormatAndFrameworks
描述模型格式及框架

公共资产管理 > 存储配置

接口名称Open API描述
创建存储配置
CreateStorageConfig
创建存储配置
修改存储配置
ModifyStorageConfig
修改存储配置
查询存储配置
DescribeStorageConfigs
查询存储配置
删除储存配置
DeleteStorageConfig
删除存储配置

模型应用 > 知识库

接口名称Open API描述
查询模型列表
DescribeKnowledgeBaseModels
查询模型列表
开通知识库服务
ActivateKnowledgeBaseService
开通知识库服务
知识库检索
RetrieveKnowledge
知识库检索
获取切片详情
DescribeChunk
获取切片详情
批量获取文档索引状态
BatchDisplayStatus
批量获取文档索引状态
获取文档索引状态
DisplayStatus
获取文档索引状态
获取文档嵌入状态
IndexingStatus
获取文档嵌入状态
删除知识库文档
DeleteDocument
删除知识库文档
获取文档详情
DescribeDocument
获取文档详情
查看知识库文档列表
DescribeDocuments
查看知识库文档列表
创建文档
ImportDocuments
创建知识库文档
删除知识库
DeleteKnowledgeBase
删除知识库
修改知识库配置
ModifyKnowledgeBase
修改知识库配置
查看知识库详情
DescribeKnowledgeBase
查看知识库详情
查看知识库列表
DescribeKnowledgeBases
查看知识库列表
创建知识库
CreateKnowledgeBase
创建知识库
知识库检索历史记录
RetrieveHistories
知识库检索历史记录
重索引知识库文档
ReindexDocuments
重索引知识库文档
修改知识库文档状态
ModifyDocumentStatus
修改知识库文档状态
查看知识库模型用量监控信息
DescribeKnowledgeTokenMonitor
查看知识库模型用量监控信息
查看知识库存储用量监控信息
DescribeKnowledgeStorageMonitor
查看知识库存储用量监控信息

模型应用 > 记忆库

接口名称Open API描述
向指定记忆库写入记忆
CreateMemorySdk
向指定记忆库写入记忆
从记忆库检索记忆
QueryMemorySdk
从记忆库检索记忆
创建记忆库
CreateMemoryCollection
创建记忆库
查询记忆库详情
GetMemoryCollection
查询记忆库详情
批量查询记忆库详情
ListMemoryCollections
批量查询记忆库详情
删除记忆库
DeleteMemoryCollection
删除记忆库
查询记忆库服务状态
GetMemoryBaseService
查询记忆库服务状态
开通记忆库服务
ActivateMemoryBaseService
开通记忆库服务
修改记忆库信息
UpdateMemoryCollection
修改记忆库信息
查询会话列表
ListSessions
查询会话列表
创建会话
AddSession
创建记忆会话
查询记忆库监控指标
QueryMemoryCollectionMetrics
查询指定记忆库的监控指标时间序列数据
查询会话记忆
QuerySessionMemories
查询会话记忆
查看记忆库模型用量监控信息
DescribeMemoryTokenMonitor
查看记忆库模型用量监控信息
查看记忆库存储用量监控信息
DescribeMemoryStorageMonitor
查看记忆库存储用量监控信息
查询记忆列表
ListMemories
记忆列表信息

模型应用 > MCP

接口名称Open API描述
删除自定义MCP服务
DeleteMcpServer
删除自定义MCP服务
修改自定义MCP服务
ModifyMcpServer
修改自定义MCP服务
创建自定义MCP服务
CreateMcpServer
创建自定义MCP服务
查询自定义MCP服务
DescribeMcpServers
查询自定义MCP服务
查询MCP官方服务
DescribeMcpOfficialServers
查询MCP官方服务
取消MCP官方服务
DeactivateMcpOfficialServer
取消MCP官方服务
激活MCP官方服务
ActivateMcpOfficialServer
激活MCP官方服务
查询MCP广场
DescribeMcpSquares
查询MCP广场
查询MCP官方服务详情
GetMcpOfficialServerDetail
查询MCP官方服务详情
查询自定义MCP服务详情
GetMcpServerDetail
查询自定义MCP服务详情
查询MCP广场详情
GetMcpSquareDetail
查询MCP广场详情
查询云产品OpenAPI详情
GetApiDetail
查询云产品OpenAPI详情
查询云产品OpenAPI概览列表
GetApiOverview
查询云产品OpenAPI概览列表
查询云产品列表
GetProductList
查询云产品列表
查询MCP运行监控
DescribeMcpRuntimeMetrics
查询MCP运行监控(只有部署方式为代码方式部署的MCP才有)
查询MCP服务调用监控信息
QueryMcpMetrics
查询MCP服务调用监控信息
查看MCP运行时日志
DescribeMcpRuntimeLogs
查看MCP运行时日志

模型应用 > 沙箱SandBox

接口名称Open API描述
创建沙箱模板
CreateSandboxTemplate
创建沙箱模板
更新沙箱模板
UpdateSandboxTemplate
更新沙箱模板
删除沙箱实例
DeleteSandboxInstance
删除沙箱实例
获取沙箱实例信息
GetSandboxInstance
获取沙箱实例信息
查询沙箱实例列表
GetSandboxInstanceList
查询沙箱实例列表
查询沙箱模板列表
GetSandboxTemplateList
查询沙箱模板列表
启动沙箱实例
StartSandboxInstance
启动沙箱实例
删除沙箱模板
DeleteSandboxTemplate
删除沙箱模板
获取沙箱模板详情
GetSandboxTemplate
获取沙箱模板详情
获取公共镜像
GetPublicImageList
获取公共镜像列表
更新沙箱实例
UpdateSandboxInstance
更新沙箱实例
文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈