文档

DescribeDomain - 查询自定义域名详情信息

更新时间:

查询绑定的自定义域名详情信息,包含系统自动分配的二级域名、自定义域名和SSL证书信息。

调试

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

授权信息

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

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

请求参数

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

API 分组 ID,系统生成,全局唯一

927d50c0f2e54b359919923d908bb015
DomainNamestring

自定义域名

api.demo.com

返回参数

名称类型描述示例值
object
CertificatePrivateKeystring

证书私钥

xxx
DomainNamestring

自定义域名

api.demo.com
DomainBindingStatusstring

自定义域名绑定状态,取值:

  • BINDING:正常
  • BOUND:未生效
BINDING
DomainRemarkstring

域名相关备注,如描述域名异常状态原因

该域名未备案
CertificateIdstring

SSL 证书 ID,系统自动生成唯一编号

6EF60BEC-0242-43AF-BB20-270359FB54A7
DomainWebSocketStatusstring

使用 WebSocket 的域名的状态

NORMAL
RequestIdstring

请求唯一标识

6EF60BEC-0242-43AF-BB20-270359FB54A7
CertificateNamestring

SSL 证书名称

myCertificate
DomainLegalStatusstring

域名合法状态,取值:

  • NORMAL:正常
  • ABNORMAL:异常,该状态会影响 API 调用,需尽快解决
NORMAL
GroupIdstring

API 分组 ID,系统生成,全局唯一

927d50c0f2e54b359919923d908bb015
CertificateBodystring

证书内容

xxx
SubDomainstring

系统为分组分配的二级域名

xxx-cn-hangzhou.alicloudapi.com
DomainCNAMEStatusstring

域名解析情况,取值:

  • RESOLVED:已解析
  • UNRESOLVED:未解析
RESOLVED
CertificateValidStartlong

证书生效时间戳(毫秒)

1672502400000
CertificateValidEndlong

证书失效时间戳(毫秒)

1704038400000

示例

正常返回示例

JSON格式

{
  "CertificatePrivateKey": "xxx",
  "DomainName": "api.demo.com",
  "DomainBindingStatus": "BINDING",
  "DomainRemark": "该域名未备案",
  "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
  "DomainWebSocketStatus": "NORMAL",
  "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
  "CertificateName": "myCertificate",
  "DomainLegalStatus": "NORMAL",
  "GroupId": "927d50c0f2e54b359919923d908bb015",
  "CertificateBody": "xxx",
  "SubDomain": "xxx-cn-hangzhou.alicloudapi.com",
  "DomainCNAMEStatus": "RESOLVED",
  "CertificateValidStart": 1672502400000,
  "CertificateValidEnd": 1704038400000
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-03-21OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情