{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-linkcard/add-card-to-directional-group":{"post":{"operationId":"cloud_aliyun_linkcard_add_card_to_directional_group","summary":"Adds cards to a specified group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IccidList","GroupId","SerialNo","AddType"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"IccidList":{"type":"string","description":"The collection of ICCID values for the cards. The maximum number of ICCIDs is 200 (JSON-encoded)"},"GroupId":{"type":"string","description":"The group ID"},"SerialNo":{"type":"string","description":"The request number. Supports idempotence"},"AddType":{"type":"string","description":"The method used to add cards. Valid values: NEW: imports only the cards that are not assigned to any group. TRANSFER: imports all cards.…"},"MsgNotify":{"type":"string","description":"Specifies whether to push a notification through MQ after successful execution. Default value: false. Valid values: false: does not push a…"},"ApiProduct":{"type":"string","description":"Linkcard"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/add-directional-address":{"post":{"operationId":"cloud_aliyun_linkcard_add_directional_address","summary":"Adds a destination address to a targeted group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupId","Source","AddressType","Address"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"GroupId":{"type":"string","description":"The group ID"},"Source":{"type":"string","description":"The address type. Valid values: user_defined: user-defined configuration. aliyun_defined: Alibaba Cloud predefined configuration"},"AddressType":{"type":"string","description":"The destination address type. Valid values: Ip: IP address. Domain: domain name"},"Address":{"type":"string","description":"The destination address"},"SerialNo":{"type":"string","description":"The request number. This parameter supports idempotence"},"MsgNotify":{"type":"string","description":"Specifies whether to push a notification through MQ after successful execution. Default value: false. Valid values: false: does not push a…"},"UrlInsecurityForce":{"type":"string","description":"Specifies whether to forcibly add a detected high-risk domain name. By default, the domain name is blocked and not added"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/add-directional-card":{"post":{"operationId":"cloud_aliyun_linkcard_add_directional_card","summary":"Imports directional cards into a directional group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupId","UploadType","UploadMethod"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"GroupId":{"type":"string","description":"The ID of the directional group. You can call the https://help.aliyun.com/document_detail/374328.html operation and view the directional…"},"UploadType":{"type":"string","description":"The import type. Valid values: NO_GROUP: imports only directional cards that have not been assigned to a group. ALL: imports all…"},"UploadMethod":{"type":"string","description":"The import method. Valid values: TAG: imports directional cards with the specified tags. ORDER: imports directional cards from the…"},"TagList":{"type":"string","description":"The list of tag IDs. This parameter is required when the import method is set to TAG (JSON-encoded)"},"OrderList":{"type":"string","description":"The list of order IDs. This parameter is required when the import method is set to ORDER (JSON-encoded)"},"FileUri":{"type":"string","description":"The OSS path of the batch file. This parameter is required when the import method is set to FILE"},"GroupName":{"type":"string","description":"The name of the directional group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/add-directional-group":{"post":{"operationId":"cloud_aliyun_linkcard_add_directional_group","summary":"Creates a directional group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupName"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"GroupName":{"type":"string","description":"The name of the directional group. The group name supports Chinese characters, English letters, digits, and underscores (_), with a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/add-tags-to-card":{"post":{"operationId":"cloud_aliyun_linkcard_add_tags_to_card","summary":"Add Tags to IoT Card","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console"},"TagNameList":{"type":"string","description":"The tag names (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/batch-add-directional-address":{"post":{"operationId":"cloud_aliyun_linkcard_batch_add_directional_address","summary":"Adds access addresses to a directional group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupId","Source","AddressType","ListAddress"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"GroupId":{"type":"integer","description":"The ID of the directional group. You can call the https://help.aliyun.com/document_detail/374328.html operation to obtain the directional…"},"Source":{"type":"string","description":"The address source. Valid values: user_defined: user-defined. aliyun_defined: Alibaba Cloud predefined"},"AddressType":{"type":"string","description":"The address type. Valid values: Ip: IP address. Domain: domain name"},"ListAddress":{"type":"string","description":"The directional addresses (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/delete-directional-address":{"post":{"operationId":"cloud_aliyun_linkcard_delete_directional_address","summary":"Delete a target address from a directional group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupId","Address"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"GroupId":{"type":"string","description":"The group ID"},"Address":{"type":"string","description":"The target address"},"SerialNo":{"type":"string","description":"The serial number of the request, which supports idempotency"},"MsgNotify":{"type":"string","description":"Specifies whether to send a notification through MQ after successful execution. Default value: false. false: The notification is not sent.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/delete-directional-group":{"post":{"operationId":"cloud_aliyun_linkcard_delete_directional_group","summary":"Deletes a targeted group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupId"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"GroupId":{"type":"string","description":"The group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/force-activation":{"post":{"operationId":"cloud_aliyun_linkcard_force_activation","summary":"Forcibly activates a card with the same-tier plan to expand the shared traffic pool","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console…"},"DateType":{"type":"string","description":"The plan type. Valid values: sameflowcard: same-tier general traffic plan. directional_sameflowcard: same-tier directional traffic plan"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/get-card-detail":{"post":{"operationId":"cloud_aliyun_linkcard_get_card_detail","summary":"Query card detail information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can find the ICCID on the IoT card, or view it on the Card Management page in the IoT SIM Service console…"},"ShowPsim":{"type":"string","description":"Specifies whether to display the detail information of sub-cards. Default value: false. true: Yes. false: No"},"InstanceId":{"type":"string","description":"The instance ID of the IoT card. This parameter is required only when the queried IoT card has been canceled (i.e., DestroyCard is true).…"},"DestroyCard":{"type":"string","description":"Specifies whether the queried IoT card has been canceled. Default value: false. true: Yes. false: No"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/get-card-flow-info":{"post":{"operationId":"cloud_aliyun_linkcard_get_card_flow_info","summary":"Queries the traffic information of a card","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console…"},"DateList":{"type":"string","description":"The months to query. You can query up to 6 months. If this parameter is left empty, data of the most recent 2 months is returned…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/get-card-latest-flow":{"post":{"operationId":"cloud_aliyun_linkcard_get_card_latest_flow","summary":"This API is used to query the real-time cycle usage of an IoT card","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/get-card-real-status":{"post":{"operationId":"cloud_aliyun_linkcard_get_card_real_status","summary":"Queries the status of an IoT card on the carrier side through intelligent diagnostics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can find the ICCID on the IoT card itself or on the Card Management page of the IoT SIM Service console"},"Msisdn":{"type":"string","description":"The MSISDN of the IoT card"},"SerialNo":{"type":"string","description":"The unique identifier for polling query results (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/get-card-status-statistics":{"post":{"operationId":"cloud_aliyun_linkcard_get_card_status_statistics","summary":"Queries risk alerts on the overview page","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/get-credential-pool-statistics":{"post":{"operationId":"cloud_aliyun_linkcard_get_credential_pool_statistics","summary":"Queries the pool information associated with a plan credential","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Date","CredentialNO"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Date":{"type":"string","description":"The month for which to query the plan data usage details"},"CredentialNO":{"type":"string","description":"The plan credential. You can obtain the plan credential by using one of the following methods: On the Plan Credential page of the IoT SIM…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/get-real-name-status":{"post":{"operationId":"cloud_aliyun_linkcard_get_real_name_status","summary":"Queries the personal real-name verification status of an IoT card","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can find the ICCID on the IoT card, or view it on the Card Management page of the IoT SIM Service console…"},"ListMsisdns":{"type":"string","description":"The MSISDNs of sub-cards for multi-network cards (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/get-sim-card-state-distribution":{"post":{"operationId":"cloud_aliyun_linkcard_get_sim_card_state_distribution","summary":"Retrieves the card status distribution","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Date"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"CredentialNO":{"type":"string","description":"The credential number of the plan. You can view this on the Credential Management page in the IoT SIM Service console…"},"Date":{"type":"string","description":"The date to query. Format: yyyyMM"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/list-card-info":{"post":{"operationId":"cloud_aliyun_linkcard_list_card_info","summary":"Query the card list","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageSize","PageNo"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"ActiveTimeEnd":{"type":"string","description":"The end time of the IoT card activation time range. Format: `yyyy-MM-dd HH:mm:ss`"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 10, 15, 25, and 40"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console…"},"CredentialNo":{"type":"string","description":"The plan credential"},"Vendor":{"type":"string","description":"The carrier. CMCC: China Mobile. CUCC: China Unicom. CTCC: China Telecom. VNO: Virtual network operator"},"PageNo":{"type":"integer","description":"The page number. This parameter must be used together with the PageSize parameter"},"Msisdn":{"type":"string","description":"The MSISDN of the IoT card"},"AliyunOrderId":{"type":"string","description":"The order ID associated with the IoT card"},"AliFee":{"type":"string","description":"The billing version"},"Period":{"type":"string","description":"The plan billing cycle. 1101: Monthly. 1103: Quarterly. 1106: Semi-annually. 1112: Annually"},"DataType":{"type":"string","description":"The data type. singlecard: Single-card general data. directionalcard: Single-card directional data. sameflowcard: Same-tier pool shared…"},"ActiveTimeStart":{"type":"string","description":"The start time of the IoT card activation time range. Format: `yyyy-MM-dd HH:mm:ss`"},"SimType":{"type":"string","description":"The SIM card type. nano: Triple-cut plug-in card (consumer-grade). micro: Dual-cut plug-in card (consumer-grade). normal: Standard plug-in…"},"ExpireTimeEnd":{"type":"string","description":"The plan expiration end time of the IoT card. Format: `yyyy-MM-dd HH:mm:ss`"},"IsAutoRecharge":{"type":"string","description":"Indicates whether the plan is automatically renewed. true: Yes. false: No"},"ExpireTimeStart":{"type":"string","description":"The plan expiration start time of the IoT card. Format: `yyyy-MM-dd HH:mm:ss`"},"OsStatus":{"type":"string","description":"The detailed status of the IoT card. 10: Test period. 20: Silent period. 100: In use. 150: Partially in use. 200: Manually deactivated.…"},"NotifyId":{"type":"string","description":"The notification ID of the automation rule"},"DataLevel":{"type":"string","description":"The data plan tier"},"Status":{"type":"string","description":"The status of the IoT card. 10: Testable. 20: Unused. 30: In use. 35: Deactivated. 40: Suspended. 50: Canceled"},"TagName":{"type":"string","description":"The tag name"},"CertifyType":{"type":"string","description":"The authentication method. Only enterprise is supported: Enterprise authentication"},"DirectionalGroupId":{"type":"string","description":"The directional group ID"},"ApnName":{"type":"string","description":"The APN name"},"Imsi":{"type":"string","description":"The IMSI of the IoT card"},"PoolId":{"type":"string","description":"The pool ID"},"MinFlow":{"type":"string","description":"The minimum usage for filtering by periodic usage range. Unit: MB"},"MaxFlow":{"type":"string","description":"The maximum usage for filtering by periodic usage range. Unit: MB"},"MaxRestFlowPercentage":{"type":"number","description":"The remaining data percentage for a single card in the billing cycle. Only the following three values are supported: 0.1: 10% remaining…"},"NetworkType":{"type":"string","description":"The network type: 4G or 5G"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/list-directional-address":{"post":{"operationId":"cloud_aliyun_linkcard_list_directional_address","summary":"Queries the list of access addresses for a directional group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageSize","PageNo","GroupId"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 10, 15, 25, and 40"},"PageNo":{"type":"integer","description":"The page number. Use this parameter together with the PageSize parameter"},"GroupId":{"type":"string","description":"The directional group ID. You can call the https://help.aliyun.com/document_detail/374328.html operation to obtain the directional group…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/list-directional-detail":{"post":{"operationId":"cloud_aliyun_linkcard_list_directional_detail","summary":"Queries the directional group and access address list of an IoT card","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid","PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console"},"PageNo":{"type":"integer","description":"The page number to query. The value cannot be 0"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 10, 15, 25, and 40"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/list-order":{"post":{"operationId":"cloud_aliyun_linkcard_list_order","summary":"Queries a list of orders","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"OrderId":{"type":"string","description":"The order ID"},"StartDate":{"type":"string","description":"The start date of the order purchase time range. Format: `YYYY-MM-dd`"},"EndDate":{"type":"string","description":"The end date of the order purchase time range. Format: `YYYY-MM-dd`"},"OrderType":{"type":"string","description":"The order type. Valid values: NEW: new purchase. ADD_FLOW: pool expansion. ADD_CARD: card replacement. FUNCTION: monthly feature fee…"},"OrderStatus":{"type":"string","description":"The order status. Valid values: processing: being processed. failure: failed. completed: completed. unpaid: pending payment. refunded:…"},"PageNo":{"type":"integer","description":"The page number. Use this parameter together with the `PageSize` parameter"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 10, 15, 25, and 40"},"CredentialNo":{"type":"string","description":"The plan credential"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/rebind-resume-single-card":{"post":{"operationId":"cloud_aliyun_linkcard_rebind_resume_single_card","summary":"Changes the status of a card from \"rebind deactivated\" to \"rebind reactivated\"","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can find the ICCID on the IoT card, or view it on the Card Management page of the IoT SIM Service console…"},"OptMsisdns":{"type":"string","description":"Specifies whether to perform the operation on a sub-card. Set this parameter to the MSISDN of the sub-card. This parameter is not required…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/renew":{"post":{"operationId":"cloud_aliyun_linkcard_renew","summary":"Renews plan subscriptions and purchases add-on packages for IoT cards. This operation applies only to…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"ApiProduct":{"type":"string","description":"The API code"},"ApiRevision":{"type":"string","description":"The API version"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can find the ICCID on the IoT card itself, or on the Card Management page of the IoT SIM Service console"},"RechargeType":{"type":"string","description":"The recharge type. Valid values: STANDARD: renews a plan subscription. OVERLAY: purchases an add-on package"},"SerialNo":{"type":"string","description":"The custom order number. The number must be unique and idempotent. If your recharge involves order management on your own platform, such…"},"OfferCode":{"type":"string","description":"This parameter is required when the recharge type is set to add-on package purchase. Contact your technical support representative for the…"},"BuyNum":{"type":"integer","description":"The number of units to purchase. Select the number based on the plan type of the IoT card. Valid values: Renew a monthly plan: 1, 2, 3, 6,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/resume-single-card":{"post":{"operationId":"cloud_aliyun_linkcard_resume_single_card","summary":"Resume a single card that is in the \"Voluntarily Deactivated\" or \"Mass Deactivated\" status to the \"Reuse\"…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can find the ICCID on the IoT card, or view the ICCID on the Card Management page of the IoT SIM Service…"},"OptMsisdns":{"type":"string","description":"Specifies whether to perform the operation on sub-cards by entering the MSISDN of the sub-cards. This parameter is not required for…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/send-message":{"post":{"operationId":"cloud_aliyun_linkcard_send_message","summary":"Sends an SMS message from the platform","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskName","MessageTemplateId","MessageSendTime"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"TaskName":{"type":"string","description":"The custom task name. The name cannot contain special characters and can be up to 40 characters in length"},"MessageTemplateId":{"type":"integer","description":"The ID of the SMS template. You can view the template ID in the console"},"MessageVariableParam":{"type":"string","description":"The replacement dynamic parameter for an SMS message, in the format {1}{2}"},"MessageSendTime":{"type":"integer","description":"The timestamp, in seconds. If the specified time is earlier than the current time, the message is sent immediately. If the specified time…"},"Msisdns":{"type":"string","description":"The list of destination MSISDNs to which the SMS message is sent (JSON-encoded)"},"ApiProduct":{"type":"string","description":"Linkcard"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/set-card-stop-rule":{"post":{"operationId":"cloud_aliyun_linkcard_set_card_stop_rule","summary":"Sets the data cap suspension rule for a card. Only same-tier pool plans and unified payment pool plans are…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid","FlowLimit","AutoRestore"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console…"},"FlowLimit":{"type":"integer","description":"The data cap threshold for suspension. Only positive integers are supported. Unit: MB. When the monthly data usage reaches this value, the…"},"AutoRestore":{"type":"string","description":"Specifies whether to automatically resume the card in the following month after it is suspended due to reaching the data cap. true…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/stop-single-card":{"post":{"operationId":"cloud_aliyun_linkcard_stop_single_card","summary":"Proactively deactivates a single card that is in the \"In Use\" state","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console…"},"OptMsisdns":{"type":"string","description":"Specifies whether to perform the operation on a sub-card. Set this parameter to the MSISDN of the sub-card. This parameter is not required…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/update-auto-recharge-switch":{"post":{"operationId":"cloud_aliyun_linkcard_update_auto_recharge_switch","summary":"Enables or disables the auto-renewal feature for a card. This operation applies only to single-card plans…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid","Open"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console…"},"Open":{"type":"string","description":"The auto-renewal switch. true: Enables auto-renewal. false: Disables auto-renewal"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/verify-iot-card":{"post":{"operationId":"cloud_aliyun_linkcard_verify_iot_card","summary":"Queries whether an IoT card is a directional card","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Iccid"],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"},"Iccid":{"type":"string","description":"The ICCID of the IoT card. You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkcard/version":{"post":{"operationId":"cloud_aliyun_linkcard_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkcard.aliyuncs.com"],"default":"https://linkcard.aliyuncs.com","description":"Regional endpoint, for example https://linkcard.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}