You need to enable JavaScript to run this app.
文档中心
复制全文
下载 pdf
路径分析
CreatePathAnalysis - 发起路径分析
复制全文
下载 pdf
CreatePathAnalysis - 发起路径分析
调用CreatePathAnalysis接口,发起路径分析。​
请求参数​
Action String 必选 示例值:CreatePathAnalysis​
接口名称。当前 API 的名称为 CreatePathAnalysis。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为 2020-04-01。​
​
SourceType String 必选 示例值:ECS​
源资源类型。取值如下:​
  • ECS:云服务器。​
  • PublicIP:公网IP。​
  • DCG:专线网关。​
  • TRIPSec:TR类型IPSEC连接。​
  • VGW:VPN网关。​
​
SourceId String 必选 示例值:i-ye8klde7swh9l3bn****​
源资源ID。​
​
SourceIP String 可选 示例值:192.168.1.64​
源IP地址。​
若SourceType传入ECS,仅用于指定主网卡或辅助网卡的主私网IP地址。​
​
TargetType String 必选 示例值:ECS​
目的资源类型。取值如下:​
  • ECS:云服务器。​
  • CLB:传统型负载均衡。​
  • PublicIP:公网IP。​
  • DCG:专线网关。​
  • TRIPSec:TR类型IPSC连接。​
  • VGW:VPN网关。​
  • PrivateIP:私网IP。​
​
TargetId String 必选 示例值:i-ye8klde7swh9l3b****​
目的资源ID。​
​
TargetIP String 可选 示例值:192.168.0.120​
目的IP地址。​
​
Protocol String 必选 示例值:TCP​
协议类型。取值如下:​
  • TCP​
  • UDP​
  • ICMP​
​
TargetPort Integer 可选 示例值:80​
目的端口。​
​
Save Boolean 可选 示例值:true​
是否保存网络路径分析结果。取值如下:​
  • true:保存。​
  • false(默认):不保存。​
​
PathName String 必选 示例值:PublicIP_ECS_TCP_80_19250​
路径名称。​
  • 长度限制为1 ~ 128个字符。​
  • 需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短横线(-)。​
​
Description String 可选 示例值:PublicIP_ECS_TCP_80_19250​
网络路径描述信息。​
  • 长度限制为0~ 255个字符。​
  • 不填默认为空字符串。​
  • 需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。​
​
PrivateIP String 可选 示例值:192.168.1.64​
自定义源私网IP地址,未传递则默认使用SourceIP。​
说明​
仅用于容器网络路径分析场景,作为实际源IP地址。​
​
​
​
返回参数​
PathId String 示例值:pa-3ogfsspk3cf0g6****​
网络路径ID。​
​
PathReportId String 示例值:par-ak3v00jduk1s3r****​
路径分析报告ID。​
​
​
​
请求示例​
​
GET /?Action=CreatePathAnalysis&Version=2020-04-01&SourceType=ECS&SourceId=i-ye8klde7swh9l3bn****&SourceIP=192.168.1.64&TargetType=ECS&TargetId=i-ye8klde7swh9l3b****&TargetIP=192.168.0.120&Protocol=TCP&TargetPort=80&Save=true&PathName=PublicIP_ECS_TCP_80_19250&Description=PublicIP_ECS_TCP_80_19250​
Host: na.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/na/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "CreatePathAnalysis",​
"Version": "2020-04-01",​
"Service": "",​
"Region": "cn-beijing"​
},​
"Result": {​
"PathId": "pa-3ogfsspk3cf0g6****",​
"PathReportId": "par-ak3v00jduk1s3r****"​
}​
}​
​
错误码​
​
状态码​
错误码​
错误信息​
说明​
400​
DataUnmarshalFailed​
Data unmarshal failed.​
请求解析失败。​
400​
InvalidAllPublicIP​
The specified source ip and target ip are public ip.​
源目都是公网IP时,需要目的端为EIP。​
400​
InvalidIPv4​
The specified ipv4 is not invalid.​
指定的IPv4不合法。​
400​
InvalidPathAnalysisEndType​
The specified end type is invalid.​
指定的端类型不合法。​
400​
InvalidPort​
The specified port is invalid.​
指定的端口号不合法。​
400​
InvalidProtocol​
The specified protocol is invalid.​
指定的协议类型不合法。​
400​
InvalidSourceTarget​
The specified source and target should not be same.​
指定的源目的不能相同。​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request, for example, the ''.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如 。​
401​
ServiceRoleUnauthorized​
service role is unauthorized​
角色未授权,请先访问控制台操作授权​
500​
InternalError​
An internal error has occurred.​
发生内部错误。​
​
​
最近更新时间:2026.08.12 11:37:50
这个页面对您有帮助吗?
有用
有用
无用
无用