Direct Connect
Direct Connect
Document
- Documentation
Direct ConnectAPI ReferenceHealth checkCreateDirectConnectHealthCheck - Creating a health check for Direct Connect
Copy page
Download PDFHealth check
CreateDirectConnectHealthCheck - Creating a health check for Direct Connect
Copy pageDownload PDFCreateDirectConnectHealthCheck - Creating a health check for Direct Connect
Call the CreateDirectConnectHealthCheck API to create a health check instance.
Instructions
Each health check instance supports specifying only one subnet as the monitoring source. The source IP is randomly allocated within the specified subnet and cannot be specified manually. For more about quota limits, see Limits.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.
Action String required Example: CreateDirectConnectHealthCheck
The interface name. The current API name is CreateDirectConnectHealthCheck.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
DirectConnectHealthCheckName String optional Example: dchc-01
The name of the health check instance.
- Must be 1 to 128 characters.
- Must start with a letter, Chinese character, or number. May include periods (.), underscores (_), and hyphens (-). Must not start with http:// or https://.
- If you do not provide this parameter or leave it empty, it defaults to the health check instance ID.
Description String optional Example: This is a healthcheck
The description of the health check instance.
- Must start with a Chinese character, letter, or number. May include Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), commas (,), Chinese commas (，), and Chinese periods (。).
- Must be 0 to 255 characters.
- If you do not provide this parameter or leave it unset, it defaults to an empty string.
Region String required Example: ap-southeast-1
The region where the health check is located. Provide the region of the probe source. It must be the same as the region of the Virtual Private Cloud (VPC).
VpcId String required Example: vpc-01
The VPC where the health check instance is located. Provide the VPC where the target monitoring source IP is located.
SubnetId String required Example: subnet-01
The subnet where the target monitoring source IP is located.
ClientToken String optional Example: 123e4567-e89b-12d3-a456-42665544****
Client Token that is used to ensure the request idempotency.
- You can use the client to automatically generate a token, but must confirm that the tokens for different requests are unique. This prevents repeated actions due to multiple client retries when the call of the API action times out or an internal server error occurs.
- Must not exceed 64 ASCII characters.
- If you do not provide ClientToken, this API call does not verify idempotency.
Response parameters
The following only details response parameters specific to this API. For more information, see Response structure.
DirectConnectHealthCheckId String Example: dhc-2752hz4tek****
The ID of the health check instance.
Request examples
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
Response examples
{
"ResponseMetadata": {
"RequestId": "2021062415303301022514515207C4****",
"Action": "CreateDirectConnectHealthCheck",
"Version": "2020-04-01",
"Service": "directconnect",
"Region": "ap-southeast-1"
},
"Result": {
"RequestId": "2021062415303301022514515207C4****",
"DirectConnectHealthCheckId": "dhc-2752hz4tek****"
}
}
Error codes
The table below describes the error codes for this API that are associated with business logic. For details, see Common error codes.
Last updated: 2026.03.04 14:05:36
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
