DescribeDomain_API 网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为100/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
apigateway:DescribeDomain
Get
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

请求参数

字段名称字段详情
GroupIdstring

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

示例值:927d50c0f2e54b359919923d908bb015参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
DomainNamestring

自定义域名

示例值:api.demo.com参考取值来源:
    SetDomain

返回参数

字段名称字段详情
CertificatePrivateKeystring

证书私钥

示例值:xxx
DomainNamestring

自定义域名

示例值:api.demo.com
DomainBindingStatusstring

自定义域名绑定状态,取值:展开详情

示例值:BINDING
DomainRemarkstring

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

示例值:该域名未备案
CertificateIdstring

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

示例值:6EF60BEC-0242-43AF-BB20-270359FB54A7
DomainWebSocketStatusstring

使用 WebSocket 的域名的状态

示例值:NORMAL
RequestIdstring

请求唯一标识

示例值:6EF60BEC-0242-43AF-BB20-270359FB54A7
CertificateNamestring

SSL 证书名称

示例值:myCertificate
DomainLegalStatusstring

域名合法状态,取值:展开详情

示例值:NORMAL
GroupIdstring

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

示例值:927d50c0f2e54b359919923d908bb015
CertificateBodystring

证书内容

示例值:xxx
SubDomainstring

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

示例值:xxx-cn-hangzhou.alicloudapi.com
DomainCNAMEStatusstring

域名解析情况,取值:展开详情

示例值:RESOLVED
CertificateValidStartinteger<int64>

证书生效时间戳(毫秒)

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1672502400000
CertificateValidEndinteger<int64>

证书失效时间戳(毫秒)

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1704038400000

返回示例

变更历史

变更时间变更内容概要操作
2023-03-21
变更返回参数

相关示例

2024年08月20日