MENU
      Login
          Login
          目次 x
          Productの照会
            目次

            Productの照会

              記事の要約

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

              Dashboardの Product関連パラメータを利用して作成された Productを照会します。

              リクエスト

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

              メソッドURI
              GET/dashboards/products

              リクエストヘッダ

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

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

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

              フィールドタイプ必須の有無説明
              regionsStringOptionalProductを照会する対象のリージョン
              • コレクションのアイテムは 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
?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

              レスポンス

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

              レスポンス構文

              構文は次の通りです。

              {
    "products": [
        {
            "productId": "productId",
            "productName": "productName",
            "deleted": false
        }
    ]
}
              JSON

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

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

              レスポンス例

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

              {
    "products": [
        {
            "productId": "*****xn0bk",
            "productName": "product-***",
            "deleted": false
        }
    ]
}
              JSON
              この記事は役に立ちましたか?
              Change password!
              Changing your password will log you out immediately. Use the new password to log back in.
              Change profile
              Success!
              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.
              Logout