API Keyサブスクリプションの照会
    • PDF

    API Keyサブスクリプションの照会

    • PDF

    記事の要約

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

    API Keyと関連付けられた Stage(サブスクリプション中の Stage)情報を照会します。

    リクエスト

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

    メソッドURI
    GET/api-keys/{api-key-id}/subscription-detail

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    api-key-idStringRequiredサブスクリプション情報照会対象の API Key ID

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

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

    フィールドタイプ必須の有無説明
    offsetLongOptional照会対象のデータリストからスタートする位置
    • 0~9,223,372,036,854,775,807
    limitLongOptional一度に照会するデータ数
    • 1~9,223,372,036,854,775,807
    apiIdStringOptionalStageが属する API ID
    stageIdStringOptionalAPI Keyと関連付けられた Stage ID
    productIdStringRequiredAPI Keyと関連付けられた Product ID

    リクエスト例

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

    curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscription-detail?productId=*****n0bk' \
    --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}'
    

    レスポンス

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

    レスポンス構文

    構文は次の通りです。

    {
        "apiKeyRelations": {
            "content": [
                {
                    "apiId": "apiId",
                    "apiName": "apiName",
                    "stageId": "stageId",
                    "stageName": "stageName",
                    "apiKeyId": "apiKeyId",
                    "apiKeyName": "apiKeyName",
                    "usagePlanId": "usagePlanId",
                    "usagePlanName": "usagePlanName",
                    "regTime": "2024-05-07T08:34:37Z",
                    "modTime": "2024-05-07T08:34:37Z",
                    "dayCallCount": 0,
                    "monthCallCount": 0,
                    "domainCode": "domainCode"
                }
            ],
            "total": 0
        }
    }
    

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

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

    レスポンス例

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

    {
        "apiKeyRelations": {
            "content": [
                {
                    "apiId": "*****uwtk",
                    "apiName": "api-***",
                    "stageId": "*****7mhdv",
                    "stageName": "v1",
                    "apiKeyId": "*****g079",
                    "apiKeyName": "apiKey-***",
                    "usagePlanId": "*****w2111",
                    "usagePlanName": "usagePlan-***",
                    "regTime": "2024-05-07T08:34:37Z",
                    "modTime": "2024-05-07T08:34:37Z",
                    "dayCallCount": 0,
                    "monthCallCount": 0,
                    "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.