You need to enable JavaScript to run this app.
导航

请求结构

最近更新时间2023.07.10 11:11:51

首次发布时间2023.07.10 11:11:51

本文介绍文件存储 NAS API 请求的组成结构。

服务地址

文件存储 NAS 产品的 API 服务接入地址为 https://filenas.volcengineapi.com;已开通的地域如下所示。

地域名地域 ID
华北2(北京)cn-beijing
华南1(广州)cn-guangzhou
华东2(上海)cn-shanghai

通信协议

支持通过 HTTP 或 HTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式来发送请求。

请求 URL

您可以通过发送 HTTPS POST 请求来调用 NAS 的 API 服务。HTTPS 请求 URL 的格式如下:

POST {URI-scheme}://{Endpoint}/?Action={Action}&Version={Version} HTTP/1.1

其中:

  • URI-scheme:表示用于传输请求的协议,当前所有 API 均采用 HTTPS 协议。

  • Endpoint:指定承载服务端点的服务器域名或 IP,即服务地址。文件存储 NAS 的服务地址为 https://filenas.volcengineapi.com

  • Action:要执行的操作,此处请填写要调用的 API 接口。文件存储 NAS 的 API 接口请参见 API 概览

  • Version:API 版本号,格式为 YYYY-MM-DD 格式。文件存储 NAS 的 API 版本是 2022-01-01

以创建文件系统为例,未编码的 HTTPS 请求 URL 如下。

https://filenas.volcengineapi.com/?Action=CreateFileSystem&Version=2022-01-01

请求参数

每个 API 请求都包含如下两类参数:

  • 公共请求参数:每个 API 接口都需要使用的参数为公共请求参数。关于公共参数的更多详情,请参见公共参数

  • 接口请求参数:每个 API 接口特有的参数为接口请求。关于各个接口的请求参数,请参见 API 概览中各接口的详细描述。

字符编码

均使用 UTF-8 编码。