Productリストの照会
- 印刷する
- PDF
Productリストの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
ユーザーが指定した条件を満たす Productリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /products |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
offset | Long | Optional | レスポンスデータの開始点
|
limit | Long | Optional | レスポンスデータの最大数
|
productName | String | Optional | 照会対象の Productの名前
|
isPublished | Boolean | Optional | 公開有無
|
subscriptionCode | String | Optional | サブスクリプション方法
|
hasDeployedStage | Boolean | Optional | Stageは作成されたか
|
hasStageNotAssociatedWithUsagePlanId | String | Optional | 特定の Usage Planと関連付けられた Stageを除いて照会
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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
}
この記事は役に立ちましたか?