ジャンプ先

• リクエスト
• レスポンス

プラグイン・テンプレートの取得

get

/services/{version}/deployments/{deployment}/plugin/templates/{plugin}

必要なロール: セキュリティ

指定されたデプロイメントにある特定のプラグイン・テンプレートのコンテンツを取得します

リクエスト

パス・パラメータ

• deployment(必須): string
  最小長: 1

  最大長: 32

  パターン: ^[A-Za-z][A-Za-z0-9-_.]*$

  Oracle GoldenGateデプロイメントの名前。

• plugin(必須): string
  最小長: 1

  最大長: 255

  テンプレートのプラグインの名前。

• version(必須): string

  Oracle GoldenGateサービスのAPIバージョン。

  指定できる値: [ "v2" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

プラグイン・テンプレートが正常に問い合せされました

本文()

ルート・スキーマ: Oracle GoldenGate Plugin Metadata

型: object

タイトル: Oracle GoldenGate Plugin Metadata

ソースの表示

• $schema:
  指定できる値: [ "ogg:pluginMetadata" ]
• metadata(必須): array metadata
  最小アイテム数: 0

  最大アイテム数: 255

  メタデータのキー/値ペアの配列

{
    "title":"Oracle GoldenGate Plugin Metadata",
    "required":[
        "metadata"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:pluginMetadata"
            ]
        },
        "metadata":{
            "description":"Array of metadata key/value pairs",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Metadata name",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"64"
                    },
                    "value":{
                        "description":"Metadata value",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"4096"
                    }
                },
                "additionalProperties":false,
                "required":[
                    "name",
                    "value"
                ]
            },
            "minItems":"0",
            "maxItems":"255"
        }
    },
    "additionalProperties":false
}

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

型: array

最小アイテム数: 0

最大アイテム数: 255

メタデータのキー/値ペアの配列

ソースの表示

• 配列: object items

{
    "description":"Array of metadata key/value pairs",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Metadata name",
                "type":"string",
                "minLength":"1",
                "maxLength":"64"
            },
            "value":{
                "description":"Metadata value",
                "type":"string",
                "minLength":"1",
                "maxLength":"4096"
            }
        },
        "additionalProperties":false,
        "required":[
            "name",
            "value"
        ]
    },
    "minItems":"0",
    "maxItems":"255"
}

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

型: object

ソースの表示

• name(必須): string
  最小長: 1

  最大長: 64

  メタデータ名
• value(必須): string
  最小長: 1

  最大長: 4096

  メタデータ値

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Metadata name",
            "type":"string",
            "minLength":"1",
            "maxLength":"64"
        },
        "value":{
            "description":"Metadata value",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        }
    },
    "additionalProperties":false,
    "required":[
        "name",
        "value"
    ]
}

レスポンスの例(application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://127.0.0.1:9011/services/v2/deployments/PluginTests/plugin/templates/libEncryption-OCIVault",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://127.0.0.1:9011/services/v2/deployments/PluginTests/plugin/templates/libEncryption-OCIVault",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://127.0.0.1:9011/services/v2/metadata-catalog/templatesPlugin",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:pluginMetadata",
        "metadata":[
            {
                "name":"OCI_VAULTKEY_OCID",
                "value":"OCI Vault Key OCID"
            },
            {
                "name":"OCI_CRYPTO_ENDPOINT",
                "value":"Cryptographic endpoint to use"
            },
            {
                "name":"OCI_AUTH",
                "value":"OCI authentication method"
            }
        ]
    }
}

先頭に戻る