ListCustomDomains - 获取自定义域名列表信息

获取自定义域名信息列表。

调试

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

授权信息

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

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

请求语法

GET /2021-04-06/custom-domains HTTP/1.1

请求参数

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

设定返回域名的前缀。

prefix_text
startKeystring

设定结果从 startKey 之后(包括 startKey)按字母排序的第一个开始返回。

next_service
nextTokenstring

当符合查询条件的数据未读取完时,服务端会返回 nextToken,此时可以使用 nextToken 继续读取后面的数据。第一次查询不需要提供这个参数。

fc-thinkphp-demo.functioncompute.com
limitinteger

限定此次返回资源的数量。取值范围[0,100],默认值为 20。返回结果小于或等于指定的数量。

20
X-Fc-Account-Idstring

您的阿里云账号(主账号)ID。

188077086902****
X-Fc-Datestring

API 调用时间,格式为EEE,d MMM yyyy HH:mm:ss GMT

Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Idstring

自定义请求 ID。

asdf*****

返回参数

名称类型描述示例值
object

返回结果。

nextTokenstring

当符合查询条件的数据未读取完时,服务端会返回 nextToken,此时可以使用 nextToken 继续读取后面的数据。第一次查询不需要提供这个参数。

example.com
customDomainsarray<object>

符合列举条件的域名列表。

customDomainobject

域名信息。

domainNamestring

域名。

example.com
accountIdstring

您的阿里云账号(主账号)ID。

1986114****4305
protocolstring

域名支持的协议类型。

  • HTTP:仅支持 HTTP 协议。
  • HTTPS:仅支持 HTTPS 协议。
  • HTTP,HTTPS:支持 HTTP 及 HTTPS 协议。
HTTP
apiVersionstring

API 的版本。

2016-08-15
createdTimestring

域名的创建时间。

2020-07-27T08:02:19Z
lastModifiedTimestring

域名上一次被更新的时间。

2020-07-27T08:02:19Z
certConfigCertConfig

HTTPS 证书的配置信息。

tlsConfigTLSConfig

TLS 配置信息。

routeConfigRouteConfig

路由表:定义域名访问时的 PATH 到 Function 的映射。

wafConfigWAFConfig

Web 应用防火墙配置信息。

示例

正常返回示例

JSON格式

{
  "nextToken": "example.com",
  "customDomains": [
    {
      "domainName": "example.com\t",
      "accountId": "1986114****4305\t",
      "protocol": "HTTP\t",
      "apiVersion": "2016-08-15\t",
      "createdTime": "2020-07-27T08:02:19Z\t",
      "lastModifiedTime": "2020-07-27T08:02:19Z\t",
      "certConfig": {
        "certName": "my-cert",
        "certificate": "-----BEGIN CERTIFICATE----- xxxxx -----END CERTIFICATE-----",
        "privateKey": "-----BEGIN RSA PRIVATE KEY----- xxxxx -----END RSA PRIVATE KEY-----"
      },
      "tlsConfig": {
        "minVersion": "TLSv1.2",
        "cipherSuites": [
          "TLS_RSA_WITH_RC4_128_SHA"
        ],
        "maxVersion": "TLSv1.3"
      },
      "routeConfig": {
        "routes": [
          {
            "functionName": "f1",
            "methods": [
              "GET"
            ],
            "path": "/login",
            "qualifier": "prod",
            "serviceName": "s1",
            "rewriteConfig": {
              "equalRules": [
                {
                  "match": "/old",
                  "replacement": "/new"
                }
              ],
              "wildcardRules": [
                {
                  "match": "/api/*",
                  "replacement": "/$1"
                }
              ],
              "regexRules": [
                {
                  "match": "^/js/(.*?)$",
                  "replacement": "/public/javascripts/$1"
                }
              ]
            }
          }
        ]
      },
      "wafConfig": {
        "enableWAF": true
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-02-19API 内部配置变更,不影响调用查看变更详情
2021-06-30OpenAPI 入参发生变更查看变更详情
2021-06-30OpenAPI 入参发生变更查看变更详情
2021-06-30OpenAPI 入参发生变更查看变更详情