Oracle Public Cloud MachineのOracle SOA Cloud ServiceのREST API

機械翻訳について

プロビジョニング済インスタンスの取得

get

/api/v1.1/instances/{identityId}

すべてのプロビジョニング済インスタンスを取得します。

リクエスト

パス・パラメータ

identityId: タイプ: string

必須: true

Oracle Cloud Serviceアカウントのアイデンティティ・ドメインの名前。

問合せのパラメータ

status

タイプ: string

必須: true

Oracle SOA Serviceインスタンスのステータス。有効な値: プロビジョニング未開始、実行中、進行中、終了中、失敗。

指定可能な値


[
    "Provisioning Not Started",
    "Running",
    "In Progress",
    "Terminating",
    "Failed"
]

レスポンス

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

application/json
text/html

200レスポンス

成功

本文

ルート・スキーマ: GetInstanceInfoResponse

タイプ: object

プロパティ

created_by

タイプ: string

Oracle SOA Cloud Serviceインスタンスの作成に使用されたユーザー・アカウントの名前。

creation_job_id

タイプ: boolean

デフォルト値: false

ジョブの作成のジョブID。

creation_time

タイプ: string

Oracle SOA Serviceインスタンスの作成日時。

description

タイプ: string

サービス・インスタンスに関する追加情報を提供する自由形式のテキスト。

identity_domain

タイプ: string

アイデンティティ・ドメイン名。

last_modified_time

タイプ: string

Oracle SOA Serviceインスタンスの最終更新日時。

resource_count

タイプ: string

スタック・サービス・インスタンス内のリソース数。

resources

タイプ: string

SOA Serviceインスタンス内の個別リソースの詳細。

service_id

タイプ: string

Oracle SOA Serviceインスタンスのグローバル一意識別子。

service_type

タイプ: string

サービスのタイプ。有効な値は次のとおりです。

osb - Oracle Service Busトポロジ。
soa - サービス指向アーキテクチャ。
soaosb - OSBおよびSOAの両方のトポロジ。
b2b - B2B (Business to Business)およびSOAの両方のトポロジ。
mft - MFT (Managed File Transfer)トポロジ。
insight - Oracle Business Insight (Business Activity Monitoring)トポロジ。

service_uri

タイプ: string

Oracle SOA ServiceインスタンスのリソースURL。

serviceName

タイプ: string

Oracle SOA Serviceインスタンスの名前。

status

タイプ: string

Oracle SOA Serviceインスタンスのステータスを示すフラグ。有効な値: プロビジョニング未開始、実行中、進行中、終了中、失敗。

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのOracle SOA Cloud Serviceインスタンスの情報を表示する方法を示しています。詳細は、「cURLの使用」を参照してください。

Oracle SOA Cloud Serviceコンソールの概要に関する項も参照してください。

cURLコマンド

curl -i -X GET -u joe@example.com:Welcome1!  -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain

注意:: この例では、アメリカ合衆国でのURL接頭辞(soacs)を使用しています。世界の他の地域のURL接頭辞の詳細は、「リクエストの送信」を参照してください。

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

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK
Date: Fri, 22 Aug 2014 14:28:33 GMT
Transfer-Encoding: chunked
Content-Type: application/json

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。この例では、12cを実行しているMy12cServerと11gを実行しているMy11gServerの2つのサービス・インスタンスがあります。詳細出力は有効ではありません。

{
"uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain",
"service_type":"soacs",
"implementation_version":"1.0",
"services" : [
    {
        "service_name":"My12cServer",
        "version":"12cR3",
        "wlsVersion":"12.1.3.0.4",
        "status":"Running",
        "error_status_desc": "",
        "compliance_status": "",
        "compliance_status_desc": "",
        "auto_update": "true",
        "description":"WebLogicEnterprise",
        "identity_domain":"ExampleIdentityDomain",
        "creation_time":"Wed Jul 23 15:36:57 GMT 2014",
        "last_modified_time":"Thu Jul 24 09:15:57 GMT 2014",
        "created_by":"joe@example.com",
        "service_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain\/My12cServer"    
    },
    {
        "service_name":"My11gServer",
        "version":"11g",
        "wlsVersion":"10.3.6.0.9",
        "status":"Running",
        "description":"",
        "identity_domain":"ExampleIdentityDomain",
        "creation_time":"Tue Jul 22 18:11:41 GMT 2014",
        "last_modified_time":"Wed Jul 23 00:35:11 GMT 2014",
        "created_by":"joe@example.com",
        "service_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain\/My11gServer"    
     }
]}

詳細出力が有効な、JSON形式のレスポンス本文の例を次に示します。

