DescribeInstances - - Alibaba Cloud ドキュメントセンター

リージョン内の 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

apigateway:DescribeInstances

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	インスタンス ID。このパラメーターを指定しない場合、すべてのインスタンスが照会されます。	api-shared-vpc-001
Language	string	任意	応答の言語。システムポリシーの説明はこの言語で返されます。 en：英語。 zh：中国語。 ja：日本語。	zh
InstanceType	string	任意
EnableTagAuthorization	boolean	任意	タグベースの権限付与を有効にするかどうかを示します。	false
Tag	array<object>	任意	インスタンスにアタッチされているタグ。
	object	任意	インスタンスにアタッチされているタグ。
Key	string	任意	タグキー。	key1
Value	string	任意	タグ値。	value

レスポンスフィールド

フィールド	型	説明	例
	object
PageNumber	integer	現在のページ番号。	1
RequestId	string	リクエスト ID。	CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSize	integer	ページあたりのエントリ数。	10
TotalCount	integer	エントリの総数。	1
Instances	object
InstanceAttribute	array<object>	インスタンスの詳細。
	array<object>	インスタンスの詳細。
Status	string	インスタンスのステータス。	RUNNING
VpcSlbIntranetEnable	boolean	VPC のプライベート向け SLB インスタンスが有効になっているかどうかを示します。	true
ClassicEgressAddress	string	クラシックネットワークの送信元 IP アドレス。	10.0.0.1
ZoneLocalName	string	ゾーンの名前。	Multi-Availability Zone 3(b,c,a)
UserVpcId	string	ユーザーの VPC の ID。	vpc-t*hxyu9**t0g4
VpcIntranetEnable	boolean	プライベート向け VPC が有効になっているかどうかを示します。	true
VpcOwnerId	integer	VPC が属する Alibaba Cloud アカウントの ID。	1408453217640291****
InstanceId	string	インスタンス ID。	api-shared-vpc-020
InstanceRpsLimit	integer	インスタンスの 1 秒あたりのレコード数 (RPS) の上限。	500
InstanceType	string	インスタンスのタイプ。有効な値： VPC_SHARED：共有インスタンス (VPC) VPC_DEDICATED：専用インスタンス (VPC)	VPC_SHARED
RegionId	string	インスタンスが存在するリージョンの ID。	cn-beijing
InstanceSpec	string	インスタンス仕様。	api.s1.small
InstanceChargeType	string	インスタンスの課金方法。有効な値： PrePaid：サブスクリプション。 PayAsYouGo：従量課金。	PrePaid
HttpsPolicies	string	HTTPS セキュリティポリシー。	HTTPS2_TLS1_2
VpcEgressAddress	string	プライベート向け VPC の送信元 CIDR ブロック。	100.104.254.0/26
NewVpcEgressAddress	string	プライベート向け VPC の新しい送信元 CIDR ブロック。	100.104.253.0/26
EgressIpv6Enable	boolean	IPv6 送信が有効になっているかどうかを示します。	true
ExpiredTime	string	インスタンスの有効期限。	1659801600000
InstanceName	string	インスタンス名。	test
ZoneId	string	ゾーン ID。	cn-hangzhou-MAZ5(g,h)
SupportIpv6	boolean	IPv6 がサポートされているかどうかを示します。	true
InternetEgressAddress	string	パブリック送信元 IP アドレス。	47.241.89.244
CreatedTime	string	インスタンスが作成された時刻。	2021-10-22 15:36:53.0
InstanceSpecAttributes	object
SpecAttribute	array<object>	インスタンス仕様の詳細。
	object	インスタンス仕様の詳細。
