全部产品
Search
文档中心

人工智能平台 PAI:ListGatewayDomains - 查询网关自定义域名列表

更新时间:Nov 22, 2024

查询私有网关自定义域名列表。

调试

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

授权信息

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

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

请求语法

GET /api/v2/gateways/{ClusterId}/{GatewayId}/domains HTTP/1.1

请求参数

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

私有网关所在地域。

cn-shanghai
GatewayIdstring

私有网关 ID。如何获取私有网关 ID,请参见接口 ListGateway 返回结果中的 GatewayId 字段。

gw-1uhcqmsc7x22******

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

40325405-579C-4D82****
Messagestring

请求返回信息。

Successfully get custom domains
CustomDomainsarray<object>

自定义域名列表。

CustomDomainsobject

自定义域名详情。

Typestring

域名类型。

枚举值:
  • intranet内网域名
  • internet公网域名
intranet
CertificateIdstring

域名绑定的 SSL 证书 ID。请在数字证书管理服务完成上传或购买证书后获取证书 ID。

1473**25
Domainstring

自定义域名。

test.com

示例

正常返回示例

JSON格式

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "Successfully get custom domains",
  "CustomDomains": [
    {
      "Type": "intranet",
      "CertificateId": "1473**25",
      "Domain": "test.com"
    }
  ]
}

错误码

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