cfs · 2019-07-19

DescribeCfsFileSystems

POST

Query file systems.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cfs/DescribeCfsFileSystems path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://cfs.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cfs/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cfs.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeCfsFileSystems' \
  -H 'X-TC-Version: 2019-07-19' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
FileSystemId	string	—	File system ID
VpcId	string	—	VPC ID
SubnetId	string	—	Subnet ID
Offset	integer	—	Offset paging number. default 0.
Limit	integer	—	Limit page size. default value 10.
CreationToken	string	—	User-defined name

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
FileSystems	FileSystemInfo[]	File system information
TotalCount	integer	Total number of file systems
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "FileSystems": …,
    "TotalCount": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cfs.

SecretIdSecretKey

Request bodyvalid JSONPOST cfs.api3.convergecloud.com · DescribeCfsFileSystems

{}

Read-only. Creates nothing.

Recorded example response

{
  "FileSystems": [],
  "TotalCount": 0,
  "RequestId": "a9dcdcd7-050a-ddaa-8e97-bb5f099376ec"
}