APIの照会
    • PDF

    APIの照会

    • PDF

    記事の要約

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

    APIの情報を照会します。
    この APIは、照会時にVIEW_GET_API (subaccount)のサブアカウントリソースリストを確認(SubAccountResourceListCheck)します。

    リクエスト

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

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

    リクエストヘッダ

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

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

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

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

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

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

    フィールドタイプ必須の有無説明
    offsetLongOptional照会対象のデータリストからスタートする位置
    • 0~9,223,372,036,854,775,807
    limitLongOptional一度に照会するデータ数
    • 1~9,223,372,036,854,775,807
    withStageBooleanOptionalStage情報を照会するかどうか
    • true | false
      • true: Stage情報を照会する
      • false: Stage情報を照会しない
    apiNameStringOptionalAPI名でフィルタリング
    • 0~20
    hasStageBooleanOptionalStageの有無でフィルタリング
    • true | false
      • true: Stageあり
      • false: Stageなし
    hasStageNotAssociatedWithUsagePlanIdStringOptional特定の Usage Planと関連付けられた Stageを除いて照会
    • 特定の Usage Plan IDを入力するとその Usage Plan IDと無関係の apiを返す

    リクエスト例

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

    curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis' \
    --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": [
            {
                "stages": [
                    {
                        "apiId": "apiId",
                        "stageId": "stageId",
                        "stageName": "stageName",
                        "isPublished": true
                    }
                ],
                "productId": "productId",
                "apiId": "apiId",
                "apiName": "apiName",
                "apiDescription": "apiDescription",
                "tenantId": "tenantId",
                "modifier": "modifier",
                "modTime": "2024-05-02T08:10:26Z",
                "isDeleted": false,
                "domainCode": "domainCode"
            }
        ],
        "total": 0
    }
    

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

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

    レスポンス例

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

    {
        "apis": [
            {
                "stages": [
                    {
                        "apiId": "*****luwtk",
                        "stageId": "*****7mhdv",
                        "stageName": "v1",
                        "isPublished": true
                    }
                ],
                "productId": "*****xn0bk",
                "apiId": "*****luwtk",
                "apiName": "api",
                "apiDescription": "",
                "tenantId": "*****02f55ae4436913a6e2c65bab47c",
                "modifier": "d12c9fd0-****-****-****-246e96591a38",
                "modTime": "2024-05-02T08:10:26Z",
                "isDeleted": false,
                "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.