你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Endpoints - Validate Custom Domain

验证自定义域映射,确保它映射到 DNS 中的正确 CDN 终结点。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain?api-version=2024-02-01

URI 参数

名称 必需 类型 说明
endpointName
path True

string

配置文件下全局唯一的终结点的名称。

profileName
path True

string

资源组中唯一的 CDN 配置文件的名称。

resourceGroupName
path True

string

Azure 订阅中的资源组的名称。

正则表达式模式: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure 订阅 ID。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。 当前版本为 2024-02-01。

请求正文

名称 必需 类型 说明
hostName True

string

自定义域的主机名。 必须是域名。

响应

名称 类型 说明
200 OK

ValidateCustomDomainOutput

没问题。 请求已成功。

Other Status Codes

ErrorResponse

描述操作失败原因的 CDN 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Endpoints_ValidateCustomDomain

示例请求

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/validateCustomDomain?api-version=2024-02-01

{
  "hostName": "www.someDomain.com"
}

示例响应

{
  "customDomainValidated": true,
  "message": null,
  "reason": null
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ValidateCustomDomainInput

要验证 DNS 映射的自定义域的输入。

ValidateCustomDomainOutput

自定义域验证的输出。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ValidateCustomDomainInput

要验证 DNS 映射的自定义域的输入。

名称 类型 说明
hostName

string

自定义域的主机名。 必须是域名。

ValidateCustomDomainOutput

自定义域验证的输出。

名称 类型 说明
customDomainValidated

boolean

指示自定义域是否有效。

message

string

描述自定义域无效原因的错误消息。

reason

string

自定义域无效的原因。