API

印刷する
共有
PDF

API

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

APIコピー

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/clone

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10

リクエストボディ

{
  "apiName" : "apiName",
  "apiDescription" : "apiDescription",
  "originApiId" : "originApiId"
}

応答コード

応答ボディ

{
  "api" : {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  }
}

APIの作成

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10

リクエストボディ

{
  "apiName" : "apiName",
  "apiDescription" : "apiDescription"
}

応答コード

応答ボディ

{
  "api" : {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  }
}

APIの削除

URL

DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10
apiId	path	Y	String	Api Id 長さ（最大/最小）：0 / 10

リクエストボディ

なし

応答コード

応答ボディ

なし

API配布

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/deploy

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10
apiId	path	Y	String	Api Id 長さ（最大/最小）：0 / 10

リクエストボディ

{
  "deploymentDescription" : "deploymentDescription",
  "stageId" : "stageId"
}

応答コード

応答ボディ

なし

API照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product 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
withStage	query string	N	Boolean	With Stage
apiName	query string	N	String	Api Name 長さ（最大/最小）：0 / 20
hasStage	query string	N	Boolean	Has Stage
hasStageNotAssociatedWithUsagePlanId	query string	N	String	Has Stage Not Associated With Usage Plan Id

リクエストボディ

なし

応答コード

応答ボディ

{
  "total" : 0,
  "apis" : [ {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  } ]
}

API照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/filter

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10

リクエストボディ

なし

応答コード

応答ボディ

{
  "total" : 0,
  "apis" : [ {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  } ]
}

API照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10
apiId	path	Y	String	Api Id 長さ（最大/最小）：0 / 10

リクエストボディ

なし

応答コード

応答ボディ

{
  "api" : {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  }
}

API検索

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/infos

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product 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
withStage	query string	N	Boolean	With Stage
apiName	query string	N	String	Api Name 長さ（最大/最小）：0 / 20
hasStage	query string	N	Boolean	Has Stage
hasStageNotAssociatedWithUsagePlanId	query string	N	String	Has Stage Not Associated With Usage Plan Id

リクエストボディ

なし

応答コード

応答ボディ

{
  "total" : 0,
  "apis" : [ {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  } ]
}

Swaggerからデータをインポートする

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/import

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10

リクエストボディ

{
  "apiName" : "apiName",
  "apiDescription" : "apiDescription",
  "importValidateType" : "FAIL_ON_WARN",
  "swagger" : "swagger"
}

応答コード

応答ボディ

{
  "errorMessages" : [ "errorMessages" ],
  "warnMessages" : [ "warnMessages" ],
  "success" : true,
  "api" : {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  }
}

APIの変更

URL

PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10
apiId	path	Y	String	Api Id 長さ（最大/最小）：0 / 10

リクエストボディ

{
  "apiDescription" : "apiDescription"
}

応答コード

応答ボディ

なし

API公開

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/publish

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
productId	path	Y	String	Product Id 長さ（最大/最小）：0 / 10
apiId	path	Y	String	Api Id 長さ（最大/最小）：0 / 10

リクエストボディ

{
  "stages" : [ {
    "isPublished" : true,
    "stageId" : "stageId"
  } ]
}

応答コード

応答ボディ

なし

この記事は役に立ちましたか?

What's Next

API Key

APIコピー
APIの作成
APIの削除
API配布
API照会
API照会
API照会
API検索
Swaggerからデータをインポートする
APIの変更
API公開

タグ

API Gateway