Get Secret List

VPC環境で利用できます。

シークレットリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)

リクエスト例

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

curl --location --request GET 'https://secretmanager.apigw.ntruss.com/api/v1/secrets?pageNo=0' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	レスポンスコード
`data`	Object	-	レスポンス結果
`data.totalPageNo`	Integer	-	ページの総数
`data.currentPageNo`	Integer	-	現在のページ番号
`data.totalCount`	Integer	-	総シークレット数
`data.secretList`	Array	-	シークレットリスト

secretList

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

フィールド	タイプ	必須の有無	説明
`secretId`	String	-	シークレット ID
`secretName`	String	-	シークレット名
`secretStatus`	String	-	シークレットの状態 `ENABLE` \| `DISABLE` \| `REVOKE` \| `ROTATING` \| `DESTROYED` `ENABLE`: 利用可能 `DISABLE`: 一時停止 `REVOKE`: 削除予定 `ROTATING`: ローテーション中 `DESTROYED`: 最終削除
`secretType`	String	-	シークレットタイプ `BASIC` (有効値)
`region`	String	-	地域コード
`registerDate`	Long	-	シークレットの作成日時 Unix Timestamp形式

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "totalPageNo": 1,
        "currentPageNo": 1,
        "totalCount": 2,
        "secretList": [
            {
                "secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
                "secretName": "test-***",
                "secretStatus": "ENABLE",
                "secretType": "BASIC",
                "region": "KR",
                "registerDate": 1753065580243
            }
        ]
    }
}