Productリストの照会

Prev Next

Classic/VPC環境で利用できます。

全アカウントの Productを対象に、ユーザーが指定した条件を満たす Productリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /published-products/search

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエスト構文

リクエスト構文は次の通りです。

{
    "subscribed" : true,
    "publisherId" : "publisherId",
    "offset" : 6,
    "limit" : 0,
    "productName" : "productName",
    "productType" : [ "MY" ]
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
subscribed Boolean Optional Publishd Productのサブスクリプション有無
  • true | false
    • true: サブスクリプションする
    • false: サブスクリプションしない
publisherId String Optional 公開された APIの Tenant ID
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文字
productType Array Optional Productタイプ
  • MY | NCP | OTHERS
    • MY: 自分の Product
    • NCP: NAVERクラウドプラットフォームの Product
    • OTHERS: その他の Product

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/published-products/search' \
--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 '{
    "offset" : 6,
    "limit" : 1,
    "productName" : "product"
}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

{
    "initialCount" : 0,
    "productPage" : {
        "total" : 6,
        "content" : [ {
            "subscriptionCode" : "PROTECTED",
            "subscribed" : true,
            "domainCode" : "domainCode",
            "productId" : "productId",
            "tenantId" : "tenantId",
            "productDescription" : "productDescription",
            "productName" : "productName",
            "zoneCode" : "PUBLIC"
        } ]
    }
}

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "productPage": {
        "content": [
            {
                "productId": "***pxks***",
                "tenantId": "***3f2489612436793577e878e69e***",
                "productName": "product2",
                "productDescription": "複数の APIをグループ化して管理するための単位",
                "subscribed": false,
                "subscriptionCode": "PUBLIC",
                "domainCode": "PUB",
                "zoneCode": "PUBLIC"
            }
        ],
        "total": 28
    },
    "initialCount": 780
}