Usage Planリストの照会
    • PDF

    Usage Planリストの照会

    • PDF

    記事の要約

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

    ユーザーが指定した条件を満たす Usage Planリストを照会します。

    リクエスト

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

    メソッドURI
    POST/usage-plans/search

    リクエストヘッダ

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

    リクエスト構文

    リクエスト構文は次の通りです。

    {
        "offset" : 6,
        "limit" : 0,
        "usagePlanName" : "usagePlanName"
    }
    

    リクエストボディ

    リクエストボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    offsetLongOptionalレスポンスデータの開始点
    • 0~9,223,372,036,854,775,807
    • limitと共にページネーションの実装に使用
    limitLongOptionalレスポンスデータの最大数
    • 1~9,223,372,036,854,775,807
    • offsetと共にページネーションの実装に使用
    usagePlanNameStringOptional照会対象の Usage Planの名前
    • 0~45文字

    リクエスト例

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

    curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans/search' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'Content-Type: application/json' \
    --data '{
        "usagePlanName" : "usageplan001"
    }'
    

    レスポンス

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

    レスポンス構文

    レスポンス構文は次の通りです。

    {
        "initialCount" : 0,
        "total" : 6,
        "usagePlans" : [ {
            "domainCode" : "domainCode",
            "usagePlanId" : "usagePlanId",
            "modifier" : "modifier",
            "associatedStagesCount" : 0,
            "dayQuotaRequest" : 6,
            "permission" : "permission",
            "rateRps" : 5,
            "usagePlanName" : "usagePlanName",
            "monthQuotaRequest" : 1,
            "tenantId" : "tenantId",
            "disabled" : true,
            "usagePlanDescription" : "usagePlanDescription",
            "quotaCondition" : "quotaCondition",
            "actionName" : "actionName"
      } ]
    }
    

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

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

    レスポンス例

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

    {
        "usagePlans": [
            {
                "tenantId": "***e230cebc1402ba89b148896951***",
                "usagePlanId": "***xogj***",
                "usagePlanName": "usageplan001",
                "domainCode": "PUB",
                "associatedStagesCount": 0
            }
        ],
        "total": 1,
        "initialCount": 2
    }
    

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

    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.