すべてのプロダクト
Search

このプロダクト

    Web Application Firewall:DescribeInstanceInfo

    ドキュメントセンター

    Web Application Firewall:DescribeInstanceInfo

    最終更新日:May 24, 2024

    Alibaba Cloudアカウント内のWeb Application Firewall (WAF) インスタンスに関する情報を照会します。

    使用上の注意

    DescribeInstanceInfoオペレーションを呼び出すと、Alibaba Cloudアカウント内のWAFインスタンスの情報を照会することができます。情報には、インスタンスのID、バージョン、ステータス、および有効期限が含まれます。

    制限事項

    この操作は、アカウントごとに1秒あたり最大50回呼び出すことができます。 1秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。 その結果、お客様のビジネスに影響を与える可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    パラメーターデータ型必須／任意例説明
    操作String必須DescribeInstanceInfo

    実行する操作です。 値をDescribeInstanceInfoに設定します。

    InstanceIdString任意waf-cn-tl32ast ****

    WAFインスタンスのID。

    このパラメーターを指定しない場合、すべてのWAFインスタンスに関する情報が返されます。

    ResourceGroupIdString任意rg-atstuj3rtop****

    リソース管理で、WAFインスタンスが所属するリソースグループのID。このパラメーターを指定しない場合、WAFインスタンスはデフォルトリソースグループに属します。

    すべてのAlibaba Cloud API操作に共通のリクエストパラメーターを含める必要があります。 共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

    サンプルリクエストの詳細については"Examples" の項をご参照ください。

    レスポンスパラメーター

    パラメーターデータ型例説明
    RequestIdStringD7861F61-5B61-46CE-A47C-6B19160D5EB0

    リクエストの ID です。

    InstanceInfoオブジェクト

    WAFインスタンスに関する情報。

    ステータスInteger1

    WAFインスタンスの有効期限が切れるかどうかを示します。 設定可能な値は以下のとおりです。

    • 0: インスタンスの有効期限が切れます。
    • 1: インスタンスの有効期限が切れていません。
    説明 PayTypeの値が0の場合、このパラメーターは返されません。 値0は、WAFインスタンスが購入されていないことを示します。
    EndDateLong1512921600

    WAFインスタンスの有効期限。 この値はUNIXタイムスタンプです。 (単位：秒)

    説明 PayTypeの値が0の場合、このパラメーターは返されません。 値0は、WAFインスタンスが購入されていないことを示します。
    VersionStringversion_3

    WAFインスタンスのエディション。 設定可能な値は以下のとおりです。

      • version_pro_china: a WAF Pro instance in the Chinese mainland

      • version_business_china: a WAF Business instance in the Chinese mainland

      • version_enterprise_china: 中国本土のWAFエンタープライズインスタンス

      • version_exclusive_china: 中国本土で排他的クラスターを使用するWAFインスタンス

      • version_hybrid_cloud_standard_china: 中国本土のハイブリッドクラウドWAFインスタンス

      • version_pro: 中国本土以外のWAF Proインスタンス

      • version_business: 中国本土外のWAFビジネスインスタンス

      • version_enterprise: 中国本土以外のWAF Enterpriseインスタンス

      • version_exclusive: 中国本土以外の排他的クラスターを使用するWAFインスタンス

      • version_hybrid_cloud_standard: 中国本土外のハイブリッドクラウドWAFインスタンス

      上記のリストには、国際サイトで作成されたアカウント内のWAFインスタンスのすべてのエディションが含まれています。 返されたバージョンがリストにない場合は、アカウントが国際サイトで作成されているかどうかを確認します。

      説明 PayTypeの値が0の場合、このパラメーターは返されません。 値0は、WAFインスタンスが購入されていないことを示します。
      残り日Integer1

      WAFインスタンスの試用期間が終了するまでの残り日数。

      説明 このパラメーターは、Trialの値が1の場合にのみ返されます。 値1は、WAFインスタンスの無料トライアルが有効化されていることを示します。
      リージョンStringcn

      WAFインスタンスが存在する地域。設定可能な値は以下のとおりです。

      • cn: 中国本土
      • cn-hongkong: 中国大陸外
      説明 PayTypeの値が0の場合、このパラメーターは返されません。 値0は、WAFインスタンスが購入されていないことを示します。
      PayTypeInteger1

      WAFの有効化ステータス。 設定可能な値は以下のとおりです。

      • 0: Alibaba Cloudアカウント内でWAFインスタンスが購入されていません。

      • 1: サブスクリプションWAFインスタンスはAlibaba Cloudアカウント内で購入されます。

      InDebtInteger1

      WAFインスタンスに料金滞納があるかどうかを示します。 設定可能な値は以下のとおりです。

      • 0: インスタンスに料金滞納があります。
      • 1: インスタンスに料金滞納がありません。
      説明 PayTypeの値が0の場合、このパラメーターは返されません。 値0は、WAFインスタンスが購入されていないことを示します。
      InstanceIdStringwaf-cn-tl32ast ****

      WAFインスタンスのID。

      説明 If the value of PayType is 0, this parameter is not returned. 値0は、WAFインスタンスが購入されていないことを示します。
      SubscriptionTypeStringサブスクリプション

        WAFインスタンスの課金方法: 値はサブスクリプションに固定されています。

        説明 PayTypeの値が0の場合、このパラメーターは返されません。 値0は、WAFインスタンスが購入されていないことを示します。
        トライアルInteger1

        WAFインスタンスの無料トライアルがAlibaba Cloudアカウント内で有効化されているかどうかを示します。 設定可能な値は以下のとおりです。

        • 0: なし
        • 1: はい
        説明 このパラメーターは、Alibaba Cloudアカウント内でWAFインスタンスの無料トライアルが有効化されている場合にのみ返されます。

        例

        リクエストの例

        http(s):// [エンドポイント]/?Action=DescribeInstanceInfo
&共通リクエストパラメータ

        正常に処理された場合のレスポンス例

        XML 形式

        HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceInfoResponse>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <InstanceInfo>
        <ステータス> 1</ステータス>
        <EndDate>1512921600</EndDate>
        <Version>version_3</Version>
        <リージョン> cn</リージョン>
        <PayType>1</PayType>
        <InDebt>1</InDebt>
        <InstanceId>waf-cn-tl32ast ****</InstanceId>
        <SubscriptionType> サブスクリプション </SubscriptionType>
    </InstanceInfo>
</DescribeInstanceInfoResponse>

        JSON 形式

        HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0" 、
  "InstanceInfo" : {
    "ステータス" : 1、
    "EndDate" : 1512921600、
    "バージョン" : "version_3" 、
    "リージョン" : "cn" 、
    "PayType" : 1、
    "InDebt" : 1、
    "InstanceId" : "waf-cn-tl32ast ****" 、
    "SubscriptionType" : "Subscription"
  }
}

        エラーコード

        エラーコードリストについては、「API エラーセンター」をご参照ください。