リポジトリリストの照会

Prev Next

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

リポジトリリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://sourcecommit.apigw.ntruss.com/api/v1/repository?repositoryName=repository&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.repository Array - リポジトリリスト

repository

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

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

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

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

レスポンス例

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

{
    "result": {
        "total": 2,
        "repository": [
            {
                "id": 632***,
                "name": "repository002",
                "permission": "Allow",
                "actionName": "View/getRepositoryDetail"
            },
            {
                "id": 632***,
                "name": "repository001",
                "permission": "Allow",
                "actionName": "View/getRepositoryDetail"
            }
        ]
    }
}