Product 목록 조회

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

사용자가 지정한 조건을 만족하는 Product 목록을 조회합니다.

요청

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

메서드	URI
GET	/products

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`offset`	Long	Optional	응답 데이터의 시작 지점 0~9,223,372,036,854,775,807 `limit`과 함께 페이지네이션 구현에 사용
`limit`	Long	Optional	응답 데이터의 최대 수 1~9,223,372,036,854,775,807 `offset`과 함께 페이지네이션 구현에 사용
`productName`	String	Optional	조회할 Product의 이름 0~100자
`isPublished`	Boolean	Optional	게시 여부 `true` \| `false` `true`: 게시됨 `false`: 게시 안 됨
`subscriptionCode`	String	Optional	구독 방식 `PUBLIC` \| `PROTECTED` `PUBLIC`: API를 승인없이 누구나 사용 가능 `PROTECTED`: API를 사용하려면 게시자의 승인 필요
`hasDeployedStage`	Boolean	Optional	Stage 생성 여부 `true` \| `false` `true`: 생성됨 `false`: 생성 안 됨
`hasStageNotAssociatedWithUsagePlanId`	String	Optional	특정 Usage Plan과 연결된 Stage는 제외하여 조회 특정 Usage Plan ID를 입력하면 해당 Usage Plan ID와 관계가 없는 API를 응답함

요청 예시

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

curl --location --request GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/products?hasDeployedStage=true&isPublished=false&subscriptionCode=PUBLIC' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 구문

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

{
    "initialCount" : 0,
    "productPage" : {
        "total" : 6,
        "content" : [ {
            "invokeId" : "invokeId",
            "domainCode" : "domainCode",
            "productId" : "productId",
            "isPublished" : true,
            "modifier" : "modifier",
            "permission" : "permission",
            "productName" : "productName",
            "hasDeployedStage" : true,
            "subscriptionCode" : "PROTECTED",
            "isDeleted" : true,
            "modTime" : "2000-01-23T04:56:07.000+00:00",
            "tenantId" : "tenantId",
            "disabled" : true,
            "productDescription" : "productDescription",
            "actionName" : "actionName"
        } ]
    }
}

응답 상태 코드

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

응답 예시

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

{
    "productPage": {
        "content": [
            {
                "productId": "***ksk9***",
                "invokeId": "***ksk9***",
                "tenantId": "***e230cebc1402ba89b148896951***",
                "productName": "product",
                "productDescription": "",
                "isPublished": false,
                "subscriptionCode": "PUBLIC",
                "modifier": "***d3020-5bb7-11ec-bfb8-246e96591***",
                "domainCode": "GOV",
                "zoneCode": "PUBLIC",
                "hasDeployedStage": true
            }
        ],
        "total": 1
    },
    "initialCount": 4
}