MENU
      API 조회

        API 조회


        기사 요약

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

        Dashboard의 Product 관련 파라미터를 이용하여 Product에 생성되어 배포된 API를 조회합니다.

        요청

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

        메서드URI
        GET/dashboards/products/{product-id}/api-ids

        요청 헤더

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

        요청 경로 파라미터

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

        필드타입필수 여부설명
        product-idStringRequiredAPI에 연결된 Product ID

        요청 쿼리 파라미터

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

        필드타입필수 여부설명
        regionsList<String>OptionalAPI를 조회할 리전
        • 컬렉션의 아이템은 null일 수 없음
        offsetLongOptional조회할 데이터 목록에서 시작할 위치
        • 0~9,223,372,036,854,775,807
        limitLongOptional한 번에 조회할 데이터 개수
        • 1~9,223,372,036,854,775,807
        fromStringRequired조회 시작 일자(yyyy-MM-dd)
        toStringRequired조회 종료 일자(yyyy-MM-dd)
        timeZoneStringRequired타임 존(+09:00)
      • GET 방식 이용 시 URL 인코딩 필요
      • 요청 예시

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

        curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/api-ids
        ?from=2024-05-09
        &to=2024-05-09
        &timeZone=%2B09%3A00' \
        --header 'Content-Type: application/json' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Curl

        응답

        응답 형식을 설명합니다.

        응답 구문

        구문은 다음과 같습니다.

        {
            "apis": {
                "content": [
                    {
                        "apiId": "apiId",
                        "apiName": "apiName",
                        "deleted": true
                    }
                ],
                "total": 1
            }
        }
        JSON

        응답 상태 코드

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

        응답 예시

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

        {
            "apis": {
                "content": [
                    {
                        "apiId": "*****vcqwb",
                        "apiName": "api-***",
                        "deleted": true
                    }
                ],
                "total": 1
            }
        }
        JSON

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

        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.