DescribeNamespaces - 查询命名空间--大数据文件存储-火山引擎

文档中心

立即注册

导航

DescribeNamespaces - 查询命名空间

最近更新时间：2025.01.23 11:36:24首次发布时间：2025.01.23 11:36:24

调用 DescribeNamespaces 接口查询命名空间。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeNamespaces	要执行的操作，取值：DescribeNamespaces。
Version	String	是	2024-08-01	API的版本，取值：2024-08-01。

Body

参数	类型	是否必填	示例值	描述
FileSystemId	String	否	123456	文件系统 ID
FileSystemName	String	否	test	文件系统名称。
NamespaceIds	Array of String	否	["1801439850948**","1801439850948**"]	命名空间 ID 列表。
Descriptions	Array of String	否	["test"]	命名空间描述列表。
TosBucket	String	否	test	命名空间所挂载 TOS 桶。
TosPrefix	String	否	test/	命名空间所挂载 TOS 前缀。
Status	String	否	UP	命名空间状态。
PageNumber	Integer	否	1	分页列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	否	10	每页记录数。取值为 1~100 间的整数，默认为 10。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Namespaces	Array of Object	详情请参见返回示例	命名空间列表。
PageNumber	Integer	1	分页列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	10	每页记录数。取值为 1~100 间的整数，默认为 10。
TotalCount	Integer	1	命名空间总数。

请求示例

POST /?Action=DescribeNamespaces&Version=2024-08-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241203T084207Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241203/cn-beijing/cfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202412031642150201200082004B8E08",
    "Action": "DescribeNamespaces",
    "Version": "2024-08-01",
    "Service": "cfs",
    "Region": "cn-beijing"
  },
  "Result": {
    "Namespaces": [
      {
        "NamespaceId": "123456",
        "FileSystemId": "123456",
        "FileSystemName": "test",
        "NamespaceType": "ACC_TOS",
        "ServiceManaged": false,
        "CreatedTime": "2024-08-01T00:00:00+08:00",
        "UpdatedTime": "2024-08-01T00:00:00+08:00",
        "Status": "UP"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidRequest	Invalid request in request body: %s.	请求体无效。
400	MissingParameter	The required parameter %s is not supplied.	缺少参数。
400	InvalidParameter	The specified parameter %s is not valid.	参数值无效。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。