• Scalable File Service

sfs
  1. Help Center
  2. Scalable File Service
  3. API Reference
  4. SFS APIs
  5. Querying API Versions
  6. Querying All API Versions

Querying All API Versions

Function

This interface is used for querying all API versions.

NOTE:

You do not need to authenticate this interface.

URI

  • GET /
  • Parameter description

None

Request

  • Parameter description

    None

  • Example request

    None

Response

  • Parameter description

    Parameter

    Type

    Description

    versions

    list<version>

    List objects of all available API versions

  • Description of field version

    Parameter

    Type

    Description

    id

    string

    Common name of the version

    status

    string

    API version status, including:

    • Current version: preferred choice for the current API
    • Supported version: previous version but still available for the current API
    • Obsolete version: version to be deleted and discarded by the current API

    links

    array

    Share links

    media-types

    object

    Media type supported by the API

    version

    string

    If the API in the current version supports microversions, here the version is the latest microversion. If microversions are not supported, here the min_version is empty.

    min_version

    string

    If the API in the current version supports microversions, here the min_version is the earliest microversion. If microversions are not supported, here the min_version is empty.

  • Example response
    {
      "versions": [
        {
          "status": "CURRENT",
          "updated": "2015-08-27T11:33:21Z",
          "links": [
            {
              "href": "http://docs.openstack.org/",
              "type": "text/html",
              "rel": "describedby"
            },
            {
              "href": "https://sfs.region.www.t-systems.com/v2/",
              "rel": "self"
            }
          ],
          "min_version": "2.0",
          "version": "2.28",
          "media-types": [
            {
              "base": "application/json",
              "type": "application/vnd.openstack.share+json;version=1"
            }
          ],
          "id": "v2.0"
        }
      ]
    }

Status Codes

  • Normal

    202 or 300

  • Abnormal

    Status Code

    Description

    400 Bad Request

    The server failed to process the request.

    400 Bad Request

    Invalid input: The post-deduction capacity must be larger than 0 and smaller than the current capacity. (Current capacity: XX; post-deduction capacity: XX)

    400 Bad Request

    Invalid input: The post-expansion capacity must be larger than the current capacity. (Current capacity: XX; post-expansion capacity: XX)

    401 Unauthorized

    You must enter a username and the password to access the requested page.

    403 Forbidden

    You are forbidden to access the requested page.

    404 Not Found

    The requested page was not found.

    405 Method Not Allowed

    You are not allowed to use the method specified in the request.

    406 Not Acceptable

    The response generated by the server could not be accepted by the client.

    407 Proxy Authentication Required

    You must use the proxy server for authentication. Then the request can be processed.

    408 Request Timeout

    The request timed out.

    409 Conflict

    The request could not be processed due to a conflict.

    500 Internal Server Error

    The request is not completed because of a service error.

    501 Not Implemented

    The request is not completed because the server does not support the requested function.

    502 Bad Gateway

    The request is not completed because the request is invalid.

    503 Service Unavailable

    The request is not completed because the service is unavailable.

    504 Gateway Timeout

    A gateway timeout error occurred.