機械翻訳について

移動先

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

資格証明のリスト

get

/api/v2/credentials/

このリソースに対してGETリクエストを行って、資格証明のリストを取得します。

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

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

countフィールドは、対象となる問合せで見つかった資格証明の合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上の資格証明レコードが含まれます。

結果

それぞれの資格証明データ構造には次のフィールドが含まれます。

• id: この資格証明のデータベースID。(整数)
• type: この資格証明のデータ型。(選択)
• url: この資格証明のURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: この資格証明が作成されたときのタイムスタンプ。(日時)
• modified: この資格証明が最後に変更されたときのタイムスタンプ。(日時)
• name: この資格証明の名前。(文字列)
• description: この資格証明のオプションの説明。(文字列)
• organization: 組織ロールから権限を継承します。 作成時に指定する場合は、ユーザーまたはチームを指定しないでください。(id)
• credential_type: 作成する資格証明のタイプを指定します。 各タイプの詳細は、ドキュメントを参照してください。(id)
• managed: (boolean)
• inputs: JSONまたはYAML構文を使用して入力を入力します。 構文例は、ドキュメンテーションを参照してください。(json)
• kind: (フィールド)
• cloud: (フィールド)
• kubernetes: (フィールド)

ソート

資格証明が特定の順序で返されるように指定するには、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 Tower 3.1.0で追加)関連フィールド全体を検索します。

?related__search=findme

リクエスト

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

• application/json

問合せパラメータ

• 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/CredentialSerializerCreate"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• Array of: object CredentialSerializerCreate

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

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

型: object

ソースを表示

• cloud: string
  タイトル: Cloud

  読取り専用: true
• created: string
  タイトル: Created

  読取り専用: true
• credential_type(required): integer
  タイトル: Credential Type

  作成する資格証明のタイプを指定します。 各タイプの詳細は、ドキュメントを参照してください。
• description: string
  タイトル: Description
• id: integer
  タイトル: ID

  読取り専用: true
• inputs: object Inputs
  タイトル: Inputs

  JSONまたはYAML構文を使用して入力を入力します。 構文の例は、ドキュメントを参照してください。
• 親切な: string
  タイトル: Kind

  読取り専用: true
• kubernetes: string
  タイトル: Kubernetes

  読取り専用: true
• managed: string
  タイトル: Managed

  読取り専用: true
• modified: string
  タイトル: Modified

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

  最小長: 1

  最大長: 512
• organization: integer
  タイトル: Organization

  組織ロールから権限を継承します。 作成時に指定する場合は、ユーザーまたはチームを指定しないでください。
• related: string
  タイトル: Related

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

  読取り専用: true
• team: integer
  タイトル: Team

  所有者ロールにチームを追加するために使用する書込み専用フィールド。 指定する場合は、ユーザーまたは組織を指定しないでください。 作成にのみ有効です。
• type: string
  タイトル: Type

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

  読取り専用: true
• user: integer
  タイトル: User

  所有者ロールにユーザーを追加するために使用する書込み専用フィールド。 指定する場合は、チームまたは組織を指定しないでください。 作成にのみ有効です。

{
    "properties":{
        "cloud":{
            "readOnly":true,
            "title":"Cloud",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential_type":{
            "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.",
            "title":"Credential Type",
            "type":"integer"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Inputs",
            "type":"object"
        },
        "kind":{
            "readOnly":true,
            "title":"Kind",
            "type":"string"
        },
        "kubernetes":{
            "readOnly":true,
            "title":"Kubernetes",
            "type":"string"
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"Inherit permissions from organization roles. If provided on creation, do not give either user or team.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "team":{
            "description":"Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.",
            "title":"Team",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "user":{
            "description":"Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.",
            "title":"User",
            "type":"integer",
            "x-nullable":true
        }
    },
    "required":[
        "name",
        "credential_type"
    ],
    "type":"object"
}

ネストされたスキーマ : 入力

型: object

タイトル: Inputs

JSONまたはYAML構文を使用して入力を入力します。 構文の例は、ドキュメントを参照してください。

先頭に戻る