View resource list
    • PDF

    View resource list

    • PDF

    Article summary

    Available in Classic and VPC

    View the list of resources based on the conditions the user specifies.

    Request

    The following describes the request format for the endpoint. The request format is as follows:

    MethodURI
    GET/products/{product-id}/apis/{api-id}/resources

    Request headers

    For headers common to API Gateway, see API Gateway common request headers.

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    product-idStringRequiredProduct ID that the API belongs to
    api-idStringRequiredID of the API whose resource you want to view

    Request example

    The following is a sample request.

    curl --location --request GET 'https://apigateway.apigw.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}'
    

    Response

    The following describes the response format.

    Response syntax

    The response syntax is as follows.

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

    Response status codes

    For response status codes common to API Gateway, see API Gateway API response status codes.

    Response example

    The following is a sample response.

    {
        "resourceList": [
            {
                "methods": [
                    {
                        "methodCode": "0002",
                        "methodName": "POST"
                    },
                    {
                        "methodCode": "0006",
                        "methodName": "OPTIONS"
                    }
                ],
                "resourceId": "***wopi***",
                "resourcePath": "/***wqod***",
                "corsAllowOrigin": "*",
                "corsAllowMethods": "GET,POST,HEAD",
                "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",
                "corsAllowCredentials": "",
                "corsMaxAge": "",
                "corsExposeHeaders": ""
            },
    // (Omitted)
        ]
    }
    

    Was this article helpful?

    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.