APIの照会_filter

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

Productに作成された API IDと名前をリストで照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`product-id`	String	Required	APIと関連付けられた Product ID

リクエスト例

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

curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/filter' \
--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}'

レスポンス

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

レスポンス構文

構文は次の通りです。

{
    "apis": [
        {
            "productId": "productId",
            "apiId": "apiId",
            "apiName": "apiName"
        }
    ],
    "total": 0
}

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

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

レスポンス例

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

{
    "apis": [
        {
            "productId": "*****xn0bk",
            "apiId": "*****y6ql9",
            "apiName": "api-***"
        },
        {
            "productId": "*****xn0bk",
            "apiId": "*****luwtk",
            "apiName": "api-***"
        }
    ],
    "total": 2
}

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

What's Next

APIの詳細照会

リクエスト
レスポンス