Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

資格証明タイプのリスト

get

/api/v2/credential_types/

このリソースに対して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: この資格証明タイプのオプションの説明。(文字列)
kind: (選択)
- ssh: マシン
- vault: ボールト
- net: ネットワーク
- scm: ソース・コントロール
- cloud: クラウド
- registry: コンテナ・レジストリ
- token: 個人アクセス・トークン
- insights: インサイト
- external: 外部
- kubernetes: Kubernetes
- galaxy: Galaxy/Automation Hub
namespace: (文字列)
managed: (boolean)
inputs: JSONまたはYAML構文を使用して入力を入力します。構文例は、ドキュメンテーションを参照してください。(json)
injectors: JSONまたはYAML構文を使用してインジェクタを入力します。構文例は、ドキュメンテーションを参照してください。(json)

ソート

資格証明タイプが特定の順序で返されるように指定するには、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

( 「Oracle Linux Automation Manaerに追加」)関連フィールド全体を検索します:

?related__search=findme

リクエスト

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

application/json

問合せパラメータ

page(オプション): 整数

ページ区切りが設定された結果セット内のページ番号。
page_size(オプション): 整数

ページごとに返す結果の数。
search(オプション): 文字列

検索条件。

先頭に戻る

レスポンス

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

application/json

200レスポンス

レスポンスの例(application/json)

{
    "count":1,
    "next":null,
    "previous":null,
    "results":[
        {
            "created":"2018-02-01T08:00:00.000000Z",
            "description":"",
            "id":1,
            "injectors":{
                "env":{
                    "AWX_MY_CLOUD_TOKEN":"{{api_token}}"
                }
            },
            "inputs":{
                "fields":[
                    {
                        "id":"api_token",
                        "label":"API Token",
                        "secret":true,
                        "type":"string"
                    }
                ]
            },
            "kind":"cloud",
            "managed":false,
            "modified":"2018-02-01T08:00:00.000000Z",
            "name":"MyCloud",
            "namespace":null,
            "related":{
                "activity_stream":"/api/v2/credential_types/1/activity_stream/",
                "credentials":"/api/v2/credential_types/1/credentials/"
            },
            "summary_fields":{
                "user_capabilities":{
                    "delete":true,
                    "edit":true
                }
            },
            "type":"credential_type",
            "url":"/api/v2/credential_types/1/"
        }
    ]
}

401レスポンス

レスポンスの例(application/json)

{
    "detail":"Authentication credentials were not provided. To establish a login session, visit /api/login/."
}

先頭に戻る