Product文書の照会
    • PDF

    Product文書の照会

    • PDF

    記事の要約

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

    ユーザーが指定した条件を満たす Product文書を照会します。

    リクエスト

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

    メソッドURI
    GET/products/{product-id}/document

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    product-idStringRequired文書照会対象の Product ID

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

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

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

    リクエスト例

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

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

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

    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.