リクエスト

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

メソッド	URI
GET	/published-products/{product-Id}/documents

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`product-id`	String	Required	文書照会対象の Product ID 0~10文字 Productリストの照会を通じて確認

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

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

フィールド	タイプ	必須の有無	説明
`offset`	Long	Optional	レスポンスデータの開始点 0~9,223,372,036,854,775,807 `limit`と共にページネーションの実装に使用
`limit`	Long	Optional	レスポンスデータの最大数 1~9,223,372,036,854,775,807 `offset`と共にページネーションの実装に使用
`apiName`	String	Optional	API名 0~20文字

リクエスト例

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

curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/published-products/***ksk9***/documents?apiName=api000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンス構文

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

{
    "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
    }
}

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

リクエスト
レスポンス