Product文書の照会
- 印刷する
- PDF
Product文書の照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
ユーザーが指定した条件を満たす Product文書を照会します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /products/{product-id}/document |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
product-id | String | Required | 文書照会対象の Product ID
|
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
offset | Long | Optional | レスポンスデータの開始点
|
limit | Long | Optional | レスポンスデータの最大数
|
apiName | String | Optional | API名
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/document' \
--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 '{
"apiName": "api000"
}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
{
"apiPage" : {
"total" : 6,
"content" : [ {
"apiName" : "apiName",
"domainCode" : "domainCode",
"stages" : [ {
"deployedStageDeploymentNo" : 0,
"stageName" : "stageName",
"host" : "host",
"stageId" : "stageId"
} ],
"apiDescription" : "apiDescription",
"apiId" : "apiId"
} ]
}
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"apiPage": {
"content": [
{
"stages": [
{
"stageId": "***5ei7***",
"stageName": "stage",
"deployedStageDeploymentNo": 251***,
"host": "https://***ksk9***.apigw.ntruss.com"
}
],
"apiId": "***51hs***",
"apiName": "api000",
"apiDescription": "",
"domainCode": "PUB"
}
],
"total": 1
}
}
この記事は役に立ちましたか?