GetDomain - 查询域名

查询域名。

调试

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

授权信息

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

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

请求语法

GET /v1/domains/{domainId} HTTP/1.1

请求参数

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

域名 id。

d-cpqnfn5lhtgqbga95sv1

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

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

3ACFC7A7-45A9-58CF-B2D5-765B60254695
dataobject

响应数据。

domainIdstring

域名 id。

d-cq1m3utlhtgvgkv7sitg
namestring

域名。

abc.com
protocolstring

域名支持的协议类型。

  • HTTP:仅支持 HTTP 协议。
  • HTTPS:仅支持 HTTPS 协议。
HTTP
createFromstring

从哪里创建。

枚举值:
  • ConsoleConsole
  • IngressIngress
Console
forceHttpsboolean

设置 HTTPS 协议类型,是否开启强制 HTTPS 跳转。

false
certIndentifierstring

云盾证书身份。

123576-cn-hangzhou
caCertIndentifierstring

云盾 ca 证书身份。

223576-cn-hangzhou
defaultboolean

是否默认域名。

false
http2Optionstring

http2 设置。

枚举值:
  • GlobalConfigGlobalConfig
  • CloseClose
  • OpenOpen
Open
tlsMaxstring

TLS 协议最大版本,最大支持 TLS 1.3。

TLS 1.3
tlsMinstring

TLS 协议最小版本,最小支持 TLS 1.0

TLS 1.0
createTimestamplong

创建时间戳。

1719386834548
updatetimestamplong

更新时间戳。

1719386834548
certNamestring

证书名称

test-cert
sansstring

证书绑定的所有域名。

aliyun.com
notAfterTimstamplong

证书过期时间。

1719386834548
notBeforeTimestamplong

证书生效时间。

1719386834548
algorithmstring

加密算法名称

RSA
issuerstring

证书颁发机构。

Alibaba
codestring

响应码。

Ok
messagestring

响应消息。

success

示例

正常返回示例

JSON格式

{
  "requestId": "3ACFC7A7-45A9-58CF-B2D5-765B60254695",
  "data": {
    "domainId": "d-cq1m3utlhtgvgkv7sitg",
    "name": "abc.com",
    "protocol": "HTTP",
    "createFrom": "Console",
    "forceHttps": false,
    "certIndentifier": "123576-cn-hangzhou",
    "caCertIndentifier": "223576-cn-hangzhou",
    "default": false,
    "http2Option": "Open",
    "tlsMax": "TLS 1.3",
    "tlsMin": "TLS 1.0\n",
    "createTimestamp": 1719386834548,
    "updatetimestamp": 1719386834548,
    "certName": "test-cert",
    "sans": "aliyun.com",
    "notAfterTimstamp": 1719386834548,
    "notBeforeTimestamp": 1719386834548,
    "algorithm": "RSA",
    "issuer": "Alibaba",
    "resourceGroupId": "",
    "statisticsInfo": {
      "totalCount": "",
      "resourceStatistics": [
        {
          "resourceType": "HttpApi",
          "resourceCount": 10
        }
      ]
    },
    "tlsCipherSuitesConfig": {
      "configType": "",
      "cipherSuites": [
        {
          "name": "",
          "supportVersions": [
            ""
          ]
        }
      ]
    }
  },
  "code": "Ok",
  "message": "success"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-11-20OpenAPI 返回结构发生变更查看变更详情
2024-11-01OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情