API standards and multilingual preset SDKs
The OpenAPI of this product (IoTCC/2021-05-13) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Service activation
|
API |
Title |
Description |
| OpenIoTCloudConnectorService | Activate the cloud connector service | Activate the cloud connector service. |
Regions
|
API |
Title |
Description |
| ListAPNs | Query APN | Query the list of APNs supported by cloud connector instances. |
APN
|
API |
Title |
Description |
| CreateIoTCloudConnector | Create a cloud connector instance | Create a cloud connector instance. |
| UpdateIoTCloudConnectorAttribute | Update Cloud Connector Instance Information | Update the cloud connector instance information. |
| ListIoTCloudConnectors | Query cloud connector instance information | Query cloud connector instance information. |
| ListIoTCloudConnectorAvailableZones | Zones for Attaching vSwitches to IoTCC Instances | Queries the zones where vSwitches can be attached to cloud connector instances. |
| AssociateVSwitchWithIoTCloudConnector | Associate a vSwitch with a cloud connector instance | Associate a vSwitch with a cloud connector instance. |
| DissociateVSwitchFromIoTCloudConnector | Detach vSwitch/VPC | Detach a vSwitch from a cloud connector instance. |
| ListIoTCloudConnectorEIPs | Query the list of Elastic IP Addresses (EIPs) associated with a cloud connector instance | Invoke the ListIoTCloudConnectorEIPs API to query the list of Elastic IP Addresses (EIPs) associated with a cloud connector instance. |
| DeleteIoTCloudConnector | Delete a cloud connector instance | Delete a cloud connector instance. |
Cloud connectors
|
API |
Title |
Description |
| CreateConnectionPool | Create a connection address pool | Create a connection address pool. |
| AddCidrToConnectionPool | Add CIDR Blocks to Connection Pool | Add CIDR blocks to a connection pool. This method is primarily used for dynamic IP scenarios and differs from adding individual card IPs. |
| UpdateConnectionPoolAttribute | Update the connection address pool | Update the connection address pool. |
| ListConnectionPools | Query cloud connection address pools | Query cloud connection address pools. |
| ListConnectionPoolIps | Query the IP address status in the connection address pool | Query the IP address status information in the connection address pool. |
| GetStsInfoAndOssPath | Obtain service account information and submission address | Obtain the Security Token Service (STS) information of the service account and the temporary submission URL for the template file. |
| AssociateIpWithConnectionPool | Bind IP addresses to the connection address pool associated with a cloud connector | Attach an existing IP access control policy. |
| DissociateIpFromConnectionPool | Detach Card IP | Detach the binding relationship between IP addresses and the connection address pool associated with the cloud connector. |
| GetConnectionPoolIpOperationResult | Obtain the Results of IP Address Attach and Detach Operations | Obtain the operation results of binding and detaching IP addresses from an address pool. |
| ListConnectionPoolAllIps | Query all IP addresses in the connection address pool | Query all IP address information in the connection address pool. |
| DeleteConnectionPool | Delete a connection address pool | Delete a connection address pool. |
Connection pools
|
API |
Title |
Description |
| CreateAuthorizationRule | Create an authorization rule | Create an authorization rule. |
| CreateAuthorizationRules | Create Multiple Authorization Rules | You can invoke the CreateAuthorizationRules API to create multiple authorization rules. |
| UpdateAuthorizationRuleAttribute | Update authorization rule information | Update authorization rule information. |
| ListAuthorizationRules | Query authorization rules | Query authorization rule information. |
| DeleteAuthorizationRule | Delete an Authorization Rule | Delete an authorization rule. |
Authorization rules
|
API |
Title |
Description |
| CreateIoTCloudConnectorGroup | Create an Instance Group | Create an instance group. |
| AddIoTCloudConnectorToGroup | Add a cloud connector to a group | Add a cloud connector instance to an instance group. |
| UpdateIoTCloudConnectorGroupAttribute | Modify the properties of a cloud connector group | Modify the properties of a cloud connector group. |
| ListIoTCloudConnectorGroups | Query the list of instance groups | Query the list of instance groups. |
| RemoveIoTCloudConnectorFromGroup | Remove a cloud connector instance from an instance group | Remove a cloud connector instance from an instance group. |
| DeleteIoTCloudConnectorGroup | Delete Instance Group | Delete an instance group. |
Instance groups
|
API |
Title |
Description |
| CreateGroupAuthorizationRule | Create an authorization rule for an instance group | Authorization rule for creating an instance group. |
| UpdateGroupAuthorizationRuleAttribute | Modify the authorization rule of an instance group | You can modify the authorization rules for an instance group. |
| ListGroupAuthorizationRules | Query authorization rules of an instance group | Retrieves the authorization rules for an instance group. |
| DeleteGroupAuthorizationRule | Delete an authorization rule for an instance group | Deletes an authorization rule for an instance group. |
Instance group authorization rules
|
API |
Title |
Description |
| GrantVirtualBorderRouter | Attach authorization to VBR | Grant the service-linked role (SLR) permissions for a virtual border router (VBR). |
VBR authorization
|
API |
Title |
Description |
| CreateDNSServiceRule | Create a DNS Authorization Rule | Create a DNS authorization rule. |
| UpdateDNSServiceRuleAttribute | Modify a DNS authorization rule | Modifies a DNS authorization rule. |
| ListDNSServiceRules | Query DNS authorization rules | List DNS authorization rules. |
| DeleteDNSServiceRule | Delete a DNS authorization rule | Deletes a DNS authorization rule. |
| MoveAuthorizationRuleToDNSService | Transfer an authorization rule to a DNS authorization rule | Moves authorization rules to DNS authorization rules. |
DNS authorization rules
|
API |
Title |
Description |
| CreateGroupDNSServiceRule | Create a DNS Authorization Rule for an Instance Group | Create a DNS authorization rule for an instance group. |
| UpdateGroupDNSServiceRuleAttribute | Modify the DNS authorization rule of an instance group | Modifies the DNS authorization rules for an instance group. |
| ListGroupDNSServiceRules | Query DNS authorization rules of an instance group | Queries DNS authorization rules for an instance group. |
| MoveGroupAuthorizationRuleToDNSService | Transfer Instance Group Rules to DNS Authorization Rules | Move an authorization rule from an instance group to a DNS authorization rule. |
| DeleteGroupDNSServiceRule | Delete the DNS authorization rule of an instance group | Deletes a DNS authorization rule for an instance group. |
Instance group DNS authorization rules
|
API |
Title |
Description |
| EnableIoTCloudConnectorAccessLog | Enable the access log feature | Enables access logging for a cloud connector. |
| DisableIoTCloudConnectorAccessLog | Disable the access log feature | Disables the access log feature. |
| GetIoTCloudConnectorAccessLog | Obtain the access log of a specified cloud connector | Retrieves the access log status for a specified cloud connector. |
Access logs
|
API |
Title |
Description |
| UpdateServiceAttribute | Modify the per-application statistics service | Update an application-based statistics service. |
| ListService | Query application-based statistics services | Queries services for application statistics. |
Per-application statistics service
|
API |
Title |
Description |
| CreateServiceEntry | Add an application entry to the per-application feature list | Add application entries to the service list to enable per-application statistics. |
| UpdateServiceEntryAttribute | Modify an application entry in the per-application statistics list | Updates an application entry in the service list to support application-specific statistics. |
| ListServiceEntries | Query application-specific statistics entries | Query statistics entries for an application. |
| DeleteServiceEntry | Delete an application-specific statistics entry | Delete an application statistics entry. |
Application entries
|
API |
Title |
Description |
| SubmitDiagnoseTaskForSingleCard | Submit a single-card diagnostic task | Submit a diagnostic task for a single IoT card. |
| GetDiagnoseResultForSingleCard | Obtain single-card diagnosis results | Retrieves the diagnostic result for a single card. |
| ListDiagnoseInfoForSingleCard | Query the diagnosis result information for a single card diagnosis | Query the diagnostic results for a single-card diagnosis. |
Network diagnostics
|
API |
Title |
Description |
| CreateIoTCloudConnectorBackhaulRoute | Create a backhaul route after the current cloud connector instance is attached to a VPC | Call the CreateIoTCloudConnectorBackhaulRoute operation to create a backhaul route after binding a cloud connector instance to a VPC. |
| ListIoTCoudConnectorBackhaulRoute | Query the backhaul routes of the current cloud connector instance after it is attached to a VPC | Call the ListIoTCloudConnectorBackhaulRoute operation to query backhaul routes for a cloud connector instance after it is attached to a VPC. |
| DeleteIoTCloudConnetorBackhaulRoute | Delete the backhaul route of the current cloud connector instance after it is attached to a VPC | Call the DeleteIoTCloudConnectorBackhaulRoute operation to delete the backhaul route of a cloud connector instance. |
Return routes
|
API |
Title |
Description |
| CreateIpMappingRule | Create the IP redirection feature for an authorization rule | Call the CreateIpMappingRule operation to enable IP redirection for an authorization rule. |
| UpdateIpMappingRule | Modify information about IP redirection for an authorization rule | Invoke the UpdateIpMappingRule API to modify information about IP redirection for an authorization rule. |
| ListIpMappingRules | Query IP redirection information of authorization rules | Call the ListIpMappingRules API to retrieve IP redirection information for authorization rules. |
| DeleteIpMappingRule | Delete IP Redirection Information of an Authorization Rule | Invoke the DeleteIpMappingRule API to delete the IP redirection information of an authorization rule. |
Authorization rule IP redirection
|
API |
Title |
Description |
| CreateGroupIpMappingRule | Create an IP redirection rule for an instance group authorization rule | Invoke the CreateGroupIpMappingRule API to create an IP redirection rule for an instance group authorization rule. |
| UpdateGroupIpMappingRule | Modify the IP redirection settings of an authorization rule for an instance group | Invoke the UpdateGroupIpMappingRule API to modify the IP redirection settings of an authorization rule for an instance group. |
| ListGroupIpMappingRules | Query IP redirection information of authorization rules for instance groups | Invoke the ListGroupIpMappingRules API to query the IP redirection information of authorization rules for an instance group. |
| DeleteGroupIpMappingRule | Delete IP Redirection Information of an Instance Group Authorization Rule | Invoke the DeleteGroupIpMappingRule API to delete the IP redirection information of an instance group authorization rule. |
Instance group authorization rule IP redirection
|
API |
Title |
Description |
| ConfirmIoTCloudConnector | Confirm or Deny Transfer of a Cloud Connector Instance | Invoke the ConfirmIoTCloudConnector API to confirm or deny the transfer of a cloud connector instance. |
| RevertIoTCloudConnector | Revert a Cloud Connector Instance Whose Transfer Was Denied | Invoke the RevertIoTCloudConnector API to revert a cloud connector instance whose transfer was denied. |
Instance transfer
|
API |
Title |
Description |
| DeleteAuthorizationRules | Batch Delete Authorization Rules | Batch delete authorization rules. |
| CreateService | Create an application-specific statistics service | Creates an application-specific statistics service. |
| DeleteService | Delete the per-application statistics service | Deletes the application-specific statistics service. |
| ListRegions | Query the list of regions supported by cloud connectors | Lists the regions supported by Cloud Connector. |
该文章对您有帮助吗？