DescribeInstances - 查詢執行個體列表 - API Gateway

查詢region下的共用執行個體/專享執行個體詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

apigateway:DescribeInstances

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	否	執行個體 id 不填寫預設查詢所有執行個體	api-shared-vpc-001
Language	string	否	語言類型。系統權限原則的描述將以此語言返回。 en：英文。 zh：中文。 ja：日文。	zh
InstanceType	string	否
EnableTagAuthorization	boolean	否	是否開啟了 Tag 授權	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	出口地址	10.0.0.1
ZoneLocalName	string	可用性區域域	多可用性區域 2
UserVpcId	string	使用者 VPC Id	vpc-t*hxyu9**t0g4
VpcIntranetEnable	boolean	是否開啟內網 VPC	true
VpcOwnerId	integer	VPC 執行個體所屬帳號 ID。	1408453217640291****
InstanceId	string	執行個體 id	api-shared-vpc-020
InstanceRpsLimit	integer	執行個體 rps 限制	500
InstanceType	string	執行個體類型 VPC_SHARED：共用執行個體(VPC) VPC_DEDICATED：專享執行個體(VPC)	VPC_SHARED
RegionId	string	所在的 region	cn-beijing
InstanceSpec	string	執行個體規格	api.s1.small
InstanceChargeType	string	執行個體的計費方式。可能值： PrePaid：訂用帳戶。 PayAsYouGo：隨用隨付。	PrePaid
HttpsPolicies	string	https 安全性原則	HTTPS2_TLS1_2
VpcEgressAddress	string	內網 VPC 出口網段	100.104.254.0/26
NewVpcEgressAddress	string	新的內網 VPC 出口網段	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	公網出口地址	47.241.89.244
CreatedTime	string	執行個體建立時間	2021-10-22 15:36:53.0
InstanceSpecAttributes	object
SpecAttribute	array<object>	執行個體規格
	object	執行個體規格
Value	string	變數值	2500
LocalName	string	變數名	最大每秒請求數
UserVswitchId	string	使用者互動機 Id	vsw-t4*ehd7q**i2f
AclName	string	存取控制策略名稱稱。	test
AclType	string	存取控制的類型： black：黑名單 white：白名單	white
AclStatus	string	是否開啟存取控制功能。取值： on：開啟存取控制。 off：關閉存取控制。	on
AclId	string	存取控制策略 ID。	acl-uf6f9zfxfxtp5j9ng3yv4
IntranetSegments	string	可訪問 API Gateway執行個體的內網網段	[\"172.36.0.0/16\",\"172.31.16.0/20\"]
IPV6AclName	string	IPV6 存取控制策略名稱稱	testIPV6
IPV6AclId	string	IPV6 存取控制策略 ID	acl-124resFfs235
IPV6AclType	string	IPV6 存取控制策略類型 black：黑名單 white：白名單	black
IPV6AclStatus	string	是否開啟 IPV6 存取控制功能。取值： on：開啟存取控制。 off：關閉存取控制。	off
DedicatedInstanceType	string	專享執行個體類型 vpc_connect：VPC 融合類型專享執行個體 normal：傳統類型專享執行個體	vpc_connect
InstanceCidrBlock	string	專享執行個體所在網段 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 融合類型專享執行個體連通的使用者 VPC 內的網路資訊
	object	VPC 融合類型專享執行個體連通的使用者 VPC 內的網路資訊
VswitchId	string	虛擬交換器 ID	vsw-2zeqals6rbj51bhjn8b89
SecurityGroupId	string	安全性群組的 ID，同一個安全性群組內的服務可以互相訪問。	sg-2zeehz13zcyj1kfk3o85
CidrBlock	string	vSwitch 的網段。	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 的內網網段。	[\"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	標籤鍵	tag3
Value	string	標籤值	50699_0

樣本

正常返回樣本

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2",
  "PageSize": 10,
  "TotalCount": 1,
  "Instances": {
    "InstanceAttribute": [
      {
        "Status": "RUNNING",
        "VpcSlbIntranetEnable": true,
        "ClassicEgressAddress": "10.0.0.1",
        "ZoneLocalName": "多可用性區域 2",
        "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": "2500",
              "LocalName": "最大每秒請求數"
            }
          ]
        },
        "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": "off",
        "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": "tag3",
              "Value": "50699_0"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。