CreatePADiagnosisTask - 创建内网诊断任务

更新时间:
复制 MD 格式

创建内网访问诊断任务

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

csas:CreatePADiagnosisTask

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

DiagnoseType

string

诊断类型,可选的有:

  • FullLink:全链路诊断

  • Application: 应用诊断

FullLink

Username

string

用户名。

Zhaosi

DevTag

string

终端设备 ID。

2987b3e0-8108-2f99-4d18-3b4f1c1c36d7

UserGroupId

string

用户组 ID。

用户组ID。

Protocol

string

内网访问应用协议。取值:

  • TCP

  • UDP

TCP

Host

string

要诊断的地址。

socialapp-gateway.client9.me

Port

string

端口。

80

PopMode

string

pop 点选择模式:

  • AutoSelect: 自动选择

  • ManualSelect: 手动选择

ManualSelect

PopId

string

POP 点 ID。

pop-3e244b62357dcafc

UdpExtraConfigs

object

UDP 诊断额外配置。如不配置,则代表接收到任何响应内容即视为成功。

RequestContent

string

UDP 请求内容。

hello

ExpectedResponse

string

用户预期的后端服务器返回信息。

hello

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

5F79AE39-6622-5292-87EF-DE45631DE4D7

DiagnosisTask

object

诊断任务。

DiagnoseType

string

诊断类型,可选的有:

  • FullLink:全链路诊断

  • Application: 应用诊断

FullLink

UserGroup

object

用户组

UserGroupId

string

用户组 ID。

ug-xxxxxxxx

UserGroupName

string

用户组名称。

IT

DevTag

string

终端设备 ID。

E9EE1CE7-4AA0-521D-B8E1-E13E47F05E94

Username

string

用户名。

zhangsan

Protocol

string

内网访问应用协议。取值:

  • TCP

  • UDP

TCP

Host

string

要诊断的地址。

172.16.6.1

Port

string

端口

443

PopMode

string

pop 点选择模式:

  • AutoSelect: 自动选择

  • ManualSelect: 手动选择

AutoSelect

PopId

string

POP 点 ID。手动选择时必传。

pop-8ded63ce9d3d317e

UdpExtraConfigs

object

UDP 诊断额外信息。

RequestContent

string

UDP 请求内容。

hello

ExpectedResponse

string

用户预期的后端服务器返回信息。

hello

DiagnoseId

string

诊断任务 ID。

diag-3e0d36d6c15a0502

Status

string

任务运行状态。取值:

  • Running:运行中。

  • Finished:已完成。

  • Failed:运行失败。

Disabled

示例

正常返回示例

JSON格式

{
  "RequestId": "5F79AE39-6622-5292-87EF-DE45631DE4D7",
  "DiagnosisTask": {
    "DiagnoseType": "FullLink",
    "UserGroup": {
      "UserGroupId": "ug-xxxxxxxx",
      "UserGroupName": "IT"
    },
    "DevTag": "E9EE1CE7-4AA0-521D-B8E1-E13E47F05E94",
    "Username": "zhangsan",
    "Protocol": "TCP",
    "Host": "172.16.6.1",
    "Port": "443",
    "PopMode": "AutoSelect",
    "PopId": "pop-8ded63ce9d3d317e",
    "UdpExtraConfigs": {
      "RequestContent": "hello",
      "ExpectedResponse": "hello"
    },
    "DiagnoseId": "diag-3e0d36d6c15a0502",
    "Status": "Disabled"
  }
}

错误码

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

变更历史

更多信息,参考变更详情