機械翻訳について

移動先

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

インスタンス・グループのロールのリスト

get

/api/v2/instance_groups/{id}/object_roles/

このリソースに対してGETリクエストを行って、選択したインスタンス・グループに関連付けられているロールのリストを取得します。

結果のデータ構造には次のものが含まれます:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

countフィールドは、特定の問合せに対して検出されたロールの合計数を示します。 nextフィールドとpreviousフィールドには、単一ページに収まる以上の結果へのリンクが表示されます。 resultsリストには、ゼロ以上のロール・レコードが含まれています。

結果

各ロール・データ構造には次のフィールドが含まれます:

• id: このロールのデータベースID。(integer)
• type: このロールのデータ型。(choice)
• url: このロールのURL。(string)
• related: 関連リソースのURLを持つデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を持つデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• name: このロールの名前。(field)
• description: このロールのオプションの説明。(field)

ソート

ロールが特定の順序で返されることを指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。

?order_by=name

フィールド名の先頭にダッシュ-を付けて、逆順にソートします:

?order_by=-name

フィールド名をカンマ,で区切ることにより、複数のソート・フィールドを指定できます:

?order_by=name,some_other_field

ページ区切り

page_size問合せ文字列パラメータを使用して、リクエストごとに返される結果の数を変更します。 page問合せ文字列パラメータを使用して、特定の結果ページを取得します。

?page_size=100&page=2

結果とともに返されるpreviousおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。

検索

search問合せ文字列パラメータを使用して、モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行します。

?search=findme

( 「Ansibleタワー3.1.0で追加」)関連フィールド全体を検索します:

?related__search=findme

リクエスト

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

• application/json

パス・パラメータ

• id(required): string

問合せパラメータ

• page: integer
  ページ区切り結果セット内のページ番号。
• page_size: integer
  ページ当たりに返す結果の数。
• search: string
  検索条件。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/Role"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• 配列: オブジェクト Role

{
    "items":{
        "$ref":"#/definitions/Role"
    },
    "type":"array"
}

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

型: object

ソースを表示

• description: string
  タイトル: Description

  読取り専用: true
• id: integer
  タイトル: ID

  読取り専用: true
• name: string
  タイトル: Name

  読取り専用: true
• related: string
  タイトル: Related

  読取り専用: true
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "description":{
            "readOnly":true,
            "title":"Description",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "name":{
            "readOnly":true,
            "title":"Name",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "type":"object"
}

先頭に戻る