APIの照会

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

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`offset`	Long	Optional	照会対象のデータリストからスタートする位置 0~9,223,372,036,854,775,807
`limit`	Long	Optional	一度に照会するデータ数 1~9,223,372,036,854,775,807
`withStage`	Boolean	Optional	Stage情報を照会するかどうか `true` \| `false` `true`: Stage情報を照会する `false`: Stage情報を照会しない
`apiName`	String	Optional	API名でフィルタリング 1~20
`hasStage`	Boolean	Optional	Stageの有無でフィルタリング `true` \| `false` `true`: Stageあり `false`: Stageなし
`hasStageNotAssociatedWithUsagePlanId`	String	Optional	特定の Usage Planと関連付けられた Stageを除いて照会特定の Usage Plan IDを入力するとその Usage Plan IDと無関係の APIを返す

リクエスト例

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

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

APIの照会_infos