Stageデプロイ履歴の照会
- 印刷する
- PDF
Stageデプロイ履歴の照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
指定した Stageに APIをデプロイした履歴を照会します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
product-id | String | Required | Stageが属する Product ID
|
api-id | String | Required | Stageが属する API ID
|
stage-id | String | Required | デプロイ履歴照会対象の Stage ID
|
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
offset | Long | Optional | レスポンスデータの開始点
|
limit | Long | Optional | レスポンスデータの最大数
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***5ei7***/deployments' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
{
"total" : 1,
"content" : [ {
"deployedTime" : "2000-01-23T04:56:07.000+00:00",
"deploymentDescription" : "deploymentDescription",
"stageDeploymentNo" : 0,
"documentJson" : "documentJson",
"stageId" : "stageId"
} ],
"defaultDeploymentNo" : 6
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"content": [
{
"stageDeploymentNo": 251***,
"deploymentDescription": "",
"stageId": "***5ei7***",
"deployedTime": "2024-05-08T02:38:43Z"
},
// (省略)
],
"total": 9,
"defaultDeploymentNo": 251***
}
この記事は役に立ちましたか?