API标准及多语言预置SDK
本产品（pds/2022-03-01）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
Domain管理
|
API |
标题 |
API概述 |
| UpdateDomain | 更新Domain | 更新 domain。 |
| ListDomains | 列举Domain | 列举Domain列表。 |
| GetDomain | 获取Domain | 获取Domain信息。 |
| DeleteDomain | 删除Domain | 删除 domain |
| CreateDomain | 创建Domain | 创建 domain。 |
| SearchDomains | 搜索Domain | 搜索 domain |
认证与授权
|
API |
标题 |
API概述 |
| Authorize | OAuth请求授权 | OAuth2.0请求授权。 |
| Token | 获取访问令牌 | OAuth2.0授权流程的获取访问令牌。 |
账号管理
|
API |
标题 |
API概述 |
| GetLinkInfoByUserId | 根据用户ID获取账号信息 | 根据用户ID获取账号信息。 |
| LinkAccount | 绑定账号 | 绑定账号。 |
| GetLinkInfo | 获取账号信息 | 获取账号信息。 |
| UnLinkAccount | 取消账号关联 | 取消账号绑定。 |
群组管理
|
API |
标题 |
API概述 |
| UpdateGroup | 修改群组信息 | 根据群组ID定位到指定的群组，并修改群组信息。 |
| GetGroup | 获取群组信息 | 获取群组信息。 |
| DeleteGroup | 删除群组 | 删除群组接口， 在删除群组前，需保证群组下没有其他群组或用户，否则会导致删除失败。 |
| CreateGroup | 创建群组 | 创建群组。 |
| ListGroup | 列举群组 | 列举群组。 |
| AddGroupMember | 添加群组成员 | 添加成员到群组。 |
| RemoveGroupMember | 移除群组成员 | 从群组移除成员。 |
| ListGroupMember | 列举群组成员 | 列举团队成员。 |
用户管理
|
API |
标题 |
API概述 |
| GetUser | 获取用户信息 | 获取用户信息。 |
| CreateUser | 创建用户 | 创建用户。 |
| ImportUser | 导入用户 | 导入用户。 |
| UpdateUser | 修改用户信息 | 修改用户信息。 |
| DeleteUser | 删除用户 | 删除用户。 |
| ListUser | 列举用户 | 列举用户。 |
| SearchUser | 搜索用户 | 搜索用户。 |
空间管理
|
API |
标题 |
API概述 |
| DeleteDrive | 删除空间 | 删除空间。 |
| CreateDrive | 创建空间 | 创建空间。 |
| UpdateDrive | 修改空间信息 | 修改空间信息。 |
| GetDrive | 获取空间信息 | 获取空间信息。 |
| ListDrive | 列举空间 | 列举空间。 |
| GetDefaultDrive | 获取缺省空间 | 获取指定用户的缺省空间。 |
| ListMyDrives | 列举我的空间 | 列举登录用户自己的空间列表。 |
| SearchDrive | 搜索空间 | 搜索空间。 |
文件管理
|
API |
标题 |
API概述 |
| ListFile | 列举文件 | 直接文件夹下列举文件和文件夹。 |
| CreateFile | 创建文件或文件夹 | 创建文件或文件夹。 |
| DeleteFile | 删除文件或文件夹 | 删除文件或文件夹。 |
| UpdateFile | 修改文件信息 | 修改文件信息，非数据。 |
| SearchFile | 搜索文件 | 搜索文件。 |
| GetFile | 获取文件详情 | 获取文件详情。 |
| DownloadFile | 下载文件 | 下载文件。 |
| GetUploadUrl | 获取上传地址 | 获取上传地址。 |
| ListUploadedParts | 列举已上传分片 | 列举已上传成功的多段。 |
| CompleteFile | 完成文件上传 | 完成文件上传。 |
| MoveFile | 移动文件或文件夹 | 移动文件或文件夹。 |
| CopyFile | 复制文件或文件夹 | 拷贝文件或目录。 |
| GetDownloadUrl | 获取文件下载地址 | 获取文件下载地址。 |
| FilePutUserTags | 添加文件自定义标签 | 对文件添加自定义标签。 |
| FileDeleteUserTags | 删除文件自定义标签 | 删除文件自定义标签。 |
| VideoDRMLicense | 获取视频DRMLicense | 获取视频的DRM License。 |
文件多版本管理
|
API |
标题 |
API概述 |
| DeleteRevision | 删除历史版本 | 删除历史版本，不支持删除最新版本。 |
| UpdateRevision | 更新版本信息 | 更新版本信息，设置版本为永久保留，或者添加版本描述信息。支持将一个文件的最多50个版本设置为永久保留。 |
| RestoreRevision | 还原历史版本 | 将文件的某个历史版本，还原为文件的最新版本，还原时生成一个新版本，被还原的版本不变。不支持还原最新版本。 |
| ListRevision | 列举版本 | 列举版本信息。 |
| GetRevision | 获取版本信息 | 获取版本详情。 |
增量处理
|
API |
标题 |
API概述 |
| ScanFile | 扫描文件 | 扫描文件。 |
| ListDelta | 列举增量信息 | 列举增量信息。 |
| DeltaGetLastCursor | 获取增量操作游标 | 获取增量操作游标。 |
权限管理
|
API |
标题 |
API概述 |
| ListReceivedFile | 收到的共享文件夹列表 | 收到的共享， 可通过此接口获取到从个人空间授权给此用户的文件列表。 |
| ListMyGroupDrive | 收到的授权团队空间列表 | 列举被授权的团队空间列表。 |
| FileRemovePermission | 取消文件共享授权 | 取消文件共享授权。 |
| FileAddPermission | 文件共享授权给用户或组 | 文件夹授权。单Drive下最多可支持1000条授权记录，超出后授权不生效。 |
| FileListPermission | 列举文件的共享或授权记录 | 列举文件的共享或授权记录。 |
| ListAssignment | 列举已分配的角色列表 | 列举已分配的角色列表。 |
| AssignRole | 分配角色 | 当前支持将用户设置为团队管理员角色。 |
| CancelAssignRole | 取消分配的角色 | 当前仅支持取消团队管理员角色。 |
分享管理
|
API |
标题 |
API概述 |
| CreateShareLink | 创建分享 | 创建分享。 |
| UpdateShareLink | 修改分享 | 修改分享。 |
| SearchShareLink | 搜索分享 | 搜索分享。 |
| CancelShareLink | 取消分享 | 删除分享。 |
| ListShareLink | 列举分享 | 列举分享。 |
| GetShareLink | 获取分享信息 | 获取分享信息。 |
| GetShareLinkByAnonymous | 匿名查看分享信息 | 匿名查看分享信息。 |
| GetShareLinkToken | 获取分享令牌 | 匿名获取分享令牌。 |
回收站管理
|
API |
标题 |
API概述 |
| TrashFile | 放入回收站 | 文件或文件夹放入回收站。 |
| ClearRecyclebin | 清空回收站 | 清空回收站中所有文件和文件夹。 |
| ListRecyclebin | 列举回收站 | 列举回收站。 |
| RestoreFile | 恢复文件或文件夹 | 从回收站恢复文件或文件夹。 |
图像AI管理
|
API |
标题 |
API概述 |
| UpdateFacegroup | 更新人脸分组信息 | 更新人脸分组信息。 |
| ListTags | 列举标签分组 | 列举标签分组。 |
| ListAddressGroups | 列举地点聚类 | 列举地点聚类。 |
| ListFacegroups | 列举人脸分组 | 列举人脸分组。 |
| SearchAddressGroups | 根据地点列表查询地点聚类 | 根据地点列表查询地点聚类。 |
| RemoveFaceGroupFile | 删除人脸分组文件 | 删除人脸分组中的文件。 |
| CreateStory | 创建推荐故事 | 创建推荐故事。 PDS 会根据请求参数中的故事类型和时间范围筛选 drive 空间下的图片和视频，将符合条件的图片、视频加入该故事的文件列表。 若没有符合条件的图片、视频，则会创建空故事。 |
| CreateCustomizedStory | 创建自定义故事 | 创建自定义故事。 区别于推荐故事，自定义故事下面的文件列表由用户指定。 |
| SearchStories | 查询故事列表 | 根据用户指定的条件，查询指定 drive 空间下的故事列表。 |
| GetStory | 获取故事详情 | 获取指定故事详情，包含封面、文件列表等。 |
| UpdateStory | 更新故事 | 更新指定故事的信息，包含名称、标签、自定义 id、封面等。 |
| DeleteStory | 删除故事 | 删除指定故事。 |
| AddStoryFiles | 故事中添加文件 | 给指定故事添加文件。 |
| RemoveStoryFiles | 故事中移除文件 | 移除指定故事中的文件。 |
| CreateSimilarImageClusterTask | 创建相似图片聚类任务 | 用户可以发起创建相似图片聚类任务，该任务会将指定 drive 空间下相似的图片聚类在一起。 |
| GetTaskStatus | 查询任务状态 | 查询增值服务异步任务执行状态。 目前支持的接口有：CreateSimilarImageClusterTask。 |
| SearchSimilarImageClusters | 查询相似图片聚类结果 | 获取指定 drive 空间下的相似图片。 |
在线视频预览
|
API |
标题 |
API概述 |
| GetVideoPreviewPlayMeta | 获取视频播放元信息 | 获取视频播放元信息。 |
| GetVideoPreviewPlayInfo | 获取视频播放信息 | 获取视频播放信息。 |
权益管理
|
API |
标题 |
API概述 |
| CreateIdentityToBenefitPkgMapping | 创建实体和权益包关联 | 创建实体和权益包关联，可用于给用户绑定权益包。 |
| UpdateIdentityToBenefitPkgMapping | 更新实体和权益包关联 | 更新实体和权益包关联，可用于给用户绑定权益包。 |
| GetIdentityToBenefitPkgMapping | 获取实体和权益包关联 | 获取实体和权益包关联，可用于获取用户绑定的权益包。 |
| ListIdentityToBenefitPkgMapping | 列举实体和权益包关联 | 列举实体和权益包关联，可用于获取用户绑定的权益包列表。 |
内容安全管理
|
API |
标题 |
API概述 |
| PunishFile | 处罚文件 | 处罚文件。 |
| InvestigateFile | 审核文件 | 将未经审核的文件送审。 |
| CsiGetFileInfo | 获取文件内容安全详情 | 获取文件的内容安全详情。 |
其他
|
API |
标题 |
API概述 |
| Batch | 批量调用API | 支持批量调用部分API，提升调用效率。 |
| AuditLogExport | 导出审计日志 | 导出审计日志。 |
| ArchiveFiles | 文件打包下载 | 文件打包下载。 |
| GetAsyncTask | 获取异步任务信息 | 获取异步任务信息。 |
该文章对您有帮助吗？