DocsICP FilingConsole
官方文档
首页

SubmitDiagnoseTaskForSingleCard

更新时间：
复制 MD 格式
产品详情
我的收藏

Submit a diagnostic task for a single IoT card.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

iotcc:SubmitDiagnoseTaskForSingleCard

create

*CloudConnector

acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
IoTCloudConnectorId

string

Yes

The ID of the cloud connector instance that runs the diagnostic task for a single IoT card.

iotcc-smy9a5ockzp08n****
SourceType

string

Yes

The source type for the network diagnostic task. Valid values:

  • Card IP: Use the IP address assigned to the IoT card.

  • Card ID: Use the ID of the IoT card.

卡IP
Source

string

Yes

The source IP address or ID of the IoT card.

169.254.XX.XX
DestinationType

string

No

The destination type for the network diagnostic task. Valid values:

  • IP: The destination is an IP address.

  • Domain Name: The destination is a domain name.

IP
Destination

string

No

The destination IP address or domain name.

114.114.XX.XX
BeginTime

integer

Yes

The start timestamp of the diagnostic task, in seconds.

1643077466
EndTime

integer

Yes

The end timestamp of the diagnostic task, in seconds.

1643077666
RegionId

string

Yes

The region ID where the diagnostic task runs.

You can call the ListRegions operation to query region IDs.

cn-hangzhou
ResourceUid

integer

No

The Alibaba Cloud account ID of the cloud connector instance owner.

253460731706911258

Response elements

Element

Type

Description

Example

object

The request ID.

RequestId

string

The request ID.

54B48E3D-DF70-471B-AA93-08E683A1B45
DiagnoseTaskId

string

The ID of the diagnostic task.

diagnoseTask-bp2qhwdp2n9x6zkvq****

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "DiagnoseTaskId": "diagnoseTask-bp2qhwdp2n9x6zkvq****"
}

Error codes

HTTP status code

Error code

Error message

Description
400 Forbidden.RAM Ram user does not have permission to perform this operation. The error message returned because the RAM user does not have the permissions to perform the operation.
400 cardIdNotExist diagnose task iccid not exist
400 CardIPNotBind card ip not bind The card IP is not bound.
400 CardIPAndIccIdNotMatch card ip and iccid not match The card IP does not match the card ID.
400 CardIPNotExist card ip not exist The card IP does not exist.
400 ResourceNotFound.IoTCloudConnector The param of IoTCloudConnectorId is illegal. The error message returned because the value of the IoTCloudConnectorId parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.