Oracle NoSQL Databaseの管理のためのREST API

plan change-parameters

post

/V0/nosql/admin/plan#change-parameters

指定されたゾーンまたはすべてのゾーンにデプロイされた、指定されたサービスまたは同じタイプのすべてのサービス・インスタンスのパラメータを変更します。

securityフラグを指定すると、ストア全体のセキュリティ・パラメータが変更されます。これは他のフラグとともに使用しないでください。

globalフラグを指定すると、ストア全体の非セキュリティ・パラメータが変更されます。これは他のフラグとともに使用しないでください。

serviceフラグは、単一のコンポーネントに影響を与えます。これは、znまたはznnameフラグと一緒に使用しないでください。

all-*フラグのいずれかをznまたはznnameフラグと組み合せると、指定したゾーンにデプロイされているそのサービス・タイプのすべてのインスタンスを変更できます。別のゾーンにデプロイされているインスタンスは、指定したタイプであっても変更されません。all-*フラグのいずれかをゾーンを指定せずに使用した場合、目的とするパラメータ変更は、ゾーンに関係なく、ストア内の指定したタイプのすべてのインスタンスに適用されます。変更するパラメータは、空白で区切られた名前/値のペアからなり、paramsフラグで指定します。スペースが含まれているパラメータ値は、引用符で囲む必要があります(例: name="value with spaces")。

また、dry-runフラグを指定した場合、新しいパラメータは、指定した変更が適用されることなく返されます。変更できるパラメータを表示するには、show parametersを使用します。

リクエスト

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

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

application/json

ルート・スキーマ: schema

型: object

ソースの表示

arguments(optional): array arguments
command: string

指定できる値: [ "change-parameters" ]

{
    "required":[
        "command"
    ],
    "properties":{
        "command":{
            "type":"string",
            "enum":[
                "change-parameters"
            ]
        },
        "arguments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "argumentName":{
                        "type":"string"
                    },
                    "argumentValue":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"boolean"
                            }
                        ]
                    }
                }
            }
        }
    },
    "example":{
        "command":"change-parameters",
        "arguments":[
            {
                "security":"true|false Whether this is a security parameter"
            },
            {
                "global":"true|false Whether this is a global parameter"
            },
            {
                "service":"Id of the service to change"
            },
            {
                "allRns":"true|false Whether to change all RNs parameters"
            },
            {
                "zn":"Change parameter in specific zone identified by zone id"
            },
            {
                "znname":"Change parameter in specific zone identified by zone name"
            },
            {
                "allAdmins":"true|false Whether to change parameter for all admins"
            },
            {
                "dryRun":"true|false boolean value to specify whether this run will actually execute on server side"
            },
            {
                "params":"Array of objects, each object has only one field of parameter name/value pair, for exmaple, {\"params\":[{\"name1\":\"value1\"},{\"name1\":\"value1\"},{\"name*\":\"value*\"}*]}"
            }
        ]
    }
}

例:

{
    "command":"change-parameters",
    "arguments":[
        {
            "security":"true|false Whether this is a security parameter"
        },
        {
            "global":"true|false Whether this is a global parameter"
        },
        {
            "service":"Id of the service to change"
        },
        {
            "allRns":"true|false Whether to change all RNs parameters"
        },
        {
            "zn":"Change parameter in specific zone identified by zone id"
        },
        {
            "znname":"Change parameter in specific zone identified by zone name"
        },
        {
            "allAdmins":"true|false Whether to change parameter for all admins"
        },
        {
            "dryRun":"true|false boolean value to specify whether this run will actually execute on server side"
        },
        {
            "params":"Array of objects, each object has only one field of parameter name/value pair, for exmaple, {\"params\":[{\"name1\":\"value1\"},{\"name1\":\"value1\"},{\"name*\":\"value*\"}*]}"
        }
    ]
}

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

型: array

ソースの表示

配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "argumentName":{
                "type":"string"
            },
            "argumentValue":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"boolean"
                    }
                ]
            }
        }
    }
}

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

型: object

ソースの表示

argumentName(optional): string
argumentValue(optional): argumentValue

{
    "type":"object",
    "properties":{
        "argumentName":{
            "type":"string"
        },
        "argumentValue":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"boolean"
                }
            ]
        }
    }
}

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

1つのスキーマに一致

ソースの表示

string
boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"boolean"
        }
    ]
}

先頭に戻る

レスポンス

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

application/json

200 Response

Operation ended successfully

ルート・スキーマ: commonResponse

型: object

ソースの表示

description: string
operation: string
returnCode: string
returnValue: object returnValue

{
    "properties":{
        "operation":{
            "type":"string"
        },
        "returnCode":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "returnValue":{
            "type":"object"
        }
    },
    "example":{
        "operation":"Command related operation",
        "returnCode":"Error code to indicate the command result, 5000 infers plan success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem of executing plan.",
        "description":"Textual output of the command",
        "returnValue":"Valuable information returned by the command execution in JSON object format"
    },
    "required":[
        "operation",
        "returnCode",
        "description",
        "returnValue"
    ]
}

例:

{
    "operation":"Command related operation",
    "returnCode":"Error code to indicate the command result, 5000 infers plan success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem of executing plan.",
    "description":"Textual output of the command",
    "returnValue":"Valuable information returned by the command execution in JSON object format"
}

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

型: object

先頭に戻る