プロジェクトの照会

Classic/VPC環境で利用できます。

デプロイプロジェクトの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/project/{projectId}

リクエストヘッダ

SourceBuild APIで共通して使用されるヘッダの詳細は、SourceBuildのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`projectId`	String	Required	プロジェクト ID プロジェクトリストの照会を参照

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://sourcebuild.apigw.ntruss.com/api/v1/project/20***' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`result`	Object	-	レスポンス結果
`result.id`	Number	-	プロジェクト ID
`result.name`	String	-	プロジェクト名
`result.description`	String	-	プロジェクトの説明
`result.created`	Object	-	プロジェクト作成情報
`result.created.timestamp`	Number	-	プロジェクトの作成日時 Unix Timestamp形式
`result.created.user`	String	-	作成者 ID
`result.source`	Object	-	ソース保存場所情報
`result.source.type`	String	-	ソース保存場所のタイプ `SourceCommit` \| `Github` \| `Bitbucket` \| `Github Enterprise Server`
`result.source.config`	Object	-	ソース保存場所のリポジトリ情報
`result.source.config.repository`	String	-	ソースの保存場所のリポジトリ名 `source.type`が`SourceCommit`または`Github`の場合、表示
`result.source.config.branch`	String	-	ソースの保存場所リポジトリのブランチ名 `source.type`が`SourceCommit`または`Github`の場合、表示
`result.source.config.workspace.id`	String	-	Bitbucketワークスペース ID `source.type`が`Bitbucket`の場合、表示
`result.source.config.workspace.name`	String	-	Bitbucketワークスペース名 `source.type`が`Bitbucket`の場合、表示
`owner`	String	-	Github Enterprise Serverの所有者 `source.type`が`Github Enterprise Server`の場合、表示
`url`	String	-	Gitリポジトリ URL `source.type`が`Github Enterprise Server`で、SSH Key方式でログインした場合、表示
`serverUrl`	String	-	サーバ URL `source.type`が`Github Enterprise Server`で、OAuthまたは Personal Access Token、Username/Password方式でログインした場合、表示
`result.env`	Object	-	ビルド環境情報
`result.env.timeout`	Number	-	ビルド実行タイムアウト(分)
`result.env.envVars`	Array	-	ビルド環境変数情報
`result.env.compute`	Object	-	コンピューティングタイプ情報
`result.env.compute.id`	Number	-	コンピューティングタイプ ID
`result.env.compute.cpu`	Number	-	vCPU数
`result.env.compute.mem`	Number	-	メモリ容量(GB)
`result.env.platform`	Object	-	ビルド環境プラットフォーム情報
`result.env.platform.type`	String	-	イメージ保存場所のタイプ `SourceBuild` \| `ContainerRegistry` \| `PublicRegistry` `SourceBuild`: SourceBuildで管理されるイメージ `ContainerRegistry`: Container Registryのイメージ `PublicRegistry`: Public Registryのイメージ
`result.env.platform.config`	Object	-	ビルド環境設定情報
`result.env.platform.config.os`	Object	-	OS情報 `env.platform.type`が`SourceBuild`の場合、下位情報を含めて表示
`result.env.platform.config.os.id`	Number	-	OSの ID
`result.env.platform.config.os.name`	String	-	OS名
`result.env.platform.config.os.version`	String	-	OSのバージョン
`result.env.platform.config.os.archi`	String	-	OSのアーキテクチャ
`result.env.platform.config.runtime`	Object	-	ランタイム情報 `env.platform.type`が`SourceBuild`の場合、下位情報を含めて表示
`result.env.platform.config.runtime.id`	Number	-	ランタイムタイプ ID
`result.env.platform.config.runtime.name`	String	-	ランタイム名
`result.env.platform.config.runtime.version`	Object	-	ランタイムバージョン情報
`result.env.platform.config.runtime.version.id`	Number	-	ランタイムバージョン ID
`result.env.platform.config.runtime.version.name`	String	-	ランタイムバージョン名
`result.env.platform.config.registry`	Object	-	レジストリ情報 `env.platform.type`が`ContainerRegistry`の場合、表示
`result.env.platform.config.image`	String	-	イメージ名 `env.platform.type`が`ContainerRegistry`または`PublicRegistry`の場合、表示
`result.env.platform.config.tag`	String	-	イメージタグ名 `env.platform.type`が`ContainerRegistry`または`PublicRegistry`の場合、表示
`result.env.docker`	Object	-	Dockerエンジン情報
`result.env.docker.use`	Boolean	-	Dockerエンジンを含めるかどうか `true` \| `false` `true`: 含める `false`: 含めない
`result.env.docker.id`	Number	-	Dockerエンジンバージョン ID `result.env.docker.use`が`true`の場合、表示
`result.env.docker.name`	String	-	Dockerエンジン名 `result.env.docker.use`が`true`の場合、表示
`result.cmd`	Object	-	ビルドコマンド情報
`result.cmd.pre`	Array	-	ビルド前のコマンド
`result.cmd.build`	Array	-	ビルドコマンド
`result.cmd.post`	Array	-	ビルド後のコマンド
`result.cmd.dockerbuild`	Object	-	Dockerイメージビルド情報 `result.cmd.dockerbuild.use`が`true`の場合、下位情報を含めて表示
`result.cmd.dockerbuild.use`	Boolean	-	Dockerイメージビルド設定を使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`result.cmd.dockerbuild.dockerfile`	String	-	dockerfileのパス
`result.cmd.dockerbuild.registry`	String	-	Container Registry名
`result.cmd.dockerbuild.image`	String	-	イメージ名
`result.cmd.dockerbuild.tag`	String	-	イメージタグ名
`result.cmd.dockerbuild.latest`	Boolean	-	latestタグ設定 `true` \| `false` `true`: 設定 `false`: 設定しない
`result.artifact`	Object	-	ビルド結果情報 `result.artifact.use`が`true`の場合、下位情報を含めて表示
`result.artifact.use`	Boolean	-	ビルド結果を保存するか `true` \| `false` `true`: 保存 `false`: 保存しない
`result.artifact.path`	String	-	ビルド結果の保存パス
`result.artifact.storage`	Object	-	結果の保存場所情報
`result.artifact.storage.bucket`	String	-	結果の保存先の Object Storageバケット名
`result.artifact.storage.path`	String	-	結果を保存するObject Storageのバケット内のパス
`result.artifact.storage.filename`	String	-	結果を保存するファイル名
`result.artifact.backup`	Boolean	-	結果のバックアップ `true` \| `false` `true`: バックアップ `false`: バックアップしない
`result.cache`	Object	-	ビルド完了後のイメージ保存情報 `result.cache.use`が`true`の場合、下位情報を含めて表示
`result.cache.use`	Boolean	-	ビルド完了後にイメージを保存するか `true` \| `false` `true`: 保存 `false`: 保存しない
`result.cache.registry`	String	-	Container Registry名
`result.cache.image`	String	-	イメージ名
`result.cache.tag`	String	-	イメージタグ名
`result.cache.latest`	Boolean	-	`latest`タグ設定 `true` \| `false` `true`: 設定 `false`: 設定しない
`result.linked`	Object	-	連携サービス情報
`result.linked.FileSafer`	Boolean	-	File Safer連携 `true` \| `false` `true`: 連携 `false`: 連携しない
`result.linked.CloudLogAnalytics`	Boolean	-	Cloud Log Analytics連携 `true` \| `false` `true`: 連携 `false`: 連携しない
`result.lastBuild`	Object	-	最近のビルドジョブ情報
`result.lastBuild.id`	String	-	ビルド番号最初のジョブ実行がない場合、表示しない
`result.lastBuild.timestamp`	Number	-	ビルド日時最初のジョブ実行がない場合、`null`と表示
`result.lastBuild.status`	String	-	ビルドの状態 `prepare` \| `upload` \| `success` \| `fail` \| `canceled` `prepare`: ビルド実行中 `upload`: ビルド結果保存中 `success`: ビルド実行完了(最終結果を保存) `fail`: ビルド実行失敗 `canceled`: ビルド実行をキャンセル最初のジョブ実行がない場合、`null`と表示

