Get Block Storage list
    • PDF

    Get Block Storage list

    • PDF

    Article summary

    Available in VPC

    Get the list of all block storage.

    Request

    The following describes the request format for the endpoint. The request format is as follows:

    MethodURI
    GET/blk-storages

    Request headers

    For headers common to all CLOVA NSML APIs, see Common CLOVA NSML headers.

    Request query parameters

    The following describes the request query parameters.

    FieldTypeRequiredDescription
    pageIntegerOptionalPage number
    • 1 (default)
    pageSizeIntegerOptionalPage output count
    • 10 (default)

    Request example

    The following is a sample request.

    curl --location --request GET 'https://nsml.apigw.ntruss.com/nsml/v1/blk-storages?page=1&pageSize=5' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'x-ncp-apigw-api-key: {API Key}' \
    --header 'Content-Type: application/json'
    

    Response

    The following describes the response format.

    Response body

    The following describes the response body.

    FieldTypeRequiredDescription
    pageInteger-Page number
    pageSizeInteger-Number of page outputs
    totalCountInteger-Number of response results
    blockStorageMgmtListArray-Block storage list

    blockStorageMgmtList

    The following describes blockStorageMgmtList.

    FieldTypeRequiredDescription
    blockStorageNoInteger-Block storage number
    blockStorageNmString-Block storage name
    projectIdString-Project ID
    statusString-Image status
    • USED | DELETED | DETACHED | CHANGING
      • USED: used
      • DELETED: deleting
      • DETACHED: available
      • CHANGING: changing
    nodeIdString-Node ID
    createTimeString-Block storage creation date and time
    updateTimeString-Block storage update date and time

    Response status codes

    For response status codes common to all CLOVA NSML APIs, see Common CLOVA NSML response status codes.

    Response example

    The following is a sample example.

    {
        "page": 1,
        "pageSize": 5,
        "totalCount": 2,
        "blockStorageMgmtList": [
            {
                "blockStorageNo": 2635****,
                "blockStorageNm": "node-******0lonwq7k******-block-storage",
                "projectId": "******ygz0iujn******",
                "status": "USED",
                "nodeId": "******0lonwq7k******",
                "createTime": "2024-09-03T10:39:07",
                "updateTime": "2024-09-03T10:39:07"
            },
            {
                "blockStorageNo": 2635****,
                "blockStorageNm": "node-******nstkot26******-block-storage",
                "projectId": "******ygz0iujn******",
                "status": "DETACHED",
                "createTime": "2024-09-03T10:25:41",
                "updateTime": "2024-09-03T10:38:52"
            }
        ]
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.