Object Storageオブジェクトリストの照会

Prev Next

Classic/VPC環境で利用できます。

使用可能な Object Storageオブジェクトリストを照会します。

参考

オブジェクトリストを照会するには、まず Object Storageサービスでバケットを作成してオブジェクトをアップロードする必要があります。バケットの作成とオブジェクトのアップロード方法の詳細は、次をご参照ください。

リクエスト

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

メソッド URI
GET /api/v1/objectstorage/bucket/{bucketName}

リクエストヘッダ

SourceDeploy APIで共通して使用されるヘッダの詳細は、SourceDeployのリクエストヘッダをご参照ください。

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

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

フィールド タイプ 必須の有無 説明
bucketName String Required バケット名

リクエスト例

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

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}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
result Object - レスポンス結果
result.objectList Array - オブジェクトリスト

objectList

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

フィールド タイプ 必須の有無 説明
key String - オブジェクト名
size Number - オブジェクトのサイズ(Byte)

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

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

レスポンス例

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

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