Oracle Cloud Stack ManagerのREST API

機械翻訳について

スタックの作成

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/stack/instances

既存のテンプレートからクラウド・スタックを作成します

リクエスト

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

multipart/form-data

パス・パラメータ

identityDomainId: string

Oracle Cloudアイデンティティ・ドメインの名前

フォーム・パラメータ

description(optional): string

新しいスタックの説明
name: string

作成するスタックの名前
parameterFile(optional): file

テンプレート・パラメータ入力値を含むJSONファイル。各パラメータは、名前:値のペアです。
parameterValues(optional): string

テンプレート・パラメータの値をJSONオブジェクトとして入力します。各パラメータは、名前:値のペアです。
tags(optional): string

このスタックにJSON配列として割り当てられたタグ。各配列アイテムは、2つのname:valueのペア、keyとvalueを持つJSONオブジェクトです。タグ・キーには、文字、数字、ダッシュ(-)、アンダースコア(_)を使用できます。
template: string

スタックを作成するために使用する既存のテンプレートの名前

トップに戻る

レスポンス

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

application/json

202レスポンス

Accepted スタックの作成が進行中です。

ルート・スキーマ : ondemand-response

型: object

ソースの表示

details(optional): object details

レスポンス本文には、リクエストしたスタック操作に関する情報が含まれます。

{
    "properties":{
        "details":{
            "description":"The response body contains information about the requested stack operation.",
            "properties":{
                "message":{
                    "type":"string",
                    "description":"Message"
                },
                "jobId":{
                    "type":"string",
                    "description":"Job ID"
                }
            }
        }
    }
}

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

型: object

レスポンス本文には、リクエストしたスタック操作に関する情報が含まれます。

ソースの表示

jobId(optional): string

ジョブID
message(optional): string

メッセージ

{
    "description":"The response body contains information about the requested stack operation.",
    "properties":{
        "message":{
            "type":"string",
            "description":"Message"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID"
        }
    }
}

400レスポンス

不正リクエスト。不正入力がある場合に返されます。

500レスポンス

サーバー・エラー。サーバー・エラーが発生した場合に返されます。

トップに戻る

例

次の例は、スタック・エンドポイントにPOSTリクエストを送信することによって、Oracle Cloud Stackにスタックを作成する方法を示しています。スタック名、説明およびテンプレートはフォーム・パラメータです。テンプレート・パラメータはすべて、値がJSONオブジェクトである単一のフォーム・パラメータとして、またはJSONオブジェクトを含むファイルとして送信できます。スタックに割り当てられたタグはすべて、単一のフォーム・パラメータとして送信され、その値はJSONオブジェクトの配列です。

cURLコマンド

curl -i -X POST \
-u yourUsername:yourPassword \
-H "Content-Type:multipart/form-data" \
-H "X-ID-TENANT-NAME:MyIdentityDomain" \
-F "name=MyStack" \
-F "template=MyTemplate" \
-F 'tags=[{"key":"stage","value":"dev"},{"key":"priority","value":"4"}]' \
-F 'parameterValues={"sshKey":"yourKey","dbShape":"oc3"}' \
https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances

注意: この例では米国用のURL接頭辞が使用されています。世界の他のリージョンのURL接頭辞の詳細は、「リクエストの送信」を参照してください。

注意: Windowsでは、tagsおよびparameterValues JSONオブジェクトにある引用符文字をエスケープする必要があります。例:

-F "parameterValues={\"sshKey\":\"yourKey\",\"dbShape\":\"oc3\"}"

または、テンプレート・パラメータを外部JSONファイルとして指定できます。例:

-F 'parameterFile=@stack-params.json'

The contents of stack-params.json:
{
  "sshKey":"yourKey",
  "dbShape":"oc3"
}

レスポンス・ヘッダーの例

作成ジョブおよび新しいスタックのRESTエンドポイントを含む、レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 202 Accepted
Date: Thu, 25 Aug 2016 18:50:14 GMT
Transfer-Encoding: chunked
Location: https://psm.us.oraclecloud.com/paas/api/v1.1/activitylog/MyIdentityDomain/job/101231
Content-Type: application/json
Service-URI: https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances/MyStack
Retry-After: 60

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
  "details":{
    "message":"Submitted job to create stack [MyStack] in domain [MyIdentityDomain].",
    "jobId":"101231"
  }
}

トップに戻る