查询绑定的自定义域名详情信息,包含系统自动分配的二级域名、自定义域名和SSL证书信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apigateway:DescribeDomain | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GroupId | string | 是 | API 分组 ID,系统生成,全局唯一 | 927d50c0f2e54b359919923d908bb015 |
DomainName | string | 是 | 自定义域名 | api.demo.com |
返回参数
示例
正常返回示例
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-21 | OpenAPI 描述信息更新、OpenAPI 返回结构发生变更 | 查看变更详情 |