ドキュメント
circleci.com
Start Building for Free

CircleCI セルフホストランナー API

1 month ago1 min read
クラウド
Server v3.x
On This Page

このドキュメントでは、CircleCI セルフホストランナー API の外部向けエンドポイント一覧を紹介します。

認証方法

CircleCI セルフホストランナー API は、さまざまな認証方法に対応しています。 使用できる認証方法は、エンドポイントや用途によって異なります。 1 つのエンドポイントで複数の認証方法を使用できる場合もあります。

Circle-token (個人認証)

この認証方法はパーソナルトークンをベースにしており、CircleCI v2 API と同じルールが適用されます。

名前説明

circle-token ヘッダー

ユーザー認証に使用される circle-token が含まれたヘッダー

ユーザー名による HTTP Basic 認証

トークンは、Basic 認証のスキームを使用して提供できます。 ユーザー名には circle-token を設定し、パスワードは空白のまま残します。

ブラウザーセッション認証

リクエストに含まれる Cookie を使用して開始する Ring セッションです。 この認証方法では、ユーザーが既に circleci.com にログインしている場合に、特定のエンドポイントにシームレスにアクセスできます。

ローンチトークン

このトークンは、launch-agent のセットアップに使用するものと同じです。

サポートされている方法

名前説明

HTTP Bearer 認証

Bearer スキームを使用してトークンを送信します。

エンドポイント

GET /api/v2/runner

指定したパラメーターに基づいて利用可能なセルフホストランナーの一覧を取得できます。 フィルター用パラメーターを 1つ以上使用することが必須です。

認証方法

  • Circle-Token (個人認証)

  • ブラウザーセッション認証

    • この認証方法では、circleci.com に既にログインしているユーザーが circleci.com/api/v2/runner でエンドポイントにアクセスできるようになります。

  • ローンチトークン

リクエスト
名前入力必須説明

resource-class

string

クエリ

省略可

指定したリソース クラスでセルフホストランナーの一覧を絞り込みます。

namespace

string

クエリ

省略可

指定した名前空間でセルフホストランナーの一覧を絞り込みます。

サンプル

curl -X GET https://runner.circleci.com/api/v2/runner?resource-class=test-namespace/test-resource \
    -H 'Circle-Token: secret-token'
curl -X GET https://runner.circleci.com/api/v2/runner?namespace=test-namespace \
    -H 'Circle-Token: secret-token'

応答

ステータス説明形式

200

エージェントの一覧

JSON

応答スキーム

名前タイプ必須説明

items

オブジェクト配列

true

セルフホストランナーの配列

resource_class

string

true

セルフホストランナーのリソースクラス

hostname

string

true

セルフホストランナーのホスト名

name

string

true

セルフホストランナー名

first_connected

文字列 (日付と時刻)

true

セルフホストランナーが最初に接続した日時

last_connected

文字列 (日付と時刻)

true

セルフホストランナーが最後に接続した日時

last_used

文字列 (日付と時刻)

true

ジョブの実行にセルフホストランナーを最後に使用した日時

version

string

true

実行中のローンチ エージェントのバージョン

{
    "items": [
        {
            "resource_class": "test-namespace/test-resource",
            "hostname": "bobby",
            "name": "bobby-sue",
            "first_connected": "2020-05-15T00:00:00Z",
            "last_connected": "2020-05-16T00:00:00Z",
            "last_used": "2020-05-17T00:00:00Z",
            "version": "5.4.3.2.1"
        }
    ]
}

GET /api/v2/tasks

指定したリソース クラスで未処理のタスクの数を取得します。

認証方法

  • circle-token (個人認証)

  • ブラウザーセッション認証

    • この認証方法では、circleci.com に既にログインしているユーザーが circleci.com/api/v2/runner でエンドポイントにアクセスできるようになります。

  • ローンチトークン

リクエスト

名前タイプ入力必須説明

resource-class

string

クエリ

true

指定したリソース クラスでタスクを絞り込みます。

サンプル

curl -X GET https://runner.circleci.com/api/v2/tasks?resource-class=test-namespace/test-resource \
    -H 'Circle-Token: secret-token'

応答

ステータス説明形式

200

未処理のタスクの数

JSON

応答スキーム

名前タイプ必須説明

unclaimed_task_count

整数

true

未処理のタスクの数

{
    "unclaimed_task_count": 42
}

GET /api/v2/tasks/running

指定したリソースクラスで実行中のタスクの数を取得します。

認証方法

  • circle-token (個人認証)

  • ブラウザーセッション認証

    • この認証方法では、circleci.com に既にログインしているユーザーが circleci.com/api/v2/runner でエンドポイントにアクセスできるようになります。

リクエスト

名前タイプ入力必須説明

resource-class

string

クエリ

true

指定したリソース クラスでタスクを絞り込みます。

サンプル

curl -X GET https://runner.circleci.com/api/v2/tasks/running?resource-class=test-namespace/test-resource \
    -H 'Circle-Token: secret-token'

応答

ステータス説明形式

200

実行中のタスクの数

JSON

応答スキーム

名前タイプ必須説明

running_runner_tasks

整数

true

実行中のタスクの数

{
    "running_runner_tasks": 42
}

ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。 ご協力いただき、ありがとうございます。

サポートが必要ですか

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、 サポートサイト から、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。