调用GetGateway查询网关信息_微服务引擎(MSE)-阿里云帮助中心

获取网关的所属VPC，所属交换机等基本信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mse:GetGateway	get	*Gateway `acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}`	无	无

请求参数

名称	类型	必填	描述	示例值
GatewayUniqueId	string	是	网关唯一标识 ID。	gw-685f661467b54f48b7b7a76605ce****
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	数据结构。
RequestId	string	请求 ID。	9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	请求是否成功的描述信息	请求处理成功
Code	integer	状态码。说明 200 表示成功。	200
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true
Data	object	网关信息。
Id	long	网关 ID。	12
Name	string	网关名称。	DEFAULT
GatewayUniqueId	string	网关唯一标识 ID。	gw-7ea3da97b96543e19f6c597cd4a9****
Region	string	地域。	cn-hangzhou
PrimaryUser	string	创建主用户 User ID。	1231254
Status	integer	获取数据集成同步任务的结果状态。取值如下： 0: 创建中 1: 创建失败 2: 运行中 3: 变更中 4: 缩容中 6: 扩容中 8: 删除中 10: 重启中 11: 重建中 12: 升级中 13: 升级失败	0
Vpc	string	VPC 网络 ID。	vpc-bp1328cm01m6uel42b5zb
Vswitch	string	交换机。	vsw-bp18zeqxx6mpuq843z4n5
SecurityGroup	string	安全组。	sg-bp11ufzqn6mmb8dtzz82
Spec	string	网关规格。	MSE_GTW_16_32_200_c
Replica	integer	网关副本数。	1
GmtCreate	string	网关设备的创建时间，GMT 格式，是用户所在地的当地时间。	2022-01-07T10:07:57.000+0000
GmtModified	string	最后一次更新实例的时间。	2022-01-07T10:07:57.000+0000
XtraceDetails	object	XTrace 详情。
Sample	integer	XTrace 采样率。	10
TraceOn	boolean	是否开启 XTrace 采样。	true
Vswitch2	string	交换机 2。	vpc-bp1j6ivhav15ve7q54kq2
InstanceId	string	实例 ID。	mse-cn-st21ri2****
ChargeType	string	付费模式，包括包年包月和按量付费。	POSTPAY
EndDate	string	网关结束时间。	2021-08-01 00:00:00
StatusDesc	string	状态描述。	正在重启中。
LogConfigDetails	object	日志配置。
LogEnabled	boolean	是否开启日志投递	true
ProjectName	string	项目名称。	k8s-log-c173117256e934a96b7fefdf2ef8a8057
LogStoreName	string	logstore 名称。	mse_access_log
MseTag	string	资源标签。	{"TagKey":"TagValue"}
ResourceGroupId	string	资源组 ID。	rg-acfm34x43l*****
TotalReplica	integer	总副本数（包括自动扩容副本数）。	3
Elastic	boolean	是否开启自动扩容。	true
ElasticReplica	integer	自动扩容副本数。	1
ElasticType	string	自动扩容类型，目前支持： CronHPA：按时间扩容	CronHPA
ElasticPolicy	object	自动扩容策略。
MaxReplica	integer	自动扩容最大实例数（水平扩容时使用）。	5
ElasticType	string	自动扩容类型，目前支持： CronHPA：按时间扩容	CronHPA
TimePolicyList	array<object>	按时间扩容策略。
timePolicyList	object
DesiredReplica	integer	期望副本数。	2
StartTime	string	自动扩容起始时间。	16:00
EndTime	string	自动扩容结束时间。	18:00

示例

正常返回示例

JSON格式

{
  "RequestId": "9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "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": "正在重启中。",
    "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"
        }
      ]
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-05-09	OpenAPI 返回结构发生变更	查看变更详情