DescribeInstance によるアセット詳細の取得 - Anti-DDoS

現在ご利用の Alibaba Cloud アカウント内の資産の詳細を照会します。資産には、Elastic IP アドレス (EIP) や、パブリック IP アドレスが割り当てられた Elastic Compute Service (ECS) インスタンスまたは Server Load Balancer (SLB) インスタンスが含まれます。この操作は段階的に廃止されます。DescribeInstanceIpAddress 操作の使用を推奨します。

操作説明

DescribeInstance 操作を呼び出して、現在ご利用の Alibaba Cloud アカウント内の資産の詳細をページ単位で照会できます。詳細には、資産の ID と IP アドレス、Anti-DDoS Origin で資産に設定されている基本防御しきい値とトラフィックスクラビングしきい値、および資産が Anti-DDoS Origin インスタンスに関連付けられているかどうかなどが含まれます。

制限事項

この操作は、アカウントあたり毎秒 200 回まで呼び出すことができます。1 秒あたりの呼び出し回数が制限を超えると、スロットリングがトリガーされます。その結果、ビジネスに影響が及ぶ可能性があります。この操作を呼び出す際は、この制限に注意することを推奨します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-ddos:DescribeInstance

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DdosRegionId	string	必須	資産のリージョン ID です。説明詳細については、「DescribeRegions」をご参照ください。	cn-hangzhou
InstanceType	string	必須	照会する資産のタイプです。有効な値： ecs：ECS インスタンス。 slb：SLB インスタンス。 eip：EIP。 ipv6：IPv6 ゲートウェイ。 swas：シンプルアプリケーションサーバー。 waf：Exclusive エディションの Web Application Firewall (WAF) インスタンス。 ga_basic：Global Accelerator (GA) インスタンス。	ecs
InstanceName	string	任意	資産名です。	launch-advisor-2022****
DdosStatus	string	任意	資産の DDoS 防御ステータスです。有効な値： mitigating：トラフィックスクラビングがトリガーされた資産を照会します。 blackholed：ブラックホールフィルタリングがトリガーされた資産を照会します。 normal：DDoS 攻撃を受けていない資産を照会します。	blackholed
InstanceId	string	任意	資産の ID です。資産 ID のフォーマットは、InstanceType パラメーターの値によって異なります。 InstanceType を ecs に設定した場合、ECS インスタンスの ID を指定します。例：i-bp1cb6x80tfgocid**。 InstanceType を slb に設定した場合、SLB インスタンスの ID を指定します。例：alb-vn2dqg3v31y2vd。 InstanceType を eip に設定した場合、EIP の ID を指定します。例：eip-j6ce6dcx9epi7rs46**。	i-bp1cb6x80tfgocid****
InstanceIp	string	任意	資産の IP アドレスです。	121.199.XX.XX
CurrentPage	integer	任意	返すページ番号です。デフォルト値：1。	1
PageSize	integer	任意	各ページで返すエントリ数です。デフォルト値：10。	10

レスポンスフィールド

フィールド	型	説明	例
	object
Total	integer	資産の総数です。	1
RequestId	string	リクエスト ID です。	C728D7E9-9A39-52E0-966B-5C33118BDBB0
InstanceList	object
Instance	array<object>	資産の詳細です。
	object	資産の詳細です。
InstanceIp	string	資産の IP アドレスです。	121.199.XX.XX
IsBgppack	boolean	資産が Anti-DDoS Origin Basic インスタンスに関連付けられているかどうかを示します。有効な値： true：はい false：いいえ	false
IpVersion	string	資産がサポートする IP プロトコルです。有効な値： v4：IPv4 v6：IPv6	v4
ElasticThreshold	integer	資産のバースト可能保護しきい値です。単位：Mbit/s。	12310
BlackholeThreshold	integer	資産の基本防御しきい値です。単位：Mbit/s。	5200
DefenseBpsThreshold	integer	資産のトラフィックスクラビングしきい値です。単位：Mbit/s。	300
InstanceName	string	資産名です。	launch-advisor-2021****
InstanceStatus	string	資産の DDoS 防御ステータスです。有効な値： mitigating：資産に対してトラフィックスクラビングがトリガーされたことを示します。 blackholed：資産に対してブラックホールフィルタリングがトリガーされたことを示します。 normal：インスタンスが正常であることを示します。	normal
DefensePpsThreshold	integer	資産のパケットスクラビングしきい値です。単位：パケット/秒 (pps)。	70000
InstanceId	string	資産の ID です。	i-bp1cb6x80tfgocid****
InstanceType	string	資産のタイプです。	ecs

例

成功レスポンス

JSONJSON

{
  "Total": 1,
  "RequestId": "C728D7E9-9A39-52E0-966B-5C33118BDBB0",
  "InstanceList": {
    "Instance": [
      {
        "InstanceIp": "121.199.XX.XX",
        "IsBgppack": false,
        "IpVersion": "v4",
        "ElasticThreshold": 12310,
        "BlackholeThreshold": 5200,
        "DefenseBpsThreshold": 300,
        "InstanceName": "launch-advisor-2021****",
        "InstanceStatus": "normal",
        "DefensePpsThreshold": 70000,
        "InstanceId": "i-bp1cb6x80tfgocid****",
        "InstanceType": "ecs"
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。