API 복사
- 인쇄
- PDF
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의 이름
|
apiDescription | String | Optional | 생성할 API에 대한 설명
|
originApiId | String | Required | 복제할 원본 API ID
|
요청 예시
요청 예시는 다음과 같습니다.
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"
}
}
이 문서가 도움이 되었습니까?