Block Storageリストの照会
    • PDF

    Block Storageリストの照会

    • PDF

    記事の要約

    VPC環境で利用できます。

    ブロックストレージの全リストを照会します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/blk-storages

    リクエストヘッダ

    CLOVA NSML APIで共通して使用されるヘッダの詳細は、CLOVA NSMLの共通ヘッダをご参照ください。

    リクエストクエリパラメータ

    リクエストクエリパラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    pageIntegerOptionalページ番号
    • 1(デフォルト)
    pageSizeIntegerOptionalページの出力数
    • 10(デフォルト)

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    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'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    pageInteger-ページ番号
    pageSizeInteger-ページ表示数
    totalCountInteger-レスポンス結果数
    blockStorageMgmtListArray-ブロックストレージリスト

    blockStorageMgmtList

    blockStorageMgmtListの説明は次の通りです。

    フィールドタイプ必須の有無説明
    blockStorageNoInteger-ブロックストレージ番号
    blockStorageNmString-ブロックストレージ名
    projectIdString-プロジェクト ID
    statusString-画像の状態
    • USED | DELETED | DETACHED | CHANGING
      • USED: 使用中
      • DELETED: 削除中
      • DETACHED: 使用可能
      • CHANGING: 変更中
    nodeIdString-ノード ID
    createTimeString-ブロックストレージの作成日時
    updateTimeString-ブロックストレージの更新日時

    レスポンスステータスコード

    CLOVA NSML APIで共通して使用されるレスポンスステータスコードの詳細は、CLOVA NSMLの共通レスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
        "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"
            }
        ]
    }
    

    この記事は役に立ちましたか?

    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.