API 조회
    • PDF

    API 조회

    • PDF

    기사 요약

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

    API의 정보를 조회합니다.
    이 API는 조회 시 VIEW_GET_API (subaccount)에 대한 서브 계정 리소스 리스트를 확인(SubAccountResourceListCheck)합니다.

    요청

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

    메서드URI
    GET/products/{product-id}/apis

    요청 헤더

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

    요청 경로 파라미터

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

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

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    offsetLongOptional조회할 데이터 목록에서 시작할 위치
    • 0~9,223,372,036,854,775,807
    limitLongOptional한 번에 조회할 데이터 개수
    • 1~9,223,372,036,854,775,807
    withStageBooleanOptionalStage 정보 조회 여부
    • true | false
      • true: Stage 정보 조회함
      • false: Stage 정보 조회 안 함
    apiNameStringOptionalAPI 이름으로 필터링
    • 0~20
    hasStageBooleanOptionalStage 유무로 필터링
    • true | false
      • true: Stage 있음
      • false: Stage 없음
    hasStageNotAssociatedWithUsagePlanIdStringOptional특정 Usage Plan과 연결된 Stage는 제외하여 조회
    • 특정 Usage Plan ID를 입력하면 해당 Usage Plan ID와 관계가 없는 api를 응답함

    요청 예시

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

    curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis' \
    --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}'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

    구문은 다음과 같습니다.

    {
        "apis": [
            {
                "stages": [
                    {
                        "apiId": "apiId",
                        "stageId": "stageId",
                        "stageName": "stageName",
                        "isPublished": true
                    }
                ],
                "productId": "productId",
                "apiId": "apiId",
                "apiName": "apiName",
                "apiDescription": "apiDescription",
                "tenantId": "tenantId",
                "modifier": "modifier",
                "modTime": "2024-05-02T08:10:26Z",
                "isDeleted": false,
                "domainCode": "domainCode"
            }
        ],
        "total": 0
    }
    

    응답 상태 코드

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

    응답 예시

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

    {
        "apis": [
            {
                "stages": [
                    {
                        "apiId": "*****luwtk",
                        "stageId": "*****7mhdv",
                        "stageName": "v1",
                        "isPublished": true
                    }
                ],
                "productId": "*****xn0bk",
                "apiId": "*****luwtk",
                "apiName": "api",
                "apiDescription": "",
                "tenantId": "*****02f55ae4436913a6e2c65bab47c",
                "modifier": "d12c9fd0-****-****-****-246e96591a38",
                "modTime": "2024-05-02T08:10:26Z",
                "isDeleted": false,
                "domainCode": "PUB"
            }
        ],
        "total": 1
    }
    

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

    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.