GetGateway - - Centre de documentation Alibaba Cloud

Obtient les informations de base sur une passerelle, telles que le cloud privé virtuel (VPC) et le vSwitch auxquels la passerelle appartient.

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.

mse:GetGateway

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GatewayUniqueId	string	Non	L'identifiant unique de la passerelle.	gw-685f661467b54f48b7b7a76605ce****
AcceptLanguage	string	Non	La langue de la réponse. Valeurs valides : zh : chinois en : anglais	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de la réponse.
RequestId	string	L'identifiant de la requête.	9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6
HttpStatusCode	integer	Le code d'état HTTP renvoyé.	200
Message	string	Le message renvoyé.	La requête a été traitée avec succès
Code	integer	Le code d'état renvoyé. Une valeur de 200 indique que la requête a réussi.	200
Success	boolean	Indique si la requête a réussi. Valeurs valides : `true` : la requête a réussi. `false` : la requête a échoué.	true
Data	object	Les informations sur la passerelle.
Id	integer	L'identifiant de la passerelle.	12
Name	string	Le nom de la passerelle.	DEFAULT
GatewayUniqueId	string	L'identifiant unique de la passerelle.	gw-7ea3da97b96543e19f6c597cd4a9****
Region	string	L'identifiant de la région.	cn-hangzhou
PrimaryUser	string	L'identifiant du compte Alibaba Cloud de l'utilisateur qui a créé la passerelle.	1231254
Status	integer	L'état de la passerelle. Valeurs valides : 0 : la passerelle est en cours de création. 1 : la création de la passerelle a échoué. 2 : la passerelle est en cours d'exécution. 3 : la passerelle est en cours de modification. 4 : la passerelle est en cours de réduction. 6 : la passerelle est en cours d'extension. 8 : la passerelle est en cours de suppression. 10 : la passerelle est en cours de redémarrage. 11 : la passerelle est en cours de reconstruction. 12 : la passerelle est en cours de mise à jour. 13 : la mise à jour de la passerelle a échoué.	0
Vpc	string	L'identifiant du VPC.	vpc-bp1328cm01m6uel42b5zb
Vswitch	string	L'identifiant du vSwitch.	vsw-bp18zeqxx6mpuq843z4n5
SecurityGroup	string	L'identifiant du groupe de sécurité.	sg-bp11ufzqn6mmb8dtzz82
Spec	string	Les spécifications de la passerelle.	MSE_GTW_16_32_200_c
Replica	integer	Le nombre de réplicas de la passerelle.	2
GmtCreate	string	L'heure à laquelle la passerelle a été créée. L'heure est affichée en GMT. Il s'agit de l'heure locale de la région où réside la passerelle.	2022-01-07T10:07:57.000+0000
GmtModified	string	L'heure de la dernière modification de la passerelle.	2022-01-07T10:07:57.000+0000
XtraceDetails	object	Les détails de Tracing Analysis.
Sample	integer	The sampling rate of Tracing Analysis.	10
TraceOn	boolean	Indicates whether sampling by using Tracing Analysis is enabled.	true
Vswitch2	string	L'identifiant du vSwitch secondaire.	vpc-bp1j6ivhav15ve7q54kq2
InstanceId	string	L'identifiant de l'instance.	mse-cn-st21ri2****
ChargeType	string	La méthode de facturation, telle que l'abonnement ou le paiement à l'usage.	POSTPAY
EndDate	string	L'heure d'expiration de la passerelle.	2021-08-01 00:00:00
StatusDesc	string	La description de l'état.	Redémarrage
LogConfigDetails	object	La configuration des journaux.
LogEnabled	boolean	Indicates whether Log Service is activated.	true
ProjectName	string	The name of the project.	k8s-log-c173117256e934a96b7fefdf2ef8a8057
LogStoreName	string	The name of the Logstore.	mse_access_log
MseTag	string	La balise de la ressource.	{"TagKey":"TagValue"}
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfm34x43l*****
TotalReplica	integer	Le nombre total de réplicas, y compris le nombre de réplicas issus d'une extension automatique.	3
Elastic	boolean	Indique si l'extension automatique est activée.	true
ElasticReplica	integer	Le nombre de réplicas ajoutés par extension automatique.	1
ElasticType	string	Le type d'extension automatique. Valeur valide : CronHPA : extension basée sur le temps	CronHPA
ElasticPolicy	object	La stratégie d'extension automatique.
MaxReplica	integer	The maximum number of instances that are automatically scaled out. This parameter is used for horizontal scale-out.	5
ElasticType	string	The type of auto scale-out. Valid value: CronHPA: scale-out by time	CronHPA
TimePolicyList	array<object>	The policy of scale-out by time.
	object
DesiredReplica	integer	The number of expected replicas.	2
StartTime	string	The start time of auto scale-out.	16:00
EndTime	string	The end time of auto scale-out.	18:00

Exemples

JSON format

{
  "RequestId": "9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6",
  "HttpStatusCode": 200,
  "Message": "The request is processed successfully.",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 12,
    "Name": "DEFAULT",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
    "Region": "cn-hangzhou",
    "PrimaryUser": "1231254",
    "Status": 0,
    "Vpc": "vpc-bp1328cm01m6uel42b5zb",
    "Vswitch": "vsw-bp18zeqxx6mpuq843z4n5",
    "SecurityGroup": "sg-bp11ufzqn6mmb8dtzz82",
    "Spec": "MSE_GTW_16_32_200_c",
    "Replica": 1,
    "GmtCreate": "2022-01-07T10:07:57.000+0000",
    "GmtModified": "2022-01-07T10:07:57.000+0000",
    "XtraceDetails": {
      "Sample": 10,
      "TraceOn": true
    },
    "Vswitch2": "vpc-bp1j6ivhav15ve7q54kq2",
    "InstanceId": "mse-cn-st21ri2****",
    "ChargeType": "POSTPAY",
    "EndDate": "2021-08-01 00:00:00",
    "StatusDesc": "Restarting",
    "LogConfigDetails": {
      "LogEnabled": true,
      "ProjectName": "k8s-log-c173117256e934a96b7fefdf2ef8a8057",
      "LogStoreName": "mse_access_log"
    },
    "MseTag": "{\"TagKey\":\"TagValue\"}",
    "ResourceGroupId": "rg-acfm34x43l*****",
    "TotalReplica": 3,
    "Elastic": true,
    "ElasticReplica": 1,
    "ElasticType": "CronHPA",
    "ElasticPolicy": {
      "MaxReplica": 5,
      "ElasticType": "CronHPA",
      "TimePolicyList": [
        {
          "DesiredReplica": 2,
          "StartTime": "16:00",
          "EndTime": "18:00"
        }
      ]
    }
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

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

Notes de version

Consultez Notes de version pour la liste complète.