1. 接口描述
接口请求域名: cfs.tencentcloudapi.com 。
本接口(DescribeCfsFileSystems)用于查询文件系统
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCfsFileSystems。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
FileSystemId | 否 | String | 文件系统 ID 示例值:cfs-12345 |
VpcId | 否 | String | 私有网络(VPC) ID 示例值:vpc-12345 |
SubnetId | 否 | String | 子网 ID 示例值:subnet-12345 |
Offset | 否 | Integer | Offset 分页码 示例值:10 |
Limit | 否 | Integer | Limit 页面大小 示例值:10 |
CreationToken | 否 | String | 用户自定义名称 示例值:test_fs |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FileSystems | Array of FileSystemInfo | 文件系统信息 |
TotalCount | Integer | 文件系统总数 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询文件系统
查询文件系统
输入示例
POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfsFileSystems
<公共请求参数>
{
"FileSystemId": "cfs-12345"
}
输出示例
{
"Response": {
"FileSystems": [
{
"CreationTime": "abc",
"CreationToken": "abc",
"FileSystemId": "abc",
"LifeCycleState": "abc",
"SizeByte": 1,
"SizeLimit": 1,
"ZoneId": 1,
"Zone": "abc",
"Protocol": "abc",
"StorageType": "abc",
"StorageResourcePkg": "abc",
"BandwidthResourcePkg": "abc",
"PGroup": {
"PGroupId": "abc",
"Name": "abc"
},
"FsName": "abc",
"Encrypted": true,
"KmsKeyId": "abc",
"AppId": 0,
"BandwidthLimit": 0,
"AutoSnapshotPolicyId": "abc",
"SnapStatus": "abc",
"Capacity": 1,
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"TieringState": "abc",
"TieringDetail": {
"TieringSizeInBytes": 0
},
"AutoScaleUpRule": {
"Status": "abc",
"ScaleThreshold": 1,
"TargetThreshold": 1
}
}
],
"TotalCount": 1,
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 请求未CAM授权。 |
InternalError | 内部错误。 |
InternalError.GetAccountStatusFailed | 获取用户费用状态失败。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.InvalidFileSystemId | FileSystemId无效。 |
InvalidParameterValue.MissingFileSystemIdOrRegion | 用户参数选择错误 (FileSystemId) 或 (Region)二者必选一。 |
InvalidParameterValue.MissingFsParameter | FileSystem参数缺失。 |
InvalidParameterValue.TagKeyFilterLimitExceeded | 参数值错误: 标签键个数超过上限(6个)。 |
InvalidParameterValue.TagKeyLimitExceeded | 标签键长度超过限制(不能超过127字节)。 |
InvalidParameterValue.UnavailableRegion | 该可用区无法提供服务。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.OutOfService | 用户已欠费, 请充值后重试。 |
UnsupportedOperation.UnverifiedUser | 用户未经过实名认证。 |