# Alibaba Cloud IoT Cloud Connector API > Alibaba Cloud IoT Cloud Connector API on Apizie: 77 endpoints (Add CIDR blocks to a connection pool. This method is primarily used for dynamic IP scenarios and differs…, Add a cloud connector instance to an instance group, Attach an existing IP access control policy, Associate a vSwitch with a cloud connector instance, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-iotcc/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-iotcc` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/iotcc - Page: https://apizie.tech/api/cloud/aliyun-iotcc - OpenAPI: https://apizie.tech/api/cloud/aliyun-iotcc/openapi.json Alibaba Cloud OpenAPI for IoT Cloud Connector (iotcc, version 2021-05-13). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Add CIDR blocks to a connection pool. This method is primarily used for dynamic IP scenarios and differs… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/add-cidr-to-connection-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | ConnectionPoolId | string | yes | The ID of the connection address pool | | Cidrs | string | no | The CIDR blocks to be associated with the connection address pool (JSON-encoded) | | ClientToken | string | no | A client token used to ensure the idempotence of the request. The client generates this parameter value, which must be unique across… | | DryRun | string | no | Specifies whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without adding the CIDR block. The… | | RegionId | string | yes | The region ID where the cloud connector instance resides. You can call the https://help.aliyun.com/document_detail/313836.html API to… | ### Add a cloud connector instance to an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/add-io-tcloud-connector-to-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance. Valid values for N: 1 to 20 (JSON-encoded) | | IoTCloudConnectorGroupId | string | yes | The instance group ID | | ClientToken | string | no | The client token used to ensure the idempotence of the request. This value is generated by the client and must be unique among different… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without adding the cloud connector… | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the region ID | ### Attach an existing IP access control policy `POST https://apizie.tech/v1/cloud:aliyun-iotcc/associate-ip-with-connection-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ClientToken | string | no | Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different… | | DryRun | string | no | Specifies whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without actually binding the IP… | | RegionId | string | yes | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the… | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | ConnectionPoolId | string | yes | The ID of the connection address pool | | Ips | string | no | The list of IP addresses to bind. You can specify up to 500 IP addresses. Separate multiple IP addresses with commas (,) (JSON-encoded) | | IpsFilePath | string | no | The OSS path of the template file, which corresponds to the OssPath parameter returned by the… | ### Associate a vSwitch with a cloud connector instance `POST https://apizie.tech/v1/cloud:aliyun-iotcc/associate-vswitch-with-io-tcloud-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | VpcId | string | yes | The ID of the VPC to associate with the cloud connector instance. If this parameter is specified, VSwitchList must also be specified. If… | | VSwitchList | string | yes | The list of vSwitches in the client's VPC. The zone of each vSwitch must match the zone of the cloud connector instance. N is set to 2,… | | ClientToken | string | no | A client token used to ensure the idempotence of the request. This value is generated by the client and must be unique across different… | | DryRun | string | no | Specifies whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without associating the vSwitches… | | RegionId | string | yes | The region ID where the cloud connector instance is located. You can call the https://help.aliyun.com/document_detail/36063.html API to… | ### Invoke the ConfirmIoTCloudConnector API to confirm or deny the transfer of a cloud connector instance `POST https://apizie.tech/v1/cloud:aliyun-iotcc/confirm-io-tcloud-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | ClientToken | string | no | A client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client to guarantee… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without confirming or denying the… | | RegionId | string | yes | The region ID where the cloud connector instance resides. You can call the https://help.aliyun.com/document_detail/313836.html API to… | | ConfirmStatus | string | yes | The confirmation status. Valid values: Confirm: Confirm. Refuse: Deny | ### Create an authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-authorization-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | DestinationType | string | yes | The type of the access target. Valid values: Cidr: CIDR block. Domain: Domain name | | DestinationPort | string | no | Target port range. Valid values: For TCP and UDP protocols: 1 to 65535. Separate the start port and end port with a forward slash (/).… | | Protocol | string | no | Protocol Type. Valid values: tcp. udp. icmp. all: Supports all protocols | | Destination | string | yes | The access target | | Policy | string | yes | The access policy. Valid values: Permit: Allow. Deny: Deny | | SourceCidrs | string | yes | The source CIDR blocks. A maximum of 20 source CIDR blocks are supported (JSON-encoded) | | AuthorizationRuleName | string | no | Authorization rule name. The name must be 2 to 128 characters in length, and can contain letters (uppercase or lowercase), Chinese… | | AuthorizationRuleDescription | string | no | The description of the authorization rule. The description must be 2 to 256 characters in length. It must start with a letter (uppercase… | | ClientToken | string | no | Client token used to ensure the idempotence of the API Request. Generate a unique value for this parameter from your client to guarantee… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without creating the authorization… | | RegionId | string | yes | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the… | ### You can invoke the CreateAuthorizationRules API to create multiple authorization rules `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-authorization-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | Instance ID of the cloud connector. | | ClientToken | string | no | Client token used to ensure idempotence of the request. Generate a unique value from your client for this parameter to guarantee… | | DryRun | string | no | Indicates whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without creating multiple… | | RegionId | string | yes | Region ID of the instance. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID. | | AuthorizationRules | string | yes | List of authorization rules (JSON-encoded) | ### Create a connection address pool `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-connection-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | Count | integer | no | The number of IP addresses in the connection address pool. Valid values: 1 to 500 | | ConnectionPoolName | string | no | The name of the connection address pool. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_),… | | ConnectionPoolDescription | string | no | The description of the connection address pool. The description must be 2 to 256 characters in length, must start with a letter or a… | | Cidrs | string | no | The Classless Inter-Domain Routing (CIDR) blocks to which the connection address pool belongs. The value range of N is 1 to 20. Multiple… | | ClientToken | string | no | The client token used to ensure the idempotence of the request. This parameter value is generated by the client and must be unique across… | | DryRun | string | no | Specifies whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without creating the connection… | | RegionId | string | no | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the… | ### Create a DNS authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-dnsservice-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | ServiceType | string | yes | The target type of the DNS authorization rule. Valid values: Normal: Normal type. DNSRedirect: Redirection type. This type redirects the… | | Destination | string | no | The DNS service endpoint after redirection. This parameter is required when the ServiceType parameter is set to DNSRedirect | | Source | string | yes | The source DNS IP address. Valid values: 100.100.2.136, 100.100.2.137, 100.100.2.138, 114.114.114.114, 8.8.8.8, 8.8.4.4, 223.5.5.5,… | | DNSServiceRuleName | string | no | The name of the DNS authorization rule. The name must be 2 to 128 characters in length. It must start with an English letter or a Chinese… | | DNSServiceRuleDescription | string | no | The description of the DNS authorization rule. The description must be 2 to 256 characters in length. It must start with an English letter… | | ClientToken | string | no | The client token ensures the idempotence of the request. Generate a parameter value from your client to ensure that the parameter value is… | | DryRun | string | no | Check the request without creating the DNS authorization rule. Valid values: true: Send a check request. The DNS authorization rule is not… | | RegionId | string | yes | The ID of the region where the DNS authorization rule is located. For more information, see… | ### Authorization rule for creating an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-group-authorization-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | ID of the IoT Cloud Connector group | | AuthorizationRuleDescription | string | no | Description of the authorization rule. The description must be 2 to 256 characters in length. It must start with a letter or Chinese… | | AuthorizationRuleName | string | no | Name of the authorization rule. The name must be 2 to 128 characters in length. It must start with a letter or Chinese character. It can… | | SourceCidrs | string | yes | Source CIDR blocks. You can specify up to 20 CIDR blocks (JSON-encoded) | | DestinationType | string | yes | Type of destination. Valid values: Cidr: A CIDR block. Domain: A domain name | | DestinationPort | string | no | Destination port range. Valid values: TCP or UDP: 1 to 65535. Use a forward slash (/) to separate the start and end ports. Example: 1/200.… | | Protocol | string | no | Protocol type. Valid values: tcp. udp. icmp. all: All protocols | | Destination | string | yes | Destination address | | ClientToken | string | no | A client token that ensures the idempotence of the request. Generate a unique value on your client side for each request. The ClientToken… | | DryRun | string | no | Indicates whether to perform a dry run. Valid values: true: Perform a check. No authorization rule is created. The system checks required… | | RegionId | string | yes | ID of the region where the IoT Cloud Connector group resides. You can call the https://help.aliyun.com/document_detail/36063.html… | | Policy | string | yes | Access policy. Valid values: Permit: Allow access. Deny: Deny access | | Type | string | no | Type of authorization rule. Valid values: System: System-defined rule. Customer: Custom rule. Default: Default rule | ### Create a DNS authorization rule for an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-group-dnsservice-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the IoT Cloud Connector instance group | | DNSServiceRuleDescription | string | no | A description of the DNS authorization rule. The description must be 2 to 256 characters in length. It must start with a letter or a… | | DNSServiceRuleName | string | no | The name of the DNS authorization rule. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese… | | Source | string | yes | The source IP address of the DNS authorization rule. Valid values include the following: 100.100.2.136, 100.100.2.137, 100.100.2.138,… | | ServiceType | string | yes | The target type of the DNS authorization rule. Valid values: Normal: The target type is normal DNS. DNSRedirect: The target type is DNS… | | Destination | string | no | The destination IP address of the DNS authorization rule. This parameter is required when ServiceType is set to DNSRedirect | | ClientToken | string | no | A client token that ensures the idempotence of the request. Generate a unique value on your client. The value must contain only ASCII… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a check. No DNS authorization rule is created. The system checks… | | RegionId | string | yes | The region ID of the IoT Cloud Connector instance group. You can call the https://help.aliyun.com/document_detail/313836.html operation to… | ### Invoke the CreateGroupIpMappingRule API to create an IP redirection rule for an instance group authorization… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-group-ip-mapping-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the cloud connector instance group | | IpMappingRuleDescription | string | no | The description of the authorization rule that requires IP redirection for the instance group. The description must be 2 to 256 characters… | | IpMappingRuleName | string | no | The name of the authorization rule that requires IP redirection for the instance group. The name must be 2 to 128 characters in length,… | | DestinationIp | string | yes | The target IP address for redirection | | MappingIp | string | yes | The IP address that requires redirection | | ClientToken | string | no | The client token used to ensure idempotence of the request. Generate a unique value from your client for this parameter to guarantee… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without creating the IP redirection… | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID | ### Create a cloud connector instance `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-io-tcloud-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ISP | string | yes | The carrier of the cloud connector instance. Valid values: telecom: China Telecom. mobile: China Mobile. unicom: China Unicom | | APN | string | yes | The carrier APN ID | | IoTCloudConnectorName | string | no | The name of the cloud connector instance. The name must be 2 to 128 characters in length, start with an uppercase or lowercase letter or a… | | IoTCloudConnectorDescription | string | no | The description of the cloud connector instance. The description must be 2 to 256 characters in length, start with a letter or Chinese… | | WildcardDomainEnabled | string | no | Specifies whether to enable the wildcard domain name feature. true (Default Value): Enabled. false: Shutdown. The wildcard domain name… | | ClientToken | string | no | Client token used to ensure the idempotence of the Request. Generate a parameter value from your client and ensure that this value is… | | DryRun | string | no | Specifies whether to perform only a dry run for this request. Valid values: true: Sends a validation request without creating an instance.… | | RegionId | string | yes | The Region ID of the cloud connector instance. You can obtain the Region ID by invoking the… | | ResourceUid | integer | no | The ID of the cloud connector instance user | | Type | string | no | The version of the cloud connector instance. Different versions have different feature limitations and billing policies. Valid values:… | ### Call the CreateIoTCloudConnectorBackhaulRoute operation to create a backhaul route after binding a cloud… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-io-tcloud-connector-backhaul-route` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | ClientToken | string | no | The client token that ensures the idempotence of the request. Generate a unique value on your client. The value must be unique among… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a check. The backhaul route is not created. The system checks… | | RegionId | string | yes | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/313836.html operation to query… | ### Create an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-io-tcloud-connector-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | Name | string | no | The name of the instance group. The name must be 2 to 128 characters in length, start with a letter (uppercase or lowercase) or a Chinese… | | Description | string | no | The description of the instance group. The description must be 2 to 256 characters in length, start with a letter or Chinese character,… | | ClientToken | string | no | The client token used to ensure the idempotence of the request. Generate a unique value from your client for this parameter to guarantee… | | DryRun | string | no | Specifies whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without creating the instance… | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the region ID | | Type | string | no | The edition of the cloud connector instance. Different editions have different feature limitations and billing policies. Valid values:… | ### Call the CreateIpMappingRule operation to enable IP redirection for an authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-ip-mapping-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | ID of the cloud connector instance | | DestinationIp | string | yes | Target IP address for redirection | | MappingIp | string | yes | IP address to redirect | | IpMappingRuleName | string | no | Name of the authorization rule that enables IP redirection. The name must be 2 to 128 characters in length. It must start with a letter or… | | IpMappingRuleDescription | string | no | Description of the authorization rule that enables IP redirection. The description must be 2 to 256 characters in length. It must start… | | ClientToken | string | no | Client token used to ensure idempotence. Generate a unique value on your client. The value must be unique across different requests. Only… | | DryRun | string | no | Indicates whether to perform only a dry run. true: Performs a check. Does not create the IP redirection rule. Checks include required… | | RegionId | string | yes | ID of the region where the instance resides. You can call the https://help.aliyun.com/document_detail/313836.html operation to query… | ### Creates an application-specific statistics service `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the IoT Cloud Connector instance | | ServiceName | string | no | The name of the application-specific statistics service. The name must be 2 to 128 characters long. It must start with an English letter… | | ServiceDescription | string | no | The description of the application-specific statistics service. The description must be 2 to 256 characters long. It must start with an… | | ClientToken | string | no | The client token. Use it to ensure request idempotence. The client generates this parameter value. Ensure it is unique across different… | | DryRun | string | no | Check if this request is a dry run. Valid values: true: Send a check request. This does not create the service. The check includes… | | RegionId | string | yes | The region ID where the application-specific statistics service is located. For more information, see [ListRegions]() | ### Add application entries to the service list to enable per-application statistics `POST https://apizie.tech/v1/cloud:aliyun-iotcc/create-service-entry` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ServiceId | string | yes | The ID of the service for application-specific statistics. This ID is globally unique | | IoTCloudConnectorId | string | yes | The ID of the IoT Cloud Connector instance | | Target | string | yes | The destination address of the application entry | | TargetType | string | yes | The type of the destination address for the application entry. Valid values: Cidr: A CIDR block. Domain: A domain name | | ServiceEntryName | string | no | The name of the application entry. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It… | | ServiceEntryDescription | string | no | The description of the application entry. The description must be 2 to 256 characters in length and must start with a letter or a Chinese… | | ClientToken | string | no | A client token used to ensure the idempotence of the request. This token is generated by the client and must be unique for each request.… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request without adding the application entry. The system checks… | | RegionId | string | yes | The ID of the region where the application entry is located. You can call the https://help.aliyun.com/document_detail/313836.html… | ### Delete an authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-authorization-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | AuthorizationRuleId | string | yes | The ID of the authorization rule | | ClientToken | string | no | The client token used to ensure the idempotence of the request. You must generate this parameter value on the client side and ensure that… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without deleting the authorization… | | RegionId | string | yes | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the… | ### Batch delete authorization rules `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-authorization-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | Cloud connector instance ID | | AuthorizationRuleIds | string | yes | List of authorization rule IDs. You can specify up to 200 authorization rule IDs (JSON-encoded) | | ClientToken | string | no | Ensures idempotence of the request. Generate a unique value for this parameter from your client to guarantee uniqueness across different… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without updating the authorization… | | RegionId | string | yes | Region ID. Default value: cn-hangzhou | ### Delete a connection address pool `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-connection-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | ConnectionPoolId | string | yes | The ID of the connection address pool | | ClientToken | string | no | Ensures idempotence of the request. Generate a unique value for this parameter from your client to guarantee uniqueness across different… | | DryRun | string | no | Specifies whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without deleting the connection… | | RegionId | string | yes | The region ID of the cloud connector instance. Only cn-hangzhou is supported | ### Deletes a DNS authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-dnsservice-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | DNSServiceRuleId | string | yes | The ID of the DNS authorization rule | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The client generates this value. Make sure that the value is… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request without deleting the DNS authorization rule. The system… | | RegionId | string | yes | The region ID of the DNS authorization rule. Currently, cloud connector is available in the following regions: China (Hangzhou), China… | ### Deletes an authorization rule for an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-group-authorization-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the instance group | | AuthorizationRuleId | string | yes | The ID of the authorization rule | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate the value from your client. The value must be unique for… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request. The authorization rule is not deleted. The check… | | RegionId | string | yes | The region ID of the instance group. Call https://help.aliyun.com/document_detail/36063.html to get the region ID | ### Deletes a DNS authorization rule for an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-group-dnsservice-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the cloud connector instance group | | DNSServiceRuleId | string | yes | The ID of the DNS authorization rule | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Make sure that the client token is unique among different… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run to check the request for validity. The system checks the… | | RegionId | string | yes | The region ID of the cloud connector instance group. Currently, cloud connector is available in the following regions: China (Hangzhou),… | ### Invoke the DeleteGroupIpMappingRule API to delete the IP redirection information of an instance group… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-group-ip-mapping-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the cloud connector instance group. | | GroupIpMappingRuleId | string | yes | The ID of the instance group IP redirection authorization rule to be deleted. | | ClientToken | string | no | The client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client to guarantee… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without deleting the IP redirection… | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID. | ### Delete a cloud connector instance `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-io-tcloud-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | ClientToken | string | no | Ensures the idempotence of the request. Generate a unique value for this parameter from your client to guarantee uniqueness across… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without deleting the instance. The… | | RegionId | string | yes | The region ID of the cloud connector instance. Valid value: cn-hangzhou only | ### Delete an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-io-tcloud-connector-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the instance group to delete | | ClientToken | string | no | The client token used to ensure the idempotence of the request. This parameter value is generated by the client and must be unique across… | | DryRun | string | no | Specifies whether to only perform a dry run for this request. Valid values: true: Sends a dry run request without deleting the instance… | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the region ID | ### Call the DeleteIoTCloudConnectorBackhaulRoute operation to delete the backhaul route of a cloud connector… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-io-tcloud-connetor-backhaul-route` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | ClientToken | string | no | A client token to ensure the idempotence of the request. Generate a unique value from your client for this parameter. ClientToken must… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the request for potential issues,… | | RegionId | string | yes | The ID of the region where the cloud connector instance is deployed. Call the https://help.aliyun.com/document_detail/313836.html… | ### Invoke the DeleteIpMappingRule API to delete the IP redirection information of an authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-ip-mapping-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | IpMappingRuleId | string | yes | The ID of the authorization rule whose IP redirection information you want to delete | | ClientToken | string | no | The client token that ensures the idempotence of the request. Generate a unique value for this parameter from your client to ensure… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without deleting the IP redirection… | | RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID | ### Deletes the application-specific statistics service `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ServiceId | string | yes | The system-generated ID for the application-specific statistics service. This ID is unique across the network | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | ClientToken | string | no | The client token. This token ensures request idempotence. Generate this value on the client side. Ensure it is unique across different… | | DryRun | string | no | Whether to only dry run this request. Valid values: true: Sends a check request. This does not delete the service. The check includes… | | RegionId | string | yes | The region ID where the application-specific statistics service is located. Obtain the region ID by calling the… | ### Delete an application statistics entry `POST https://apizie.tech/v1/cloud:aliyun-iotcc/delete-service-entry` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ServiceId | string | yes | The globally unique ID that the system generates for the application statistics service | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | ServiceEntryId | string | yes | The ID of the application entry | | ClientToken | string | no | A client token that ensures idempotence. Generate a unique value on the client side. The value must be unique across requests and contain… | | DryRun | string | no | Specify whether to perform a dry run. true: Run a check only. The system does not delete the application entry. The check includes… | | RegionId | string | yes | The region ID where the application entry resides. You can call the https://help.aliyun.com/document_detail/313836.html operation to query… | ### Disables the access log feature `POST https://apizie.tech/v1/cloud:aliyun-iotcc/disable-io-tcloud-connector-access-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The client generates this parameter value. Make sure that the… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request but does not disable the access log feature. The system… | | RegionId | string | yes | The ID of the region where the cloud connector instance is deployed. You can call the https://help.aliyun.com/document_detail/313836.html… | ### Detach the binding relationship between IP addresses and the connection address pool associated with the… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/dissociate-ip-from-connection-pool` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ClientToken | string | no | Ensures the idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without detaching the binding… | | RegionId | string | yes | Region ID of the cloud connector instance. Only cn-hangzhou is supported | | IoTCloudConnectorId | string | yes | Cloud connector instance ID | | ConnectionPoolId | string | yes | Connection address pool ID | | Ips | string | no | List of IP addresses to be detached. Up to 500 IP addresses can be specified. Separate multiple IP addresses with commas (,) (JSON-encoded) | | IpsFilePath | string | no | OSS path of the template file, which corresponds to the OssPath parameter returned by the… | ### Detach a vSwitch from a cloud connector instance `POST https://apizie.tech/v1/cloud:aliyun-iotcc/dissociate-vswitch-from-io-tcloud-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | ClientToken | string | no | Ensures idempotence of the request. Generate a unique value for this parameter from your client to guarantee uniqueness across different… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without detaching the vSwitch from the… | | RegionId | string | yes | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the… | ### Enables access logging for a cloud connector `POST https://apizie.tech/v1/cloud:aliyun-iotcc/enable-io-tcloud-connector-access-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | AccessLogSlsProject | string | yes | The Log Service project that receives access logs | | AccessLogSlsLogStore | string | yes | The Logstore that receives access logs | | ClientToken | string | no | A client token that ensures the idempotence of the request. Generate a unique value on the client side. The value must be unique across… | | DryRun | string | no | Specifies whether to perform only a dry run. true: Performs a check. Does not enable access logging. Checks include required parameters,… | | RegionId | string | yes | The ID of the region where the cloud connector instance resides. You can call the https://help.aliyun.com/document_detail/313836.html… | ### Obtain the operation results of binding and detaching IP addresses from an address pool `POST https://apizie.tech/v1/cloud:aliyun-iotcc/get-connection-pool-ip-operation-result` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | RegionId | string | yes | The region ID where the cloud connector instance resides. You can obtain the region ID by invoking the… | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | ConnectionPoolId | string | yes | The connection address pool ID | | QueryRequestId | string | yes | The request ID used for the query. This is the RequestId returned after successfully invoking the… | ### Retrieves the diagnostic result for a single card `POST https://apizie.tech/v1/cloud:aliyun-iotcc/get-diagnose-result-for-single-card` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | DiagnoseTaskId | string | yes | The ID of the network diagnostic task | | RegionId | string | no | The region ID of the Cloud Connector instance. For more information, see https://help.aliyun.com/document_detail/313836.html | ### Retrieves the access log status for a specified cloud connector `POST https://apizie.tech/v1/cloud:aliyun-iotcc/get-io-tcloud-connector-access-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | ClientToken | string | no | A client token that ensures the idempotence of the request. Generate this value on the client side. It must be unique across requests and… | | DryRun | string | no | Specify whether to perform only a dry run of this request. Valid values: true: Submit a dry-run request. The system does not return access… | | RegionId | string | yes | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/313836.html operation to query… | ### Obtain the Security Token Service (STS) information of the service account and the temporary submission URL… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/get-sts-info-and-oss-path` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ClientToken | string | no | Ensures request idempotence. You can generate a parameter value from your client to guarantee that this value is unique across different… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without retrieving information. The… | | RegionId | string | yes | The region ID of the cloud connector instance. Valid value: cn-hangzhou only | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | ConnectionPoolId | string | yes | ID of the address pool | | FileName | string | no | Template file name. The template file supports only the CSV format | ### Grant the service-linked role (SLR) permissions for a virtual border router (VBR) `POST https://apizie.tech/v1/cloud:aliyun-iotcc/grant-virtual-border-router` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | VirtualBorderRouterId | string | no | The ID of the virtual border router (VBR) instance | | RegionId | string | no | The ID of the region where the VBR instance resides. You can call the https://help.aliyun.com/document_detail/36063.html operation to… | ### Query the list of APNs supported by cloud connector instances. `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-apns` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | NextToken | string | no | Indicates whether a token for the next query exists. Valid values: Do not specify this parameter for the first query or when there is no… | | MaxResults | integer | no | The number of entries to return per page when performing a paginated query. Valid values: 1 to 50. Default Value: 10. | | RegionId | string | yes | The region ID of the cloud connector instance. You can obtain the region ID by invoking the… | | APN | string | no | The carrier APN ID. | | ISP | string | no | The carrier corresponding to the APN. Valid values: telecom: China Telecom. mobile: China Mobile. unicom: China Unicom. | | Type | string | no | The edition of the cloud connector instance. Different editions have different feature limitations and billing policies. Valid values:… | ### Query authorization rule information `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-authorization-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector. | | AuthorizationRuleIds | string | no | A list of authorization rule IDs. You can specify up to 20 authorization rule IDs. (JSON-encoded) | | DestinationType | string | no | The type of access target. You can specify up to 20 access target types. Valid values: Cidr: CIDR block. Domain: Domain name (JSON-encoded) | | Protocol | string | no | The protocol type. You can specify up to 20 protocol types. Valid values: tcp udp icmp all: Supports all protocols (JSON-encoded) | | DestinationPort | string | no | The destination port range. You can specify up to 20 port ranges. Valid values: For TCP and UDP protocols: 1 to 65535. Separate the start… | | Destination | string | no | Access target (JSON-encoded) | | AuthorizationRuleStatus | string | no | The status of the authorization rule. You can specify up to 20 authorization rule statuses. Valid values: Creating: Creation in progress.… | | AuthorizationRuleName | string | no | Authorization rule name. You can specify up to 20 authorization rule names. The name must be 2 to 128 characters in length, and can… | | Policy | string | no | Access policy. You can specify up to 20 access policies. Permit: Allow. Deny: Deny (JSON-encoded) | | NextToken | string | no | Indicates whether a token for the next query exists. Valid values: Do not specify this parameter for the first query or when there is no… | | MaxResults | integer | no | The paging size. Valid values: 1 to 50. If you leave this parameter empty, the default value is 10 | | RegionId | string | yes | The region ID where the cloud connector instance resides. You can obtain the region ID by invoking the… | | AuthorizationRuleType | string | no | The type of the authorization rule. Valid values: System: Indicates a system-defined authorization rule. Customer: Indicates a custom… | | FuzzyDestination | string | no | The fuzzy access target. | | FuzzyAuthorizationRuleName | string | no | The fuzzy authorization rule name | ### Query all IP address information in the connection address pool `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-connection-pool-all-ips` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | NextToken | string | no | Indicates whether a token for the next query exists. Valid values: Do not specify this parameter for the first query or when there is no… | | MaxResults | integer | no | The number of entries to return per page during a paginated query. Valid values: 1 to 50. Default Value: 10 | | RegionId | string | yes | The Region ID of the cloud connector instance. You can invoke the https://help.aliyun.com/document_detail/36063.html API to obtain the… | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | ConnectionPoolId | string | yes | The ID of the connection address pool to query | | Ip | string | no | The IP address in the connection address pool | | Type | string | no | The type of IP address in the connection address pool. Valid values: Cidr: The CIDR block to which the connection address pool belongs.… | ### Query the IP address status information in the connection address pool `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-connection-pool-ips` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | NextToken | string | no | A token used to mark the starting position for the current read operation. An empty value indicates reading from the beginning. Do not… | | MaxResults | integer | no | Paging size. Valid values: 1 to 2000. If left empty, the default value is 10 | | RegionId | string | yes | The Region ID where the cloud connector instance is located. Valid value: cn-hangzhou only | | IoTCloudConnectorId | string | no | The instance ID of the cloud connector | | ConnectionPoolId | string | no | The ID of the connection address pool | | Ip | string | no | IP address in the connection address pool | ### Query cloud connection address pools `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-connection-pools` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | ConnectionPoolIds | string | no | A list of connection address pool IDs. You can specify up to 20 connection address pool IDs (JSON-encoded) | | ConnectionPoolName | string | no | The name of the connection address pool. You can specify up to 20 connection address pool names. The name must be 2 to 128 characters in… | | ConnectionPoolStatus | string | no | The status of the connection address pool. You can specify up to 20 connection address pool statuses. Creating: Creation in progress.… | | NextToken | string | no | A token used to mark the starting position for the current read operation. An empty value indicates reading from the beginning. You do not… | | MaxResults | integer | no | The maximum number of data records to read in this request. Valid values: 1 to 50. If this parameter is left empty, the default value is 10 | | RegionId | string | yes | The region ID of the cloud connector instance. Valid value: cn-hangzhou only | ### List DNS authorization rules `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-dnsservice-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | ID of the cloud connector instance | | DNSServiceRuleIds | string | no | IDs of DNS authorization rules (JSON-encoded) | | ServiceType | string | no | Type of the DNS authorization rule. Valid values: Normal: normal type. DNSRedirect: redirection type. This type redirects the current DNS… | | Destination | string | no | IP addresses of destination DNS authorization rules (JSON-encoded) | | DNSServiceRuleStatus | string | no | Status of the DNS authorization rule (JSON-encoded) | | DNSServiceRuleName | string | no | Names of DNS authorization rules. You can specify up to 20 rule names (JSON-encoded) | | Source | string | no | IP addresses of source DNS authorization rules (JSON-encoded) | | NextToken | string | no | Token for the next query. Valid values: Omit this parameter for the first query or if no more results are available. For subsequent… | | MaxResults | integer | no | Maximum number of entries to return per page. Valid values: 1 to 50. Default value: 10 | | RegionId | string | yes | ID of the region where the cloud connector instance resides. You can call the https://help.aliyun.com/document_detail/313836.html… | ### Query the diagnostic results for a single-card diagnosis `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-diagnose-info-for-single-card` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | RegionId | string | no | The region ID of the cloud connector instance used for network diagnostics. You can call the… | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance used for network diagnostics | | SourceType | string | no | The source type for network diagnostics. Valid values: CardIP: Use the IoT card's IP address for diagnostics. CardID: Use the IoT card's… | | Source | string | no | The IoT card's IP address or ID used as the source for network diagnostics | | NextToken | string | no | A token that indicates whether more results are available. Valid values: Omit this parameter for the first request or when no more results… | | MaxResults | integer | no | The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 20 | ### Retrieves the authorization rules for an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-group-authorization-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | ID of the IoT Cloud Connector group | | AuthorizationRuleIds | string | no | IDs of authorization rules. You can specify up to 20 rule IDs (JSON-encoded) | | DestinationType | string | no | Type of destination. You can specify up to 20 destination types. Valid values: Cidr: CIDR block. Domain: Domain name (JSON-encoded) | | Destination | string | no | Destination address. You can specify up to 20 destination addresses (JSON-encoded) | | Protocol | string | no | Protocol type. Valid values: tcp. udp. icmp. all: All protocols (JSON-encoded) | | DestinationPort | string | no | Destination port range. You can specify up to 20 destination ports. Valid values: TCP and UDP: 1 to 65535. Use a forward slash (/) to… | | AuthorizationRuleStatus | string | no | Status of the authorization rule. You can specify up to 20 rule statuses. Valid values: Creating: Creating. Created: Created. Deleting:… | | AuthorizationRuleName | string | no | Name of the authorization rule. You can specify up to 20 rule names. The name must be 2 to 128 characters in length. It must start with a… | | Policy | string | no | Access policy. You can specify up to 20 policies. Valid values: Permit: Allow. Deny: Deny (JSON-encoded) | | NextToken | string | no | Token for the next query. Valid values: Leave this parameter empty for the first query or when no more results are available. If more… | | MaxResults | integer | no | Maximum number of entries to return per page. Valid values: 1 to 50. Default value: 10 | | RegionId | string | yes | ID of the region where the IoT Cloud Connector group resides. You can call the https://help.aliyun.com/document_detail/36063.html… | | Type | string | no | Type of the authorization rule. Valid values: System: System-defined rule. Customer: Custom rule. Default: Default rule | ### Queries DNS authorization rules for an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-group-dnsservice-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the Cloud Connector instance group | | DNSServiceRuleIds | string | no | The ID of the DNS authorization rule (JSON-encoded) | | ServiceType | string | no | The target type of the DNS authorization rule. Valid values: Normal: The target type is a standard DNS type. DNSRedirect: The target type… | | Destination | string | no | The destination IP addresses of the DNS authorization rule (JSON-encoded) | | Source | string | no | The source IP addresses of the DNS authorization rule (JSON-encoded) | | DNSServiceRuleStatus | string | no | The status of the DNS authorization rule (JSON-encoded) | | DNSServiceRuleName | string | no | The names of DNS authorization rules. You can specify up to 20 rule names (JSON-encoded) | | NextToken | string | no | The token used to retrieve the next page of results. Valid values: Leave this parameter empty for the first query or if no further queries… | | MaxResults | integer | no | The number of entries to return on each page. Valid values: 1–50. Default value: 10 | | RegionId | string | yes | The region ID of the Cloud Connector instance group. You can call the https://help.aliyun.com/document_detail/313836.html operation to… | ### Invoke the ListGroupIpMappingRules API to query the IP redirection information of authorization rules for an… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-group-ip-mapping-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the cloud connector instance group | | IpMappingRuleIds | string | no | The IDs of authorization rules that require IP redirection. You can specify up to 20 rule IDs (JSON-encoded) | | DestinationIps | string | no | The target IP addresses for redirection. A maximum of 20 IP addresses is supported (JSON-encoded) | | IpMappingRuleStatuses | string | no | The status of IP redirection for authorization rules. You can specify up to 20 statuses (JSON-encoded) | | IpMappingRuleNames | string | no | The names of authorization rules that require IP redirection. A maximum of 20 authorization rule names is supported (JSON-encoded) | | NextToken | string | no | Indicates whether a token for the next query exists. Valid values: If NextToken is empty, there is no subsequent query. If NextToken has a… | | MaxResults | integer | no | The number of entries returned per page when queries are performed in batches. Valid values: 1 to 100. Default value: 20 | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID | | MappingIps | string | no | The IP addresses that require redirection. You can specify up to 20 IP addresses (JSON-encoded) | ### Queries the zones where vSwitches can be attached to cloud connector instances `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-io-tcloud-connector-available-zones` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | RegionId | string | yes | The region ID of the cloud connector instance. Valid value: cn-hangzhou only | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | ### Invoke the ListIoTCloudConnectorEIPs API to query the list of Elastic IP Addresses (EIPs) associated with a… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-io-tcloud-connector-eips` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | NextToken | string | no | Indicates whether a token for the next query exists. Valid values: Do not specify this parameter for the first query or when there is no… | | MaxResults | integer | no | The number of entries returned per page when querying results in batches. Valid values: 1 to 100. Default value: 20 | | RegionId | string | yes | The region ID of the cloud connector instance. You can obtain the region ID by invoking the… | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | ### Query the list of instance groups `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-io-tcloud-connector-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupStatus | string | no | The status of the instance groups. A maximum of 20 instance group statuses are supported. Valid values: Creating: Creation in progress.… | | IoTCloudConnectorGroupIds | string | no | The list of instance group IDs. A maximum of 20 instance group IDs are supported (JSON-encoded) | | IoTCloudConnectorGroupName | string | no | The name of the instance group. A maximum of 20 instance group names are supported (JSON-encoded) | | NextToken | string | no | Indicates whether a token for the next query exists. Valid values: Do not specify this parameter for the first query or when there is no… | | MaxResults | integer | no | The number of entries to return per page when using batch queries. Valid values: 1 to 50. Default value: 10 | | RegionId | string | yes | The region ID where the instance groups are located. You can obtain the region ID by invoking the… | | Type | string | no | The edition of the cloud connector instance. Different editions have different feature limitations and billing policies. Valid values:… | ### Query cloud connector instance information `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-io-tcloud-connectors` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorStatus | string | no | The status of the cloud connector instance. You can specify up to 20 instance statuses. Valid values: Creating: Creation in progress.… | | IoTCloudConnectorIds | string | no | A list of cloud connector instance IDs (JSON-encoded) | | IoTCloudConnectorName | string | no | The name of the cloud connector instance. You can specify up to 20 instance names. The name must be 2 to 128 characters in length and can… | | ISP | string | no | The carrier of the cloud connector instance. You can specify up to 20 carriers. Valid values: telecom: China Telecom. mobile: China… | | VpcId | string | no | The ID of the VPC connected to the cloud connector instance (JSON-encoded) | | APN | string | no | The ID of the carrier APN. (JSON-encoded) | | NextToken | string | no | Indicates whether a token for the next query exists. Valid values: Do not specify this parameter for the first query or when there is no… | | MaxResults | integer | no | The number of entries to return per page when querying results in batches. Valid values: 1 to 50. Default Value: 10. | | RegionId | string | yes | The region ID of the cloud connector instance. You can invoke the https://help.aliyun.com/document_detail/313836.html API to obtain the… | | IsInGroup | string | no | Specifies whether to query instances in an instance group. Valid values: true: Query instances in an instance group. false (default): Do… | | IoTCloudConnectorGroupId | string | no | The group ID of the cloud connector instance. | ### Call the ListIoTCloudConnectorBackhaulRoute operation to query backhaul routes for a cloud connector… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-io-tcoud-connector-backhaul-route` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | NextToken | string | no | The token to retrieve the next page of results. For the first query, leave this parameter empty. For subsequent queries, set this… | | MaxResults | integer | no | The number of entries to return on each page. Valid values: 1 to 100. Default value: 20 | | RegionId | string | yes | The region ID of the cloud connector instance. Call the https://help.aliyun.com/document_detail/313836.html operation to obtain the region… | ### Call the ListIpMappingRules API to retrieve IP redirection information for authorization rules `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-ip-mapping-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | ID of the cloud connector instance | | IpMappingRuleIds | string | no | IDs of authorization rules that require IP redirection (JSON-encoded) | | MappingIps | string | no | IP addresses that require redirection (JSON-encoded) | | IpMappingRuleStatuses | string | no | Status of IP redirection for authorization rules. You can specify up to 20 statuses. Valid values: Creating: The rule is being created.… | | IpMappingRuleNames | string | no | Names of authorization rules that require IP redirection (JSON-encoded) | | DestinationIps | string | no | Target IP addresses for redirection (JSON-encoded) | | NextToken | string | no | Token for the next query. Valid values: Omit this parameter for the first query or when no more results are available. For subsequent… | | MaxResults | integer | no | The number of entries to display per page when you query in batches. Valid values are 1 to 100. The default value is 20 | | RegionId | string | yes | ID of the region where the instance resides. You can call the https://help.aliyun.com/document_detail/313836.html API to query region IDs | ### Lists the regions supported by Cloud Connector `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-regions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | AcceptLanguage | string | no | Supported language. Valid values: zh-CN: Chinese. en-US: English. ja: Japanese | | RegionId | string | yes | The region ID of the Cloud Connector instance | ### Queries services for application statistics `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | Cloud connector instance ID | | ServiceIds | string | no | List of application statistics service IDs (JSON-encoded) | | ServiceNames | string | no | A list of service names, grouped by application (JSON-encoded) | | ResourceStatuses | string | no | List the statuses of service resources by application (JSON-encoded) | | NextToken | string | no | Whether a token exists for the next query. Values: Do not enter a value for the first query or if no next query exists. If a next query… | | MaxResults | integer | no | The number of entries displayed per paged query. Value range: 1 to 100. Default value: 20 | | RegionId | string | yes | The region ID where the application statistics service is located. Call the https://help.aliyun.com/document_detail/313836.html API to get… | ### Query statistics entries for an application `POST https://apizie.tech/v1/cloud:aliyun-iotcc/list-service-entries` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ServiceId | string | yes | The globally unique ID that the system assigns to the application-based statistics service | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | Target | string | no | The destination address of the service entry (JSON-encoded) | | TargetType | string | no | The type of the destination address of the service entry (JSON-encoded) | | ServiceEntryStatus | string | no | The status of the service entry (JSON-encoded) | | ServiceEntryName | string | no | The name of the service entry (JSON-encoded) | | NextToken | string | no | The token used for the next query. Valid values: Leave this parameter empty for the first query or when no more results are available. If… | | MaxResults | integer | no | The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 20 | | RegionId | string | yes | The region ID where the service entries reside. You can call the https://help.aliyun.com/document_detail/313836.html operation to query… | | ServiceEntryIds | string | no | Application entry ID (JSON-encoded) | ### Moves authorization rules to DNS authorization rules `POST https://apizie.tech/v1/cloud:aliyun-iotcc/move-authorization-rule-to-dnsservice` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | AuthorizationRuleId | string | yes | The authorization rule ID | | ClientToken | string | no | The client token, used to ensure request idempotence. The client generates this value. Ensure it is unique across different requests. The… | | DryRun | string | no | Specifies whether to perform a dry run for this request. Valid values: true: Sends a check request without moving the authorization rule.… | | RegionId | string | yes | The region ID where the cloud connector instance resides. Regions that support cloud connectors include China (Hangzhou), China… | ### Move an authorization rule from an instance group to a DNS authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/move-group-authorization-rule-to-dnsservice` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the cloud connector instance group | | AuthorizationRuleId | string | yes | The ID of the authorization rule | | ClientToken | string | no | A client token that ensures the idempotence of the request. Generate a unique value on the client side. The value must be unique across… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a check. The authorization rule is not moved. The check includes… | | RegionId | string | yes | The ID of the region where the cloud connector instance group resides. Cloud Connector is available in these regions: China East 1… | ### Activate the cloud connector service `POST https://apizie.tech/v1/cloud:aliyun-iotcc/open-io-tcloud-connector-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | RegionId | string | yes | The Region ID of the cloud connector instance. You can invoke the https://help.aliyun.com/document_detail/313836.html API to obtain the… | ### Remove a cloud connector instance from an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/remove-io-tcloud-connector-from-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance. Valid values for N: 1 to 20 (JSON-encoded) | | IoTCloudConnectorGroupId | string | yes | The ID of the instance group | | ClientToken | string | no | The client token used to ensure the idempotence of the request. The client generates this parameter value, which must be unique across… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without removing the cloud connector… | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the region ID | ### Invoke the RevertIoTCloudConnector API to revert a cloud connector instance whose transfer was denied `POST https://apizie.tech/v1/cloud:aliyun-iotcc/revert-io-tcloud-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | Cloud connector instance ID | | ClientToken | string | no | Client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client to guarantee… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without reverting the cloud connector… | | RegionId | string | yes | Region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID | ### Submit a diagnostic task for a single IoT card `POST https://apizie.tech/v1/cloud:aliyun-iotcc/submit-diagnose-task-for-single-card` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance that runs the diagnostic task for a single IoT card | | 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… | | Source | string | yes | The source IP address or ID of the IoT card | | 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… | | Destination | string | no | The destination IP address or domain name | | BeginTime | integer | yes | The start timestamp of the diagnostic task, in seconds | | EndTime | integer | yes | The end timestamp of the diagnostic task, in seconds | | RegionId | string | yes | The region ID where the diagnostic task runs. You can call the https://help.aliyun.com/document_detail/313836.html operation to query… | | ResourceUid | integer | no | The Alibaba Cloud account ID of the cloud connector instance owner | ### Update authorization rule information `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-authorization-rule-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | AuthorizationRuleId | string | yes | The authorization rule ID | | DestinationType | string | no | The type of the access target. Cidr: CIDR block. Domain: Domain name | | DestinationPort | string | no | The destination port range. Valid values: For TCP and UDP protocols: 1 to 65535. Separate the start and end ports with a forward slash… | | Protocol | string | no | Protocol Type. Valid values: tcp. udp. icmp. all: Supports all protocols | | Destination | string | no | The access target | | Policy | string | no | The access policy. Permit: Allow. Deny: Deny | | SourceCidrs | string | no | The source CIDR blocks. You can specify up to 20 source CIDR blocks (JSON-encoded) | | AuthorizationRuleName | string | no | Authorization rule Name. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens… | | AuthorizationRuleDescription | string | no | The description of the authorization rule. The description must be 2 to 256 characters in length, and must start with a letter (uppercase… | | ClientToken | string | no | Client token used to ensure the idempotence of the API Request. Generate a unique value for this parameter from your client to guarantee… | | DryRun | string | no | Specifies whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without updating the authorization… | | RegionId | string | yes | The region ID of the cloud connector instance. You can obtain the region ID by invoking the… | ### Update the connection address pool `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-connection-pool-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | ConnectionPoolId | string | yes | The ID of the connection address pool | | Count | integer | no | The number of Internet of Things SIM cards | | ConnectionPoolName | string | no | The name of the connection address pool. The name must be 2 to 128 characters in length, and start with a letter or a Chinese character.… | | ConnectionPoolDescription | string | no | The description of the connection address pool. The description must be 2 to 256 characters in length, and start with a letter or a… | | Cidrs | string | no | The Classless Inter-Domain Routing (CIDR) blocks associated with the connection address pool. The value range of N is 1 to 20. Multiple… | | ClientToken | string | no | The client token used to ensure the idempotence of the request. This value is generated by the client and must be unique across different… | | DryRun | string | no | Specifies whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without updating the connection… | | RegionId | string | yes | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the… | ### Modifies a DNS authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-dnsservice-rule-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | DNSServiceRuleId | string | yes | The DNS authorization rule ID | | ServiceType | string | no | The destination type for the DNS authorization rule. Valid values: Normal: a standard rule. DNSRedirect: a redirection rule. This type… | | Destination | string | no | The DNS service endpoint after redirection. This parameter is required when ServiceType is set to DNSRedirect | | Source | string | no | The source DNS IP address. Examples include but are not limited to: 100.100.2.136, 100.100.2.137, 100.100.2.138, 114.114.114.114, 8.8.8.8,… | | DNSServiceRuleName | string | no | The name of the DNS authorization rule. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character… | | DNSServiceRuleDescription | string | no | The description of the DNS authorization rule. The description must be 2 to 256 characters in length. It must start with a letter or a… | | ClientToken | string | no | A client token that is used to ensure the idempotence of the request. Generate a unique value from your client to ensure that the same… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: sends a check request without modifying the DNS authorization rule. The system… | | RegionId | string | yes | The region ID of the DNS authorization rule. Call the https://help.aliyun.com/document_detail/313836.html operation to obtain the region ID | ### You can modify the authorization rules for an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-group-authorization-rule-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the IoT Cloud Connector group | | AuthorizationRuleDescription | string | no | A description of the authorization rule. The description must be 2 to 256 characters in length. It must start with a letter or a Chinese… | | AuthorizationRuleName | string | no | The name of the authorization rule. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character. It… | | AuthorizationRuleId | string | yes | The ID of the authorization rule to update | | SourceCidrs | string | no | The source CIDR blocks. Valid values of N: 1 to 20 (JSON-encoded) | | DestinationType | string | no | The type of destination. Valid values: Cidr: A CIDR block. Domain: A domain name | | DestinationPort | string | no | The destination port range. Valid values: TCP or UDP: 1 to 65535. Use a forward slash (/) to separate the start port from the end port.… | | Protocol | string | no | The protocol type. Valid values: tcp. udp. icmp. all: All protocols | | Destination | string | no | The destination to access | | Policy | string | no | The access policy. Valid values: Permit: Allow access. Deny: Deny access | | ClientToken | string | no | A client token that ensures the idempotence of the request. You must generate a unique value for this parameter. The value can be up to 64… | | DryRun | string | no | Specifies whether to perform only a dry run. Valid values: true: Perform a check. The authorization rule is not updated. The system checks… | | RegionId | string | yes | The region ID of the IoT Cloud Connector group. You can call the https://help.aliyun.com/document_detail/36063.html operation to query the… | ### Modifies the DNS authorization rules for an instance group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-group-dnsservice-rule-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the cloud connector instance group | | DNSServiceRuleDescription | string | no | The description of the DNS authorization rule. The length is 2 to 256 characters. It must start with an uppercase or lowercase English… | | DNSServiceRuleName | string | no | The name of the DNS authorization rule. The length is 2 to 128 English or Chinese characters. It must start with an uppercase or lowercase… | | DNSServiceRuleId | string | yes | The ID of the DNS authorization rule | | Source | string | no | The source IP address of the DNS authorization rule. This includes, but is not limited to, the following values: 100.100.2.136,… | | ServiceType | string | no | The target type of the DNS authorization rule. Valid values: Normal: The target type is a normal DNS type. DNSRedirect: The target type is… | | Destination | string | no | The destination IP address of the DNS authorization rule. If the ServiceType parameter is set to DNSRedirect, this parameter is required | | ClientToken | string | no | A client token used to ensure the idempotence of the request. Generate a parameter value from your client. Ensure this value is unique… | | DryRun | string | no | Checks whether this request would succeed. Valid values: true: Send a check request. This does not modify the DNS authorization rule. The… | | RegionId | string | yes | The region ID where the cloud connector instance group resides. Call the https://help.aliyun.com/document_detail/313836.html interface to… | ### Invoke the UpdateGroupIpMappingRule API to modify the IP redirection settings of an authorization rule for… `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-group-ip-mapping-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the cloud connector instance group. | | IpMappingRuleDescription | string | no | The description of the authorization rule for IP redirection in the instance group. The description must be 2 to 256 characters in length,… | | IpMappingRuleName | string | no | The name of the authorization rule for IP redirection in the instance group. The name must be 2 to 128 characters in length, start with a… | | GroupIpMappingRuleId | string | yes | The ID of the authorization rule to be redirected | | MappingIp | string | no | The IP address that requires redirection. | | DestinationIp | string | no | The destination IP address to access | | ClientToken | string | no | The client token used to ensure the idempotence of the request. Generate a unique value from your client for this parameter to guarantee… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without modifying the IP redirection… | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID | ### Update the cloud connector instance information `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-io-tcloud-connector-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The cloud connector instance ID | | IoTCloudConnectorName | string | no | The name of the cloud connector instance. The name must be 2 to 128 characters in length, start with an uppercase or lowercase letter or a… | | IoTCloudConnectorDescription | string | no | The description of the cloud connector instance. The description must be 2 to 256 characters in length, start with a letter or a Chinese… | | WildcardDomainEnabled | string | no | Whether to enable the wildcard domain name feature. Valid values: true (default): Enabled. false: Disabled | | ClientToken | string | no | The client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client to guarantee… | | DryRun | string | no | Whether to perform only a dry run of the request. Valid values: true: Sends a dry run request without updating the instance information.… | | RegionId | string | yes | The region ID of the cloud connector instance. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the… | | Mode | string | no | The instance mode. Valid values: PassThrough: Pass-through mode. VpcNat: Private network NAT mode | ### Modify the properties of a cloud connector group `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-io-tcloud-connector-group-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorGroupId | string | yes | The ID of the instance group | | Name | string | no | The name of the instance group to be modified. The name must be 2 to 128 characters in length and start with an uppercase or lowercase… | | Description | string | no | The description of the instance group to be modified. The description must be 2 to 256 characters in length. It must start with an… | | ClientToken | string | no | The client token used to ensure the idempotence of the request. This value is generated by the client and must be unique across different… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without modifying the instance group… | | RegionId | string | yes | The region ID of the instance group. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID | ### Invoke the UpdateIpMappingRule API to modify information about IP redirection for an authorization rule `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-ip-mapping-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | IoTCloudConnectorId | string | yes | The instance ID of the cloud connector | | IpMappingRuleId | string | yes | The ID of the authorization rule to be redirected | | DestinationIp | string | no | The target IP address for redirection | | MappingIp | string | no | The IP address to be redirected | | IpMappingRuleName | string | no | The name of the authorization rule for which IP redirection is configured. The name must be 2 to 128 English or Chinese characters in… | | IpMappingRuleDescription | string | no | The description of the authorization rule for which IP redirection is configured. The description must be 2 to 256 characters in length,… | | ClientToken | string | no | The client token used to ensure the idempotence of the request. Generate a unique value from your client for this parameter to guarantee… | | DryRun | string | no | Specifies whether to perform a dry run of the request. Valid values: true: Sends a dry run request without modifying the IP redirection… | | RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/313836.html API to obtain the region ID | ### Update an application-based statistics service `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-service-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ServiceId | string | yes | The unique ID that the system generates for the application-based statistics service | | IoTCloudConnectorId | string | yes | The ID of the cloud connector instance | | ServiceName | string | no | The name of the application-based statistics service. The name must be 2 to 128 characters in length. It must start with a letter or… | | ServiceDescription | string | no | The description of the application-based statistics service. The description must be 2 to 256 characters in length. It must start with a… | | ClientToken | string | no | A client token that ensures the idempotence of the request. Generate a unique value for this parameter on the client side. The value must… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a check only. Does not modify the service. Checks include required… | | RegionId | string | yes | The region ID where the application-based statistics service is located. You can call the… | ### Updates an application entry in the service list to support application-specific statistics `POST https://apizie.tech/v1/cloud:aliyun-iotcc/update-service-entry-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | | ServiceId | string | yes | The ID of the service for application-specific statistics. The system generates this ID, and it is globally unique | | IoTCloudConnectorId | string | yes | The ID of the Cloud Connector instance | | ServiceEntryId | string | yes | The ID of the application entry | | ServiceEntryName | string | no | The name of the application entry. The name must be 2 to 128 characters long. It must start with an uppercase or lowercase letter or a… | | ServiceEntryDescription | string | no | The description of the application entry. The description must be 2 to 256 characters long. It must start with an uppercase or lowercase… | | ClientToken | string | no | The client token to ensure the idempotence of the request. A client-generated token that is unique for different requests. The token can… | | DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request without modifying the application entry. The system… | | RegionId | string | yes | The ID of the region where the application entry is located. Call the https://help.aliyun.com/document_detail/313836.html operation to… | ### version `POST https://apizie.tech/v1/cloud:aliyun-iotcc/version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://iotcc.cn-hangzhou.aliyuncs.com | ## Example ``` curl "https://apizie.tech/v1/cloud:aliyun-iotcc/add-cidr-to-connection-pool" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud IoT Cloud Connector API? Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-iotcc/add-cidr-to-connection-pool with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud IoT Cloud Connector API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud IoT Cloud Connector itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud IoT Cloud Connector API? Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-iotcc. ### What is the status of the Alibaba Cloud IoT Cloud Connector API? Needs your own provider key (bring your own key)