文档

ListGatewayDomain - 查询网关已关联域名列表

更新时间:

查询网关已关联域名列表。

调试

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

授权信息

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

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

请求参数

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

网关唯一标识 ID。

gw-c9bc5afd61014165bd58f621b491****
Typestring

域名类型。

All
DomainNamestring

按域名模糊搜索

example.com
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

3F5D8E93-CA66-57F1-8BCF-A223E11B6B91
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

错误信息。

You are not authorized to perform this operation.
Codeinteger

返回码。

200
Successboolean

请求结果,取值如下:

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

节点数据。

Idlong

域名 ID。

243
Namestring

域名。

test.com
Protocolstring

协议。

HTTP
MustHttpsboolean

是否强制 HTTPS。

true
CertIdentifierstring

证书 ID。

3452-cn-hangzhou
CertBeforeDatestring

证书到期时间(已废弃,请进入域名详情页查看)。

2031-03-30 02:35:12
GatewayIdlong

网关 ID。

12
GmtCreatestring

域名记录创建时间。

2031-03-30 02:35:12
GmtModifiedstring

域名记录更新时间。

2031-03-30 02:35:12
Statusinteger

域名状态。 枚举值

  • 0 未发布
  • 2 发布中
  • 3 已发布
  • 4 编辑中
  • 5 下线中
  • 6 不可用
3
Typestring

域名来源类型:

  • Op:控制台创建
  • Ingress:MSE Ingress 创建
Op
Commentobject

路由备注(ingress)

Statusstring

状态

Error
Http2string

是否开启Http2

  • open:开启Http2
  • close:关闭Http2
  • globalConfig:使用全局配置。
close
TlsMaxstring

Tls 最大版本。

TLS 1.3
TlsMinstring

Tls 最小版本.

TLS 1.0

示例

正常返回示例

JSON格式

{
  "RequestId": "3F5D8E93-CA66-57F1-8BCF-A223E11B6B91",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": 243,
      "Name": "test.com",
      "Protocol": "HTTP",
      "MustHttps": true,
      "CertIdentifier": "3452-cn-hangzhou",
      "CertBeforeDate": " 2031-03-30 02:35:12",
      "GatewayId": 12,
      "GmtCreate": " 2031-03-30 02:35:12",
      "GmtModified": " 2031-03-30 02:35:12",
      "Status": 3,
      "Type": "Op",
      "Comment": {
        "Status": "Error"
      },
      "Http2": "close",
      "TlsMax": "TLS 1.3",
      "TlsMin": "TLS 1.0"
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-01-18OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:DomainName
  • 本页导读 (1)