Get Object Storage object list

Prev Next

Available in Classic and VPC

Get the list of available Object Storage objects.

Note

To get the object list, you must first create a object in the Object Storage service. See the following for how to create a bucket and upload an object.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/objectstorage/bucket/{bucketName}

Request headers

For information about the headers common to all SourceDeploy APIs, see SourceDeploy request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
bucketName String Required Bucket name

Request example

The request example is as follows:

curl --location --request GET 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/objectstorage/bucket/devtool' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Object - Response result
result.objectList Array - Object list

objectList

The following describes objectList.

Field Type Required Description
key String - Object name
size Number - Object size (byte)

Response status codes

For information about the HTTP status codes common to all SourceDeploy APIs, see SourceDeploy response status codes.

Response example

The response example is as follows:

{
    "result": {
        "objectList": [
            {
                "key": "deploy/",
                "size": 0
            },
            {
                "key": "deploy/main.py",
                "size": 121
            },
            {
                "key": "result/build-sample.zip",
                "size": 778
            },
            {
                "key": "sourcebuild_backup/20083240-****-****-****-01f1c6db53a5/build-sample.zip",
                "size": 778
            },
            ...
        ]
    }
}