DescribeInstances - - Centre de documentation Alibaba Cloud

Consulte les détails d'une ou plusieurs instances partagées ou dédiées dans une région.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

apigateway:DescribeInstances

get

*Instance

acs:apigateway:{#regionId}:{#accountId}:instance/*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Non	L'identifiant de l'instance. Si vous ne spécifiez pas ce paramètre, toutes les instances sont interrogées.	api-shared-vpc-001
Language	string	Non	La langue de la réponse. Les descriptions des stratégies système sont renvoyées dans cette langue.	zh
InstanceType	string	Non
EnableTagAuthorization	boolean	Non	Indique si l'autorisation basée sur les balises doit être activée.	false
Tag	array<object>	Non	Les balises associées à l'instance.
	object	Non	Les balises associées à l'instance.
Key	string	Non	La clé de la balise.	key1
Value	string	Non	La valeur de la balise.	value
PageNumber	integer	Non
PageSize	integer	Non		500

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageNumber	integer	Le numéro de page actuel.	1
RequestId	string	L'identifiant de la requête.	CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSize	integer	Le nombre d'entrées par page.	10
TotalCount	integer	Le nombre total d'entrées.	1
Instances	object
InstanceAttribute	array<object>	Les détails des instances.
	array<object>	Les détails des instances.
Status	string	The instance status.	RUNNING
VpcSlbIntranetEnable	boolean	Indicates whether the internal-facing SLB for the VPC is enabled.	true
ClassicEgressAddress	string	The egress IP address of the classic network.	10.0.0.1
ZoneLocalName	string	The name of the zone.	Multi Zone 2
UserVpcId	string	The ID of the user's VPC.	vpc-t*hxyu9**t0g4
VpcIntranetEnable	boolean	Indicates whether the internal-facing VPC is enabled.	true
VpcOwnerId	integer	The ID of the Alibaba Cloud account to which the VPC belongs.	1408453217640291****
InstanceId	string	The instance ID.	api-shared-vpc-020
InstanceRpsLimit	integer	The records per second (RPS) limit of the instance.	500
InstanceType	string	The type of the instance. Valid values: VPC_SHARED: shared instance (VPC) VPC_DEDICATED: dedicated instance (VPC)	VPC_SHARED
RegionId	string	The ID of the region where the instance resides.	cn-beijing
InstanceSpec	string	The instance specification.	api.s1.small
InstanceChargeType	string	The billing method of the instance. Valid values: PrePaid: subscription. PayAsYouGo: pay-as-you-go.	PrePaid
HttpsPolicies	string	The HTTPS security policy.	HTTPS2_TLS1_2
VpcEgressAddress	string	The egress CIDR block of the internal-facing VPC.	100.104.254.0/26
NewVpcEgressAddress	string	The new egress CIDR block of the internal-facing VPC.	100.104.253.0/26
EgressIpv6Enable	boolean	Indicates whether IPv6 egress is enabled.	true
ExpiredTime	string	The expiration time of the instance.	1659801600000
InstanceName	string	The instance name.	test
ZoneId	string	The zone ID.	cn-hangzhou-MAZ5(g,h)
SupportIpv6	boolean	Indicates whether IPv6 is supported.	true
InternetEgressAddress	string	The public egress IP address.	47.241.89.244
CreatedTime	string	The time when the instance was created.	2021-10-22 15:36:53.0
InstanceSpecAttributes	object
SpecAttribute	array<object>	The details of the instance specifications.
	object	The details of the instance specifications.
Value	string	The value of the specification.	2500
LocalName	string	The name of the variable.	最大每秒请求数
UserVswitchId	string	The ID of the user's vSwitch.	vsw-t4*ehd7q**i2f
AclName	string	The name of the access control list (ACL).	test
AclType	string	The type of the ACL. Valid values: black: blacklist white: whitelist	white
AclStatus	string	Indicates whether the ACL is enabled. Valid values: on: enabled. off: disabled.	on
AclId	string	The ID of the ACL.	acl-uf6f9zfxfxtp5j9ng3yv4
IntranetSegments	string	The internal network CIDR blocks from which the API Gateway instance can be accessed.	[\"172.36.0.0/16\",\"172.31.16.0/20\"]
IPV6AclName	string	The name of the IPv6 ACL.	testIPV6
IPV6AclId	string	The ID of the IPv6 ACL.	acl-124resFfs235
IPV6AclType	string	The type of the IPv6 ACL. Valid values: black: blacklist white: whitelist	black
IPV6AclStatus	string	Indicates whether the IPv6 ACL is enabled. Valid values: on: enabled. off: disabled.	off
DedicatedInstanceType	string	The type of the dedicated instance. Valid values: vpc_connect: VPC-connected dedicated instance normal: classic network-based dedicated instance	vpc_connect
InstanceCidrBlock	string	The CIDR block where the dedicated instance resides. 172.16.0.0/12 192.168.0.0/16	192.168.0.0/16
ConnectVpcId	string	The ID of the user VPC that is connected to the VPC-connected dedicated instance.	vpc-m5eo7khlb4h4f8y9egsdg
NetworkInterfaceAttributes	object
NetworkInterfaceAttribute	array<object>	The network interface details of the user VPC connected to the dedicated instance.
	object	The network interface details of the user VPC connected to the dedicated instance.
VswitchId	string	The ID of the vSwitch.	vsw-2zeqals6rbj51bhjn8b89
SecurityGroupId	string	The ID of the security group. Services in the same security group can access each other.	sg-2zeehz13zcyj1kfk3o85
CidrBlock	string	The CIDR block of the vSwitch.	192.168.17.0/24
ZoneId	string	The zone ID.	cn-shenzhen-d
InstanceClusterId	string	The ID of the dedicated instance cluster that manages this dedicated instance.	apigateway-cluster-sh-1523cafbgffd
MaintainStartTime	string	The start time of the maintenance window. The time is in the HH:mmZ format and is in UTC.	22:00Z
MaintainEndTime	string	The end time of the maintenance window. The time is in the HH:mmZ format and is in UTC.	01:00Z
ConnectCidrBlocks	string	The internal CIDR blocks of the user VPC that can be accessed by the VPC-connected dedicated instance.	[\"172.16.0.0/24\",\"172.16.1.0/24\"]
PrivateDnsList	object
PrivateDns	array	A list of internal domain names.
	string	The internal domain name.	www.private.com
Tags	object
TagInfo	array<object>	A list of tags.
	object
Key	string	The tag key.	tag3
Value	string	The tag value.	50699_0

Exemples

JSON format

{
  "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 Zone 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"
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.