DescribeVsDomainDetail - 查询域名信息

获取指定视图计算域名配置的基本信息。

调试

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

授权信息

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

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

请求参数

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

视图计算域名名称

example.aliyundoc.com

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

9BEC5E85-C76B-56EF-A922-860EFDB8B64B
DomainConfigobject

域名配置列表信息。

GmtCreatedstring

创建时间。

2021-07-19T10:27:23Z
Descriptionstring

域名描述信息。

测试使用
SSLProtocolstring

HTTPS 证书是否启用。取值:

  • on:启用。

  • off(默认值):不启用。

off
Regionstring

域名所在区域。

cn-qingdao
Scopestring

加速区域。取值范围:

  • domestic
  • overseas
  • global
domestic
Cnamestring

为视图计算域名生成的一个 CNAME 域名,需要在域名解析服务商处将域名 CNAME 解析到该域名。

example.aliyundoc.com.*****.com
DomainStatusstring

视图计算加速域名运行状态。取值:

  • online:启用。

  • offline:停用。

  • configuring:配置中。

online
GmtModifiedstring

最近修改时间。

2021-07-19T10:27:23Z
DomainNamestring

视图计算域名名称。

example.aliyundoc.com
DomainTypestring

域名类型。

说明 固定值:vs
vs

示例

正常返回示例

JSON格式

{
  "RequestId": "9BEC5E85-C76B-56EF-A922-860EFDB8B64B",
  "DomainConfig": {
    "GmtCreated": "2021-07-19T10:27:23Z",
    "Description": "测试使用",
    "SSLProtocol": "off",
    "Region": "cn-qingdao",
    "Scope": "domestic",
    "Cname": "example.aliyundoc.com.*****.com",
    "DomainStatus": "online",
    "GmtModified": "2021-07-19T10:27:23Z",
    "DomainName": "example.aliyundoc.com",
    "DomainType": "vs"
  }
}

错误码

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

特殊错误码

ErrorCode 错误码Message 错误信息HTTP 状态语义
InvalidDomain.NotFoundThe domain provided does not belong to you.404域名不存在或不属于当前用户。
ServiceBusyThe specified Domain is configuring, please retry again later.403域名正在配置中,请稍后再试。