機械翻訳について
  1. Oracle Java Cloud ServiceのREST API
  2. タスク
  3. タグと割り当て

すべてのタグを一覧表示

get

/paas/api/v1.1/tags/{identityDomainId}/tags

指定したアイデンティティ・ドメインIDのタグとタグの割り当てをすべて返します。

?outputLevel問合せパラメータをFULLに設定し、タグ割当てのサービス名とタグの割当て数を戻します。

1つ以上の特定のサービス・インスタンスのタグを一覧表示するには、オプションの?services問合せパラメータを使用します。

オプションの?tagFilter問合せパラメータを使用して、タグに基づいて検索条件を指定します。

リクエスト

パス・パラメータ
問合せパラメータ
  • FULLに設定すると、タグの割当てとともにサービス名が含まれます。 それ以外の場合は、タグが割り当てられているサービス・リソースの数のみが返されます(デフォルト)。
  • service_type.instance_nameの形式で特定のサービス・タイプとサービス名に設定されている場合、レスポンスには指定されたインスタンスのタグと割り当てのみが含まれます。 2つ以上のサービス・インスタンスの情報を取得するには、コンマ区切りのリストを使用します。

    たとえば:

    • JaaS.ExampleInstance
    • JaaS.ExampleInstance,JaaS.MyInstance01
    • JaaS.ExampleInstance,DBaaS.MyDBInstance

  • 検索結果をフィルタリングするためのタグ・キーと値を使用する式。 式を満たす結果のみが検索で返されます。

    フィルタ式を作成するとき:

    • 複数の文字を一致させるには、パーセント記号(%)を使用します。
    • 単一の文字を照合するには、アンダースコア(_)を使用します。
    • リテラル文字の前にバックスラッシュ文字を付けます(キーまたは値にリテラルのパーセント記号(%)、アポストロフィまたは一重引用符(')、またはアンダースコア(_)が含まれる場合は\))。

    有効な式は次のとおりです:

    • 'foo':'bar' - 'foo'のキーと'bar'の値を持つすべてのタグと割り当てを検索
    • 'ora\_%':'%prod%' - 'ora_'で始まるキーと'prod'を含む値を持つすべてのタグと割り当てを検索します。
    • 'haMode' - タグ・キーが'haMode'のすべてのタグと割り当てを検索
    • 'ora\_%' - 'ora_'で始まるタグ・キーをすべてのタグと割り当てで検索
    • 'site':'pe_r' - アンダースコアのワイルドカードを使用して、1文字のみをワイルドカードで一致させます。 たとえば、site=pearまたはsite=peerは一致します。site=pepperは一致しません。
    • 'foo':'' - タグ・キー'foo'と空の文字列を値として持つすべてのタグと代入を検索します。
    • 'accuracy':'100\%' - 値にリテラルのパーセント記号を使用するため、ワイルドカードの一致として解釈されません。
    • 'type':'Abe\'s test' - キーまたは値にアポストロフィ(一重引用符)を使用します。
    • 'key\_contains\_underscores':'value\_does\_too' - キーまたは値にアンダースコアを使用するため、1文字のワイルドカードとして解釈されません。

ヘッダー・パラメータ
  • Oracle Identity Cloud Serviceから取得したコロンまたはOAuthアクセス・トークンで区切られた、Base64でエンコードされたユーザー名とパスワード。 「認証」を参照してください。
  • Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID。
先頭に戻る

レスポンス

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

200レスポンス

OK。

レスポンス本文には、すべてのタグとその割り当てに関する情報が含まれています。

本文()
ルート・スキーマ : alltagsassignments-response
型: object
ソースを表示
ネストされたスキーマ: items
型: array
タグとその割り当ての詳細をグループ化します。
ソースを表示
ネストされたスキーマ : tagsassignments-details
型: object
各オブジェクトはタグとその割り当てを記述します。
ソースを表示
ネストされたスキーマ : assignmentCounts
型: object
現品票割当数。
ソースを表示
ネストされたスキーマ : assignments
型: object
このタグの割り当ての詳細をグループ化します。
ソースを表示
ネストされたスキーマ: services
型: array
このタグで割り当てられたサービス・リソースをグループ化します。
ソースを表示
ネストされたスキーマ : serviceassignment-details
型: object
各オブジェクトはサービス・リソースを記述します。
ソースを表示
  • タグの割り当てまたは未割り当てのどちらが進行中であるか。 使用可能な値: Assigning, Unassigning, Assigned

    このプロパティは、タグの作成と割り当てエンドポイントまたは割り当ての作成と削除エンドポイントを使用すると表示されません。

  • サービス・インスタンスの名前。
  • サービスのタイプ。

    たとえば、Java Cloud Serviceインスタンスの場合はJaaS、Database Cloud Serviceデプロイメントの場合はDBaaSです。

400レスポンス

不正リクエスト

パーセント記号(%)を使用して複数の文字を照合するときにSM-UI-PROXYというメッセージが表示された場合は、パーセント記号がパーセント記号で%25としてエンコードされている必要があります。 %文字のパーセント符号化を使用してコマンドを再試行してください。

先頭に戻る

例

ノート: この例のコマンドは、URL構造https://rest_server_url/resource-pathを使用します。ここで、rest_server_urlは、アイデンティティ・ドメイン(またはクラウド・アカウント)に接続するRESTサーバーです。 「リクエストの送信」を参照してください。

cURLコマンド

次の例は、cURLを使用してRESTリソースに対してGETリクエストを発行して、アイデンティティ・ドメインIDのすべてのタグとその割当てをリストする方法を示しています。

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?outputLevel=FULL"

次のコマンドは、queryパラメータを使用して、特定のインスタンスのタグを一覧表示します。

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?services=JaaS.MyJCSExample"

次のコマンドは、問合せパラメータを使用してタグ・フィルタ式に基づいてタグと割り当てを検索します。

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" "https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?tagFilter='dev%25'&outputLevel=FULL"

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

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

HTTP/1.1 200 OK
Date: Fri, 05 Jan 2018 20:30:43 GMT
Content-Length: 1024
Content-Type: application/vnd.oracle.resource+json;type=collection
X-ORACLE-DMS-ECID: 1bcaf164-c5b5-4c70-b7d8-5a24c1e19493-00001d8f
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Access-Control-Allow-Origin: *

レスポンス本文の例

次に、outputLevel=FULLの場合にすべてのタグに対して返されるレスポンスの例を示します。

{
   "items":[
      {
         "key": "db",
         "value": "atp",
         "readOnly": false,
         "assignments": {
            "services": [
               {
                  "serviceType": "JaaS",
                  "serviceName": "ExampleJaaSInstance",
                  "assignmentState": "Assigned"
               }
            ]
         },
         "assignmentCounts": {
            "services": 1
         },
         "links": [
            {
               "rel": "canonical",
               "href": "https://jaas.oraclecloud.com:443/paas/api/v1.1/tags/ExampleIdentityDomain/tags/db/atp"
            }
         ],
         "state": "Ready"
      },
   ],
   "limit":200,
   "hasMore":false,
   "offset":0,
   "links":[
      {
         "rel":"first",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?offset=0&outputLevel=FULL"
      },
      {
         "rel":"last",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?offset=0&outputLevel=FULL"
      },
      {
         "rel":"canonical",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/"
      },
      {
         "rel":"self",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?outputLevel=FULL"
      }
   ]
}

次に、特定の1つのサービス・インスタンスに対して返されるレスポンスの例を示します。

{
   "items":[
      {
         "key":"environment",
         "value":"development",
         "readOnly":false,
         "assignmentCounts":{
            "services": 0
         },
         "links":[
            {
               "rel":"canonical",
               "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/environment/development"
            }
         ],
         "state": "Ready"
      },
      {
         "key":"environment",
         "value":"qa",
         "readOnly":false,
         "assignmentCounts":{
            "services": 0
         },
         "links":[
            {
               "rel":"canonical",
               "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/environment/qa"
            }
         ],
         "state": "Ready"
      }
   ],
   "limit":200,
   "hasMore":false,
   "offset":0,
   "links":[
      {
         "rel":"first",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?services=JaaS.MyJCSExample&offset=0"
      },
      {
         "rel":"last",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?services=JaaS.MyJCSExample&offset=0"
      },
      {
         "rel":"canonical",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/"
      },
      {
         "rel":"self",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?services=JaaS.MyJCSExample"
      }
   ]
}

次の例は、'dev'で始まるキーを持つタグとoutputLevel=FULLのときのタグで返されるレスポンスです。

{
   "items":[
      {
         "key":"development",
         "value":"hr",
         "readOnly":false,
         "assignments":{
            "services":[
               {
                  "serviceType":"JaaS",
                  "serviceName":"MyJCSExample",
                  "assignmentState": "Assigned"
               }
            ]
         },
         "assignmentCounts": {
            "services": 1
         },
         "links":[
            {
               "rel":"canonical",
               "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/development/hr"
            }
         ],
         "state": "Ready"
      },
      {
         "key":"development",
         "value":"sales",
         "readOnly":false,
         "assignments":{
            "services":[
               {
                  "serviceType":"JaaS",
                  "serviceName":"MyJCSExampleSales",
                  "assignmentState": "Assigned"
               }
            ]
         },
         "assignmentCounts": {
            "services": 1
         },
         "links":[
            {
               "rel":"canonical",
               "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/development/sales"
            }
         ],
         "state": "Ready"
      },
      {
         "key":"development",
         "value":"",
         "readOnly":false,
         "assignments":{
            "services":[]
         },
         "assignmentCounts": {
            "services": 0
         },
         "links":[
            {
               "rel":"canonical",
               "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/development/"
            }
         ],
         "state": "Ready"
      }
   ],
   "limit":200,
   "hasMore":false,
   "offset":0,
   "links":[
      {
         "rel":"first",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?tagFilter=%27dev%25%27&offset=0&outputLevel=FULL"
      },
      {
         "rel":"last",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?tagFilter=%27dev%25%27&offset=0&outputLevel=FULL"
      },
      {
         "rel":"canonical",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags/"
      },
      {
         "rel":"self",
         "href":"https://rest_server_url/paas/api/v1.1/tags/ExampleIdentityDomain/tags?tagFilter=%27dev%25%27&outputLevel=FULL"
      }
   ]
}
先頭に戻る