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

Prev Next

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

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

リクエスト

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

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

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/sourcebuild/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 - ビルドプロジェクト名
permission String - 詳細情報の照会権限を持っているか
  • Allow | Deny
    • Allow: 持っている
    • Deny: 持っていない
actionName String - 詳細情報照会権限名

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

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

レスポンス例

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

{
    "result": {
        "projectList": [
            {
                "id": 20***,
                "name": "build-sample",
                "permission": "Allow",
                "actionName": "View/getBuildProjectDetail"
            },
            {
                "id": 20***,
                "name": "build1",
                "permission": "Allow",
                "actionName": "View/getBuildProjectDetail"
            }
        ]
    }
}