Resource 생성
    • PDF

    Resource 생성

    • PDF

    기사 요약

    Classic/VPC 환경에서 이용 가능합니다.

    사용자가 지정한 조건에 따라 Resource를 생성합니다.

    요청

    요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

    메서드URI
    POST/products/{product-id}/apis/{api-id}/resources

    요청 헤더

    API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

    요청 경로 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    product-idStringRequiredAPI가 속한 Product ID
    api-idStringRequiredResource를 생성할 API ID

    요청 구문

    요청 구문은 다음과 같습니다.

    {
        "corsMaxAge" : "corsMaxAge",
        "corsAllowMethods" : "corsAllowMethods",
        "corsAllowOrigin" : "corsAllowOrigin",
        "resourcePath" : "resourcePath",
        "corsAllowCredentials" : "corsAllowCredentials",
        "corsExposeHeaders" : "corsExposeHeaders",
        "corsAllowHeaders" : "corsAllowHeaders"
    }
    

    요청 바디

    요청 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    corsMaxAgeStringOptional클라이언트가 Preflight 요청 결과를 저장할 기간
    corsAllowMethodsStringOptional클라이언트 요청(리소스 접근) 시 허용할 메서드
    • GET | POST | PUT | PATCH | DELETE | HEAD | OPTIONS
    corsAllowOriginStringOptional클라이언트 요청(리소스 접근) 허용 도메인 설정
    • 모든 도메인 허용 시 * 입력
    resourcePathStringRequired리소스 경로
    • <예시> /resource
    corsAllowCredentialsStringOptionalHTTP의 Access-Control-Allow-Credentials 헤더 값에 상응되는 값
    corsExposeHeadersStringOptional클라이언트 요청(리소스 접근)에 포함 가능한 사용자 정의 헤더
    corsAllowHeadersStringOptional클라이언트 요청(리소스 접근) 시 허용할 헤더

    요청 예시

    요청 예시는 다음과 같습니다.

    curl --location --request POST 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/resources' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'Content-Type: application/json' \
    --data '{
        "corsAllowMethods" : "DELETE",
        "corsAllowOrigin" : "*",
        "resourcePath" : "/test01***2233",
        "corsAllowHeaders" : "content-type,x-ncp-apigw-api-key,x-ncp-apigw-timestamp,x-ncp-iam-access-key,x-ncp-apigw-signature-v1,x-ncp-apigw-signature-v2"
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

    응답 구문은 다음과 같습니다.

    {
        "resource" : {
            "corsMaxAge" : "corsMaxAge",
            "resourceId" : "resourceId",
            "corsAllowMethods" : "corsAllowMethods",
            "methods" : [ {
                "methodName" : "ANY",
                "methodCode" : "methodCode"
            } ],
            "corsAllowOrigin" : "corsAllowOrigin",
            "resourcePath" : "resourcePath",
            "corsAllowCredentials" : "corsAllowCredentials",
            "corsExposeHeaders" : "corsExposeHeaders",
            "apiId" : "apiId",
            "corsAllowHeaders" : "corsAllowHeaders"
        }
    }
    

    응답 상태 코드

    API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    {
        "resource": {
            "apiId": "***51hs***",
            "resourceId": "***hoc2***",
            "resourcePath": "/test01***2233",
            "corsAllowOrigin": "*",
            "corsAllowMethods": "DELETE",
            "corsAllowHeaders": "content-type,x-ncp-apigw-api-key,x-ncp-apigw-timestamp,x-ncp-iam-access-key,x-ncp-apigw-signature-v1,x-ncp-apigw-signature-v2"
        }
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.