プロジェクトの詳細照会

印刷する
共有
PDF

プロジェクトの詳細照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

概要

SourceBuildプロジェクトを詳細に照会します。

リクエスト

API URL

TEnvPlatformConfig

GET  {SOURCEBUILD_API_URL}/project/{projectId}

リクエスト Parameter

項目	タイプ	説明	備考
projectId	string	プロジェクト ID	projectList APIで照会

リクエスト Query

なし

リクエスト Body

なし

レスポンス

レスポンス Body

{
    "id": "number",
    "name": "string",
    "description": "string",
    "created": {
        "timestamp": "number",
        "user": "string"
    },
    "source": {
        "type": "string",
        "config": "TSourceSourceCommitGithub", | "TSourceBitbucket" |  "TSourceGithubEnterpriseHttps" | "TSourceGithubEnterpriseSsh"
    },
    "env": {
        "compute": {
            "id": "number",
            "cpu": "number",
            "mem": "number"
        },
        "platform": {
            "type": "string",
            "config": "TEnvSourceBuild" | "TEnvContainerRegistry" | "TEnvPublicRegistry"
        },
        "docker": {
            "use": "boolean",
            "id": "number",
            "name": "string"
        },
        "timeout": "number",
        "envVars": [
            {
                "key": "string",
                "value": "stirng"
            }
        ]
    },
    "cmd": {
        "pre": ["string"],
        "build": ["string"],
        "post": ["string"],
        "dockerbuild": {
            "use": "boolean",
            "dockerfile": "string",
            "registry": "string",
            "image": "string",
            "tag": "string",
            "latest": "boolean"
        }
    },
    "artifact": {
        "use": "boolean",
        "path": "string",
        "storage": {
            "bucket": "string",
            "path": "string",
            "filename": "string"
        },
        "backup": "boolean"
    },
    "cache": {
        "use": "boolean",
        "registry": "string",
        "image": "string",
        "tag": "string",
        "latest": "boolean"
    },
    "linked": {
        "CloudLogAnalytics": "boolean",
        "FileSafer": "boolean"
    },
    "lastBuild": {
        "id": "string",
        "timestamp": "number",
        "status": "string"
    }
}

項目	タイプ	説明	備考
id	number	プロジェクト ID
name	string	プロジェクト名
description	string	プロジェクトの説明
source.type	"SourceCommit" , "Github", "Bitbucket", "Github Enterprise Server"	ソース保存場所のタイプ
source.config	TSourceSourceCommitGithub \| TSourceBitbucket \| TSourceGithubEnterpriseHttps \| TSourceGithubEnterpriseSsh	ソース保存場所のリポジトリ名	source.type="SourceCommit"または "Github"の場合、TSourceSourceCommitGithub source.type="Bitbucket"の場合、TSourceBitbucket source.type="Github Enterprise Server" & OAuth, Personal Access Token, Username / Passwordでログインした場合、TSourceGithubEnterpriseHttps source.type="Github Enterprise Server" & SSH keyでログインした場合、TSourceGithubEnterpriseSsh
env.compute.id	number	ビルド環境のコンピューティングタイプ id	buildEnvComputeList APIで照会
env.compute.cpu	number	ビルド環境の vCPU数
env.compute.mem	number	ビルド環境の mem容量	単位: GB
env.platform.type	"SourceBuild" \|"ContainerRegistry" \|"PublicRegistry"	ビルド環境のイメージ保存場所タイプ	SourceBuild: SourceBuildで管理されるイメージ、 ContainerRegistry: Container Registryのイメージ PublicRegistry: Public Registryのイメージ
env.platform.config	TEnvSourceBuild \| TEnvContainerRegistry \| TEnvPublicRegistry	ビルド環境の設定	env.platform.type="SourceBuild"の場合、TEnvSourceBuild nv.platform.type="ContainerRegistry"の場合、TEnvContainerRegistry env.platform.type="PublicRegistry"の場合、TEnvPublicRegistry 以下の TEnvPlatformConfigを参照
env.docker.use	boolean	Dockerビルドのためのビルド環境における Dockerエンジン(使用)の有無
env.docker.id	number	Dockerエンジンバージョン id	buildEnvDockerList APIで照会
env.docker.name	string	Dockerエンジン名
env.timeout	number	ビルド実行のタイムアウト	単位: 分
env.envVars	{"key": string, "value": string}[]	ビルドの環境変数
cmd.pre	string[]	ビルド前のコマンド
cmd.build	string[]	ビルドコマンド
cmd.post	string[]	ビルド後のコマンド
cmd.dockerbuild.use	boolean	Dockerイメージのビルド設定の使用有無
cmd.dockerbuild.dockerfile	string	dockerfileのファイル名を含むパス	source.config.repositoryに指定されたソースの保存場所に dockerfileが含まれている必要があり、パスはソース保存場所の最上位からのパスを入力。
cmd.dockerbuild.registry	string	イメージを保存する Container Registryのレジストリ名
cmd.dockerbuild.image	string	イメージ名
cmd.dockerbuild.tag	string	タグ名
cmd.dockerbuild.latest	boolean	latestタグの保存有無
artifact.use	boolean	ビルド結果の保存有無
artifact.path	string[]	ビルド結果の位置	source.config.repositoryに指定されたソース保存場所の最上位からのパスを入力。ファイルパス、ディレクトリパスの両方とも可能。
artifact.storage.bucket	string	結果を保存する Object Storageのバケット名
artifact.storage.path	string	結果を保存する Object Storageバケット内のパス
artifact.storage.filename		結果を保存するファイル名	ZIP形式で圧縮保存されます。拡張子が.zipではない場合は、自動的に.zipが付与されて保存されます。
artifact.backup	boolean	結果のバックアップ有無
cache.use	boolean	ビルド完了後のビルド環境の保存有無	ビルド完了後にビルド環境をイメージ化して保存できます。そのイメージはビルド環境のイメージに設定して xxxビルドとして使用できます。
cache.registry	string	ビルド完了後にビルド環境のイメージを保存する Container Registryのレジストリ名
cache.image	string	イメージ名
cache.tag	string	タグ名
cache.latest	boolean	latestタグの保存有無
linked.CloudLogAnalytics	boolean	ビルドログの Cloud Log Analyticsへの保存有無
linked.FileSafer	boolean	ビルド結果の File Safer(File Filter)による検査有無
lastBuild.id	string	最後にビルドしたビルド ID
lastBuild.timestamp	number	最後のビルド時刻
lastBuild.status	string	最後にビルドしたビルドの状態

