You need to enable JavaScript to run this app.
文档中心
专线连接

专线连接

复制全文
下载 pdf
专线健康检查
CreateDirectConnectHealthCheck - 创建专线健康检查
复制全文
下载 pdf
CreateDirectConnectHealthCheck - 创建专线健康检查
调用 CreateDirectConnectHealthCheck 接口 ,创建健康检查实例。​
使用说明​
一个健康检查实例仅支持指定一个子网作为监测源,源IP在指定子网内随机分配,不支持指定IP。更多配额限制请参见约束限制。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:CreateDirectConnectHealthCheck​
接口名称。当前 API 的名称为 CreateDirectConnectHealthCheck。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为 2020-04-01。​
​
DirectConnectHealthCheckName String 可选 示例值:dchc-01​
健康检查实例的名称。​
  • 长度限制为1 ~ 128个字符。​
  • 需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。不能以http:// 或者 https://作为开头。​
  • 不传入该参数或该参数不传入数值时,默认为健康检查实例的ID。​
​
Description String 可选 示例值:This is a healthcheck​
健康检查实例的描述。​
  • 以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。​
  • 长度限制为0 ~ 255个字符。​
  • 不传入该参数或该参数不传入数值时,默认为空字符串。​
​
Region String 必选 示例值:ap-southeast-1​
健康检查实例所在的地域。需传入探测源所在的地域,与私有网络所在的地域相同。​
​
VpcId String 必选 示例值:vpc-01​
健康检查实例所在的私有网络。需传入目标监测源IP所在的私有网络。​
​
SubnetId String 必选 示例值:subnet-01​
目标监测源IP所在的子网。​
​
ClientToken String 可选 示例值:123e4567-e89b-12d3-a456-42665544****​
客户端Token,用于保证请求幂等性。​
  • 由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。​
  • 仅支持ASCII字符,且不能超过64个字符。​
  • 若不传入ClientToken,则此次API调用不进行幂等校验。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
DirectConnectHealthCheckId String 示例值:dhc-2752hz4tek****​
健康检查实例的ID。​
​
​
​
请求示例​
​
GET /?Action=CreateDirectConnectHealthCheck&Version=2020-04-01&Region=ap-southeast-1&VpcId=vpc-01&SubnetId=subnet-01 HTTP/1.1​
Host: directconnect.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/directconnect/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2021062415303301022514515207C4****",​
"Action": "CreateDirectConnectHealthCheck",​
"Version": "2020-04-01",​
"Service": "directconnect",​
"Region": "ap-southeast-1"​
},​
"Result": {​
"RequestId": "2021062415303301022514515207C4****",​
"DirectConnectHealthCheckId": "dhc-2752hz4tek****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidDescription.Malformed​
The specified description is malformed.​
指定的描述格式不合法。请修复描述格式后重试。​
400​
InvalidDescription.Malformed​
The specified description is malformed. Ensure the maximum length of description is 255.​
指定的描述格式不合法。描述长度不能超过255个字符。​
400​
InvalidDirectConnectHealthCheck.SubnetAZNotSupported​
The specified subnet does not support direct connect health check.​
指定的子网不支持健康检查。​
400​
InvalidDirectConnectHealthCheck.ClusterUnavailable​
No available health check cluster.​
没有可用的健康检查集群。​
400​
InvalidDirectConnectHealthCheck.SubnetConflictWithVpc​
The specified subnet does not belong to the specified VPC.​
指定的子网不属于指定的VPC。​
400​
InvalidDirectConnectHealthCheck.SubnetNoAvailableIp​
The specified subnet does not have available IP addresses.​
指定的子网没有可用的IP地址。​
400​
InvalidDirectConnectHealthCheck.VpcConflictWithAccount​
The specified VPC does not belong to the specified account.​
指定的VPC不属于指定的账号。​
400​
InvalidName.Malformed​
The specified name is malformed.​
指定的名称格式不合法。请修复名称格式后重试。​
400​
InvalidName.Malformed​
The specified name is malformed. Ensure the maximum length of name is 128.​
指定的名称格式不合法。名称长度不能超过128个字符。​
400​
QuotaExceeded.DirectConnectHealthCheck​
You've reached the limit on the number of direct connect health check that you can create.​
已达到可创建的健康检查的数量上限。​
404​
InvalidDirectConnectHealthCheck.SecurityGroupNotFound​
The specified security group does not exist.​
指定的安全组不存在。​
404​
InvalidDirectConnectHealthCheck.SubnetNotFound​
The specified subnet does not exist.​
指定的子网不存在。​
404​
InvalidDirectConnectHealthCheck.VpcNotFound​
The specified VPC does not exist.​
指定的VPC不存在。​
404​
InvalidDirectConnectHealthCheckCluster.NotFound​
The specified direct connect direct connect health check cluster does not exist.​
指定的健康检查集群不存在。​
​
​
最近更新时间:2026.01.23 17:00:42
这个页面对您有帮助吗?
有用
有用
无用
无用