文档

GetGateway - 查询网关信息

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:GetGatewayRead
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

名称类型必填描述示例值
GatewayUniqueIdstring

网关唯一标识 ID。

gw-685f661467b54f48b7b7a76605ce****
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

9C96CDF8-9E6C-5AB6-B83C-8F87A10117E6
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

请求是否成功的描述信息

请求处理成功
Codeinteger

状态码。说明 200 表示成功。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Dataobject

网关信息。

Idlong

网关 ID。

12
Namestring

网关名称。

DEFAULT
GatewayUniqueIdstring

网关唯一标识 ID。

gw-7ea3da97b96543e19f6c597cd4a9****
Regionstring

地域。

cn-hangzhou
PrimaryUserstring

创建主用户 User ID。

1231254
Statusinteger

获取数据集成同步任务的结果状态。取值如下:

  • 0: 创建中
  • 1: 创建失败
  • 2: 运行中
  • 3: 变更中
  • 4: 缩容中
  • 6: 扩容中
  • 8: 删除中
  • 10: 重启中
  • 11: 重建中
  • 12: 升级中
  • 13: 升级失败
0
Vpcstring

VPC 网络 ID。

vpc-bp1328cm01m6uel42b5zb
Vswitchstring

交换机。

vsw-bp18zeqxx6mpuq843z4n5
SecurityGroupstring

安全组。

sg-bp11ufzqn6mmb8dtzz82
Specstring

网关规格。

MSE_GTW_16_32_200_c
Replicainteger

网关副本数。

1
GmtCreatestring

网关设备的创建时间,GMT 格式,是用户所在地的当地时间。

2022-01-07T10:07:57.000+0000
GmtModifiedstring

最后一次更新实例的时间。

2022-01-07T10:07:57.000+0000
XtraceDetailsobject

XTrace 详情。

Sampleinteger

XTrace 采样率。

10
TraceOnboolean

是否开启 XTrace 采样。

true
Vswitch2string

交换机 2。

vpc-bp1j6ivhav15ve7q54kq2
InstanceIdstring

实例 ID。

mse-cn-st21ri2****
ChargeTypestring

付费模式,包括包年包月和按量付费。

POSTPAY
EndDatestring

网关结束时间。

2021-08-01 00:00:00
StatusDescstring

状态描述。

正在重启中。
LogConfigDetailsobject

日志配置。

LogEnabledboolean

是否开启日志投递

true
ProjectNamestring

项目名称。

k8s-log-c173117256e934a96b7fefdf2ef8a8057
LogStoreNamestring

logstore 名称。

mse_access_log
MseTagstring

资源标签。

{"TagKey":"TagValue"}
ResourceGroupIdstring

资源组 ID。

rg-acfm34x43l*****
TotalReplicainteger

总副本数(包括自动扩容副本数)。

3
Elasticboolean

是否开启自动扩容。

true
ElasticReplicainteger

自动扩容副本数。

1
ElasticTypestring

自动扩容类型,目前支持:

  • CronHPA:按时间扩容
CronHPA
ElasticPolicyobject

自动扩容策略。

MaxReplicainteger

自动扩容最大实例数(水平扩容时使用)。

5
ElasticTypestring

自动扩容类型,目前支持:

  • CronHPA:按时间扩容
CronHPA
TimePolicyListarray<object>

按时间扩容策略。

object
DesiredReplicainteger

期望副本数。

2
StartTimestring

自动扩容起始时间。

16:00
EndTimestring

自动扩容结束时间。

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错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

变更历史

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