API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(PAILangStudio/2024-07-10)的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

运行时

API

标题

API概述

CreateRuntime 创建运行时 创建一个运行时
UpdateRuntime 更新运行时 更新运行时。
GetRuntime 获取运行时详情 获取运行时的详情。
ListRuntimes 获取运行时列表 获取运行时列表。
DeleteRuntime 删除运行时 删除运行时。

部署任务

API

标题

API概述

CreateDeployment 创建部署任务 创建部署任务。
GetDeployment 获取部署任务详情 获取部署任务详情。
UpdateDeployment 更新部署任务 更新部署任务。
ListDeployments 获取部署任务列表 获取部署任务列表。
DeleteDeployment 删除部署任务 删除部署任务。

快照管理

API

标题

API概述

CreateSnapshot 创建快照 创建一个快照。
GetSnapshot 获取快照详情 获取快照详情。
UpdateSnapshot 更新快照 更新快照。
ListSnapshots 获取快照列表 获取快照列表。
DeleteSnapshot 删除快照 删除快照。

知识库

API

标题

API概述

CreateKnowledgeBase 创建知识库 创建一个知识库。
GetKnowledgeBase 获取知识库 获取知识库。
UpdateKnowledgeBase 更新知识库 更新知识库。
DeleteKnowledgeBase 删除知识库 删除知识库。
ListKnowledgeBases 获取知识库列表 获取知识库列表。
RetrieveKnowledgeBase 检索知识库 检索知识库。
CreateKnowledgeBaseJob 创建知识库任务 创建知识库任务。
GetKnowledgeBaseJob 获取知识库任务 获取知识库任务。
UpdateKnowledgeBaseJob 更新知识库任务 更新知识库任务。
DeleteKnowledgeBaseJob 删除知识库任务 删除知识库任务。
ListKnowledgeBaseJobs 获取知识库任务列表 获取知识库任务列表。
UpdateKnowledgeBaseChunk 更新知识库切片 更新知识库切片。
ListKnowledgeBaseChunks 获取知识库切片列表 获取知识库切片列表。