{
"uri":"https:\/\/api-host/\/paas/\service\/soa\/api\/v1.1\/instances\/yourIdentityDomain?outputLevel=verbose",
"service_type":"soacs",
"implementation_version":"1.0",
"services" : [
    {
        "service_name":"My12cServer",
        "version":"12cR3",
        "wlsVersion":"12.1.3.0.4",
        "status":"Running",
        "error_status_desc": "",
        "compliance_status": "",
        "compliance_status_desc": "",
        "auto_update": "true",
        "description":"WebLogicEnterprise",
        "identity_domain":"ExampleIdentityDomain",
        "creation_time":"Wed Jul 23 15:36:57 GMT 2014",
        "last_modified_time":"Thu Jul 24 09:15:57 GMT 2014",
        "created_by":"joe@example.com",
        "service_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain\/My12cServer",
        "domain_name" : "ExampleDomain",
        "domain_mode" : "PRODUCTION",
        "cluster_name" : "ExampleCluster",
        "num_nodes" : 3,
        "level" : "PAAS",
        "subscription_type" : "HOURLY",
        "edition" : "EE",
        "shape" : "oc3m",
        "otd_provisioned" : "yes",
        "otd_shape" : "oc3",
        "otd_storage_size": 43008,
        "service_components": [
            {
                "type": "JDK",
                "version": "1.7.0_76"
            },
            {
                "type": "OTD_JDK",
                "version": "1.7.0_76"
            },
            {
                "type": "OTD",
                "version": "11.1.1.7.0"
            },
            {
                "type": "WLS",
                "version": "12.1.3.0.4"
            }
        ],
        "creation_job_id" : "1",
        "deletion_job_id" : "0",
        "lifecycle_control_job_id": 273,
        "db_info" : "myDB:1521\/PDB1.exampleidentitydomain",
        "db_service_name" : "myDBService", 
        "num_ip_reservations" : 3,
        "wls_admin_url" : "https:\/\/192.0.2.0:7002\/console",
        "fmw_control_url" : "https:\/\/192.0.2.16:7002\/em",
        "otd_admin_url" : "https:\/\/192.0.2.23:8989",
        "sample_app_url": "https:\/\/192.1.2.3\/sample-app\/",
        "secure_content_url" : "https:\/\/192.0.2.3:8081",
        "content_url" : "https:\/\/192.0.4.5:8080",
        "wls_deployment_channel_port": 9001,
        "psm_plugin_version": "15.3.3-0-1507110315"   
    },
    {
        "service_name":"My11gServer",
        "version":"11g",
        "wlsVersion":"10.3.6.0.9",
        "status":"Running",
        "description":"",
        "identity_domain":"ExampleIdentityDomain",
        "creation_time":"Tue Jul 22 18:11:41 GMT 2014",
        "last_modified_time":"Wed Jul 23 00:35:11 GMT 2014",
        "created_by":"joe@example.com",
        "service_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain\/My11gServer" ,        
        "domain_name" : "ExampleDomain",
        "domain_mode" : "PRODUCTION",
        "cluster_name" : "ExampleCluster",
        "num_nodes" : 3,
        "level" : "PAAS",
        "subscription_type" : "HOURLY",
        "edition" : "EE",
        "shape" : "oc3m",
        "otd_provisioned" : "yes",
        "otd_shape" : "oc3",
        "otd_storage_size": 43008,
        "service_components": [
            {
                "type": "JDK",
                "version": "1.7.0_76"
            },
            {
                "type": "OTD_JDK",
                "version": "1.7.0_76"
            },
            {
                "type": "OTD",
                "version": "11.1.1.7.0"
            },
            {
                "type": "WLS",
                "version": "12.1.3.0.4"
            }
        ],
        "creation_job_id" : "1",
        "deletion_job_id" : "0",
        "lifecycle_control_job_id": 236,
        "db_info" : "myDB:1521\/PDB1.exampleidentitydomain",
        "db_service_name" : "myDBService", 
        "num_ip_reservations" : 3,
        "wls_admin_url" : "https:\/\/192.1.2.0:7002\/console",
        "fmw_control_url" : "https:\/\/192.1.2.16:7002\/em",
        "otd_admin_url" : "https:\/\/192.0.2.23:8989",
        "sample_app_url": "https:\/\/192.1.2.3\/sample-app\/",
        "secure_content_url" : "https:\/\/192.1.2.3:8081",
        "content_url" : "https:\/\/192.1.4.5:8080",
        "wls_deployment_channel_port": 9001,
        "psm_plugin_version": "15.3.3-0-1507110315"  
   }
]}