TSourceConfig

TSourceSourceCommitGithub

{
    "repository": "string",
    "branch": "string"
}

項目	タイプ	説明	備考
repository	string	リポジトリ
branch	string	ブランチ

TSourceBitbucket

{
    "repository": "string",
    "branch": "string",
    "workspace": {
        "id": "string",
        "name": "string"
    }
}

項目	タイプ	説明
repository	string	リポジトリ
branch	string	ブランチ
workspace.id	string	workspace id
workspace.name	string	workspace名

TSourceGithubEnterpriseHttps

{
    "owner": "string",
    "repository": "string",
    "branch": "string",
    "serverUrl": "string"
}

項目	タイプ	説明
owner	string	所有者
repository	string	リポジトリ
branch	string	ブランチ
serverUrl	string	サーバ URL

TSourceGithubEnterpriseSsh

{
    "owner": "string",
    "repository": "string",
    "branch": "string",
    "url": "string"
}

項目	タイプ	説明
owner	string	所有者
repository	string	リポジトリ
branch	string	ブランチ
url	string	リポジトリ URL

TEnvPlatformConfig

TEnvSourceBuild

{
    "os": {
        "id": "number",
        "name": "string",
        "version": "string",
        "archi": "string"
    },
    "runtime": {
        "id": "number",
        "name": "string",
        "version": {
            "id": "number",
            "name": "string"
        }
    }
}

項目	タイプ	説明	備考
os.id	number	OS ID	buildEnvOSList APIで照会
os.name	string	OS名	buildEnvOSList APIで照会
os.version	string	OSバージョン	buildEnvOSList APIで照会
os.archi	string	OSアーキテクチャ	buildEnvOSList APIで照会
runtime.id	number	ランタイム ID	buildEnvRunTimeList APIで照会
runtime.name	string	ランタイム名	buildEnvRunTimeList APIで照会
runtime.version.id	number	ランタイムバージョン ID	buildEnvRunTimeVersionList APIで照会
runtime.version.name	string	ランタイムバージョン名	buildEnvRunTimeVersionList APIで照会

TEnvContainerRegistry

{
		"registry": "string",
		"image": "string",
		"tag": "string"
}

項目	タイプ	説明
registry	string	レジストリ名
image	string	イメージ名
tag	string	タグ名

TEnvPublicRegistry

{
    "image": "string",
    "tag": "string"
}

項目	タイプ	説明	備考
image	string	イメージ名
tag	string	タグ名

この記事は役に立ちましたか?

What's Next

プロジェクトの作成

概要
リクエスト
レスポンス

タグ

SourceBuild