APIの照会
    • PDF

    APIの照会

    • PDF

    記事の要約

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

    Dashboardの Product関連パラメータを利用して Productに作成されてデプロイされた APIを照会します。

    リクエスト

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

    メソッドURI
    GET/dashboards/products/{product-id}/api-ids

    リクエストヘッダ

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

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

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

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

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

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

    フィールドタイプ必須の有無説明
    regionsList<String>OptionalAPIを照会する対象のリージョン
    • コレクションのアイテムは nullであってはいけない
    offsetLongOptional照会対象のデータリストからスタートする位置
    • 0~9,223,372,036,854,775,807
    limitLongOptional一度に照会するデータ数
    • 1~9,223,372,036,854,775,807
    fromStringRequired照会開始日(yyyy-MM-dd)
    toStringRequired照会終了日(yyyy-MM-dd)
    timeZoneStringRequiredタイムゾーン(+09:00)
  • GETメソッド利用時、URLエンコードが必要
  • リクエスト例

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

    curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/api-ids
    ?from=2024-05-09
    &to=2024-05-09
    &timeZone=%2B09%3A00' \
    --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": {
            "content": [
                {
                    "apiId": "apiId",
                    "apiName": "apiName",
                    "deleted": true
                }
            ],
            "total": 1
        }
    }
    

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

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

    レスポンス例

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

    {
        "apis": {
            "content": [
                {
                    "apiId": "*****vcqwb",
                    "apiName": "api-***",
                    "deleted": true
                }
            ],
            "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.