Oracle Analytics CloudのためのREST API

機械翻訳について

すべてのスナップショットの取得

get

/api/20210901/snapshots

単一のアナリティクス・インスタンスのすべての既知のスナップショットのリストを返します。つまり、Oracle Cloud Infrastructureストレージのスナップショットは、REST APIを使用して作成または登録されます。

リクエスト

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

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作。

ルート・スキーマ: schema

Type: object

ソースを表示

items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snapshot"
            }
        }
    }
}

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

Type: array

ソースを表示

Array of: object Snapshot

スナップショットを表すオブジェクト。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snapshot"
    }
}

ネストされたスキーマ : スナップショット

Type: object

スナップショットを表すオブジェクト。

ソースを表示

bar(required): object Bar

スナップショットBARファイル。
createdByUser(required): string

スナップショットを作成したユーザー。
id(必須): string

スナップショットのID。
name(required): string

スナップショットの名前。
storage(required): 識別子: type

識別子 : { "propertyName":"type", "mapping":{ "OCI_NATIVE":"#/components/schemas/OCINativeStorage" } }
timeCreated(required): string (日時)

スナップショットが作成された時間。

{
    "description":"Object which represents a snapshot.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the snapshot."
        },
        "name":{
            "type":"string",
            "description":"Name of the snapshot."
        },
        "createdByUser":{
            "type":"string",
            "description":"User who created the snapshot."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time the snapshot was created."
        },
        "storage":{
            "$ref":"#/components/schemas/StorageOneOf"
        },
        "bar":{
            "$ref":"#/components/schemas/Bar"
        }
    },
    "required":[
        "id",
        "name",
        "createdByUser",
        "timeCreated",
        "storage",
        "bar"
    ]
}

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

Type: object

スナップショットBARファイル。

ソースを表示

uri: string

ストレージ内のBARファイルのURI。

{
    "description":"Snapshot BAR file.",
    "type":"object",
    "properties":{
        "uri":{
            "type":"string",
            "description":"URI of the BAR file in storage."
        }
    }
}

ネストされたスキーマ : Discriminator: type

Type: object

識別子: type

弁別子の値

OCI_NATIVE

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCINativeStorage"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OCI_NATIVE":"#/components/schemas/OCINativeStorage"
        }
    }
}

1つのスキーマに一致

ソースを表示

OCINativeStorage

Oracle Cloud Infrastructure (OCI)ストレージの詳細。

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCINativeStorage"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OCI_NATIVE":"#/components/schemas/OCINativeStorage"
        }
    }
}

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

Oracle Cloud Infrastructure (OCI)ストレージの詳細。

すべてに一致

Oracle Cloud Infrastructure (OCI)ストレージの詳細。

ソースを表示

object 「ストレージ」

記憶域詳細
object OCINativeStorage-allOf[1]

{
    "description":"Oracle Cloud Infrastructure (OCI) storage details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Storage"
        },
        {
            "type":"object",
            "properties":{
                "bucket":{
                    "type":"string",
                    "description":"Name of a storage bucket in OCI object storage."
                },
                "bucketOciRegion":{
                    "type":"string",
                    "description":"Region where the storage bucket exists. Only required when the bucket is located in a different region."
                },
                "bucketOciNamespace":{
                    "type":"string",
                    "description":"Namespace where the storage bucket exists. Only required when the bucket is located in a different tenancy."
                }
            }
        }
    ]
}

ネストされたスキーマ : ストレージ

Type: object

記憶域詳細

ソースを表示

auth(required): 識別子: type

識別子: { "propertyName":"type", "mapping":{ "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth", "OCI_RESOURCE_PRINCIPAL":"#/components/schemas/OCIResourcePrincipalAuth" } }
type(required): string

許容値: [ "OCI_NATIVE" ]

記憶域のタイプ。

{
    "description":"Storage details.",
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/StorageType"
        },
        "auth":{
            "$ref":"#/components/schemas/AuthOneOf"
        }
    },
    "required":[
        "type",
        "auth"
    ]
}

ネストされたスキーマ : OCINativeStorage-allOf[1]

Type: object

ソースを表示

bucket: string

OCIオブジェクト・ストレージのストレージ・バケットの名前。
bucketOciNamespace: string

ストレージ・バケットが存在するネームスペース。バケットが別のテナンシにある場合にのみ必要です。
bucketOciRegion: string

ストレージ・バケットが存在するリージョン。バケットが別のリージョンにある場合にのみ必要です。

{
    "type":"object",
    "properties":{
        "bucket":{
            "type":"string",
            "description":"Name of a storage bucket in OCI object storage."
        },
        "bucketOciRegion":{
            "type":"string",
            "description":"Region where the storage bucket exists. Only required when the bucket is located in a different region."
        },
        "bucketOciNamespace":{
            "type":"string",
            "description":"Namespace where the storage bucket exists. Only required when the bucket is located in a different tenancy."
        }
    }
}

ネストされたスキーマ : Discriminator: type

Type: object

