SourceDeployプロジェクトリストの照会

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

使用可能な SourceDeployプロジェクトリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/sourcedeploy/project

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Number	Optional	ページ番号 1~N `pageSize`入力時、必ず入力
`pageSize`	Number	Optional	ページごとの項目数 1~N `pageNo`入力時、必ず入力
`searchWord`	String	Optional	検索キーワードプロジェクト名が完全一致または一部一致する値を絞り込み

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`result`	Object	-	レスポンス結果
`result.projectList`	Array	-	デプロイプロジェクトリスト

`projectList`

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

フィールド	タイプ	必須の有無	説明
`id`	Number	-	デプロイプロジェクト ID
`name`	String	-	デプロイプロジェクト名

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

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

レスポンス例

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

{
    "result": {
        "projectList": [
            {
                "id": 2***,
                "name": "deploy2"
            },
            {
                "id": 2***,
                "name": "deploy1"
            }
        ]
    }
}