`envVars`

envVarsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`key`	String	-	環境変数キー
`value`	String	-	環境変数の値

レスポンスステータスコード

SourceBuild APIで共通して使用されるレスポンスステータスコードの詳細は、SourceBuildのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "result": {
        "id": 20***,
        "name": "Build001",
        "description": "Build001",
        "created": {
            "timestamp": 1747294359000,
            "user": "nb******"
        },
        "source": {
            "type": "SourceCommit",
            "config": {
                "repository": "repository001",
                "branch": "master"
            }
        },
        "env": {
            "timeout": 60,
            "envVars": [
                {
                    "key": "env1",
                    "value": "value1"
                }
            ],
            "compute": {
                "id": 1,
                "cpu": 2,
                "mem": 4
            },
            "platform": {
                "type": "SourceBuild",
                "config": {
                    "os": {
                        "id": 1,
                        "name": "ubuntu",
                        "version": "16.04",
                        "archi": "x64"
                    },
                    "runtime": {
                        "id": 5,
                        "name": "python",
                        "version": {
                            "id": 27,
                            "name": "3.10-1.0.0"
                        }
                    }
                }
            },
            "docker": {
                "use": true,
                "id": 1,
                "name": "Docker:18.09.1"
            }
        },
        "cmd": {
            "pre": [],
            "build": [],
            "post": [],
            "dockerbuild": {
                "use": false
            }
        },
        "artifact": {
            "use": false
        },
        "cache": {
            "use": false
        },
        "linked": {
            "FileSafer": false,
            "CloudLogAnalytics": false
        },
        "lastBuild": {
            "id": "4e3c7860-****-****-****-4db7e2de2984",
            "timestamp": 1747363743000,
            "status": "success"
        }
    }
}