識別子: type

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCIUserIdAuth"
        },
        {
            "$ref":"#/components/schemas/OCIResourcePrincipalAuth"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth",
            "OCI_RESOURCE_PRINCIPAL":"#/components/schemas/OCIResourcePrincipalAuth"
        }
    }
}

1つのスキーマに一致

ソースを表示

OCIUserIdAuth

非推奨のOracle Cloud Infrastructure (OCI)ユーザーID認証の詳細。 [API署名の生成方法Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two)]を参照してください。
OCIResourcePrincipalAuth

Oracle Cloud Infrastructure (OCI)リソース・プリンシパル認証の詳細。

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCIUserIdAuth"
        },
        {
            "$ref":"#/components/schemas/OCIResourcePrincipalAuth"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth",
            "OCI_RESOURCE_PRINCIPAL":"#/components/schemas/OCIResourcePrincipalAuth"
        }
    }
}

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

非推奨のOracle Cloud Infrastructure (OCI)ユーザーID認証の詳細。 [API署名の生成方法Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two)]を参照してください。

すべてに一致

ソースを表示

object 「認証」

認証の詳細。
object OCIUserIdAuth-allOf[1]

{
    "deprecated":true,
    "description":"Deprecated, Oracle Cloud Infrastructure (OCI) user ID authentication details. See [How to Generate an API Signing Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two).",
    "allOf":[
        {
            "$ref":"#/components/schemas/Auth"
        },
        {
            "type":"object",
            "properties":{
                "ociRegion":{
                    "type":"string",
                    "description":"Name of the OCI region."
                },
                "ociTenancyId":{
                    "type":"string",
                    "description":"OCID of the tenancy."
                },
                "ociUserId":{
                    "type":"string",
                    "description":"OCID of the user."
                },
                "ociKeyFingerprint":{
                    "type":"string",
                    "description":"Fingerprint of the public key."
                },
                "ociPrivateKeyWrapped":{
                    "type":"string",
                    "description":"Base64URL encoded private key."
                }
            }
        }
    ],
    "required":[
        "ociRegion",
        "ociTenancyId",
        "ociUserId"
    ]
}

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

Oracle Cloud Infrastructure (OCI)リソース・プリンシパル認証の詳細。

すべてに一致

Oracle Cloud Infrastructure (OCI)リソース・プリンシパル認証の詳細。

ソースを表示

object 「認証」

認証の詳細。
object OCIResourcePrincipalAuth-allOf[1]

{
    "description":"Oracle Cloud Infrastructure (OCI) Resource Principal authentication details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Auth"
        },
        {
            "type":"object"
        }
    ]
}

ネストされたスキーマ : 認証

Type: object

認証の詳細。

ソースを表示

type(required): string

許容値: [ "OSS_AUTH_OCI_USER_ID", "OCI_RESOURCE_PRINCIPAL" ]

認証のタイプ。

{
    "description":"Authentication details.",
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/AuthType"
        }
    },
    "required":[
        "type"
    ]
}

ネストされたスキーマ : OCIUserIdAuth-allOf[1]

Type: object

ソースを表示

ociKeyFingerprint: string

公開キーのフィンガープリント。
ociPrivateKeyWrapped: string

Base64URLエンコードされた秘密キー。
ociRegion: string

OCIリージョンの名前。
ociTenancyId: string

テナンシのOCID。
ociUserId: string

ユーザーのOCID。

{
    "type":"object",
    "properties":{
        "ociRegion":{
            "type":"string",
            "description":"Name of the OCI region."
        },
        "ociTenancyId":{
            "type":"string",
            "description":"OCID of the tenancy."
        },
        "ociUserId":{
            "type":"string",
            "description":"OCID of the user."
        },
        "ociKeyFingerprint":{
            "type":"string",
            "description":"Fingerprint of the public key."
        },
        "ociPrivateKeyWrapped":{
            "type":"string",
            "description":"Base64URL encoded private key."
        }
    }
}

ネストされたスキーマ : OCIResourcePrincipalAuth-allOf[1]

Type: object

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"
    ]
}

先頭に戻る

例

この例では、使用可能なすべてのスナップショットの詳細を取得します。

cURLの例:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --request GET 'https://<hostname>/api/20210901/snapshots'

リクエスト本文の例

Not applicable.

レスポンス本文の例

Status 200:

{

  "items": [

    {

      "id": "ac6fdab7-9c16-4d22-a56f-cb7b5d15505a",

      "name": "myfirstsnapshot",

      "createdByUser": "Admin",

      "timeCreated": "2021-10-01T14:20:17.288Z",

      "storage": {

        "type": "OCI_NATIVE",

        "bucket": "mysnapshot-bucket",

        "auth": {

          "type": "OCI_RESOURCE_PRINCIPAL",

          "ociRegion": "us-phoenix-1",

          "ociTenancyId": "ocid1.tenancy.oc1..xxxxx...",

          "ociUserId": "ocid1.user.oc1..xxxxxxxxxxxx..."

        }

      },

      "bar": {

        "uri": "file:///myfolder/myfirstsnapshot.bar"

      }

    }

  ]

}

先頭に戻る