APIのコピー

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

APIをコピーして新規 APIを作成します。

リクエスト

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

メソッド	URI
POST	/products/{product-id}/apis/clone

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`product-id`	String	Required	APIと関連付けられた Product ID

リクエスト構文

リクエスト構文は次の通りです。

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`apiName`	String	Required	作成する APIの名前英数字、記号の「-」、「_」を使用して0~20文字以内で入力
`apiDescription`	String	Optional	作成する APIの説明 0~300文字
`originApiId`	String	Required	コピーするソース API ID 0~10文字

リクエスト例

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

curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/clone' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
  "apiName" : "api-***",
  "apiDescription" : "api-*** Description",
  "originApiId" : "**********"
}

レスポンス

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

レスポンス構文

構文は次の通りです。

{
    "api": {
        "productId": "productId",
        "apiId": "apiId",
        "apiName": "apiName",
        "apiDescription": "apiDescription",
        "tenantId": "tenantId",
        "modifier": "modifier",
        "modTime": "2024-05-03T07:46:37Z",
        "isDeleted": false,
        "domainCode": "domainCode"
    }
}

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

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

レスポンス例

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

{
    "api": {
        "productId": "*****0bk",
        "apiId": "*****1r9cm",
        "apiName": "api_clone",
        "apiDescription": "api_clone Description",
        "tenantId": "*****02f55ae4436913a6e2c65bab47c",
        "modifier": "d12c9fd0-****-****-****-246e96591a38",
        "modTime": "2024-05-03T07:46:37Z",
        "isDeleted": false,
        "domainCode": "PUB"
    }
}

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

What's Next

APIの作成

リクエスト
レスポンス