Oracle Analytics CloudのためのREST API

スナップショットの削除

delete

/api/20210901/snapshots/{snapshotId}

アナリティクス・インスタンスからスナップショット・リソースを削除します。この操作では、現在Analyticsインスタンスに登録されているスナップショットが登録解除されます。 deleteStorageパラメータがtrueに設定されている場合、削除操作によって、スナップショット(BARファイル)もストレージ(Oracle Cloud Infrastructure (OCI)ストレージなど)から削除されます。

リクエスト

パス・パラメータ

snapshotId(required): string

スナップショットID。

問合せパラメータ

deleteStorage: boolean

trueに設定すると、スナップショットが登録解除され、スナップショットBARファイルがストレージ(Oracle Cloud Infrastructure (OCI)ストレージなど)から削除されます。 falseに設定すると、BARファイルは登録解除されますが、BARファイルはストレージに残ります。

デフォルト値: false

この操作のリクエスト本文がありません。

先頭に戻る

レスポンス

200レスポンス

成功した操作。

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラム解析のためのエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404レスポンス

見つかりません。リクエストされたリソースは見つかりませんでした。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラム解析のためのエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

先頭に戻る

例

これらの例は、Oracle Analyticsインスタンスに関連付けられたスナップショットを削除する方法を示しています。

例1 - スナップショットの登録解除
例2 - スナップショットの登録解除とストレージからの削除

例1 スナップショットの登録解除

この例では、Oracle Analyticsインスタンスに関連付けられているスナップショットを登録解除します。スナップショットのIDはac6fdab7-9c16-4d22-a56f-cb7b5d15505aです。「すべてのスナップショットの取得」を使用してスナップショットIDを検索できます。

ノート:

デフォルトでは、スナップショットに関連付けられたBARファイルは、クラウド・ストレージ( deleteStorage=false)で引き続き使用できます。

cURLの例:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --request DELETE 'https://<hostname>/api/20210901/snapshots/ac6fdab7-9c16-4d22-a56f-cb7b5d15505a'

リクエスト本文の例

Not applicable.

レスポンス本文の例

Not applicable.

例2 スナップショットの登録解除とストレージからの削除

この例では、Oracle Analyticsインスタンスに関連付けられているスナップショットを登録解除し、Oracle Cloud Infrastructure Object Storageからスナップショットを削除します。スナップショットのIDはac6fdab7-9c16-4d22-a56f-cb7b5d15505aです。「すべてのスナップショットの取得」を使用してスナップショットIDを検索できます。

cURLの例:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --request DELETE 'https://<hostname>/api/20210901/snapshots/ac6fdab7-9c16-4d22-a56f-cb7b5d15505a?deleteStorage=true'

リクエスト本文の例

Not applicable.

レスポンス本文の例

Not applicable.

先頭に戻る