Stage
- 印刷する
- PDF
Stage
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Usage Planの連結
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/associate-usage-plan
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
リクエストボディ
{
"usagePlanId" : "usagePlanId"
}
レスポンスコード
- 204
レスポンスボディ
- なし
Stageの作成
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
リクエストボディ
{
"cacheTtlSec" : 0,
"ipAclList" : "ipAclList",
"stageName" : "stageName",
"throttleRps" : 6,
"response" : "response",
"deploymentDescription" : "deploymentDescription",
"isMaintenance" : true,
"enabledContentEncoding": true,
"minimumCompressionSize": 0,
"ipAclCode" : "ALLOWED",
"endpointDomain" : "endpointDomain",
"statusCode" : 1
}
レスポンスコード
- 201
レスポンスボディ
{
"stage" : {
"canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
"modifier" : "modifier",
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryThrottleRps" : 5,
"cacheTtlSec" : 0,
"stageName" : "stageName",
"throttleRps" : 4,
"monthQuotaRequest" : 9,
"canaryCacheTtlSec" : 6,
"canaryDistributionRate" : 5.962134,
"apiId" : "apiId",
"stageId" : "stageId",
"deployedStageDeploymentNo" : 7,
"useDistributionRate" : true,
"canaryDeploymentDescription" : "canaryDeploymentDescription",
"dayQuotaRequest" : 2,
"isMaintenance" : true,
"rateRps" : 3,
"endpointDomain" : "endpointDomain",
"ipAclList" : "ipAclList",
"canaryDeploymentNo" : 1,
"regTime" : "2000-01-23T04:56:07.000+00:00",
"response" : "response",
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"tenantId" : "tenantId",
"ipAclCode" : "ALLOWED",
"statusCode" : 2,
"enabledContentEncoding": true,
"minimumCompressionSize": 0
}
}
Stageの削除
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
リクエストボディ
- なし
レスポンスコード
- 204
レスポンスボディ
- なし
Stageのリリース
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/deploy
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
リクエストボディ
{
"deploymentNo" : 0
}
レスポンスコード
- 200
レスポンスボディ
{
"stage" : {
"canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
"modifier" : "modifier",
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryThrottleRps" : 5,
"cacheTtlSec" : 0,
"stageName" : "stageName",
"throttleRps" : 4,
"monthQuotaRequest" : 9,
"canaryCacheTtlSec" : 6,
"canaryDistributionRate" : 5.962134,
"apiId" : "apiId",
"stageId" : "stageId",
"deployedStageDeploymentNo" : 7,
"useDistributionRate" : true,
"canaryDeploymentDescription" : "canaryDeploymentDescription",
"dayQuotaRequest" : 2,
"isMaintenance" : true,
"rateRps" : 3,
"endpointDomain" : "endpointDomain",
"ipAclList" : "ipAclList",
"canaryDeploymentNo" : 1,
"regTime" : "2000-01-23T04:56:07.000+00:00",
"response" : "response",
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"tenantId" : "tenantId",
"ipAclCode" : "ALLOWED",
"statusCode" : 2,
"enabledContentEncoding": true,
"minimumCompressionSize": 0
}
}
Usage Planの連結削除
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/disassociate-usage-plan
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
リクエストボディ
{
"usagePlanId" : "usagePlanId"
}
レスポンスコード
- 204
レスポンスボディ
- なし
連結する Usage Planの照会
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/search
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
リクエストボディ
{
"usagePlanId" : "usagePlanId"
}
レスポンスコード
- 200
レスポンスボディ
{
"stages" : [ {
"stageName" : "stageName",
"stageId" : "stageId"
} ]
}
Stageの検索
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
リクエストボディ
- なし
レスポンスコード
- 200
レスポンスボディ
{
"stage" : {
"canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
"modifier" : "modifier",
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryThrottleRps" : 5,
"cacheTtlSec" : 0,
"stageName" : "stageName",
"throttleRps" : 4,
"monthQuotaRequest" : 9,
"canaryCacheTtlSec" : 6,
"canaryDistributionRate" : 5.962134,
"apiId" : "apiId",
"stageId" : "stageId",
"deployedStageDeploymentNo" : 7,
"useDistributionRate" : true,
"canaryDeploymentDescription" : "canaryDeploymentDescription",
"dayQuotaRequest" : 2,
"isMaintenance" : true,
"rateRps" : 3,
"endpointDomain" : "endpointDomain",
"ipAclList" : "ipAclList",
"canaryDeploymentNo" : 1,
"regTime" : "2000-01-23T04:56:07.000+00:00",
"response" : "response",
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"tenantId" : "tenantId",
"ipAclCode" : "ALLOWED",
"statusCode" : 2,
"enabledContentEncoding": true,
"minimumCompressionSize": 0
}
}
Stageの照会
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
リクエストボディ
- なし
レスポンスコード
- 200
レスポンスボディ
{
"host" : "host",
"stages" : [ {
"canaryDeploymentNo" : 0,
"stageName" : "stageName",
"isCanary" : true,
"resourceDtos" : [ {
"corsMaxAge" : "corsMaxAge",
"resourceId" : "resourceId",
"corsAllowMethods" : "corsAllowMethods",
"methods" : [ {
"methodName" : "ANY",
"methodCode" : "methodCode"
} ],
"corsAllowOrigin" : "corsAllowOrigin",
"resourcePath" : "resourcePath",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"apiId" : "apiId",
"corsAllowHeaders" : "corsAllowHeaders"
} ],
"defaultDeploymentNo" : 6,
"stageId" : "stageId"
} ]
}
Stageの照会
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/filter
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
リクエストボディ
- なし
レスポンスコード
- 200
レスポンスボディ
{
"host" : "host",
"stages" : [ {
"canaryDeploymentNo" : 0,
"stageName" : "stageName",
"isCanary" : true,
"resourceDtos" : [ {
"corsMaxAge" : "corsMaxAge",
"resourceId" : "resourceId",
"corsAllowMethods" : "corsAllowMethods",
"methods" : [ {
"methodName" : "ANY",
"methodCode" : "methodCode"
} ],
"corsAllowOrigin" : "corsAllowOrigin",
"resourcePath" : "resourcePath",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"apiId" : "apiId",
"corsAllowHeaders" : "corsAllowHeaders"
} ],
"defaultDeploymentNo" : 6,
"stageId" : "stageId"
} ]
}
キャッシュの初期化
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/cache-initialize
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
リクエストボディ
- なし
レスポンスコード
- 200
レスポンスボディ
- なし
Stageに接続された Usage Plan検索
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/usage-plans
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
offset | query string | N | Long | Offset 最小: 0 最大: 9,223,372,036,854,775,807 |
limit | query string | N | Long | Limit 最小: 1 最大: 9,223,372,036,854,775,807 |
usagePlanName | query string | N | String | Usage Plan Name 長さ(最大/最小): 0/20 |
リクエストボディ
- なし
レスポンスコード
- 200
レスポンスボディ
{
"total" : 5,
"monthQuotaRequest" : 6,
"dayQuotaRequest" : 0,
"rateRps" : 1,
"quotaCondition" : "quotaCondition",
"content" : [ {
"domainCode" : "domainCode",
"usagePlanId" : "usagePlanId",
"modifier" : "modifier",
"associatedStagesCount" : 0,
"dayQuotaRequest" : 6,
"permission" : "permission",
"rateRps" : 5,
"usagePlanName" : "usagePlanName",
"monthQuotaRequest" : 1,
"tenantId" : "tenantId",
"disabled" : true,
"usagePlanDescription" : "usagePlanDescription",
"quotaCondition" : "quotaCondition",
"actionName" : "actionName"
} ]
}
デフォルト Usage Planの設定
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/usage-plan
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
リクエストボディ
{
"monthQuotaRequest" : 1,
"dayQuotaRequest" : 6,
"rateRps" : 0,
"quotaCondition" : "quotaCondition"
}
レスポンスコード
- 200
レスポンスボディ
{
"stage" : {
"canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
"modifier" : "modifier",
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryThrottleRps" : 5,
"cacheTtlSec" : 0,
"stageName" : "stageName",
"throttleRps" : 4,
"monthQuotaRequest" : 9,
"canaryCacheTtlSec" : 6,
"canaryDistributionRate" : 5.962134,
"apiId" : "apiId",
"stageId" : "stageId",
"deployedStageDeploymentNo" : 7,
"useDistributionRate" : true,
"canaryDeploymentDescription" : "canaryDeploymentDescription",
"dayQuotaRequest" : 2,
"isMaintenance" : true,
"rateRps" : 3,
"endpointDomain" : "endpointDomain",
"ipAclList" : "ipAclList",
"canaryDeploymentNo" : 1,
"regTime" : "2000-01-23T04:56:07.000+00:00",
"response" : "response",
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"tenantId" : "tenantId",
"ipAclCode" : "ALLOWED",
"statusCode" : 2,
"enabledContentEncoding": true,
"minimumCompressionSize": 0
}
}
Stage設定の修正
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}
リクエストパラメータ
氏名 | 位置 | 要否 | タイプ | 説明 |
---|---|---|---|---|
productId | path | Y | String | Product Id 長さ(最大/最小): 0/10 |
apiId | path | Y | String | Api Id 長さ(最大/最小): 0/10 |
stageId | path | Y | String | Stage Id 長さ(最大/最小): 0/10 |
リクエストボディ
{
"cacheTtlSec" : 0,
"ipAclList" : "ipAclList",
"throttleRps" : 6,
"response" : "response",
"isMaintenance" : true,
"ipAclCode" : "ALLOWED",
"endpointDomain" : "endpointDomain",
"statusCode" : 1,
"enabledContentEncoding": true,
"minimumCompressionSize": 0
}
レスポンスコード
- 200
レスポンスボディ
{
"stage" : {
"canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
"modifier" : "modifier",
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryThrottleRps" : 5,
"cacheTtlSec" : 0,
"stageName" : "stageName",
"throttleRps" : 4,
"monthQuotaRequest" : 9,
"canaryCacheTtlSec" : 6,
"canaryDistributionRate" : 5.962134,
"apiId" : "apiId",
"stageId" : "stageId",
"deployedStageDeploymentNo" : 7,
"useDistributionRate" : true,
"canaryDeploymentDescription" : "canaryDeploymentDescription",
"dayQuotaRequest" : 2,
"isMaintenance" : true,
"rateRps" : 3,
"endpointDomain" : "endpointDomain",
"ipAclList" : "ipAclList",
"canaryDeploymentNo" : 1,
"regTime" : "2000-01-23T04:56:07.000+00:00",
"response" : "response",
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"tenantId" : "tenantId",
"ipAclCode" : "ALLOWED",
"statusCode" : 2,
"enabledContentEncoding": true,
"minimumCompressionSize": 0
}
}
この記事は役に立ちましたか?