OAA管理API

スナップショットをDBに格納する。

post

/policy/risk/v1/snapshots

スナップショットは、システムで直接生成するか、バイナリ/zipファイルとしてアップロードすることで、DBに格納できます。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされるメディア・タイプ

application/octet-stream
application/json

ルート・スキーマ : schema

型: binary

ルート・スキーマ : schema

型: object

スナップショット・データ

ソースの表示

createTime: string

スナップショットの作成時間
description: integer

スナップショットの説明
name: string

スナップショットの名前
snapshotId: string

スナップショットの一意の識別子

{
    "type":"object",
    "description":"Snapshot data",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the snapshot"
        },
        "description":{
            "type":"integer",
            "description":"Description of the snapshot"
        },
        "snapshotId":{
            "type":"string",
            "description":"Unique identifier of snapshot"
        },
        "createTime":{
            "type":"string",
            "description":"Create Time of snapshot"
        }
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/xml
application/json

200レスポンス

スナップショット情報。

ルート・スキーマ: SnapshotsResponse

型: object

スナップショット・レスポンス

ソースの表示

message: integer

メッセージ
snapshot: object schema

スナップショット・データ
status: string

ステータス

{
    "type":"object",
    "description":"Snapshot response",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status"
        },
        "message":{
            "type":"integer",
            "description":"Message"
        },
        "snapshot":{
            "type":"object",
            "$ref":"#/components/schemas/SnapshotData",
            "description":"All snapshots that are available."
        }
    }
}

ネストされたスキーマ: schema

型: object

スナップショット・データ

ソースの表示

createTime: string

スナップショットの作成時間
description: integer

スナップショットの説明
name: string

スナップショットの名前
snapshotId: string

スナップショットの一意の識別子

{
    "type":"object",
    "description":"Snapshot data",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the snapshot"
        },
        "description":{
            "type":"integer",
            "description":"Description of the snapshot"
        },
        "snapshotId":{
            "type":"string",
            "description":"Unique identifier of snapshot"
        },
        "createTime":{
            "type":"string",
            "description":"Create Time of snapshot"
        }
    }
}

401レスポンス

未認可

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、DBにスナップショットを作成するサンプルのリクエストとレスポンスを示します。

JSON形式でスナップショットを格納するcURLコマンド

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "name":"A sample snapshot",
    "description": "This is a test sample snapshot"
}'

JSON形式のサンプル・レスポンス

{
    "status": "201",
    "message": "Snapshot created successfully.",
    "snapshot": {
        "name": "A sample snapshot",
        "description": "This is a test sample snapshot",
        "snapshotId": "20101",
        "createTime": "11-17-2021 11:10:38"
    }
}

次の例は、スナップショットZIPファイルの取得を使用して以前にダウンロードしたスナップショットZIPファイルをアップロードするサンプルのリクエストとレスポンスを示します。

JSON形式でスナップショットを格納するcURLコマンド

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/octet-stream' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data-binary '@/scratch/hvellapp/respone_files/snapshot_11122021_163405143.zip'

JSON形式のサンプル・レスポンス

{
    "status": "201",
    "message": "Snapshot created successfully.",
    "snapshot": {
        "name": "A sample SS",
        "description": "This is a test sample SS",
        "snapshotId": "20101",
        "createTime": "11-17-2021 11:10:38"
    }
}

XML形式でスナップショットを格納するcURLコマンド

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <OARMSnapshotData>
     <name>A sample snapshot</name>
     <description>This is a test sample snapshot</description>
 </OARMSnapshotData>
'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <SnapshotResponse>
     <status>201</status>
     <message>Snapshot created successfully.</message>
     <snapshot>
         <name>A sample snapshot</name>
         <description>This is a test sample snapshot</description>
         <snapshotId>20101</snapshotId>
         <createTime>11-17-2021 11:10:38</createTime>
     </snapshot>
 </SnapshotResponse>

XML形式でスナップショットを格納するcURLコマンド

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/octet-stream' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data-binary '@/scratch/hvellapp/respone_files/snapshot_11122021_163405143.zip'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" ?>
 <SnapshotResponse>
     <status>201</status>
     <message>Snapshot created successfully.</message>
     <snapshot>
         <name>A sample SS</name>
         <description>This is a test sample SS</description>
         <snapshotId>20101</snapshotId>
         <createTime>11-17-2021 11:10:38</createTime>
     </snapshot>
 </SnapshotResponse>

先頭に戻る