Value	string	仕様の値。	99.95%
LocalName	string	変数の名前。	SLA
UserVswitchId	string	ユーザーの vSwitch の ID。	vsw-t4*ehd7q**i2f
AclName	string	アクセス制御リスト (ACL) の名前。	test
AclType	string	ACL のタイプ。有効な値： black：ブラックリスト white：ホワイトリスト	white
AclStatus	string	ACL が有効になっているかどうかを示します。有効な値： on：有効。 off：無効。	on
AclId	string	ACL の ID。	acl-uf6f9zfxfxtp5j9ng3yv4
IntranetSegments	string	API Gateway インスタンスがアクセスできる内部ネットワークの CIDR ブロック。	[\"172.36.0.0/16\",\"172.31.16.0/20\"]
IPV6AclName	string	IPv6 ACL の名前。	testIPV6
IPV6AclId	string	IPv6 ACL の ID。	acl-124resFfs235
IPV6AclType	string	IPv6 ACL のタイプ。有効な値： black：ブラックリスト white：ホワイトリスト	black
IPV6AclStatus	string	IPv6 ACL が有効になっているかどうかを示します。有効な値： on：有効。 off：無効。	on
DedicatedInstanceType	string	専用インスタンスのタイプ。有効な値： vpc_connect：VPC 接続専用インスタンス normal：クラシックネットワークベースの専用インスタンス	vpc_connect
InstanceCidrBlock	string	専用インスタンスが存在する CIDR ブロック。 172.16.0.0/12 192.168.0.0/16	192.168.0.0/16
ConnectVpcId	string	VPC 接続専用インスタンスに接続されているユーザー VPC の ID。	vpc-m5eo7khlb4h4f8y9egsdg
NetworkInterfaceAttributes	object
NetworkInterfaceAttribute	array<object>	専用インスタンスに接続されているユーザー VPC のネットワークインターフェースの詳細。
	object	専用インスタンスに接続されているユーザー VPC のネットワークインターフェースの詳細。
VswitchId	string	vSwitch の ID。	vsw-2zeqals6rbj51bhjn8b89
SecurityGroupId	string	セキュリティグループの ID。同じセキュリティグループ内のサービスは相互にアクセスできます。	sg-2zeehz13zcyj1kfk3o85
CidrBlock	string	vSwitch の CIDR ブロック。	192.168.17.0/24
ZoneId	string	ゾーン ID。	cn-shenzhen-d
InstanceClusterId	string	この専用インスタンスを管理する専用インスタンスクラスターの ID。	apigateway-cluster-sh-1523cafbgffd
MaintainStartTime	string	メンテナンスウィンドウの開始時刻。時刻は HH:mmZ 形式で、UTC です。	22:00Z
MaintainEndTime	string	メンテナンスウィンドウの終了時刻。時刻は HH:mmZ 形式で、UTC です。	01:00Z
ConnectCidrBlocks	string	VPC 接続専用インスタンスがアクセスできるユーザー VPC の内部 CIDR ブロック。	[\"172.16.0.0/24\",\"172.16.1.0/24\"]
PrivateDnsList	object
PrivateDns	array	内部ドメイン名のリスト。
	string	内部ドメイン名。	www.private.com
Tags	object
TagInfo	array<object>	タグのリスト。
	object
Key	string	タグキー。	Cookie
Value	string	タグ値。	240

例

成功レスポンス

JSONJSON

{
  "PageNumber": 1,
  "RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2",
  "PageSize": 10,
  "TotalCount": 1,
  "Instances": {
    "InstanceAttribute": [
      {
        "Status": "RUNNING",
        "VpcSlbIntranetEnable": true,
        "ClassicEgressAddress": "10.0.0.1",
        "ZoneLocalName": "Multi-Availability Zone 3(b,c,a)",
        "UserVpcId": "vpc-t***hx****yu9****t0g4",
        "VpcIntranetEnable": true,
        "VpcOwnerId": 0,
        "InstanceId": "api-shared-vpc-020",
        "InstanceRpsLimit": 500,
        "InstanceType": "VPC_SHARED",
        "RegionId": "cn-beijing",
        "InstanceSpec": "api.s1.small",
        "InstanceChargeType": "PrePaid",
        "HttpsPolicies": "HTTPS2_TLS1_2",
        "VpcEgressAddress": "100.104.254.0/26",
        "NewVpcEgressAddress": "100.104.253.0/26",
        "EgressIpv6Enable": true,
        "ExpiredTime": "1659801600000",
        "InstanceName": "test",
        "ZoneId": "cn-hangzhou-MAZ5(g,h)",
        "SupportIpv6": true,
        "InternetEgressAddress": "47.241.89.244",
        "CreatedTime": "2021-10-22 15:36:53.0",
        "InstanceSpecAttributes": {
          "SpecAttribute": [
            {
              "Value": "99.95%",
              "LocalName": "SLA"
            }
          ]
        },
        "UserVswitchId": "vsw-t4***eh****d7q****i2f",
        "AclName": "test",
        "AclType": "white",
        "AclStatus": "on",
        "AclId": "acl-uf6f9zfxfxtp5j9ng3yv4",
        "IntranetSegments": "[\\\"172.36.0.0/16\\\",\\\"172.31.16.0/20\\\"]",
        "IPV6AclName": "testIPV6",
        "IPV6AclId": "acl-124resFfs235",
        "IPV6AclType": "black",
        "IPV6AclStatus": "on",
        "DedicatedInstanceType": "vpc_connect",
        "InstanceCidrBlock": "192.168.0.0/16",
        "ConnectVpcId": "vpc-m5eo7khlb4h4f8y9egsdg",
        "NetworkInterfaceAttributes": {
          "NetworkInterfaceAttribute": [
            {
              "VswitchId": "vsw-2zeqals6rbj51bhjn8b89",
              "SecurityGroupId": "sg-2zeehz13zcyj1kfk3o85",
              "CidrBlock": "192.168.17.0/24",
              "ZoneId": "cn-shenzhen-d"
            }
          ]
        },
        "InstanceClusterId": "apigateway-cluster-sh-1523cafbgffd",
        "MaintainStartTime": "22:00Z",
        "MaintainEndTime": "01:00Z",
        "ConnectCidrBlocks": "[\\\"172.16.0.0/24\\\",\\\"172.16.1.0/24\\\"]",
        "PrivateDnsList": {
          "PrivateDns": [
            "www.private.com"
          ]
        },
        "Tags": {
          "TagInfo": [
            {
              "Key": "Cookie",
              "Value": "240"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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