プロジェクト設定の変更

印刷する
共有
PDF

記事の要約

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

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

概要

SourceBuildプロジェクトの設定を修正します。

リクエスト

API URL

PATCH	{SOURCEBUILD_API_URL}/project/{projectId}

リクエストパラメータ

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

リクエストクエリ

なし

リクエストボディ

{
    "description": "string",
    "source": {
        "type": "string",
        "config": {
            "repository": "string",
            "branch": "string"
        }
    },
    "env":  {
        "compute": { "id": "number" },
        "platform": {
            "type": "string",
            "config": "TEnvSourceBuild" | "TEnvContainerRegistry" | "TEnvPublicRegistry"
        },
        "docker": {
            "use": "boolean",
            "id": "number"
        },
        "timeout": "number",
        "envVars": {
            "key": "string",
            "value": "string"
        }
    },
    "cmd": {
        "pre": ["string"],
        "build": ["string"],
        "post": ["string"],
        "dockerbuild": {
            "use": ["string"],
            "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"
    }
}

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

TEnvPlatformConfig

TEnvSourceBuild

{
    "os": {
        "id": "number"
    },
    "runtime": {
        "id": "number",
        "version": {
            "id": "number"
        }
    }
}

項目	Required	Type	説明	備考
os.id	Y	number	OS ID	buildEnvOSListAPIで照会
runtime.id	Y	number	ランタイムID	buildEnvRunTimeList APIで照会
runtime.version.id	Y	number	ランタイムバージョンID	buildEnvRunTimeVersionList APIで照会

TEnvContainerRegistry

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

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

TEnvPublicRegistry

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

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

レスポンス

レスポンスボディ

{
    "id": "number",
    "name": "string"
}

項目	タイプ	説明	備考
id	number	プロジェクトID
name	string	プロジェクト名

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

What's Next

プロジェクトの削除

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

タグ

SourceBuild