• Data Warehouse Service

dws
  1. Help Center
  2. Data Warehouse Service
  3. API Reference
  4. API Description
  5. Snapshot Management APIs
  6. Querying Snapshot Details

Querying Snapshot Details

Function

This API is used to query snapshot details by using the snapshot ID.

URI

  • URI format

    GET /v1.0/{project_id}/snapshots/{snapshot_id}

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    snapshot_id

    Yes

    String

    Snapshot ID

Request

Sample request

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/b5c45780-1006-49e3-b2d5-b3229975bbc7

Response

  • Sample response
    STATUS CODE 200
    {
        "snapshot": {
            "id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
            "name": "snapshot-1",
            "description": "snapshot description",
            "started": "2016-08-23T03:59:23Z",
            "finished": "2016-08-23T04:01:40Z", 
            "size": 500,
            "status": "AVAILABLE",
            "type": "MANUAL",
            "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
        }
    }
  • Parameter description
    Table 2 Response parameter description

    Parameter

    Mandatory

    Type

    Description

    snapshot

    Yes

    Object

    Snapshot object

    name

    Yes

    String

    Snapshot name

    Id

    Yes

    String

    Snapshot ID

    description

    Yes

    String

    Snapshot description

    started

    Yes

    String

    Time when a snapshot is being created. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.

    finished

    Yes

    String

    Time when a snapshot has been created. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.

    size

    Yes

    Double

    Snapshot size, expressed in GB.

    status

    Yes

    String

    Snapshot status, which can be one of the following:

    • CREATING
    • AVAILABLE
    • UNAVAILABLE

    type

    Yes

    String

    Snapshot creation type. Currently, only MANUAL is supported.

    cluster_id

    Yes

    String

    ID of the cluster for which a snapshot is created

Returned Value

  • Normal

    200

  • Abnormal
    Table 3 Returned value description

    Returned Value

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    You do not have the rights to perform the operation.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    The service is unavailable.