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

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

デプロイプロジェクトリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`projectName`	String	Optional	検索キーワードプロジェクト名が完全一致または一部一致する値を絞り込み
`pageNo`	Number	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Number	Optional	ページごとの項目数 1~N 入力しないと全リストを表示

リクエスト例

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

curl --location --request GET 'https://sourcebuild.apigw.ntruss.com/api/v1/project?projectName=Build3&pageNo=1&pageSize=100' \
--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.total`	Number	-	レスポンス結果数
`result.project`	Array	-	プロジェクトリスト

`project`

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

フィールド	タイプ	必須の有無	説明
`id`	Number	-	プロジェクト ID
`name`	String	-	プロジェクト名
`permission`	String	-	詳細情報の照会権限を持っているか `Allow` \| `Deny` `Allow`: 持っている `Deny`: 持っていない
`actionName`	String	-	詳細情報照会権限名

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

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

レスポンス例

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

{
    "result": {
        "total": 2,
        "project": [
            {
                "id": 20632,
                "name": "Build001",
                "permission": "Allow",
                "actionName": "View/getProjectDetail"
            },
            {
                "id": 20631,
                "name": "Build002",
                "permission": "Allow",
                "actionName": "View/getProjectDetail"
            }
        ]
    }
}