ListDomains - 查询域名列表

更新时间:
复制 MD 格式

查询域名列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:ListDomains

none

*Domain

acs:apig:{#regionId}:{#accountId}:domain/*

请求语法

GET /v1/domains HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

nameLike

string

域名,模糊搜索。

test

pageSize

integer

每页条数,默认 10。

10

pageNumber

integer

页码,默认 1

1

gatewayId

string

网关 ID。

gw-xxxxxx

domainScope

string

Serverless

resourceGroupId

string

资源组 ID

rg-aek27lpqyiie6qy

gatewayType

string

网关类型过滤,目前支持 AIAPI 两种网关类型。

枚举值:

  • AI :

    AI

  • API :

    API

API

返回参数

名称

类型

描述

示例值

object

返回数据体

requestId

string

请求 id,用于追溯 API 调用链路。

C61E30D3-579A-5B43-994E-31E02EDC9129

code

string

响应码。

Ok

message

string

响应描述。

success

data

object

响应数据。

pageNumber

integer

页码。

1

pageSize

integer

每页条数。

10

totalSize

integer

总条数。

9

items

array

域名信息列表。

DomainInfo

域名信息。

示例

正常返回示例

JSON格式

{
  "requestId": "C61E30D3-579A-5B43-994E-31E02EDC9129",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 9,
    "items": [
      {
        "domainId": "d-cq1lthllhtgja4dk54eg",
        "status": "Published",
        "createFrom": "Console",
        "name": "abc.com",
        "protocol": "HTTP",
        "domainScope": "",
        "forceHttps": false,
        "updateTimestamp": 1719386834548,
        "createTimestamp": 1719386834548,
        "certIdentifier": "235556-cn-hangzhou",
        "resourceGroupId": "rg-xxxx",
        "mTLSEnabled": true,
        "clientCACert": "-----BEGIN CERTIFICATE-----\nMIIFBTCCAu2gAwIBAgIUORLpYPGSFD1YOP6PMbE7Wd/mpTQwDQYJKoZIhvcNAQEL\nBQAwE************************************************2VwVOJ2gqX3\nYuGaxvIbDy0iQJ1GMerPRyzJTeVEtdIKT29u0PdFRr4KZWom35qX7G4=\n-----END CERTIFICATE-----"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情