プロジェクトの更新

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

デプロイプロジェクトの設定を変更します。

リクエスト

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

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

リクエストヘッダ

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

リクエストパラメータ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`description`	String	Optional	プロジェクトの説明
`source`	Object	Optional	ソース保存場所情報
`source.type`	String	Optional	ソース保存場所のタイプ `SourceCommit` (有効値)
`source.config`	Object	Conditional	ソース保存場所のリポジトリ情報 `source.type`を入力した場合、下位情報を含めて必ず入力
`source.config.repository`	String	Conditional	ソース保存場所リポジトリ名 SourceCommitリポジトリリストの照会を参照
`source.config.branch`	String	Conditional	ソース保存場所リポジトリブランチ名 SourceCommitブランチリストの照会を参照
`env`	Object	Optional	ビルド環境情報
`env.compute`	Object	Optional	ビルド環境のコンピューティングタイプ情報
`env.compute.id`	Number	Optional	コンピューティングタイプ ID コンピューティングタイプリストの照会を参照
`env.platform`	Object	Optional	ビルド環境プラットフォーム情報
`env.platform.type`	String	Optional	イメージ保存場所のタイプ `SourceBuild` \| `ContainerRegistry` \| `PublicRegistry` `SourceBuild`: SourceBuildで管理されるイメージ `ContainerRegistry`: Container Registryのイメージ `PublicRegistry`: Public Registryのイメージ
`env.platform.config`	Object	Conditional	ビルド環境の設定 `env.platform.type`を入力した場合、下位情報を含めて必ず入力
`env.platform.config.os`	Object	Conditional	OS情報 `env.platform.type`が`SourceBuild`の場合、下位情報を含めて必ず入力
`env.platform.config.os.id`	Number	Conditional	OSの ID OSリストの照会を参照
`env.platform.config.runtime`	Object	Conditional	ランタイム情報 `env.platform.type`が`SourceBuild`の場合、下位情報を含めて必ず入力
`env.platform.config.runtime.id`	Number	Conditional	ランタイムタイプ ID ランタイムタイプリストの照会を参照
`env.platform.config.runtime.version`	Object	Conditional	ランタイムバージョン情報
`env.platform.config.runtime.version.id`	Number	Conditional	ランタイムバージョン ID ランタイムバージョンリストの照会を参照
`env.platform.config.registry`	Object	Conditional	レジストリ情報 `env.platform.type`が`ContainerRegistry`の場合、必ず入力 Container Registryリストの照会を参照
`env.platform.config.image`	String	Conditional	イメージ名 `env.platform.type`が`ContainerRegistry`または`PublicRegistry`の場合、必ず入力
`env.platform.config.tag`	String	Conditional	イメージタグ名 `env.platform.type`が`ContainerRegistry`または`PublicRegistry`の場合、必ず入力
`env.docker`	Object	Optional	Dockerエンジン情報
`env.docker.use`	Boolean	Optional	Dockerビルドに Dockerエンジンを含めるかどうか `true` \| `false` (デフォルト) `true`: 含める `false`: 含めない
`env.docker.id`	Number	Conditional	Dockerエンジンバージョン ID Dockerエンジンリストの照会を参照 `env.docker.use`が`true`の場合、必ず入力
`env.timeout`	Number	Optional	ビルド実行タイムアウト(分) 5~540 (デフォルト: 5)
`env.envVars`	Array	Optional	ビルド環境変数情報
`cmd`	Object	Optional	ビルドコマンド情報
`cmd.pre`	Array	Optional	ビルド前のコマンド
`cmd.build`	Array	Optional	ビルドコマンド
`cmd.post`	Array	Optional	ビルド後のコマンド
`cmd.dockerbuild`	Object	Conditional	Dockerイメージビルド情報 `cmd.dockerbuild.use`が`true`の場合、下位情報を含めて必ず入力ただし、`cmd.dockerbuild.latest`はオプション(Optional)
`cmd.dockerbuild.use`	Boolean	Optional	Dockerイメージビルド設定を使用するか `true` \| `false` (デフォルト) `true`: 使用 `env.docker.use`が`true`の場合にのみ使用可能 `false`: 使用しない
`cmd.dockerbuild.dockerfile`	String	Conditional	dockerfileのパス
`cmd.dockerbuild.registry`	String	Conditional	Container Registry名
`cmd.dockerbuild.image`	String	Conditional	イメージ名
`cmd.dockerbuild.tag`	String	Conditional	イメージタグ名
`cmd.dockerbuild.latest`	Boolean	Optional	latestタグ設定 `true` \| `false` (デフォルト) `true`: 設定 `false`: 設定しない
`artifact`	Object	Conditional	ビルド結果の保存情報 `artifact.use`が`true`の場合、下位情報を含めて必ず入力ただし、`artifact.backup`は任意入力
`artifact.use`	Boolean	Optional	ビルド結果を保存するか `true` \| `false` (デフォルト) `true`: 保存 `false`: 保存しないビルド結果は圧縮ファイル(*.zip)で保存
`artifact.path`	Array	Conditional	ビルド結果のパス `artifact.use`が`true`の場合、必ず入力
`artifact.storage.bucket`	String	Conditional	結果の保存先 Object Storageバケットの名前 `artifact.use`が`true`の場合、必ず入力
`artifact.storage.path`	String	Conditional	結果の保存先 Object Storageバケットのパス `artifact.use`が`true`の場合、必ず入力
`artifact.storage.filename`	String	Conditional	結果を保存するファイルの名前 `artifact.use`が`true`の場合、必ず入力
`artifact.backup`	Boolean	Optional	結果のバックアップ `true` \| `false` (デフォルト) `true`: バックアップ `false`: バックアップしない
`cache`	Object	Optional	ビルド完了後のイメージ保存情報 `cache.use`が`true`の場合、下位情報を含めて必ず入力ただし、`cache.latest`は任意入力
`cache.use`	Boolean	Optional	ビルド完了後にイメージを保存するか `true` \| `false` (デフォルト) `true`: 保存 `false`: 保存しない
`cache.registry`	String	Conditional	Container Registry名 `cache.use`が`true`の場合、必ず入力
`cache.image`	String	Conditional	イメージ名 `cache.use`が`true`の場合、必ず入力
`cache.tag`	String	Conditional	イメージタグ名 `cache.use`が`true`の場合、必ず入力
`cache.latest`	Boolean	Optional	latestタグ設定 `true` \| `false` (デフォルト) `true`: 設定 `false`: 設定しない
`linked`	Object	Optional	連携サービス情報
`linked.CloudLogAnalytics`	Boolean	Optional	Cloud Log Analytics連携 `true` \| `false` (デフォルト) `true`: 連携 `false`: 連携しない
`linked.FileSafer`	Boolean	Optional	File Safer連携 `true` \| `false` (デフォルト) `true`: 連携 `false`: 連携しない

