Productリストの照会
    • PDF

    Productリストの照会

    • PDF

    記事の要約

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

    ユーザーが指定した条件を満たす Productリストを照会します。

    リクエスト

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

    メソッドURI
    GET/products

    リクエストヘッダ

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

    リクエストクエリパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    offsetLongOptionalレスポンスデータの開始点
    • 0~9,223,372,036,854,775,807
    • limitと共にページネーションの実装に使用
    limitLongOptionalレスポンスデータの最大数
    • 1~9,223,372,036,854,775,807
    • offsetと共にページネーションの実装に使用
    productNameStringOptional照会対象の Productの名前
    • 0~100文字
    isPublishedBooleanOptional公開有無
    • true | false
      • true: 公開される
      • false: 公開されない
    subscriptionCodeStringOptionalサブスクリプション方法
    • PUBLIC | PROTECTED
      • PUBLIC: APIを承認なしで誰でも使用可能
      • PROTECTED: APIを使用するには、公開者の承認が必要
    hasDeployedStageBooleanOptionalStageは作成されたか
    • true | false
      • true: 作成済み
      • false: 未作成
    hasStageNotAssociatedWithUsagePlanIdStringOptional特定の Usage Planと関連付けられた Stageを除いて照会
    • 特定の Usage Plan IDを入力するとその Usage Plan IDと無関係の APIを返す

    リクエスト例

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

    curl --location --request GET 'https://apigateway.apigw.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": "PUB",
                    "zoneCode": "PUBLIC",
                    "hasDeployedStage": true
                }
            ],
            "total": 1
        },
        "initialCount": 4
    }
    

    この記事は役に立ちましたか?

    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.