Search Bucket List
    • PDF

    Search Bucket List

    • PDF

    Article summary

    Available in VPC

    Description

    This searches the Object Storage Bucket list.

    • Checks the permission to use the bucket based on the set API authentication key.

    Request

    Request URL

    GET https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/getBucketList/{service-group-instance-no} [KR]
    GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/snapshot/getBucketList/{service-group-instance-no} [SGN]
    

    Request header

    Header nameDescription
    x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
    If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyAccess Key ID value issued on the NAVER Cloud Platform portal
    x-ncp-iam-access-key:{Account Access Key}
    x-ncp-apigw-signature-v2Signature encrypted with the Access Key ID value and Secret Key
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeSpecifies the request body content type as application/json
    Content-Type: application/json

    Request example

    GET https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/getBucketList/1789920
    HOST: vpcsearchengine.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
    x-ncp-apigw-timestamp: 1593848345548
    x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
    
    curl -X GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/getBucketList/1789920 \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
    -H "x-ncp-apigw-timestamp: 1601971222179" \
    -H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4=" 
    

    Response parameter

    public class GetObjectStorageBucketList {
        List<BucketInfo> bucketList;
    }
    
    public class BucketInfo {
        String name;
        Long bytesUsed;
        Long  objectCount;
        Long creationTime;
    }
    

    Response example

    {
      "code": 0,
      "message": "SUCCESS",
      "result": {
        "bucketList": [
          {
            "name": "common",
            "bytesUsed": 8053428730,
            "objectCount": 1174,
            "creationTime": 1626053207541,
            "bucketProtectionState": "DISABLED",
            "permission": "Allow"
          },
          {
            "name": "common2",
            "bytesUsed": 25542177823,
            "objectCount": 227,
            "creationTime": 1626054508184,
            "bucketProtectionState": "DISABLED",
            "permission": "Allow"
          },
          {
            "name": "estest",
            "bytesUsed": 981474971046,
            "objectCount": 11508,
            "creationTime": 1626053041402,
            "bucketProtectionState": "DISABLED",
            "permission": "Allow"
          }
        ]
      },
      "requestId": "d7ea6d82-afcc-4675-886a-f304497ea465"
    }
    

    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.