`envVars`

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

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

リクエスト例

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

curl --location --request PATCH '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}' \
--data '{
    "description": "Build001",
    "source": {
        "type": "SourceCommit",
        "config": {
            "repository": "repository001", 
            "branch": "master"
        }
    },
    "env": {
        "compute": {
            "id": 1
            },
        "platform": {
            "type": "SourceBuild",
            "config": {
                "os": {
                    "id": 1
                    },
                "runtime": {
                    "id": 5,
                    "version": {
                        "id": 27
                    }
                }    
            }
        },
        "docker": {
           "use": true,
           "id": 1
        },
        "timeout": 60,
        "envVars": [
            {
                "key": "env1",
                "value": "value1"
            }
        ]
    },
    "cmd": {
       "pre": [],
       "build": [],
       "post": [],
       "dockerbuild": {
           "use": false,
           "dockerfile": "",
           "registry": "",
           "image": "",
           "tag": "",
           "latest": false
       }
    },
    "artifact": {
        "use": false,
        "path": [],
        "storage": {
            "bucket": "string",
            "path": "string",
            "filename": "string"
        },
        "backup": false
    },
    "cache": {
        "use": false,
        "registry": "",
        "image": "",
        "tag": "",
        "latest": false
    },
    "linked": {
        "CloudLogAnalytics": false,
        "FileSafer": false
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`result`	Object	-	レスポンス結果
`result.id`	Number	-	プロジェクト ID
`result.name`	String	-	プロジェクト名

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

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

レスポンス例

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

{
    "result": {
        "id": 20***,
        "name": "Build001"
    }
}