summaryrefslogtreecommitdiff
path: root/data/en_us/linkcard
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/linkcard
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/linkcard')
-rw-r--r--data/en_us/linkcard/2021-05-20/api-docs.php8832
1 files changed, 3911 insertions, 4921 deletions
diff --git a/data/en_us/linkcard/2021-05-20/api-docs.php b/data/en_us/linkcard/2021-05-20/api-docs.php
index f7f114a..0170470 100644
--- a/data/en_us/linkcard/2021-05-20/api-docs.php
+++ b/data/en_us/linkcard/2021-05-20/api-docs.php
@@ -1,76 +1,30 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Linkcard',
- 'version' => '2021-05-20',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Linkcard', 'version' => '2021-05-20'],
'directories' => [
[
- 'id' => 124178,
- 'title' => null,
+ 'children' => ['Renew', 'StopSingleCard', 'ResumeSingleCard', 'RebindResumeSingleCard', 'ForceActivation', 'SetCardStopRule', 'UpdateAutoRechargeSwitch', 'GetCredentialPoolStatistics', 'GetCardFlowInfo', 'GetCardDetail', 'ListCardInfo', 'ListOrder'],
'type' => 'directory',
- 'children' => [
- 'Renew',
- 'StopSingleCard',
- 'ResumeSingleCard',
- 'RebindResumeSingleCard',
- 'ForceActivation',
- 'SetCardStopRule',
- 'UpdateAutoRechargeSwitch',
- 'GetCredentialPoolStatistics',
- 'GetCardFlowInfo',
- 'GetCardDetail',
- 'ListCardInfo',
- 'ListOrder',
- ],
+ 'title' => 'Card',
],
[
- 'id' => 170671,
- 'title' => null,
+ 'children' => ['AddDirectionalCard', 'AddDirectionalGroup', 'BatchAddDirectionalAddress', 'ListDirectionalAddress', 'ListDirectionalDetail', 'VerifyIotCard'],
'type' => 'directory',
- 'children' => [
- 'AddDirectionalCard',
- 'AddDirectionalGroup',
- 'BatchAddDirectionalAddress',
- 'ListDirectionalAddress',
- 'ListDirectionalDetail',
- 'VerifyIotCard',
- ],
+ 'title' => 'Directed service',
],
[
- 'id' => 361620,
- 'title' => null,
+ 'children' => ['AddTagsToCard', 'GetSimCardStateDistribution', 'AddDirectionalAddress', 'DeleteDirectionalAddress', 'DeleteDirectionalGroup', 'GetCardStatusStatistics', 'GetCardRealStatus', 'GetCardLatestFlow', 'AddCardToDirectionalGroup', 'GetRealNameStatus', 'SendMessage'],
'type' => 'directory',
- 'children' => [
- 'AddTagsToCard',
- 'GetSimCardStateDistribution',
- 'AddDirectionalAddress',
- 'DeleteDirectionalAddress',
- 'DeleteDirectionalGroup',
- 'GetCardStatusStatistics',
- 'GetCardRealStatus',
- 'GetCardLatestFlow',
- 'AddCardToDirectionalGroup',
- 'GetRealNameStatus',
- 'SendMessage',
- ],
+ 'title' => 'Other',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'Renew' => [
- 'summary' => '充值(订单和支付一体)',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddCardToDirectionalGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -78,555 +32,499 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'ApiProduct',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'linkcard',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ApiRevision',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '2021-05-20',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'Iccid',
+ 'name' => 'IccidList',
'in' => 'query',
- 'allowEmptyValue' => false,
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
+ 'description' => 'The collection of ICCID values for the cards. The maximum number of ICCIDs is 200.',
+ 'type' => 'array',
+ 'items' => ['description' => 'ICCID。', 'type' => 'string', 'required' => true, 'example' => '1111****6225', 'title' => ''],
'required' => true,
- 'type' => 'string',
+ 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'RechargeType',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'STANDARD',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => '10000002595', 'title' => ''],
],
[
'name' => 'SerialNo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '12345678',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The request number. Supports idempotence.', 'type' => 'string', 'required' => true, 'example' => '123123', 'title' => ''],
],
[
- 'name' => 'OfferCode',
+ 'name' => 'AddType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => false,
- 'example' => 'COM***0203',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The method used to add cards. Valid values:'."\n"
+ ."\n"
+ .'NEW: imports only the cards that are not assigned to any group.'."\n"
+ ."\n"
+ .'TRANSFER: imports all cards. The cards are removed from their original groups.', 'type' => 'string', 'required' => true, 'example' => 'NEW', 'title' => ''],
],
[
- 'name' => 'BuyNum',
+ 'name' => 'MsgNotify',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '12',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'Specifies whether to push a notification through MQ after successful execution. Default value: false. Valid values: '."\n"
+ ."\n"
+ .'false: does not push a notification. '."\n"
+ ."\n"
+ .'true: pushes a notification.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'ApiProduct',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Linkcard.', 'type' => 'string', 'required' => false, 'example' => 'Linkcard', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'AddCardToDirectionalGroupResponse',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['description' => 'The request ID. The identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'true: The call was successful.'."\n"
+ ."\n"
+ .'false: The call failed.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => 'The return code. Valid values:'."\n"
+ ."\n"
+ .'200: The call was successful.'."\n"
+ ."\n"
+ .'Other values: The call failed. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call failed.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language corresponding to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The request result.',
+ 'type' => 'object',
'properties' => [
- 'OrderNo' => [
- 'description' => '',
- 'example' => '21450******0275',
- 'type' => 'string',
- ],
- 'SerialNo' => [
- 'description' => '',
- 'example' => '12345678',
- 'type' => 'string',
- ],
+ 'Result' => ['description' => 'Indicates whether the execution was successful. Valid values:'."\n"
+ ."\n"
+ .'true: The cards were added successfully.'."\n"
+ ."\n"
+ .'false: The cards failed to be added.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SerialNo' => ['description' => 'The request number. The idempotence sequence number.', 'type' => 'string', 'example' => '123213', 'title' => ''],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny ',
- 'errorMessage' => 'You do not have the RAM permission. ',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderNo\\": \\"21450******0275\\",\\n \\"SerialNo\\": \\"12345678\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RenewResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <OrderNo>21450******0275</OrderNo>\\n <SerialNo>12345678</SerialNo>\\n </Data>\\n</RenewResponse>","errorExample":""}]',
- 'title' => 'Renew',
- ],
- 'StopSingleCard' => [
- 'summary' => '一张卡停用',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"Result\\": true,\\n \\"SerialNo\\": \\"123213\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Add cards to a specified group',
+ 'summary' => 'Adds cards to a specified group.',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T07:56:29.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCardToDirectionalGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddCardToDirectionalGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard:*:{#accountId}:directionalmanage/{#DirectionalManageId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AddDirectionalAddress' => [
+ 'summary' => 'Adds a destination address to a targeted group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000002595', 'title' => ''],
],
[
- 'name' => 'OptMsisdns',
+ 'name' => 'Source',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'example' => '["1112******826","1112******827"] ',
- 'items' => [
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
- 'type' => 'array',
- ],
+ 'schema' => ['description' => 'The address type. Valid values:'."\n"
+ ."\n"
+ .'- user_defined: user-defined configuration.'."\n"
+ .'- aliyun_defined: Alibaba Cloud predefined configuration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user_defined', 'title' => ''],
+ ],
+ [
+ 'name' => 'AddressType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination address type. Valid values:'."\n"
+ ."\n"
+ .'- Ip: IP address.'."\n"
+ .'- Domain: domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Domain', 'title' => ''],
+ ],
+ [
+ 'name' => 'Address',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination address.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*.aliyun.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'SerialNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The request number. This parameter supports idempotence.', 'type' => 'string', 'required' => false, 'example' => '123123', 'title' => ''],
+ ],
+ [
+ 'name' => 'MsgNotify',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to push a notification through MQ after successful execution. Default value: false. Valid values:'."\n"
+ .'- false: does not push a notification.'."\n"
+ .'- true: pushes a notification (currently not supported).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'UrlInsecurityForce',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to forcibly add a detected high-risk domain name. By default, the domain name is blocked and not added.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty. ',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
+ 'Data' => ['description' => 'Indicates whether the address is added. Valid values:'."\n"
+ ."\n"
+ .'- true: The address is added.'."\n"
+ .'- false: The address failed to be added.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The call is successful.'."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Code' => ['description' => 'The response code. Valid values:'."\n"
+ ."\n"
+ .'- 200: The call is successful.'."\n"
+ .'- Other values: The call failed. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.check.IccidCanNotEmpty',
- 'errorMessage' => 'Iccid cannot be empty.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<StopSingleCardResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</StopSingleCardResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'StopSingleCard',
- ],
- 'ResumeSingleCard' => [
- 'summary' => '一张卡复用',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Add destination address to targeted group',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-15T08:04:50.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalAddress'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddDirectionalAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AddDirectionalCard' => [
+ 'summary' => 'Imports directional cards into a directional group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'GroupId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the directional group.'."\n"
+ ."\n"
+ .'You can call the [GetCardDetail](~~374328~~) operation and view the directional group ID (DirectionalGroupId) in the response parameters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''],
+ ],
+ [
+ 'name' => 'UploadType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The import type. Valid values:'."\n"
+ ."\n"
+ .'- **NO_GROUP**: imports only directional cards that have not been assigned to a group.'."\n"
+ ."\n"
+ .'- **ALL**: imports all directional cards.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALL', 'title' => ''],
+ ],
+ [
+ 'name' => 'UploadMethod',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The import method. Valid values:'."\n"
+ ."\n"
+ .'- **TAG**: imports directional cards with the specified tags.'."\n"
+ ."\n"
+ .'- **ORDER**: imports directional cards from the specified orders.'."\n"
+ ."\n"
+ .'- **FILE**: imports directional cards from a batch file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TAG', 'title' => ''],
+ ],
+ [
+ 'name' => 'TagList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
+ 'description' => 'The list of tag IDs. This parameter is required when the import method is set to TAG.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The tag ID. This parameter is required when the import method is set to TAG.'."\n"
+ ."\n"
+ .'You can view tag IDs on the **SIM Card Management** > **Tag Management** page in the IoT Wireless Connection Service console.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''],
'required' => true,
- 'type' => 'string',
+ 'docRequired' => true,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'OptMsisdns',
+ 'name' => 'OrderList',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
- 'example' => '["111******6826","11*******6827"]',
- 'items' => [
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
+ 'description' => 'The list of order IDs. This parameter is required when the import method is set to ORDER.',
'type' => 'array',
+ 'items' => ['description' => 'The order ID. This parameter is required when the import method is set to ORDER.'."\n"
+ ."\n"
+ .'You can view order IDs on the **Order Statistics** > **Order Management** page in the IoT Wireless Connection Service console.', 'type' => 'string', 'required' => false, 'example' => '2172***80589', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 50,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'FileUri',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The OSS path of the batch file. This parameter is required when the import method is set to FILE.', 'type' => 'string', 'required' => false, 'example' => 'https://linkcard-user-online.oss-cn-zhangjiakou.aliyuncs.com/DIRECTIONAL_GROUP/20220811/xxxx.csv', 'title' => ''],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the directional group.', 'type' => 'string', 'required' => false, 'example' => '测试分组', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty. ',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
+ 'Data' => ['description' => 'Indicates whether the import was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The import was successful.'."\n"
+ ."\n"
+ .'- **false**: The import failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language of the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Code' => ['description' => 'The response code. Valid values:'."\n"
+ ."\n"
+ .'- 200: The call was successful.'."\n"
+ ."\n"
+ .'- Other values: The call failed. For more information about error codes, see [Error codes](~~87387~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.check.IccidCanNotEmpty',
- 'errorMessage' => 'Iccid cannot be empty.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Import directional cards into a directional group',
+ 'description' => '## Usage notes'."\n"
+ .'Directional cards are IoT cards that can access only specified addresses. You can call the [VerifyIotCard](~~446797~~) operation to check whether an IoT card is a directional card.',
+ 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see [Common parameters](~~30561~~). For the metric description of each parameter, see the preceding parameter description.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalCard'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddDirectionalCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ResumeSingleCardResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</ResumeSingleCardResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'ResumeSingleCard',
],
- 'RebindResumeSingleCard' => [
- 'summary' => '一张卡换绑复用',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddDirectionalGroup' => [
+ 'summary' => 'Creates a directional group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'Iccid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'OptMsisdns',
+ 'name' => 'GroupName',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'example' => ' ["1112******826","1112******827"] ',
- 'items' => [
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
- 'type' => 'array',
- ],
+ 'schema' => ['description' => 'The name of the directional group.'."\n"
+ ."\n"
+ .'The group name supports Chinese characters, English letters, digits, and underscores (_), with a maximum length of 30 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 30, 'minLength' => 0, 'example' => '测试分组', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'Iccid cannot be empty. ',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
+ 'Data' => ['description' => 'The directional group ID.'."\n"
+ ."\n"
+ .'Record the directional group ID. You need to specify the directional group ID when you call other API operations later. For example, when you call the [AddDirectionalCard](~~446808~~) operation to import IoT cards into the directional group, you need to specify the directional group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the API call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the API call is successful.'."\n"
+ .'- **true**: The API call is successful.'."\n"
+ .'- **false**: The API call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language corresponding to the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- 200: The call is successful.'."\n"
+ ."\n"
+ .'- Others: The call fails. For more information about error codes, see [Error codes](~~87387~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'linkcard.check.IccidCanNotEmpty',
- 'errorMessage' => 'Iccid cannot be empty.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
- ],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"Iccid cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<RebindResumeSingleCardResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</RebindResumeSingleCardResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'RebindResumeSingleCard',
- ],
- 'ForceActivation' => [
- 'summary' => '同档位单卡强制激活',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 6,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'CreateDirectionalGroup',
+ 'description' => '## Usage notes'."\n"
+ .'Only the new version of the directional service menu supports the directional group feature. If you are using the old version of the directional service menu, you cannot use this API operation. For more information, see [Directional service](~~279455~~).',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-09T11:58:12.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalGroup'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddDirectionalGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard::{#accountId}:directionalmanage/*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AddTagsToCard' => [
+ 'summary' => 'Add Tags to IoT Card',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -634,129 +532,114 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'DateType',
+ 'name' => 'TagNameList',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'sameflowcard',
+ 'description' => 'The tag names.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The tag name.'."\n"
+ ."\n"
+ .'If this parameter is empty or an empty collection, all tags are removed from the card.'."\n"
+ ."\n"
+ .'If the specified tag does not exist, the tag is automatically created and applied to the card.', 'type' => 'string', 'required' => false, 'example' => '测试标签', 'title' => ''],
'required' => false,
- 'type' => 'string',
+ 'maxItems' => 4,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'200: The request is successful. Other values: error codes. For more information about error codes, see Error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
+ 'description' => 'The collection of existing tags on the card.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '测试标签', 'title' => ''],
+ 'TagId' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '14', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
'example' => '',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. It is a unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ ."\n"
+ .'true: The call is successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.check.ForceActivationSameFlowCard',
- 'errorMessage' => 'Only cards in the same flow support forced activation.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
- [
- 'errorCode' => 'linkcard.check.OnlyUnusedCanForceActivation',
- 'errorMessage' => 'Only unused cards support forced activation.',
- ],
+ ['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => 'Iccid cannot be empty.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny ',
- 'errorMessage' => 'You do not have the RAM permission. ',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ForceActivationResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</ForceActivationResponse>","errorExample":""}]',
- 'title' => 'ForceActivation',
- ],
- 'SetCardStopRule' => [
- 'summary' => '一张卡达量停用',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"TagId\\": \\"14\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AddTagsToCard',
+ 'changeSet' => [
+ ['createdAt' => '2023-06-29T05:50:10.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTagsToCard'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddTagsToCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'BatchAddDirectionalAddress' => [
+ 'summary' => 'Adds access addresses to a directional group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -764,133 +647,121 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the directional group.'."\n"
+ ."\n"
+ .'You can call the [GetCardDetail](~~374328~~) operation to obtain the directional group ID (DirectionalGroupId) from the response parameters.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5', 'title' => ''],
],
[
- 'name' => 'FlowLimit',
+ 'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '100',
- 'format' => 'int64',
- 'required' => true,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The address source. Valid values:'."\n"
+ ."\n"
+ .'- **user_defined**: user-defined.'."\n"
+ ."\n"
+ .'- **aliyun_defined**: Alibaba Cloud predefined.', 'type' => 'string', 'required' => true, 'example' => 'user_defined', 'title' => ''],
],
[
- 'name' => 'AutoRestore',
+ 'name' => 'AddressType',
'in' => 'query',
+ 'schema' => ['description' => 'The address type. Valid values:'."\n"
+ ."\n"
+ .'- **Ip**: IP address.'."\n"
+ ."\n"
+ .'- **Domain**: domain name.', 'type' => 'string', 'required' => true, 'example' => 'Domain', 'title' => ''],
+ ],
+ [
+ 'name' => 'ListAddress',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'true',
+ 'description' => 'The directional addresses.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The specific address. A maximum of 10 addresses are supported.', 'type' => 'string', 'required' => false, 'example' => '*.aliyun.com', 'title' => ''],
'required' => true,
- 'type' => 'boolean',
+ 'maxItems' => 10,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'BatchAddDirectionalAddressResponse',
+ 'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- 200: The call was successful.'."\n"
+ ."\n"
+ .'- Other codes: The call failed. For more information, see [Error codes](~~87387~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call failed.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Data' => ['description' => 'Indicates whether the addresses were added. Valid values:'."\n"
+ ."\n"
+ .'- true: The addresses were added.'."\n"
+ ."\n"
+ .'- false: The addresses failed to be added.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
- 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.check.RuleMaxValueLimit',
- 'errorMessage' => 'The maximum value of Rule must be less than 9007199254740991.',
- ],
- [
- 'errorCode' => 'linkcard.check.RuleMustBePositiveInteger',
- 'errorMessage' => 'The valid values of Rule are positive integers and zero.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<SetCardStopRuleResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</SetCardStopRuleResponse>","errorExample":""}]',
- 'title' => 'SetCardStopRule',
- ],
- 'UpdateAutoRechargeSwitch' => [
- 'summary' => '自动充值开关',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ 'title' => 'Add directional addresses',
+ 'description' => '## Usage notes'."\n"
+ .'Only the new directional service menu supports the directional group feature. If you use the legacy directional service menu, you cannot call this operation. For more information, see [Directional service](~~279455~~).',
+ 'requestParamsDescription' => 'When you invoke this operation, you must include common request parameters in addition to the operation-specific request parameters described in this topic. For more information about common request parameters, see [Common parameters](~~30561~~). For the metric description of each parameter, see the request parameter section.',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T07:56:28.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-08-09T12:00:23.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchAddDirectionalAddress'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:BatchAddDirectionalAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteDirectionalAddress' => [
+ 'summary' => 'Delete a target address from a directional group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -898,320 +769,191 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000002595', 'title' => ''],
],
[
- 'name' => 'Open',
+ 'name' => 'Address',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'true',
- 'required' => true,
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => 'The target address.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*.aliyun.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'SerialNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The serial number of the request, which supports idempotency.', 'type' => 'string', 'required' => false, 'example' => '123123', 'title' => ''],
+ ],
+ [
+ 'name' => 'MsgNotify',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to send a notification through MQ after successful execution. Default value: false.'."\n"
+ ."\n"
+ .'false: The notification is not sent.'."\n"
+ ."\n"
+ .'true: The notification is sent.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
+ 'Data' => ['description' => 'Indicates whether the operation was successful.'."\n"
+ ."\n"
+ .'true: The operation was successful.'."\n"
+ ."\n"
+ .'false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'true: The request was successful. false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'200: The request was successful.'."\n"
+ ."\n"
+ .'Other values: The request failed. For more information about error codes, see Error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAutoRechargeSwitchResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</UpdateAutoRechargeSwitchResponse>","errorExample":""}]',
- 'title' => 'UpdateAutoRechargeSwitch',
- ],
- 'GetCredentialPoolStatistics' => [
- 'summary' => '套餐凭证池统计',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Target Address from Directional Group',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDirectionalAddress'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:DeleteDirectionalAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteDirectionalGroup' => [
+ 'summary' => 'Deletes a targeted group.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'Date',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '202108',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'CredentialNO',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'CM-SF-M-2-12G',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000002595', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Data' => [
- 'description' => '',
- 'properties' => [
- 'PoolUsed' => [
- 'description' => '',
- 'example' => '0KB',
- 'type' => 'string',
- ],
- 'CredentialNO' => [
- 'description' => '',
- 'example' => 'CM-SF-M-2-12G',
- 'type' => 'string',
- ],
- 'PoolOutUsed' => [
- 'description' => '',
- 'example' => '0KB',
- 'type' => 'string',
- ],
- 'PoolGrandTotalUsed' => [
- 'description' => '',
- 'example' => '6.00GB',
- 'type' => 'string',
- ],
- 'CredentialType' => [
- 'description' => '',
- 'example' => 'CT-SC-M-1-30M',
- 'type' => 'string',
- ],
- 'CardTotalNum' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'PoolGrandTotal' => [
- 'description' => '',
- 'example' => '12.00GB',
- 'type' => 'string',
- ],
- 'CardActiveNum' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'EffectiveTotalFlow' => [
- 'description' => '',
- 'example' => '12.00GB',
- 'type' => 'string',
- ],
- 'EffectiveAvailableFlow' => [
- 'description' => '',
- 'example' => '6.00GB',
- 'type' => 'string',
- ],
- 'PoolAvaiable' => [
- 'description' => '',
- 'example' => '6.00GB',
- 'type' => 'string',
- ],
- 'MonthFeatureFee' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'CredentialInstanceId' => [
- 'description' => '',
- 'example' => '259****',
- 'type' => 'string',
- ],
- 'SmsUsed' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'MonthUsedAmount' => [
- 'description' => '',
- 'example' => '3.00GB',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'MonthExceedFee' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'type' => 'object',
- ],
+ 'Data' => ['description' => 'Indicates whether the operation was successful.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ .'- true: The operation was successful.'."\n"
+ .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ .'- true: The call was successful.'."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'200: The call was successful.'."\n"
+ ."\n"
+ .'Other values: The call failed. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.check.TimeFormatError',
- 'errorMessage' => 'Time format error.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.common.BusinessProcessError',
- 'errorMessage' => 'A business processing exception occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PoolUsed\\": \\"0KB\\",\\n \\"CredentialNO\\": \\"CM-SF-M-2-12G\\",\\n \\"PoolOutUsed\\": \\"0KB\\",\\n \\"PoolGrandTotalUsed\\": \\"6.00GB\\",\\n \\"CredentialType\\": \\"CT-SC-M-1-30M\\",\\n \\"CardTotalNum\\": 20,\\n \\"PoolGrandTotal\\": \\"12.00GB\\",\\n \\"CardActiveNum\\": 10,\\n \\"EffectiveTotalFlow\\": \\"12.00GB\\",\\n \\"EffectiveAvailableFlow\\": \\"6.00GB\\",\\n \\"PoolAvaiable\\": \\"6.00GB\\",\\n \\"MonthFeatureFee\\": 100,\\n \\"CredentialInstanceId\\": \\"259****\\",\\n \\"SmsUsed\\": 0,\\n \\"MonthUsedAmount\\": 0,\\n \\"MonthExceedFee\\": 200\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCredentialPoolStatisticsResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PoolUsed>0KB</PoolUsed>\\n <CredentialNO>CM-SF-M-2-12G</CredentialNO>\\n <PoolOutUsed>0KB</PoolOutUsed>\\n <PoolGrandTotalUsed>6.00GB</PoolGrandTotalUsed>\\n <CredentialType>CM-SF-M-2-12G</CredentialType>\\n <CardTotalNum>20</CardTotalNum>\\n <PoolGrandTotal>12.00GB</PoolGrandTotal>\\n <CardActiveNum>10</CardActiveNum>\\n <EffectiveTotalFlow>12.00GB</EffectiveTotalFlow>\\n <EffectiveAvailableFlow>6.00GB</EffectiveAvailableFlow>\\n <PoolAvaiable>6.00GB</PoolAvaiable>\\n <MonthFeatureFee>100</MonthFeatureFee>\\n <CredentialInstanceId>259****</CredentialInstanceId>\\n <SmsUsed>0</SmsUsed>\\n </Data>\\n</GetCredentialPoolStatisticsResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'GetCredentialPoolStatistics',
- ],
- 'GetCardFlowInfo' => [
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a targeted group',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T07:56:28.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDirectionalGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:DeleteDirectionalGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ForceActivation' => [
+ 'summary' => 'Forcibly activates a card with the same-tier plan to expand the shared traffic pool.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1219,240 +961,105 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card or on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'DateList',
+ 'name' => 'DateType',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'example' => '["202110","202111"]',
- 'items' => [
- 'description' => '',
- 'example' => '["202110","202111"]',
- 'required' => false,
- 'type' => 'string',
- ],
- 'maxItems' => 5,
- 'required' => false,
- 'type' => 'array',
- ],
+ 'schema' => ['description' => 'The plan type. Valid values:'."\n"
+ ."\n"
+ .'- **sameflowcard**: same-tier general traffic plan.'."\n"
+ ."\n"
+ .'- **directional_sameflowcard**: same-tier directional traffic plan.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sameflowcard', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Data' => [
- 'description' => '',
- 'properties' => [
- 'ListVendorDetail' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'NetWorkDelay' => [
- 'description' => '',
- 'example' => '20',
- 'type' => 'string',
- ],
- 'SignalStrength' => [
- 'description' => '',
- 'example' => '20',
- 'type' => 'string',
- ],
- 'Vendor' => [
- 'description' => '',
- 'example' => 'CMCC',
- 'type' => 'string',
- ],
- 'UsedFlow' => [
- 'description' => '',
- 'example' => '100MB',
- 'type' => 'string',
- ],
- 'Ratio' => [
- 'description' => '',
- 'example' => '80%',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- 'ListCardMonthFlow' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'FlowCount' => [
- 'description' => '',
- 'example' => '200MB',
- 'type' => 'string',
- ],
- 'Month' => [
- 'description' => '',
- 'example' => '202112',
- 'type' => 'string',
- ],
- 'ListDayFlow' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'Flow' => [
- 'description' => '',
- 'example' => '100MB',
- 'type' => 'string',
- ],
- 'Day' => [
- 'description' => '',
- 'example' => '20211201',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- 'ListPackageDTO' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'EffectiveTime' => [
- 'description' => '',
- 'example' => '2022-03-20 23:59:59',
- 'type' => 'string',
- ],
- 'Remark' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'PackageName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'example' => '2022-04-30 23:59:59',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- ],
- 'type' => 'object',
- ],
+ 'Data' => ['description' => 'The execution result. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Succeeded.'."\n"
+ ."\n"
+ .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: Successful.'."\n"
+ .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Code' => ['description' => 'The response code. Valid values:'."\n"
+ ."\n"
+ .'- **200**: Success.'."\n"
+ .'- Other values: Error codes. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.check.IccidCanNotEmpty',
- 'errorMessage' => 'Iccid cannot be empty.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardNotExist',
- 'errorMessage' => 'The card does not exist.',
- ],
- [
- 'errorCode' => 'CardDisabled',
- 'errorMessage' => 'The SIM card has been permanently disabled.',
- ],
+ ['errorCode' => 'linkcard.check.ForceActivationSameFlowCard', 'errorMessage' => 'Only cards in the same flow support forced activation.', 'description' => 'Only same flow card can be force activation.'],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
+ ['errorCode' => 'linkcard.check.OnlyUnusedCanForceActivation', 'errorMessage' => 'Only unused cards support forced activation.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Forcibly activate a card',
+ 'description' => '## Limits'."\n"
+ ."\n"
+ .'The maximum number of queries per second (QPS) per Alibaba Cloud account for invoking this operation is 20.'."\n"
+ ."\n"
+ .'> Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.',
+ 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~375336~~).',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T07:56:27.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-06-29T06:51:32.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-10-28T11:23:14.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ForceActivation'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:ForceActivation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"ListVendorDetail\\": [\\n {\\n \\"NetWorkDelay\\": \\"20\\",\\n \\"SignalStrength\\": \\"20\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"UsedFlow\\": \\"100MB\\",\\n \\"Ratio\\": \\"80%\\"\\n }\\n ],\\n \\"ListCardMonthFlow\\": [\\n {\\n \\"FlowCount\\": \\"200MB\\",\\n \\"Month\\": \\"202112\\",\\n \\"ListDayFlow\\": [\\n {\\n \\"Flow\\": \\"100MB\\",\\n \\"Day\\": \\"20211201\\"\\n }\\n ]\\n }\\n ],\\n \\"ListPackageDTO\\": [\\n {\\n \\"EffectiveTime\\": \\"2022-03-20 23:59:59\\",\\n \\"Remark\\": \\"备注内容\\",\\n \\"PackageName\\": \\"移动-单卡通用流量-月包-30M\\",\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCardFlowInfoResponse>\\n <Code>200</Code>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Data>\\n <ListVendorDetail>\\n <NetWorkDelay>20</NetWorkDelay>\\n <SignalStrength>20</SignalStrength>\\n <Vendor>CMCC</Vendor>\\n </ListVendorDetail>\\n <ListCardMonthFlow>\\n <FlowCount>200MB</FlowCount>\\n <Month>202112</Month>\\n <ListDayFlow>\\n <Flow>100MB</Flow>\\n <Day>20211201</Day>\\n </ListDayFlow>\\n </ListCardMonthFlow>\\n <ListPackageDTO>\\n <EffectiveTime>2022-03-20 23:59:59</EffectiveTime>\\n <Remark>备注内容</Remark>\\n <PackageName>移动-单卡通用流量-月包-30M</PackageName>\\n <ExpireTime>2022-04-30 23:59:59</ExpireTime>\\n </ListPackageDTO>\\n </Data>\\n</GetCardFlowInfoResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'GetCardFlowInfo',
],
'GetCardDetail' => [
- 'summary' => '获取卡详情',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Query card detail information.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1465,1120 +1072,606 @@
[
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can find the ICCID on the IoT card, or view it on the **Card Management** page in the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
'name' => 'ShowPsim',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => 'Specifies whether to display the detail information of sub-cards. Default value: false.'."\n"
+ ."\n"
+ .'- **true**: Yes.'."\n"
+ .'- **false**: No.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => false,
- 'example' => '411****',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The instance ID of the IoT card.'."\n"
+ ."\n"
+ .'This parameter is required only when the queried IoT card has been canceled (i.e., **DestroyCard** is **true**).'."\n"
+ ."\n"
+ .'You can call the [ListCardInfo](~~425529~~) API and view the instance ID (VsimInstanceId) of the IoT card in the response parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '411****', 'title' => ''],
],
[
'name' => 'DestroyCard',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => 'Specifies whether the queried IoT card has been canceled. Default value: false.'."\n"
+ ."\n"
+ .'- **true**: Yes.'."\n"
+ .'- **false**: No.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Response parameters.',
+ 'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
+ 'Code' => ['description' => 'The API return code.'."\n"
+ ."\n"
+ .'- **200**: Success.'."\n"
+ .'- Others: Error codes. For details about error codes, see [Error Codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID, an identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the corresponding language based on the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The detail information of the IoT card.',
+ 'type' => 'object',
'properties' => [
'ListPsimCards' => [
- 'description' => '',
+ 'description' => 'The sub-card details of the multi-network card.',
+ 'type' => 'array',
'items' => [
+ 'description' => 'The sub-card details of the multi-network card.',
+ 'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'example' => '35',
- 'type' => 'string',
- ],
- 'PrivateNetworkSegment' => [
- 'description' => '',
- 'example' => '*.2.*.4',
- 'type' => 'string',
- ],
- 'OsStatus' => [
- 'description' => '',
- 'example' => '300',
- 'type' => 'string',
- ],
- 'CertifyStatus' => [
- 'description' => '',
- 'example' => '2',
- 'type' => 'string',
- ],
- 'ApnName' => [
- 'description' => '',
- 'example' => 'cmiot',
- 'type' => 'string',
- ],
- 'PeriodAddFlow' => [
- 'description' => '',
- 'example' => '130.00MB',
- 'type' => 'string',
- ],
- 'Iccid' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'type' => 'string',
- ],
- 'Vendor' => [
- 'description' => '',
- 'example' => 'CMCC',
- 'type' => 'string',
- ],
- 'PeriodSmsUse' => [
- 'description' => '',
- 'example' => '0',
- 'type' => 'string',
- ],
+ 'Status' => ['description' => 'The status of the IoT card.'."\n"
+ ."\n"
+ .'- **10**: Testable.'."\n"
+ ."\n"
+ .'- **20**: Unused.'."\n"
+ ."\n"
+ .'- **30**: In use.'."\n"
+ ."\n"
+ .'- **35**: Deactivated.'."\n"
+ ."\n"
+ .'- **40**: Suspended.'."\n"
+ ."\n"
+ .'- **50**: Canceled.', 'type' => 'string', 'example' => '35', 'title' => ''],
+ 'PrivateNetworkSegment' => ['description' => 'The private network segment (directional card).', 'type' => 'string', 'example' => '*.2.*.4', 'title' => ''],
+ 'OsStatus' => ['description' => 'The specific status of the IoT card.'."\n"
+ ."\n"
+ .'- **10**: Testing period.'."\n"
+ .'- **20**: Silent period.'."\n"
+ .'- **100**: In use.'."\n"
+ .'- **130**: Test period rebinding deactivation.'."\n"
+ .'- **150**: Partially in use.'."\n"
+ .'- **200**: Voluntarily deactivated.'."\n"
+ .'- **300**: Deactivated due to data cap.'."\n"
+ .'- **400**: Deactivated due to credit control.'."\n"
+ .'- **500**: Deactivated due to rebinding.'."\n"
+ .'- **600**: Deactivated due to real-name verification.'."\n"
+ .'- **700**: Deactivated due to anomaly.'."\n"
+ .'- **40**: Suspended.'."\n"
+ .'- **50**: Canceled.', 'type' => 'string', 'example' => '300', 'title' => ''],
+ 'CertifyStatus' => ['description' => 'The real-name authentication status.'."\n"
+ ."\n"
+ .'- **1**: Not authenticated.'."\n"
+ ."\n"
+ .'- **2**: Authenticated.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'ApnName' => ['description' => 'The APN name.', 'type' => 'string', 'example' => 'cmiot', 'title' => ''],
+ 'PeriodAddFlow' => ['description' => 'The cumulative data usage in the current period.', 'type' => 'string', 'example' => '130.00MB', 'title' => ''],
+ 'Iccid' => ['description' => 'The ICCID of the sub-card.', 'type' => 'string', 'example' => '89860321******15668', 'title' => ''],
+ 'Vendor' => ['description' => 'The carrier.'."\n"
+ ."\n"
+ .'- **CMCC**: China Mobile.'."\n"
+ ."\n"
+ .'- **CUCC**: China Unicom.'."\n"
+ ."\n"
+ .'- **CTCC**: China Telecom.', 'type' => 'string', 'example' => 'CMCC', 'title' => ''],
+ 'PeriodSmsUse' => ['description' => 'The SMS usage in the current period.', 'type' => 'string', 'example' => '0', 'title' => ''],
'Imsi' => [
- 'items' => [
- 'description' => '',
- 'example' => '460081937******',
- 'type' => 'string',
- ],
+ 'description' => 'The IMSI of the sub-card.',
'type' => 'array',
+ 'items' => ['description' => 'The IMSI of the sub-card.', 'type' => 'string', 'example' => '460081937******', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
'Msisdn' => [
- 'items' => [
- 'description' => '',
- 'example' => '1411111******',
- 'type' => 'string',
- ],
+ 'description' => 'The MSISDN of the sub-card.',
'type' => 'array',
+ 'items' => ['description' => 'The MSISDN of the sub-card.', 'type' => 'string', 'example' => '1411111******', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'OpenSms' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
+ 'OpenSms' => ['description' => 'The SMS function activation status.'."\n"
+ ."\n"
+ .' - **true**: Enabled.'."\n"
+ ."\n"
+ .'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Ip' => [
- 'items' => [
- 'description' => '',
- 'example' => '1.1.*.*',
- 'type' => 'string',
- ],
+ 'description' => 'The IP address of the IoT card.',
'type' => 'array',
+ 'items' => ['description' => 'The IP address of the IoT card.', 'type' => 'string', 'example' => '1.1.*.*', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
'VsimCardInfo' => [
- 'description' => '',
+ 'description' => 'The details of the IoT card.'."\n"
+ ."\n"
+ .'When querying multi-network cards, this displays the virtual card information.',
+ 'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'example' => '35',
- 'type' => 'string',
- ],
- 'DataType' => [
- 'description' => '',
- 'example' => 'sameflowcard',
- 'type' => 'string',
- ],
- 'CardLimitSpeedThreshold' => [
- 'description' => '',
- 'example' => '1024',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PeriodRestFlow' => [
- 'description' => '',
- 'example' => '130.00MB',
- 'type' => 'string',
- ],
- 'DirectionalGroupName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CredentialType' => [
- 'description' => '',
- 'example' => 'CT-SC-M-1-30M',
- 'type' => 'string',
- ],
- 'PeriodAddFlow' => [
- 'description' => '',
- 'example' => '0KB',
- 'type' => 'string',
- ],
- 'DirectionalGroupId' => [
- 'description' => '',
- 'example' => '22',
- 'type' => 'string',
- ],
- 'PeriodSmsUse' => [
- 'description' => '',
- 'example' => '0',
- 'type' => 'string',
- ],
- 'OsStatus' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'NotifyId' => [
- 'description' => '',
- 'example' => '11111',
- 'type' => 'string',
- ],
- 'DataLevel' => [
- 'description' => '',
- 'example' => '30MB',
- 'type' => 'string',
- ],
+ 'Status' => ['description' => 'The status of the IoT card.'."\n"
+ ."\n"
+ .'- **10**: Testable.'."\n"
+ ."\n"
+ .'- **20**: Unused.'."\n"
+ ."\n"
+ .'- **30**: In use.'."\n"
+ ."\n"
+ .'- **35**: Deactivated.'."\n"
+ ."\n"
+ .'- **40**: Suspended.'."\n"
+ ."\n"
+ .'- **50**: Canceled.', 'type' => 'string', 'example' => '35', 'title' => ''],
+ 'DataType' => ['description' => 'The data type.'."\n"
+ ."\n"
+ .'- **singlecard**: Single card general data.'."\n"
+ ."\n"
+ .'- **directionalcard**: Single card directional data.'."\n"
+ ."\n"
+ .'- **sameflowcard**: Same-tier pool shared data.'."\n"
+ ."\n"
+ .'- **directional_sameflowcard**: Same-tier pool shared directional data.'."\n"
+ ."\n"
+ .'- **unityPayPool**: Unified payment pool general data.'."\n"
+ ."\n"
+ .'- **GREcard**: Unified payment pool directional data.', 'type' => 'string', 'example' => 'sameflowcard', 'title' => ''],
+ 'CardLimitSpeedThreshold' => ['description' => 'The data cap speed limit threshold of the IoT card, in KB. (Not supported yet)', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''],
+ 'PeriodRestFlow' => ['description' => 'The remaining data in the current period.', 'type' => 'string', 'example' => '130.00MB', 'title' => ''],
+ 'DirectionalGroupName' => ['description' => 'The directional group name.', 'type' => 'string', 'example' => '测试分组', 'title' => ''],
+ 'CredentialType' => ['description' => 'The plan credential type.'."\n"
+ ."\n"
+ .'- Single card plan example: CT-SC-M-1-30M (Carrier-Plan type-Plan cycle-Pricing version-Data package tier).'."\n"
+ ."\n"
+ .'- Same-tier pool plan example: CM-SF-M-3-100M (Carrier-Plan type-Plan cycle-Pricing version-Data package tier).'."\n"
+ ."\n"
+ .'- Unified payment pool plan example: CU-UPG-M-2-Pool ID (Carrier-Plan type-Plan cycle-Pricing version-Pool ID).', 'type' => 'string', 'example' => 'CT-SC-M-1-30M', 'title' => ''],
+ 'PeriodAddFlow' => ['description' => 'The cumulative data usage in the current period.', 'type' => 'string', 'example' => '0KB', 'title' => ''],
+ 'DirectionalGroupId' => ['description' => 'The directional group ID.', 'type' => 'string', 'example' => '22', 'title' => ''],
+ 'PeriodSmsUse' => ['description' => 'The SMS usage in the current period.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'OsStatus' => ['description' => 'The specific status of the IoT card.'."\n"
+ ."\n"
+ .'- **10**: Testing period.'."\n"
+ ."\n"
+ .'- **20**: Silent period.'."\n"
+ ."\n"
+ .'- **100**: In use.'."\n"
+ ."\n"
+ .'- **150**: Partially in use.'."\n"
+ ."\n"
+ .'- **200**: Voluntarily deactivated.'."\n"
+ ."\n"
+ .'- **300**: Deactivated due to data cap.'."\n"
+ ."\n"
+ .'- **400**: Deactivated due to credit control.'."\n"
+ ."\n"
+ .'- **500**: Deactivated due to rebinding.'."\n"
+ ."\n"
+ .'- **600**: Deactivated due to real-name verification.'."\n"
+ ."\n"
+ .'- **700**: Deactivated due to anomaly.'."\n"
+ ."\n"
+ .'- **40**: Suspended.'."\n"
+ ."\n"
+ .'- **50**: Canceled.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'NotifyId' => ['description' => 'The notification ID of the automation rule.', 'type' => 'string', 'example' => '11111', 'title' => ''],
+ 'DataLevel' => ['description' => 'The data package tier.', 'type' => 'string', 'example' => '30MB', 'title' => ''],
'TagList' => [
- 'description' => '',
- 'example' => '',
+ 'description' => 'The tags of the IoT card.',
+ 'type' => 'array',
'items' => [
+ 'description' => 'The tag list.',
+ 'type' => 'object',
'properties' => [
- 'TagName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Id' => [
- 'description' => '',
- 'example' => '24',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
+ 'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '测试标签', 'title' => ''],
+ 'Id' => ['description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '24', 'title' => ''],
],
- 'type' => 'object',
+ 'example' => 'TestTag',
+ 'title' => '',
],
- 'type' => 'array',
- ],
- 'AliyunOrderId' => [
- 'description' => '',
- 'example' => '211519634******',
- 'type' => 'string',
- ],
- 'AliFee' => [
- 'description' => '',
- 'example' => 'ali_2',
- 'type' => 'string',
- ],
- 'ActiveType' => [
- 'description' => '',
- 'example' => 'first_data_record',
- 'type' => 'string',
- ],
- 'IsAutoRecharge' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'AutoLimitResume' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'CredentialInstanceId' => [
- 'description' => '',
- 'example' => '2622***',
- 'type' => 'string',
- ],
- 'CredentialLimitSpeedThreshold' => [
- 'description' => '',
- 'example' => '1024',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'example' => '2022-04-30 23:59:59',
- 'type' => 'string',
- ],
- 'FlowThresholdUnit' => [
- 'description' => '',
- 'example' => 'KB',
- 'type' => 'string',
- ],
- 'ApnName' => [
- 'description' => '',
- 'example' => 'cmiot',
- 'type' => 'string',
- ],
- 'ActiveTime' => [
- 'description' => '',
- 'example' => '2021-11-16 16:35:50',
- 'type' => 'string',
- ],
- 'CardLimitStopThreshold' => [
- 'description' => '',
- 'example' => '20480',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'Iccid' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'type' => 'string',
- ],
- 'Vendor' => [
- 'description' => '',
- 'example' => 'CMCC',
- 'type' => 'string',
- ],
- 'Period' => [
- 'description' => '',
- 'example' => '1101',
- 'type' => 'string',
- ],
- 'PrivateNetworkSegment' => [
- 'description' => '',
- 'example' => '1.*.3.*',
- 'type' => 'string',
- ],
- 'OpenAccountTime' => [
- 'description' => '',
- 'example' => '2021-11-29 16:12:14',
- 'type' => 'string',
- ],
- 'CertifyType' => [
- 'description' => '',
- 'example' => 'enterprise',
- 'type' => 'string',
- ],
- 'SimType' => [
- 'description' => '',
- 'example' => 'nano',
- 'type' => 'string',
- ],
- 'CertifyStatus' => [
- 'description' => '',
- 'example' => '2',
- 'type' => 'string',
- ],
- 'DeviceImei' => [
- 'description' => '',
- 'example' => '11111111******',
- 'type' => 'string',
- ],
- 'VsimInstanceId' => [
- 'description' => '',
- 'example' => '123456',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'AutoRebindReuse' => [
- 'description' => '',
- 'example' => 'false',
- 'type' => 'boolean',
- ],
- 'CredentialNo' => [
- 'description' => '',
- 'example' => 'CM-***-*-2-**M',
- 'type' => 'string',
- ],
- 'CredentialLimitStopThreshold' => [
- 'description' => '',
- 'example' => '20480',
- 'format' => 'int32',
- 'type' => 'integer',
+ 'example' => '测试标签',
+ 'title' => '',
],
+ 'AliyunOrderId' => ['description' => 'The order ID associated with the IoT card.', 'type' => 'string', 'example' => '211519634******', 'title' => ''],
+ 'AliFee' => ['description' => 'The pricing version.', 'type' => 'string', 'example' => 'ali_2', 'title' => ''],
+ 'ActiveType' => ['description' => 'The activation method.'."\n"
+ ."\n"
+ .'- **first_data_record**: First CDR activation.'."\n"
+ ."\n"
+ .'- **carrier_status_push**: Carrier status push activation.'."\n"
+ ."\n"
+ .'- **silence_expire**: Silent period expiration activation.'."\n"
+ ."\n"
+ .'- **manage**: Manual activation.'."\n"
+ ."\n"
+ .'- **test_flow_depleted**: Test data overage activation.', 'type' => 'string', 'example' => 'first_data_record', 'title' => ''],
+ 'IsAutoRecharge' => ['description' => 'Indicates whether the plan auto-renews.'."\n"
+ ."\n"
+ .'- **true**: Yes.'."\n"
+ ."\n"
+ .'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'AutoLimitResume' => ['description' => 'Indicates whether to automatically resume the next month after data cap deactivation.'."\n"
+ ."\n"
+ .'- **true**: Yes.'."\n"
+ ."\n"
+ .'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'CredentialInstanceId' => ['description' => 'The credential instance ID.', 'type' => 'string', 'example' => '2622***', 'title' => ''],
+ 'CredentialLimitSpeedThreshold' => ['description' => 'The credential data cap speed limit threshold, in KB. (Not supported yet).', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The plan expiration time.', 'type' => 'string', 'example' => '2022-04-30 23:59:59', 'title' => ''],
+ 'FlowThresholdUnit' => ['description' => 'The threshold data unit.', 'type' => 'string', 'example' => 'KB', 'title' => ''],
+ 'ApnName' => ['description' => 'The APN name.', 'type' => 'string', 'example' => 'cmiot', 'title' => ''],
+ 'ActiveTime' => ['description' => 'The activation time.', 'type' => 'string', 'example' => '2021-11-16 16:35:50', 'title' => ''],
+ 'CardLimitStopThreshold' => ['description' => 'The data cap deactivation threshold of the IoT card, in KB. (Not supported yet)', 'type' => 'integer', 'format' => 'int32', 'example' => '20480', 'title' => ''],
+ 'Iccid' => ['description' => 'The ICCID of the IoT card.', 'type' => 'string', 'example' => '89860321******15668', 'title' => ''],
+ 'Vendor' => ['description' => 'The carrier.'."\n"
+ ."\n"
+ .'- **CMCC**: China Mobile.'."\n"
+ ."\n"
+ .'- **CUCC**: China Unicom.'."\n"
+ ."\n"
+ .'- **CTCC**: China Telecom.'."\n"
+ ."\n"
+ .'- **VNO**: Virtual carrier.', 'type' => 'string', 'example' => 'CMCC', 'title' => ''],
+ 'Period' => ['description' => 'The plan billing cycle.'."\n"
+ ."\n"
+ .'- **1101**: Monthly.'."\n"
+ ."\n"
+ .'- **1103**: Quarterly.'."\n"
+ ."\n"
+ .'- **1106**: Semi-annually.'."\n"
+ ."\n"
+ .'- **1112**: Annually.', 'type' => 'string', 'example' => '1101', 'title' => ''],
+ 'PrivateNetworkSegment' => ['description' => 'The private network segment (directional card).', 'type' => 'string', 'example' => '1.*.3.*', 'title' => ''],
+ 'OpenAccountTime' => ['description' => 'The account opening time.', 'type' => 'string', 'example' => '2021-11-29 16:12:14', 'title' => ''],
+ 'CertifyType' => ['description' => 'The authentication method.'."\n"
+ ."\n"
+ .'enterprise: Enterprise authentication.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''],
+ 'SimType' => ['description' => 'The SIM card type.'."\n"
+ ."\n"
+ .'- **nano**: Plug-in triple-cut card (consumer grade).'."\n"
+ ."\n"
+ .'- **micro**: Plug-in dual-cut card (consumer grade).'."\n"
+ ."\n"
+ .'- **normal**: Plug-in standard card (consumer grade).'."\n"
+ ."\n"
+ .'- **simplus56**: Embedded card 5x6 (consumer grade).'."\n"
+ ."\n"
+ .'- **simplus22**: Embedded card 2x2 (consumer grade).'."\n"
+ ."\n"
+ .'- **industry-normal**: Plug-in standard card (industrial grade).'."\n"
+ ."\n"
+ .'- **industry-micro**: Plug-in dual-cut card (industrial grade).'."\n"
+ ."\n"
+ .'- **industry-nano**: Plug-in triple-cut card (industrial grade).'."\n"
+ ."\n"
+ .'- **simplus**: Embedded card 5x6 (industrial grade).'."\n"
+ ."\n"
+ .'- **industry-simplus22**: Embedded card 2x2 (industrial grade).', 'type' => 'string', 'example' => 'nano', 'title' => ''],
+ 'CertifyStatus' => ['description' => 'The real-name authentication status.'."\n"
+ ."\n"
+ .'- **1**: Not authenticated.'."\n"
+ ."\n"
+ .'- **2**: Authenticated.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'DeviceImei' => ['description' => 'The IMEI number of the device.', 'type' => 'string', 'example' => '11111111******', 'title' => ''],
+ 'VsimInstanceId' => ['description' => 'The InstanceId value of the IoT card.', 'type' => 'integer', 'format' => 'int32', 'example' => '123456', 'title' => ''],
+ 'AutoRebindReuse' => ['description' => 'The auto rebinding reuse status.'."\n"
+ ."\n"
+ .'- **true**: Enabled.'."\n"
+ ."\n"
+ .'- **false**: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'CredentialNo' => ['description' => 'The plan credential.', 'type' => 'string', 'example' => 'CM-***-*-2-**M', 'title' => ''],
+ 'CredentialLimitStopThreshold' => ['description' => 'The credential data cap deactivation threshold.', 'type' => 'integer', 'format' => 'int32', 'example' => '20480', 'title' => ''],
'Imsi' => [
- 'items' => [
- 'description' => '',
- 'example' => '460081937******',
- 'type' => 'string',
- ],
+ 'description' => 'The IMSI of the IoT card.',
'type' => 'array',
+ 'items' => ['description' => 'The IMSI of the IoT card.', 'type' => 'string', 'example' => '460081937******', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
'Msisdn' => [
- 'items' => [
- 'description' => '',
- 'example' => '1440993******',
- 'type' => 'string',
- ],
+ 'description' => 'The MSISDN of the IoT card.',
'type' => 'array',
+ 'items' => ['description' => 'The MSISDN of the IoT card.', 'type' => 'string', 'example' => '1440993******', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'OpenSms' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
+ 'OpenSms' => ['description' => 'The SMS function activation status.'."\n"
+ ."\n"
+ .'- true: Enabled.'."\n"
+ ."\n"
+ .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Ip' => [
- 'items' => [
- 'description' => '',
- 'example' => '190.*.*.*',
- 'type' => 'string',
- ],
+ 'description' => 'The IP address of the IoT card.',
'type' => 'array',
+ 'items' => ['description' => 'The IP address of the IoT card.', 'type' => 'string', 'example' => '190.*.*.*', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.check.InstanceIdCanNotEmpty',
- 'errorMessage' => 'InstanceId cannot be empty.',
- ],
- [
- 'errorCode' => 'linkcard.check.IccidCanNotEmpty',
- 'errorMessage' => 'Iccid cannot be empty.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardNotExist',
- 'errorMessage' => 'The card does not exist.',
- ],
- [
- 'errorCode' => 'CardDisabled',
- 'errorMessage' => 'The SIM card has been permanently disabled.',
- ],
+ ['errorCode' => 'linkcard.check.InstanceIdCanNotEmpty', 'errorMessage' => 'InstanceId cannot be empty.', 'description' => 'InstanceId cannot be empty.'],
+ ['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => 'Iccid cannot be empty.'],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.CardNotExist', 'errorMessage' => 'The card does not exist.', 'description' => ''],
+ ['errorCode' => 'CardDisabled', 'errorMessage' => 'The SIM card has been permanently disabled.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.common.BusinessProcessError',
- 'errorMessage' => 'A business processing exception occurred.',
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => 'linkcard.common.BusinessProcessError'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"ListPsimCards\\": [\\n {\\n \\"Status\\": \\"35\\",\\n \\"PrivateNetworkSegment\\": \\"*.2.*.4\\",\\n \\"OsStatus\\": \\"300\\",\\n \\"CertifyStatus\\": \\"2\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"PeriodAddFlow\\": \\"130.00MB\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1411111******\\"\\n ],\\n \\"OpenSms\\": true,\\n \\"Ip\\": [\\n \\"1.1.*.*\\"\\n ]\\n }\\n ],\\n \\"VsimCardInfo\\": {\\n \\"Status\\": \\"35\\",\\n \\"DataType\\": \\"sameflowcard\\",\\n \\"CardLimitSpeedThreshold\\": 1024,\\n \\"PeriodRestFlow\\": \\"130.00MB\\",\\n \\"DirectionalGroupName\\": \\"测试分组\\",\\n \\"CredentialType\\": \\"CT-SC-M-1-30M\\",\\n \\"PeriodAddFlow\\": \\"0KB\\",\\n \\"DirectionalGroupId\\": \\"22\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"OsStatus\\": \\"200\\",\\n \\"NotifyId\\": \\"11111\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"TagList\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"Id\\": 24\\n }\\n ],\\n \\"AliyunOrderId\\": \\"211519634******\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"ActiveType\\": \\"first_data_record\\",\\n \\"IsAutoRecharge\\": true,\\n \\"AutoLimitResume\\": true,\\n \\"CredentialInstanceId\\": \\"2622***\\",\\n \\"CredentialLimitSpeedThreshold\\": 1024,\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\",\\n \\"FlowThresholdUnit\\": \\"KB\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"ActiveTime\\": \\"2021-11-16 16:35:50\\",\\n \\"CardLimitStopThreshold\\": 20480,\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"Period\\": \\"1101\\",\\n \\"PrivateNetworkSegment\\": \\"1.*.3.*\\",\\n \\"OpenAccountTime\\": \\"2021-11-29 16:12:14\\",\\n \\"CertifyType\\": \\"enterprise\\",\\n \\"SimType\\": \\"nano\\",\\n \\"CertifyStatus\\": \\"2\\",\\n \\"DeviceImei\\": \\"11111111******\\",\\n \\"VsimInstanceId\\": 123456,\\n \\"AutoRebindReuse\\": false,\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"CredentialLimitStopThreshold\\": 20480,\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1440993******\\"\\n ],\\n \\"OpenSms\\": true,\\n \\"Ip\\": [\\n \\"190.*.*.*\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Query Card Details',
+ 'description' => '## Throttling'."\n"
+ ."\n\n"
+ .'The maximum queries per second (QPS) for a single Alibaba Cloud account calling this API is 20.'."\n"
+ ."\n"
+ .'> RAM users share the Alibaba Cloud account quota.',
+ 'requestParamsDescription' => ' When calling this API, in addition to the request parameters specific to this API described here, you also need to include common request parameters. For details about common request parameters, see [Common Parameters](~~375336~~).',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-03-06T05:41:12.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-12-08T06:04:15.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-01-20T05:58:48.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardDetail'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"ListPsimCards\\": [\\n {\\n \\"Status\\": \\"35\\",\\n \\"PrivateNetworkSegment\\": \\"*.2.*.4\\",\\n \\"OsStatus\\": \\"300\\",\\n \\"CertifyStatus\\": \\"2\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"PeriodAddFlow\\": \\"130.00MB\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1411111******\\"\\n ],\\n \\"OpenSms\\": true,\\n \\"Ip\\": [\\n \\"1.1.*.*\\"\\n ]\\n }\\n ],\\n \\"VsimCardInfo\\": {\\n \\"Status\\": \\"35\\",\\n \\"DataType\\": \\"sameflowcard\\",\\n \\"CardLimitSpeedThreshold\\": 1024,\\n \\"PeriodRestFlow\\": \\"130.00MB\\",\\n \\"DirectionalGroupName\\": \\"测试分组\\",\\n \\"CredentialType\\": \\"CT-SC-M-1-30M\\",\\n \\"PeriodAddFlow\\": \\"0KB\\",\\n \\"DirectionalGroupId\\": \\"22\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"OsStatus\\": \\"200\\",\\n \\"NotifyId\\": \\"11111\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"TagList\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"Id\\": 24\\n }\\n ],\\n \\"AliyunOrderId\\": \\"211519634******\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"ActiveType\\": \\"first_data_record\\",\\n \\"IsAutoRecharge\\": true,\\n \\"AutoLimitResume\\": true,\\n \\"CredentialInstanceId\\": \\"2622***\\",\\n \\"CredentialLimitSpeedThreshold\\": 1024,\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\",\\n \\"FlowThresholdUnit\\": \\"KB\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"ActiveTime\\": \\"2021-11-16 16:35:50\\",\\n \\"CardLimitStopThreshold\\": 20480,\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"Period\\": \\"1101\\",\\n \\"PrivateNetworkSegment\\": \\"1.*.3.*\\",\\n \\"OpenAccountTime\\": \\"2021-11-29 16:12:14\\",\\n \\"CertifyType\\": \\"enterprise\\",\\n \\"SimType\\": \\"nano\\",\\n \\"CertifyStatus\\": \\"2\\",\\n \\"DeviceImei\\": \\"11111111******\\",\\n \\"VsimInstanceId\\": 123456,\\n \\"AutoRebindReuse\\": false,\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"CredentialLimitStopThreshold\\": 20480,\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1440993******\\"\\n ],\\n \\"OpenSms\\": true,\\n \\"Ip\\": [\\n \\"190.*.*.*\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCardDetailResponse>\\n <Code>200</Code>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <ListPsimCards>\\n <Status>35</Status>\\n <PrivateNetworkSegment>*.2.*.4</PrivateNetworkSegment>\\n <OsStatus>300</OsStatus>\\n <CertifyStatus>2</CertifyStatus>\\n <ApnName>cmiot</ApnName>\\n <PeriodAddFlow>130.00MB</PeriodAddFlow>\\n <Iccid>89860321******15668</Iccid>\\n <Vendor>CMCC</Vendor>\\n <PeriodSmsUse>0</PeriodSmsUse>\\n <Imsi>460081937******</Imsi>\\n <Msisdn>1411111******</Msisdn>\\n <OpenSms>true</OpenSms>\\n <Ip>1.1.*.*</Ip>\\n </ListPsimCards>\\n <VsimCardInfo>\\n <Status>35</Status>\\n <DataType>sameflowcard</DataType>\\n <CardLimitSpeedThreshold>1024</CardLimitSpeedThreshold>\\n <PeriodRestFlow>130.00MB</PeriodRestFlow>\\n <DirectionalGroupName>测试分组</DirectionalGroupName>\\n <CredentialType>CT-SC-M-1-30M</CredentialType>\\n <PeriodAddFlow>0KB</PeriodAddFlow>\\n <DirectionalGroupId>22</DirectionalGroupId>\\n <PeriodSmsUse>0</PeriodSmsUse>\\n <OsStatus>200</OsStatus>\\n <NotifyId>11111</NotifyId>\\n <DataLevel>30MB</DataLevel>\\n <TagList>\\n <TagName>测试标签</TagName>\\n <Id>24</Id>\\n </TagList>\\n <AliyunOrderId>211519634******</AliyunOrderId>\\n <AliFee>ali_2</AliFee>\\n <ActiveType>first_data_record</ActiveType>\\n <IsAutoRecharge>true</IsAutoRecharge>\\n <AutoLimitResume>true</AutoLimitResume>\\n <CredentialInstanceId>2622***</CredentialInstanceId>\\n <CredentialLimitSpeedThreshold>1024</CredentialLimitSpeedThreshold>\\n <ExpireTime>2022-04-30 23:59:59</ExpireTime>\\n <FlowThresholdUnit>KB</FlowThresholdUnit>\\n <ApnName>cmiot</ApnName>\\n <ActiveTime>2021-11-16 16:35:50</ActiveTime>\\n <CardLimitStopThreshold>20480</CardLimitStopThreshold>\\n <Iccid>89860321******15668</Iccid>\\n <Vendor>CMCC</Vendor>\\n <Period>1101</Period>\\n <PrivateNetworkSegment>1.*.3.*</PrivateNetworkSegment>\\n <OpenAccountTime>2021-11-29 16:12:14</OpenAccountTime>\\n <CertifyType>enterprise</CertifyType>\\n <SimType>nano</SimType>\\n <CertifyStatus>2</CertifyStatus>\\n <DeviceImei>11111111******</DeviceImei>\\n <VsimInstanceId>123456</VsimInstanceId>\\n <AutoRebindReuse>false</AutoRebindReuse>\\n <CredentialNo>CM-***-*-2-**M</CredentialNo>\\n <CredentialLimitStopThreshold>20480</CredentialLimitStopThreshold>\\n <Imsi>460081937******</Imsi>\\n <Msisdn>1440993******</Msisdn>\\n <OpenSms>true</OpenSms>\\n <Ip>190.*.*.*</Ip>\\n </VsimCardInfo>\\n </Data>\\n</GetCardDetailResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'GetCardDetail',
],
- 'ListCardInfo' => [
- 'summary' => '卡列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetCardFlowInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ActiveTimeEnd',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '2022-05-25 23:59:59',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '10',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
- ],
- [
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'CredentialNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'CM-***-*-2-**M',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'Vendor',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'CMCC',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'PageNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '1',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
- ],
- [
- 'name' => 'Msisdn',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '1440993******',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'AliyunOrderId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '211519634******',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'AliFee',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'ali_2',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'Period',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '1101',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'DataType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'sameflowcard',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ActiveTimeStart',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '2022-05-25 23:59:59',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'SimType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'nano',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ExpireTimeEnd',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '2022-05-25 23:59:59',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'IsAutoRecharge',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'type' => 'boolean',
- ],
- ],
- [
- 'name' => 'ExpireTimeStart',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '2022-05-25 23:59:59',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'OsStatus',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '300',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'NotifyId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '11111',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'DataLevel',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '30MB',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card or on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '35',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'TagName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'CertifyType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'enterprise',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'DirectionalGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '22',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ApnName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'cmiot',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'Imsi',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '460081937******',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'PoolId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'test1',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'MinFlow',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '20',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'MaxFlow',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '30',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'MaxRestFlowPercentage',
+ 'name' => 'DateList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'example' => '0.2',
- 'format' => 'double',
+ 'description' => 'The months to query.'."\n"
+ ."\n"
+ .'You can query up to 6 months. If this parameter is left empty, data of the most recent 2 months is returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The months to query.'."\n"
+ ."\n"
+ .'You can query up to 6 months. If this parameter is left empty, data of the most recent 2 months is returned.', 'type' => 'string', 'required' => false, 'example' => '["202110","202111"]', 'title' => ''],
'required' => false,
- 'type' => 'number',
- ],
- ],
- [
- 'name' => 'NetworkType',
- 'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'type' => 'string',
+ 'example' => '["202110","202111"]',
+ 'maxItems' => 5,
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- **200**: success.'."\n"
+ .'- Other values: error codes. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID, which is the identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language of the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The traffic information of the IoT card.',
+ 'type' => 'object',
'properties' => [
- 'PageNo' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'Total' => [
- 'description' => '',
- 'example' => '199',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'List' => [
- 'description' => '',
+ 'ListVendorDetail' => [
+ 'description' => 'The network data.',
+ 'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NetWorkDelay' => ['description' => 'The network latency, in ms.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'SignalStrength' => ['description' => 'The signal strength.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'Vendor' => ['description' => 'The carrier of the IoT card. Valid values:'."\n"
+ .'- CMCC: China Mobile.'."\n"
+ .'- CUCC: China Unicom.'."\n"
+ .'- CTCC: China Telecom.', 'type' => 'string', 'example' => 'CMCC', 'title' => ''],
+ 'UsedFlow' => ['description' => 'The used traffic.', 'type' => 'string', 'example' => '100MB', 'title' => ''],
+ 'Ratio' => ['description' => 'The usage ratio.', 'type' => 'string', 'example' => '80%', 'title' => ''],
+ ],
'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ListCardMonthFlow' => [
+ 'description' => 'The monthly usage details.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'example' => '35',
- 'type' => 'string',
- ],
- 'DataType' => [
- 'description' => '',
- 'example' => 'sameflowcard',
- 'type' => 'string',
- ],
- 'DirectionalGroupName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'PeriodRestFlow' => [
- 'description' => '',
- 'example' => '130.00MB',
- 'type' => 'string',
- ],
- 'CredentialType' => [
- 'description' => '',
- 'example' => 'unityPayPool',
- 'type' => 'string',
- ],
- 'PeriodAddFlow' => [
- 'description' => '',
- 'example' => '0KB',
- 'type' => 'string',
- ],
- 'PeriodSmsUse' => [
- 'description' => '',
- 'example' => '0',
- 'type' => 'string',
- ],
- 'DataLevel' => [
- 'description' => '',
- 'example' => '30MB',
- 'type' => 'string',
- ],
- 'OsStatus' => [
- 'description' => '',
- 'example' => '300',
- 'type' => 'string',
- ],
- 'NotifyId' => [
- 'description' => '',
- 'example' => '11111',
- 'type' => 'string',
- ],
- 'AliFee' => [
- 'description' => '',
- 'example' => 'ali_2',
- 'type' => 'string',
- ],
- 'AliyunOrderId' => [
- 'description' => '',
- 'example' => '211519634******',
- 'type' => 'string',
- ],
- 'ActiveType' => [
- 'description' => '',
- 'example' => 'first_data_record',
- 'type' => 'string',
- ],
- 'IsAutoRecharge' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'CredentialInstanceId' => [
- 'description' => '',
- 'example' => '2622***',
- 'type' => 'string',
- ],
- 'ExpireTime' => [
- 'description' => '',
- 'example' => '2022-04-30 23:59:59',
- 'type' => 'string',
- ],
- 'ApnName' => [
- 'description' => '',
- 'example' => 'cmiot',
- 'type' => 'string',
- ],
- 'ActiveTime' => [
- 'description' => '',
- 'example' => '2021-11-16 16:35:50',
- 'type' => 'string',
- ],
- 'Iccid' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'type' => 'string',
- ],
- 'Vendor' => [
- 'description' => '',
- 'example' => 'CMCC',
- 'type' => 'string',
- ],
- 'Period' => [
- 'description' => '',
- 'example' => '1101',
- 'type' => 'string',
- ],
- 'CertifyType' => [
- 'description' => '',
- 'example' => 'enterprise',
- 'type' => 'string',
- ],
- 'PrivateNetworkSegment' => [
- 'description' => '',
- 'example' => '1.*.3.*',
- 'type' => 'string',
- ],
- 'OpenAccountTime' => [
- 'description' => '',
- 'example' => '2021-11-29 16:12:14',
- 'type' => 'string',
- ],
- 'SimType' => [
- 'description' => '',
- 'example' => 'nano',
- 'type' => 'string',
- ],
- 'VsimInstanceId' => [
- 'description' => '',
- 'example' => '123456',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'CredentialNo' => [
- 'description' => '',
- 'example' => 'CM-***-*-2-**M',
- 'type' => 'string',
- ],
- 'TagList' => [
- 'description' => '',
+ 'FlowCount' => ['description' => 'The total monthly traffic.', 'type' => 'string', 'example' => '200MB', 'title' => ''],
+ 'Month' => ['description' => 'The month of the traffic.', 'type' => 'string', 'example' => '202112', 'title' => ''],
+ 'ListDayFlow' => [
+ 'description' => 'The daily usage.',
+ 'type' => 'array',
'items' => [
- 'description' => '',
+ 'type' => 'object',
'properties' => [
- 'TagName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Id' => [
- 'description' => '',
- 'example' => '24',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
+ 'Flow' => ['description' => 'The daily usage.', 'type' => 'string', 'example' => '100MB', 'title' => ''],
+ 'Day' => ['description' => 'The date of the traffic.', 'type' => 'string', 'example' => '20211201', 'title' => ''],
],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- 'Imsi' => [
- 'description' => '',
- 'items' => [
'description' => '',
- 'example' => '460081937******',
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'array',
- ],
- 'Msisdn' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '1440993******',
- 'type' => 'string',
- ],
- 'type' => 'array',
- ],
- 'Remark' => [
- 'description' => '',
+ 'title' => '',
'example' => '',
- 'type' => 'string',
- ],
- 'DirectionalGroupId' => [
- 'description' => '',
- 'example' => '55',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'NetworkType' => [
- 'type' => 'string',
- ],
- 'FlowLatestModifiedTime' => [
- 'type' => 'string',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ListPackageDTO' => [
+ 'description' => 'The package information.',
'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EffectiveTime' => ['description' => 'The effective period of the package.', 'type' => 'string', 'example' => '2022-03-20 23:59:59', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '备注内容', 'title' => ''],
+ 'PackageName' => ['description' => 'The package name.', 'type' => 'string', 'example' => '移动-单卡通用流量-月包-30M', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The time when the package expires.', 'type' => 'string', 'example' => '2022-04-30 23:59:59', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.common.InvalidAliyunPK',
- 'errorMessage' => 'AliyunPk is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => 'Iccid cannot be empty.'],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.CardNotExist', 'errorMessage' => 'The card does not exist.', 'description' => ''],
+ ['errorCode' => 'CardDisabled', 'errorMessage' => 'The SIM card has been permanently disabled.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.common.BusinessProcessError',
- 'errorMessage' => 'A business processing exception occurred.',
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"ListVendorDetail\\": [\\n {\\n \\"NetWorkDelay\\": \\"20\\",\\n \\"SignalStrength\\": \\"20\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"UsedFlow\\": \\"100MB\\",\\n \\"Ratio\\": \\"80%\\"\\n }\\n ],\\n \\"ListCardMonthFlow\\": [\\n {\\n \\"FlowCount\\": \\"200MB\\",\\n \\"Month\\": \\"202112\\",\\n \\"ListDayFlow\\": [\\n {\\n \\"Flow\\": \\"100MB\\",\\n \\"Day\\": \\"20211201\\"\\n }\\n ]\\n }\\n ],\\n \\"ListPackageDTO\\": [\\n {\\n \\"EffectiveTime\\": \\"2022-03-20 23:59:59\\",\\n \\"Remark\\": \\"备注内容\\",\\n \\"PackageName\\": \\"移动-单卡通用流量-月包-30M\\",\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Query card traffic',
+ 'summary' => 'Queries the traffic information of a card.',
+ 'description' => '## Before you begin'."\n"
+ ."\n\n"
+ .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 20.'."\n"
+ ."\n"
+ .'> Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.',
+ 'requestParamsDescription' => 'When you invoke this operation, in addition to the operation-specific request parameters described in this topic, you must also specify common request parameters. For the metric description of common request parameters, see [Common parameters](~~375336~~).',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-03-06T05:41:12.000Z', 'description' => 'Error codes changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardFlowInfo'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardFlowInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 20,\\n \\"Total\\": 199,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"35\\",\\n \\"DataType\\": \\"sameflowcard\\",\\n \\"DirectionalGroupName\\": \\"测试分组\\",\\n \\"PeriodRestFlow\\": \\"130.00MB\\",\\n \\"CredentialType\\": \\"unityPayPool\\",\\n \\"PeriodAddFlow\\": \\"0KB\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"OsStatus\\": \\"300\\",\\n \\"NotifyId\\": \\"11111\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"AliyunOrderId\\": \\"211519634******\\",\\n \\"ActiveType\\": \\"first_data_record\\",\\n \\"IsAutoRecharge\\": true,\\n \\"CredentialInstanceId\\": \\"2622***\\",\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"ActiveTime\\": \\"2021-11-16 16:35:50\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"Period\\": \\"1101\\",\\n \\"CertifyType\\": \\"enterprise\\",\\n \\"PrivateNetworkSegment\\": \\"1.*.3.*\\",\\n \\"OpenAccountTime\\": \\"2021-11-29 16:12:14\\",\\n \\"SimType\\": \\"nano\\",\\n \\"VsimInstanceId\\": 123456,\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"TagList\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"Id\\": 24\\n }\\n ],\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1440993******\\"\\n ],\\n \\"Remark\\": \\"备注信息\\",\\n \\"DirectionalGroupId\\": 55,\\n \\"NetworkType\\": \\"4G\\",\\n \\"FlowLatestModifiedTime\\": \\"2023-08-15 18:20:11\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCardInfoResponse>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <PageCount>20</PageCount>\\n <Total>199</Total>\\n <List>\\n <Status>35</Status>\\n <DataType>sameflowcard</DataType>\\n <DirectionalGroupName>测试分组</DirectionalGroupName>\\n <PeriodRestFlow>130.00MB</PeriodRestFlow>\\n <CredentialType>unityPayPool</CredentialType>\\n <PeriodAddFlow>0KB</PeriodAddFlow>\\n <PeriodSmsUse>0</PeriodSmsUse>\\n <DataLevel>30MB</DataLevel>\\n <OsStatus>300</OsStatus>\\n <NotifyId>11111</NotifyId>\\n <AliFee>ali_2</AliFee>\\n <AliyunOrderId>211519634******</AliyunOrderId>\\n <ActiveType>first_data_record</ActiveType>\\n <IsAutoRecharge>true</IsAutoRecharge>\\n <CredentialInstanceId>2622***</CredentialInstanceId>\\n <ExpireTime>2022-04-30 23:59:59</ExpireTime>\\n <ApnName>cmiot</ApnName>\\n <ActiveTime>2021-11-16 16:35:50</ActiveTime>\\n <Iccid>89860321******15668</Iccid>\\n <Vendor>CMCC</Vendor>\\n <Period>1101</Period>\\n <CertifyType>enterprise</CertifyType>\\n <PrivateNetworkSegment>1.*.3.*</PrivateNetworkSegment>\\n <OpenAccountTime>2021-11-29 16:12:14</OpenAccountTime>\\n <SimType>nano</SimType>\\n <VsimInstanceId>123456</VsimInstanceId>\\n <CredentialNo>CM-***-*-2-**M</CredentialNo>\\n <TagList>\\n <TagName>测试标签</TagName>\\n <Id>24</Id>\\n </TagList>\\n <Imsi>460081937******</Imsi>\\n <Msisdn>1440993******</Msisdn>\\n <Remark>备注信息</Remark>\\n <DirectionalGroupId>55</DirectionalGroupId>\\n </List>\\n </Data>\\n</ListCardInfoResponse>","errorExample":""}]',
- 'title' => 'ListCardInfo',
],
- 'ListOrder' => [
- 'summary' => '订单列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetCardLatestFlow' => [
+ 'summary' => 'This API is used to query the real-time cycle usage of an IoT card.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -2586,799 +1679,1283 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'OrderId',
+ 'name' => 'Iccid',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card, or on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/sim/card).', 'type' => 'string', 'required' => true, 'example' => '89860321******15668'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
'schema' => [
- 'description' => '',
- 'example' => '21450******0275',
- 'required' => false,
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'GetCardLatestFlowResponse',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID. It is a unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'true: The call was successful.'."\n"
+ .'false: The call failed.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'200: The call was successful.'."\n"
+ ."\n"
+ .'Other values indicate an error code. For more information about error codes, see Error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Data' => ['description' => 'The real-time cycle usage, with the data usage unit included.', 'type' => 'string', 'example' => '1.00MB', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.IccidNotExist', 'errorMessage' => 'IccId does not exist.', 'description' => 'Iccid not exist.'],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ],
+ 500 => [
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": \\"1.00MB\\"\\n}","type":"json"}]',
+ 'title' => 'GetCardLatestFlow',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardLatestFlow'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '2022-04-05',
- 'required' => false,
- 'type' => 'string',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardLatestFlow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:cardmanage/{#cardmanageId}'],
+ ],
],
],
+ ],
+ ],
+ 'GetCardRealStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- 'name' => 'EndDate',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '2022-04-05',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can find the ICCID on the IoT card itself or on the Card Management page of the IoT SIM Service console.', 'type' => 'string', 'required' => false, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'OrderType',
+ 'name' => 'Msisdn',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'NEW',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The MSISDN of the IoT card.', 'type' => 'string', 'required' => false, 'example' => '144******1111', 'title' => ''],
],
[
- 'name' => 'OrderStatus',
+ 'name' => 'SerialNo',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'example' => 'processing',
+ 'description' => 'The unique identifier for polling query results.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The unique identifier for polling query results.'."\n"
+ ."\n"
+ .'Note:'."\n"
+ ."\n"
+ .'1. Because the carrier capability of this operation is limited and query results take time, use this operation with the polling mechanism.'."\n"
+ ."\n"
+ .'2. After the first request, if Status is not successful, this value is returned in the response parameters. Use this value to poll for results.', 'type' => 'string', 'required' => false, 'example' => '4f84******7895', 'title' => ''],
'required' => false,
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'PageNo',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '1',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
+ 'title' => '',
+ 'description' => 'GetCardRealStatusResponse',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => 'The return code of the operation.'."\n"
+ ."\n"
+ .'200: The call was successful. Other values: An error occurred. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SerialNo' => ['description' => 'The unique identifier for polling query results.'."\n"
+ ."\n"
+ .'Note:'."\n"
+ ."\n"
+ .'1. Because the carrier capability of this operation is limited and query results take time, use this operation with the polling mechanism.'."\n"
+ ."\n"
+ .'2. After the first request, if Status is not successful, this value is returned in the response parameters. Use this value to poll for results.', 'type' => 'string', 'example' => '4f84******7895', 'title' => ''],
+ 'Iccid' => ['description' => 'The ICCID of the card. If the requested ICCID is the primary card of a multi-network card, the ICCID of the secondary card is returned.', 'type' => 'string', 'example' => '89860321******15668', 'title' => ''],
+ 'Gprs' => ['description' => 'The network service status.'."\n"
+ ."\n"
+ .'true: Enabled.'."\n"
+ ."\n"
+ .'false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Online' => ['description' => 'The online status.'."\n"
+ ."\n"
+ .'true: Online.'."\n"
+ ."\n"
+ .'false: Offline.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Status' => ['description' => 'The status of the query result. Valid values: '."\n"
+ ."\n"
+ .'SUCCESS: The query was successful.'."\n"
+ ."\n"
+ .'FAILURE: The query failed.'."\n"
+ ."\n"
+ .'PROCESSING: The query is being processed.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '10',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ],
+ 403 => [
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => 'linkcard.common.BusinessProcessError'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": [\\n {\\n \\"SerialNo\\": \\"4f84******7895\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Gprs\\": true,\\n \\"Online\\": true,\\n \\"Status\\": \\"SUCCESS\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Intelligent diagnostics - query card status on carrier side',
+ 'summary' => 'Queries the status of an IoT card on the carrier side through intelligent diagnostics.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardRealStatus'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardRealStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetCardStatusStatistics' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
+ 'security' => [
[
- 'name' => 'CredentialNo',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'AK' => [],
],
],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'200: Success.'."\n"
+ .'Other values: Error codes. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ ."\n"
+ .'true: The call is successful.'."\n"
+ .'false: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.',
+ 'type' => 'object',
'properties' => [
- 'PageNo' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
+ 'UnbindResumeStatisticsDTO' => [
+ 'description' => 'The statistics on cards deactivated due to rebinding.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolCount' => ['description' => 'The number of pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'SingleCardCount' => ['description' => 'The number of single-card plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'SameFlowCardCount' => ['description' => 'The number of same-tier pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'PageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
+ 'FlowOutStatisticsDTO' => [
+ 'description' => 'The statistics on cards deactivated due to credit-based payment control.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolCount' => ['description' => 'The number of pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'SingleCardCount' => ['description' => 'The number of single-card plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'SameFlowCardCount' => ['description' => 'The number of same-tier pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'PageCount' => [
- 'description' => '',
- 'example' => '5',
- 'format' => 'int32',
- 'type' => 'integer',
+ 'ErrorStopStatisticsDTO' => [
+ 'description' => 'The statistics on cards deactivated due to exceptions.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolCount' => ['description' => 'The number of pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'SingleCardCount' => ['description' => 'The number of single-card plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'SameFlowCardCount' => ['description' => 'The number of same-tier pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'Total' => [
- 'description' => '',
- 'example' => '48',
- 'format' => 'int32',
- 'type' => 'integer',
+ 'ExhaustStopStatisticsDTO' => [
+ 'description' => 'The statistics on cards deactivated due to data usage limit reached.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolCount' => ['description' => 'The number of pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'SingleCardCount' => ['description' => 'The number of single-card plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'SameFlowCardCount' => ['description' => 'The number of same-tier pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'List' => [
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'BillingCycle' => [
- 'description' => '',
- 'example' => '1101',
- 'type' => 'string',
- ],
- 'BuyNum' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PoolCapacityUnit' => [
- 'description' => '',
- 'example' => 'GB',
- 'type' => 'string',
- ],
- 'CardPayCount' => [
- 'description' => '',
- 'example' => '2022-04-11 16:43:00',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'CredentialPackage' => [
- 'description' => '',
- 'example' => 'AL-UPG-******3_beika4',
- 'type' => 'string',
- ],
- 'Vendor' => [
- 'description' => '',
- 'example' => 'CMCC',
- 'type' => 'string',
- ],
- 'DataLevel' => [
- 'description' => '',
- 'example' => '30MB',
- 'type' => 'string',
- ],
- 'PayDuration' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'AliFee' => [
- 'description' => '',
- 'example' => 'ali_2',
- 'type' => 'string',
- ],
- 'OrderStatus' => [
- 'description' => '',
- 'example' => 'processing',
- 'type' => 'string',
- ],
- 'PoolNo' => [
- 'description' => '',
- 'example' => 'beika4',
- 'type' => 'string',
- ],
- 'FunctionFee' => [
- 'description' => '',
- 'example' => '90',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PayTime' => [
- 'description' => '',
- 'example' => '2022-04-11 16:43:00',
- 'type' => 'string',
- ],
- 'FlowType' => [
- 'description' => '',
- 'example' => 'singlecard',
- 'type' => 'string',
- ],
- 'PoolCapacity' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'OrderInfo' => [
- 'description' => '',
- 'example' => '123123',
- 'type' => 'string',
- ],
- 'OrderType' => [
- 'description' => '',
- 'example' => 'NEW',
- 'type' => 'string',
- ],
- 'OrderId' => [
- 'description' => '',
- 'example' => '21450******0275',
- 'type' => 'string',
- ],
- 'CredentialNo' => [
- 'description' => '',
- 'example' => 'CM-***-*-2-**M',
- 'type' => 'string',
- ],
- 'ExpressNoList' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '123123123',
- 'type' => 'string',
- ],
- 'type' => 'array',
- ],
- 'DeliveryInfo' => [
- 'description' => '',
- 'properties' => [
- 'ZipCode' => [
- 'description' => '',
- 'example' => '100000',
- 'type' => 'string',
- ],
- 'Address' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Mail' => [
- 'description' => '',
- 'example' => 'xxx@xxx.com',
- 'type' => 'string',
- ],
- 'Receiver' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'BuyerMessage' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'OrderDetailUrl' => [
- 'description' => '',
- 'example' => 'https://us******60589',
- 'type' => 'string',
- ],
- 'ApnName' => [
- 'type' => 'string',
- ],
- 'ApnRegion' => [
- 'type' => 'string',
- ],
- 'ResourceQuantity' => [
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'NetworkType' => [
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
+ 'UnCertifiedStopStatisticsDTO' => [
+ 'description' => 'The statistics on cards deactivated due to incomplete real-name verification.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolCount' => ['description' => 'The number of pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'SingleCardCount' => ['description' => 'The number of single-card plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'SameFlowCardCount' => ['description' => 'The number of same-tier pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
],
- 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ManageStopStatisticsDTO' => [
+ 'description' => 'The statistics on cards manually deactivated.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolCount' => ['description' => 'The number of pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'SingleCardCount' => ['description' => 'The number of single-card plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'SameFlowCardCount' => ['description' => 'The number of same-tier pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ExpireStopStatisticsDTO' => [
+ 'description' => 'The statistics on cards suspended due to plan expiration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolCount' => ['description' => 'The number of pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'SingleCardCount' => ['description' => 'The number of single-card plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'SameFlowCardCount' => ['description' => 'The number of same-tier pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'WeekWarnStatisticsDTO' => [
+ 'description' => 'The statistics on alerts for plans expiring within 7 days.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolCount' => ['description' => 'The number of pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'SingleCardCount' => ['description' => 'The number of single-card plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'SameFlowCardCount' => ['description' => 'The number of same-tier pooled plan cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RiskWaringStatisticsDTO' => [
+ 'description' => 'The risk alert statistics. The data is consistent with the risk alert section in the console.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WarningCount' => ['description' => 'The number of expiration alerts. Plans expiring within 7 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'WaringTotalCount' => ['description' => 'The total number of alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'StopCount' => ['description' => 'The number of suspended or deactivated cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''],
+ 'LeftFlowPercentageWarnCount' => ['description' => 'The number of remaining data alerts. Single-card plan remaining data is less than 10%.', 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SingCardPeriodLeftFlowWarnDTO' => [
+ 'description' => 'The statistics on insufficient plan remaining data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LessFlowPercentage10Count' => ['description' => 'The number of alerts for single-card periodic plans with less than 10% remaining data.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'LessFlowPercentage30Count' => ['description' => 'The number of alerts for single-card periodic plans with less than 30% remaining data.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.InvalidAliyunPK',
- 'errorMessage' => 'AliyunPk is invalid.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.common.BusinessProcessError',
- 'errorMessage' => 'A business processing exception occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 5,\\n \\"Total\\": 48,\\n \\"List\\": [\\n {\\n \\"BillingCycle\\": \\"1101\\",\\n \\"BuyNum\\": 100,\\n \\"PoolCapacityUnit\\": \\"GB\\",\\n \\"CardPayCount\\": 0,\\n \\"CredentialPackage\\": \\"AL-UPG-******3_beika4\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"PayDuration\\": \\"12月\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"OrderStatus\\": \\"processing\\",\\n \\"PoolNo\\": \\"beika4\\",\\n \\"FunctionFee\\": 90,\\n \\"PayTime\\": \\"2022-04-11 16:43:00\\",\\n \\"FlowType\\": \\"singlecard\\",\\n \\"PoolCapacity\\": \\"200\\",\\n \\"OrderInfo\\": \\"123123\\",\\n \\"OrderType\\": \\"NEW\\",\\n \\"OrderId\\": \\"21450******0275\\",\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"ExpressNoList\\": [\\n \\"123123123\\"\\n ],\\n \\"DeliveryInfo\\": {\\n \\"ZipCode\\": \\"100000\\",\\n \\"Address\\": \\"收货地址\\",\\n \\"Mail\\": \\"xxx@xxx.com\\",\\n \\"Receiver\\": \\"收件人\\",\\n \\"BuyerMessage\\": \\"收件电话\\"\\n },\\n \\"OrderDetailUrl\\": \\"https://us******60589\\",\\n \\"ApnName\\": \\"CMIOTCZHZA.JS\\",\\n \\"ApnRegion\\": \\"cn-hangzhou\\",\\n \\"ResourceQuantity\\": 10000,\\n \\"NetworkType\\": \\"4G\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListOrderResponse>\\n <Code>200</Code>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <PageCount>5</PageCount>\\n <Total>48</Total>\\n <List>\\n <BillingCycle>1101</BillingCycle>\\n <BuyNum>100</BuyNum>\\n <PoolCapacityUnit>GB</PoolCapacityUnit>\\n <CredentialPackage>AL-UPG-******3_beika4</CredentialPackage>\\n <Vendor>CMCC</Vendor>\\n <DataLevel>30MB</DataLevel>\\n <PayDuration>12月</PayDuration>\\n <AliFee>ali_2</AliFee>\\n <OrderStatus>processing</OrderStatus>\\n <PoolNo>beika4</PoolNo>\\n <FunctionFee>90</FunctionFee>\\n <PayTime>2022-04-11 16:43:00</PayTime>\\n <FlowType>singlecard</FlowType>\\n <PoolCapacity>200</PoolCapacity>\\n <OrderInfo>123123</OrderInfo>\\n <OrderType>NEW</OrderType>\\n <OrderId>21450******0275</OrderId>\\n <CredentialNo>CM-***-*-2-**M</CredentialNo>\\n <ExpressNoList>123123123</ExpressNoList>\\n <DeliveryInfo>\\n <ZipCode>100000</ZipCode>\\n <Address>收货地址</Address>\\n <Mail>xxx@xxx.com</Mail>\\n <Receiver>收件人</Receiver>\\n <BuyerMessage>收件电话</BuyerMessage>\\n </DeliveryInfo>\\n <OrderDetailUrl>https://us******60589</OrderDetailUrl>\\n </List>\\n </Data>\\n</ListOrderResponse>","errorExample":""}]',
- 'title' => 'ListOrder',
- ],
- 'AddDirectionalCard' => [
- 'summary' => '新增定向卡',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"UnbindResumeStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"FlowOutStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ErrorStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ExhaustStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"UnCertifiedStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ManageStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ExpireStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"WeekWarnStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"RiskWaringStatisticsDTO\\": {\\n \\"WarningCount\\": 20,\\n \\"WaringTotalCount\\": 100,\\n \\"StopCount\\": 40,\\n \\"LeftFlowPercentageWarnCount\\": 40\\n },\\n \\"SingCardPeriodLeftFlowWarnDTO\\": {\\n \\"LessFlowPercentage10Count\\": 5,\\n \\"LessFlowPercentage30Count\\": 8\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Query risk alerts on the overview page',
+ 'summary' => 'Queries risk alerts on the overview page.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardStatusStatistics'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardStatusStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetCredentialPoolStatistics' => [
+ 'summary' => 'Queries the pool information associated with a plan credential.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'GroupId',
+ 'name' => 'Date',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '5',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The month for which to query the plan data usage details.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '202108', 'title' => ''],
],
[
- 'name' => 'UploadType',
+ 'name' => 'CredentialNO',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'ALL',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The plan credential. You can obtain the plan credential by using one of the following methods:'."\n"
+ ."\n"
+ .'- On the **Plan Credential** page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8), view the plan credential.'."\n"
+ ."\n"
+ .'- Call the [GetCardDetail](~~374328~~) operation and view the plan credential (CredentialNo) in the response parameters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CM-SF-M-2-12G', 'title' => ''],
],
- [
- 'name' => 'UploadMethod',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- **200**: success.'."\n"
+ .'- Other values: error codes. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'- true: The call was successful.'."\n"
+ ."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The plan data usage details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolUsed' => ['description' => 'The data usage for the current month.', 'type' => 'string', 'example' => '0KB', 'title' => ''],
+ 'CredentialNO' => ['description' => 'The plan credential.', 'type' => 'string', 'example' => 'CM-SF-M-2-12G', 'title' => ''],
+ 'PoolOutUsed' => ['description' => 'The out-of-plan data usage for the current month.', 'type' => 'string', 'example' => '0KB', 'title' => ''],
+ 'PoolGrandTotalUsed' => ['description' => 'The total plan data usage. This parameter is displayed only for unified payment pool plans.', 'type' => 'string', 'example' => '6.00GB', 'title' => ''],
+ 'CredentialType' => ['description' => 'The plan credential type.'."\n"
+ ."\n"
+ .'- Single-card plan example: CT-SC-M-1-30M (carrier-plan type-plan cycle-rate version-data package tier).'."\n"
+ ."\n"
+ .'- Same-tier pool plan example: CM-SF-M-3-100M (carrier-plan type-plan cycle-rate version-data package tier).'."\n"
+ ."\n"
+ .'- Unified payment pool plan example: CU-UPG-M-2-pool ID (carrier-plan type-plan cycle-rate version-pool ID).', 'type' => 'string', 'example' => 'CT-SC-M-1-30M', 'title' => ''],
+ 'CardTotalNum' => ['description' => 'The total number of cards in the plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'PoolGrandTotal' => ['description' => 'The total plan data allowance. This parameter is displayed only for unified payment pool plans.', 'type' => 'string', 'example' => '12.00GB', 'title' => ''],
+ 'CardActiveNum' => ['description' => 'The number of active cards in the plan (activated, not suspended, and not deregistered).', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'EffectiveTotalFlow' => ['description' => 'The total plan data allowance. This parameter is displayed only for same-tier pool plans.', 'type' => 'string', 'example' => '12.00GB', 'title' => ''],
+ 'EffectiveAvailableFlow' => ['description' => 'The remaining available data in the plan. This parameter is displayed only for same-tier pool plans.', 'type' => 'string', 'example' => '6.00GB', 'title' => ''],
+ 'PoolAvaiable' => ['description' => 'The remaining available data in the plan. This parameter is displayed only for unified payment pool plans.', 'type' => 'string', 'example' => '6.00GB', 'title' => ''],
+ 'MonthFeatureFee' => ['description' => 'The number of monthly feature fee units. This parameter is displayed only for unified payment pool plans.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'CredentialInstanceId' => ['description' => 'The credential instance ID.', 'type' => 'string', 'example' => '259****', 'title' => ''],
+ 'SmsUsed' => ['description' => 'The SMS usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'MonthUsedAmount' => ['description' => 'The total monthly data usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '3.00GB', 'title' => ''],
+ 'MonthExceedFee' => ['description' => 'The number of feature fee units that exceeded the plan for the current month.'."\n"
+ ."\n"
+ .'A value greater than 0 indicates that the feature fee has exceeded the plan. A value of 0 or null indicates that the feature fee has not exceeded the plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'docRequired' => true,
- 'example' => 'TAG',
- 'required' => true,
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'linkcard.check.TimeFormatError', 'errorMessage' => 'Time format error.', 'description' => 'Time format error.'],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ],
+ 403 => [
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => 'linkcard.common.BusinessProcessError'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PoolUsed\\": \\"0KB\\",\\n \\"CredentialNO\\": \\"CM-SF-M-2-12G\\",\\n \\"PoolOutUsed\\": \\"0KB\\",\\n \\"PoolGrandTotalUsed\\": \\"6.00GB\\",\\n \\"CredentialType\\": \\"CT-SC-M-1-30M\\",\\n \\"CardTotalNum\\": 20,\\n \\"PoolGrandTotal\\": \\"12.00GB\\",\\n \\"CardActiveNum\\": 10,\\n \\"EffectiveTotalFlow\\": \\"12.00GB\\",\\n \\"EffectiveAvailableFlow\\": \\"6.00GB\\",\\n \\"PoolAvaiable\\": \\"6.00GB\\",\\n \\"MonthFeatureFee\\": 100,\\n \\"CredentialInstanceId\\": \\"259****\\",\\n \\"SmsUsed\\": 0,\\n \\"MonthUsedAmount\\": 0,\\n \\"MonthExceedFee\\": 200\\n }\\n}","type":"json"}]',
+ 'title' => 'Query plan credential information',
+ 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters. For the metric description of common request parameters, see [Common parameters](~~375336~~).',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-06-28T06:32:07.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCredentialPoolStatistics'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TagList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'items' => [
- 'description' => '',
- 'example' => '5',
- 'required' => false,
- 'type' => 'string',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCredentialPoolStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'maxItems' => 100,
- 'required' => true,
- 'type' => 'array',
],
],
+ ],
+ ],
+ 'GetRealNameStatus' => [
+ 'summary' => 'Queries the personal real-name verification status of an IoT card.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'OrderList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '2172***80589',
- 'required' => false,
- 'type' => 'string',
- ],
- 'maxItems' => 50,
- 'required' => false,
- 'type' => 'array',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'FileUri',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'https://linkcard-user-online.oss-cn-zhangjiakou.aliyuncs.com/DIRECTIONAL_GROUP/20220811/xxxx.csv',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can find the ICCID on the IoT card, or view it on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/sim/card).', 'type' => 'string', 'required' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'GroupName',
+ 'name' => 'ListMsisdns',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'example' => '',
+ 'description' => 'The MSISDNs of sub-cards for multi-network cards.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The MSISDN of the IoT card.', 'type' => 'string', 'required' => false, 'example' => '144******1111', 'title' => ''],
'required' => false,
- 'type' => 'string',
+ 'maxItems' => 10,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'GetRealNameStatusResponse',
+ 'type' => 'object',
'properties' => [
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'true: The call was successful.'."\n"
+ .'false: The call failed.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'200: Success.'."\n"
+ .'Other values: Error code. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language corresponding to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RealNameStatus' => ['description' => 'The personal real-name verification status. Valid values:'."\n"
+ .'- NOT_CERTIFIED: not verified.'."\n"
+ .'- APPROVING: verification in progress.'."\n"
+ .'- CERTIFIED: verified.', 'type' => 'string', 'example' => 'CERTIFIED', 'title' => ''],
+ 'Desc' => ['description' => 'The description of the verification status.', 'type' => 'string', 'example' => '已认证', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => 'Iccid cannot be empty.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.IccidFormatError', 'errorMessage' => 'Iccid format error.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.VnoCardNotSupported', 'errorMessage' => 'This function does not support vno card.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<AddDirectionalCardResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</AddDirectionalCardResponse>","errorExample":""}]',
- ],
- 'AddDirectionalGroup' => [
- 'summary' => '增加定向分组',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"RealNameStatus\\": \\"CERTIFIED\\",\\n \\"Desc\\": \\"已认证\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetRealNameStatus',
+ 'changeSet' => [
+ ['createdAt' => '2023-03-08T01:57:55.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealNameStatus'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetRealNameStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetSimCardStateDistribution' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'GroupName',
+ 'name' => 'CredentialNO',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '',
- 'required' => true,
- 'type' => 'string',
- 'maxLength' => 30,
- 'minLength' => 0,
- ],
+ 'schema' => ['description' => 'The credential number of the plan. You can view this on the Credential Management page in the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/sim/license).', 'type' => 'string', 'required' => false, 'example' => 'CT-SC-M-2-100M', 'title' => ''],
+ ],
+ [
+ 'name' => 'Date',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The date to query.'."\n"
+ ."\n"
+ .'Format: yyyyMM.', 'type' => 'string', 'required' => true, 'example' => '202209', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
+ 'type' => 'object',
'properties' => [
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'200: success.'."\n"
+ ."\n"
+ .'Other values: error codes. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. This is a unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'true: The call was successful.'."\n"
+ .'false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'example' => '6',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CardCount' => ['description' => 'The total number of cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'TestCount' => ['description' => 'The number of testable cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'UnusedCount' => ['description' => 'The number of unused cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'StopCount' => ['description' => 'The number of deactivated cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'DestoryedCount' => ['description' => 'The number of canceled cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'UsingCount' => ['description' => 'The number of cards in use.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
+ 'ShutDownCount' => ['description' => 'The number of suspended cards.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.check.TimeFormatError', 'errorMessage' => 'Time format error.', 'description' => 'Time format error.'],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.CredentialInstanceNotExist', 'errorMessage' => 'The credential instance does not exist.', 'description' => 'Credential instance not exist.'],
+ ['errorCode' => 'linkcard.common.CredentialNoNotExist', 'errorMessage' => 'The credentialNo does not exist', 'description' => ''],
+ ],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 6,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<AddDirectionalGroupResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>系统异常</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</AddDirectionalGroupResponse>","errorExample":""}]',
- 'title' => 'AddDirectionalGroup',
- ],
- 'BatchAddDirectionalAddress' => [
- 'summary' => '批量增加地址到定向组',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CardCount\\": 100,\\n \\"TestCount\\": 20,\\n \\"UnusedCount\\": 10,\\n \\"StopCount\\": 5,\\n \\"DestoryedCount\\": 0,\\n \\"UsingCount\\": 50,\\n \\"ShutDownCount\\": 10\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve card status distribution',
+ 'summary' => 'Retrieves the card status distribution.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSimCardStateDistribution'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetSimCardStateDistribution',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListCardInfo' => [
+ 'summary' => 'Query the card list.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'GroupId',
+ 'name' => 'ActiveTimeEnd',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '5',
- 'format' => 'int64',
- 'required' => true,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The end time of the IoT card activation time range.'."\n"
+ ."\n"
+ .'Format: `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'required' => false, 'example' => '2022-05-25 23:59:59', 'title' => ''],
],
[
- 'name' => 'Source',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'user_defined',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Valid values: 10, 15, 25, and 40.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'AddressType',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'Domain',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card, or on the **Card Management** page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => false, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'ListAddress',
+ 'name' => 'CredentialNo',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '*.aliyun.com',
- 'required' => false,
- 'type' => 'string',
- ],
- 'maxItems' => 10,
- 'required' => true,
- 'type' => 'array',
- ],
+ 'schema' => ['description' => 'The plan credential.'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'CM-***-*-2-**M', 'title' => ''],
+ ],
+ [
+ 'name' => 'Vendor',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The carrier.'."\n"
+ ."\n"
+ .'- **CMCC**: China Mobile.'."\n"
+ ."\n"
+ .'- **CUCC**: China Unicom.'."\n"
+ ."\n"
+ .'- **CTCC**: China Telecom.'."\n"
+ ."\n"
+ .'- **VNO**: Virtual network operator.', 'type' => 'string', 'required' => false, 'example' => 'CMCC', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. This parameter must be used together with the **PageSize** parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Msisdn',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The MSISDN of the IoT card.', 'type' => 'string', 'required' => false, 'example' => '1440993******', 'title' => ''],
+ ],
+ [
+ 'name' => 'AliyunOrderId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The order ID associated with the IoT card.'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '211519634******', 'title' => ''],
+ ],
+ [
+ 'name' => 'AliFee',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The billing version.', 'type' => 'string', 'required' => false, 'example' => 'ali_2', 'title' => ''],
+ ],
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The plan billing cycle.'."\n"
+ ."\n"
+ .'- **1101**: Monthly.'."\n"
+ ."\n"
+ .'- **1103**: Quarterly.'."\n"
+ ."\n"
+ .'- **1106**: Semi-annually.'."\n"
+ ."\n"
+ .'- **1112**: Annually.', 'type' => 'string', 'required' => false, 'example' => '1101', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data type.'."\n"
+ ."\n"
+ .'- **singlecard**: Single-card general data.'."\n"
+ ."\n"
+ .'- **directionalcard**: Single-card directional data.'."\n"
+ ."\n"
+ .'- **sameflowcard**: Same-tier pool shared data.'."\n"
+ ."\n"
+ .'- **directional_sameflowcard**: Same-tier pool shared directional data.'."\n"
+ ."\n"
+ .'- **unityPayPool**: Unified payment pool general data.'."\n"
+ ."\n"
+ .'- **GREcard**: Unified payment pool directional data.', 'type' => 'string', 'required' => false, 'example' => 'sameflowcard', 'title' => ''],
+ ],
+ [
+ 'name' => 'ActiveTimeStart',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The start time of the IoT card activation time range.'."\n"
+ ."\n"
+ .'Format: `yyyy-MM-dd HH:mm:ss`.', 'type' => 'string', 'required' => false, 'example' => '2022-05-25 23:59:59', 'title' => ''],
+ ],
+ [
+ 'name' => 'SimType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The SIM card type.'."\n"
+ ."\n"
+ .'- **nano**: Triple-cut plug-in card (consumer-grade).'."\n"
+ ."\n"
+ .'- **micro**: Dual-cut plug-in card (consumer-grade).'."\n"
+ ."\n"
+ .'- **normal**: Standard plug-in card (consumer-grade).'."\n"
+ ."\n"
+ .'- **simplus56**: Embedded card 5x6 (consumer-grade).'."\n"
+ ."\n"
+ .'- **simplus22**: Embedded card 2x2 (consumer-grade).'."\n"
+ ."\n"
+ .'- **industry-normal**: Standard plug-in card (industrial-grade).'."\n"
+ ."\n"
+ .'- **industry-micro**: Dual-cut plug-in card (industrial-grade).'."\n"
+ ."\n"
+ .'- **industry-nano**: Triple-cut plug-in card (industrial-grade).'."\n"
+ ."\n"
+ .'- **simplus**: Embedded card 5x6 (industrial-grade).'."\n"
+ ."\n"
+ .'- **industry-simplus22**: Embedded card 2x2 (industrial-grade).', 'type' => 'string', 'required' => false, 'example' => 'nano', 'title' => ''],
+ ],
+ [
+ 'name' => 'ExpireTimeEnd',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The plan expiration end time of the IoT card.'."\n"
+ ."\n"
+ .'Format: `yyyy-MM-dd HH:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '2022-05-25 23:59:59', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsAutoRecharge',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Indicates whether the plan is automatically renewed.'."\n"
+ ."\n"
+ .'- **true**: Yes.'."\n"
+ ."\n"
+ .'- **false**: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'ExpireTimeStart',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The plan expiration start time of the IoT card.'."\n"
+ ."\n"
+ .'Format: `yyyy-MM-dd HH:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '2022-05-25 23:59:59', 'title' => ''],
+ ],
+ [
+ 'name' => 'OsStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The detailed status of the IoT card.'."\n"
+ ."\n"
+ .'- **10**: Test period.'."\n"
+ ."\n"
+ .'- **20**: Silent period.'."\n"
+ ."\n"
+ .'- **100**: In use.'."\n"
+ ."\n"
+ .'- **150**: Partially in use.'."\n"
+ ."\n"
+ .'- **200**: Manually deactivated.'."\n"
+ ."\n"
+ .'- **300**: Deactivated due to data cap.'."\n"
+ ."\n"
+ .'- **400**: Deactivated by signal control.'."\n"
+ ."\n"
+ .'- **500**: Deactivated due to rebinding.'."\n"
+ ."\n"
+ .'- **600**: Deactivated due to real-name verification.'."\n"
+ ."\n"
+ .'- **700**: Deactivated due to anomaly.'."\n"
+ ."\n"
+ .'- **40**: Suspended.'."\n"
+ ."\n"
+ .'- **50**: Canceled.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''],
+ ],
+ [
+ 'name' => 'NotifyId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The notification ID of the automation rule.', 'type' => 'string', 'required' => false, 'example' => '11111', 'title' => ''],
+ ],
+ [
+ 'name' => 'DataLevel',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data plan tier.', 'type' => 'string', 'required' => false, 'example' => '30MB', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The status of the IoT card.'."\n"
+ ."\n"
+ .'- **10**: Testable.'."\n"
+ ."\n"
+ .'- **20**: Unused.'."\n"
+ ."\n"
+ .'- **30**: In use.'."\n"
+ ."\n"
+ .'- **35**: Deactivated.'."\n"
+ ."\n"
+ .'- **40**: Suspended.'."\n"
+ ."\n"
+ .'- **50**: Canceled.', 'type' => 'string', 'required' => false, 'example' => '35', 'title' => ''],
+ ],
+ [
+ 'name' => 'TagName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The tag name.'."\n", 'type' => 'string', 'required' => false, 'example' => '测试标签', 'title' => ''],
+ ],
+ [
+ 'name' => 'CertifyType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The authentication method.'."\n"
+ ."\n"
+ .'Only enterprise is supported: Enterprise authentication.', 'type' => 'string', 'required' => false, 'example' => 'enterprise', 'title' => ''],
+ ],
+ [
+ 'name' => 'DirectionalGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The directional group ID.', 'type' => 'string', 'required' => false, 'example' => '22', 'title' => ''],
+ ],
+ [
+ 'name' => 'ApnName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The APN name.'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'cmiot', 'title' => ''],
+ ],
+ [
+ 'name' => 'Imsi',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IMSI of the IoT card.', 'type' => 'string', 'required' => false, 'example' => '460081937******', 'title' => ''],
+ ],
+ [
+ 'name' => 'PoolId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The pool ID.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''],
+ ],
+ [
+ 'name' => 'MinFlow',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The minimum usage for filtering by periodic usage range. Unit: MB.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxFlow',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The maximum usage for filtering by periodic usage range. Unit: MB.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxRestFlowPercentage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The remaining data percentage for a single card in the billing cycle. Only the following three values are supported:'."\n"
+ .'0.1: 10% remaining'."\n"
+ .'0.2: 20% remaining'."\n"
+ .'0.3: 30% remaining', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.2', 'title' => ''],
+ ],
+ [
+ 'name' => 'NetworkType',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => 'The network type: 4G or 5G.', 'type' => 'string', 'required' => false, 'example' => '4G', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'BatchAddDirectionalAddressResponse',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '必填',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- **200**: Success.'."\n"
+ .'- Other values: Error codes. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'- true: The call was successful.'."\n"
+ ."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language of the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
+ 'description' => 'The returned pagination information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'Total' => ['description' => 'The total number of IoT cards that match the filter conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '199', 'title' => ''],
+ 'List' => [
+ 'description' => 'The card list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The card list.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the card.'."\n"
+ ."\n"
+ .'- **10**: Testable.'."\n"
+ ."\n"
+ .'- **20**: Unused.'."\n"
+ ."\n"
+ .'- **30**: In use.'."\n"
+ ."\n"
+ .'- **35**: Deactivated.'."\n"
+ ."\n"
+ .'- **40**: Suspended.'."\n"
+ ."\n"
+ .'- **50**: Canceled.', 'type' => 'string', 'example' => '35', 'title' => ''],
+ 'DataType' => ['description' => 'The data type.'."\n"
+ ."\n"
+ .'- **singlecard**: Single-card general data.'."\n"
+ ."\n"
+ .'- **directionalcard**: Single-card directional data.'."\n"
+ ."\n"
+ .'- **sameflowcard**: Same-tier pool shared data.'."\n"
+ ."\n"
+ .'- **directional_sameflowcard**: Same-tier pool shared directional data.'."\n"
+ ."\n"
+ .'- **unityPayPool**: Unified payment pool general data.'."\n"
+ ."\n"
+ .'- **GREcard**: Unified payment pool directional data.', 'type' => 'string', 'example' => 'sameflowcard', 'title' => ''],
+ 'DirectionalGroupName' => ['description' => 'The directional group name.', 'type' => 'string', 'example' => '测试分组', 'title' => ''],
+ 'PeriodRestFlow' => ['description' => 'The remaining data in the billing cycle.', 'type' => 'string', 'example' => '130.00MB', 'title' => ''],
+ 'CredentialType' => ['description' => 'The plan credential type.', 'type' => 'string', 'example' => 'unityPayPool', 'title' => ''],
+ 'PeriodAddFlow' => ['description' => 'The accumulated data in the billing cycle.', 'type' => 'string', 'example' => '0KB', 'title' => ''],
+ 'PeriodSmsUse' => ['description' => 'The SMS usage in the billing cycle.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'DataLevel' => ['description' => 'The data plan tier.', 'type' => 'string', 'example' => '30MB', 'title' => ''],
+ 'OsStatus' => ['description' => 'The detailed status of the IoT card.'."\n"
+ ."\n"
+ .'- **10**: Test period.'."\n"
+ ."\n"
+ .'- **20**: Silent period.'."\n"
+ ."\n"
+ .'- **100**: In use.'."\n"
+ ."\n"
+ .'- **150**: Partially in use.'."\n"
+ ."\n"
+ .'- **200**: Manually deactivated.'."\n"
+ ."\n"
+ .'- **300**: Deactivated due to data cap.'."\n"
+ ."\n"
+ .'- **400**: Deactivated by signal control.'."\n"
+ ."\n"
+ .'- **500**: Deactivated due to rebinding.'."\n"
+ ."\n"
+ .'- **600**: Deactivated due to real-name verification.'."\n"
+ ."\n"
+ .'- **700**: Deactivated due to anomaly.'."\n"
+ ."\n"
+ .'- **40**: Suspended.'."\n"
+ ."\n"
+ .'- **50**: Canceled.', 'type' => 'string', 'example' => '300', 'title' => ''],
+ 'NotifyId' => ['description' => 'The notification ID of the automation rule.', 'type' => 'string', 'example' => '11111', 'title' => ''],
+ 'AliFee' => ['description' => 'The billing version.', 'type' => 'string', 'example' => 'ali_2', 'title' => ''],
+ 'AliyunOrderId' => ['description' => 'The order ID associated with the IoT card.', 'type' => 'string', 'example' => '211519634******', 'title' => ''],
+ 'ActiveType' => ['description' => 'The activation method of the IoT card.'."\n"
+ ."\n"
+ .'- **firstdatarecord**: Activated by the first data record.'."\n"
+ ."\n"
+ .'- **carrierstatuspush**: Activated by carrier status push.'."\n"
+ ."\n"
+ .'- **silence_expire**: Activated after the silent period expires.'."\n"
+ ."\n"
+ .'- **manage**: Manually activated.'."\n"
+ ."\n"
+ .'- **testflowdepleted**: Activated after the test period data is depleted.', 'type' => 'string', 'example' => 'first_data_record', 'title' => ''],
+ 'IsAutoRecharge' => ['description' => 'Indicates whether the plan is automatically renewed.'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'- false: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'CredentialInstanceId' => ['description' => 'The credential instance ID.', 'type' => 'string', 'example' => '2622***', 'title' => ''],
+ 'ExpireTime' => ['description' => 'The plan expiration time.', 'type' => 'string', 'example' => '2022-04-30 23:59:59', 'title' => ''],
+ 'ApnName' => ['description' => 'The APN name.', 'type' => 'string', 'example' => 'cmiot', 'title' => ''],
+ 'ActiveTime' => ['description' => 'The activation time.', 'type' => 'string', 'example' => '2021-11-16 16:35:50', 'title' => ''],
+ 'Iccid' => ['description' => 'The ICCID of the IoT card.', 'type' => 'string', 'example' => '89860321******15668', 'title' => ''],
+ 'Vendor' => ['description' => 'The carrier.'."\n"
+ ."\n"
+ .'- **CMCC**: China Mobile.'."\n"
+ ."\n"
+ .'- **CUCC**: China Unicom.'."\n"
+ ."\n"
+ .'- **CTCC**: China Telecom.'."\n"
+ ."\n"
+ .'- **VNO**: Virtual network operator.', 'type' => 'string', 'example' => 'CMCC', 'title' => ''],
+ 'Period' => ['description' => 'The plan billing cycle.'."\n"
+ ."\n"
+ .'- **1101**: Monthly.'."\n"
+ ."\n"
+ .'- **1103**: Quarterly.'."\n"
+ ."\n"
+ .'- **1106**: Semi-annually.'."\n"
+ ."\n"
+ .'- **1112**: Annually.', 'type' => 'string', 'example' => '1101', 'title' => ''],
+ 'CertifyType' => ['description' => 'The authentication method.'."\n"
+ ."\n"
+ .'enterprise: Enterprise authentication.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''],
+ 'PrivateNetworkSegment' => ['description' => 'The private network segment (for directional cards).', 'type' => 'string', 'example' => '1.*.3.*', 'title' => ''],
+ 'OpenAccountTime' => ['description' => 'The account opening time.', 'type' => 'string', 'example' => '2021-11-29 16:12:14', 'title' => ''],
+ 'SimType' => ['description' => 'The SIM card type.'."\n"
+ ."\n"
+ .'- **nano**: Triple-cut plug-in card (consumer-grade).'."\n"
+ ."\n"
+ .'- **micro**: Dual-cut plug-in card (consumer-grade).'."\n"
+ ."\n"
+ .'- **normal**: Standard plug-in card (consumer-grade).'."\n"
+ ."\n"
+ .'- **simplus56**: Embedded card 5x6 (consumer-grade).'."\n"
+ ."\n"
+ .'- **simplus22**: Embedded card 2x2 (consumer-grade).'."\n"
+ ."\n"
+ .'- **industry-normal**: Standard plug-in card (industrial-grade).'."\n"
+ ."\n"
+ .'- **industry-micro**: Dual-cut plug-in card (industrial-grade).'."\n"
+ ."\n"
+ .'- **industry-nano**: Triple-cut plug-in card (industrial-grade).'."\n"
+ ."\n"
+ .'- **simplus**: Embedded card 5x6 (industrial-grade).'."\n"
+ ."\n"
+ .'- **industry-simplus22**: Embedded card 2x2 (industrial-grade).', 'type' => 'string', 'example' => 'nano', 'title' => ''],
+ 'VsimInstanceId' => ['description' => 'The InstanceId of the IoT card.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''],
+ 'CredentialNo' => ['description' => 'The plan credential.', 'type' => 'string', 'example' => 'CM-***-*-2-**M', 'title' => ''],
+ 'TagList' => [
+ 'description' => 'The tags of the IoT card.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag list.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '测试标签', 'title' => ''],
+ 'Id' => ['description' => 'The tag ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '24', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Imsi' => [
+ 'description' => 'The IMSI of the IoT card.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The IMSI of the IoT card.', 'type' => 'string', 'example' => '460081937******', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Msisdn' => [
+ 'description' => 'The MSISDN of the IoT card.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The MSISDN of the IoT card.', 'type' => 'string', 'example' => '1440993******', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '备注信息', 'title' => ''],
+ 'DirectionalGroupId' => ['description' => 'The directional group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '55', 'title' => ''],
+ 'NetworkType' => ['description' => 'The network type: 4G or 5G.', 'type' => 'string', 'example' => '4G', 'title' => ''],
+ 'FlowLatestModifiedTime' => ['description' => 'The time when the usage was last updated.', 'type' => 'string', 'example' => '2023-08-15 18:20:11', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'BatchAddDirectionalAddressResponse',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny ',
- 'errorMessage' => 'You do not have the RAM permission. ',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => 'linkcard.common.BusinessProcessError'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchAddDirectionalAddressResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>true</Data>\\n</BatchAddDirectionalAddressResponse>","errorExample":""}]',
- ],
- 'ListDirectionalAddress' => [
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 20,\\n \\"Total\\": 199,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"35\\",\\n \\"DataType\\": \\"sameflowcard\\",\\n \\"DirectionalGroupName\\": \\"测试分组\\",\\n \\"PeriodRestFlow\\": \\"130.00MB\\",\\n \\"CredentialType\\": \\"unityPayPool\\",\\n \\"PeriodAddFlow\\": \\"0KB\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"OsStatus\\": \\"300\\",\\n \\"NotifyId\\": \\"11111\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"AliyunOrderId\\": \\"211519634******\\",\\n \\"ActiveType\\": \\"first_data_record\\",\\n \\"IsAutoRecharge\\": true,\\n \\"CredentialInstanceId\\": \\"2622***\\",\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"ActiveTime\\": \\"2021-11-16 16:35:50\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"Period\\": \\"1101\\",\\n \\"CertifyType\\": \\"enterprise\\",\\n \\"PrivateNetworkSegment\\": \\"1.*.3.*\\",\\n \\"OpenAccountTime\\": \\"2021-11-29 16:12:14\\",\\n \\"SimType\\": \\"nano\\",\\n \\"VsimInstanceId\\": 123456,\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"TagList\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"Id\\": 24\\n }\\n ],\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1440993******\\"\\n ],\\n \\"Remark\\": \\"备注信息\\",\\n \\"DirectionalGroupId\\": 55,\\n \\"NetworkType\\": \\"4G\\",\\n \\"FlowLatestModifiedTime\\": \\"2023-08-15 18:20:11\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'ListCardInfo',
+ 'description' => '### Usage Notes'."\n"
+ .'You can view and obtain the request parameters of this API on the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8), or by calling the [GetCardDetail](~~374328~~) API and viewing the response parameters (the latter is recommended).'."\n",
+ 'requestParamsDescription' => 'When calling this API, in addition to the request parameters described in this topic, you must also include common request parameters. For more information about common request parameters, see [Common parameters](~~375336~~).',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-03T02:45:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-09-29T01:48:11.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCardInfo'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'ListDirectionalAddress' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3386,198 +2963,145 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '10',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- 'maximum' => '200',
- 'minimum' => '1',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Valid values: 10, 15, 25, and 40.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '1',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- 'minimum' => '1',
- ],
+ 'schema' => ['description' => 'The page number. Use this parameter together with the PageSize parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '5',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The directional group ID.'."\n"
+ ."\n"
+ .'You can call the [GetCardDetail](~~374328~~) operation to obtain the directional group ID (DirectionalGroupId) from the response parameters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- 200: success.'."\n"
+ ."\n"
+ .'- Other codes: failure. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID, which is the unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language of the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned access addresses.',
+ 'type' => 'object',
'properties' => [
- 'PageNo' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageCount' => [
- 'description' => '',
- 'example' => '9',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'Total' => [
- 'description' => '',
- 'example' => '90',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
+ 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''],
+ 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''],
'List' => [
- 'description' => '',
+ 'description' => 'The access addresses.',
+ 'type' => 'array',
'items' => [
+ 'type' => 'object',
'properties' => [
- 'Address' => [
- 'description' => '',
- 'example' => '*.aliyun.com',
- 'type' => 'string',
- ],
- 'AddressType' => [
- 'description' => '',
- 'example' => 'Domain',
- 'type' => 'string',
- ],
- 'Source' => [
- 'description' => '',
- 'example' => 'user_defined',
- 'type' => 'string',
- ],
- 'GroupId' => [
- 'description' => '',
- 'example' => '5',
- 'type' => 'string',
- ],
- 'State' => [
- 'description' => '',
- 'example' => '500',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
+ 'Address' => ['description' => 'The directional access address.', 'type' => 'string', 'example' => '*.aliyun.com', 'title' => ''],
+ 'AddressType' => ['description' => 'The address type. Valid values:'."\n"
+ ."\n"
+ .'- **Ip**: IP address.'."\n"
+ ."\n"
+ .'- **Domain**: domain name.', 'type' => 'string', 'example' => 'Domain', 'title' => ''],
+ 'Source' => ['description' => 'The address source. Valid values:'."\n"
+ ."\n"
+ .'- **user_defined**: user-configured.'."\n"
+ ."\n"
+ .'- **aliyun_defined**: Alibaba Cloud pre-configured.', 'type' => 'string', 'example' => 'user_defined', 'title' => ''],
+ 'GroupId' => ['description' => 'The directional group ID.', 'type' => 'string', 'example' => '5', 'title' => ''],
+ 'State' => ['description' => 'The address status. Valid values:'."\n"
+ ."\n"
+ .'- **100**: addition in progress.'."\n"
+ ."\n"
+ .'- **200**: deletion in progress.'."\n"
+ ."\n"
+ .'- **300**: addition failed.'."\n"
+ ."\n"
+ .'- **400**: deletion failed.'."\n"
+ ."\n"
+ .'- **500**: addition succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 9,\\n \\"Total\\": 90,\\n \\"List\\": [\\n {\\n \\"Address\\": \\"*.aliyun.com\\",\\n \\"AddressType\\": \\"Domain\\",\\n \\"Source\\": \\"user_defined\\",\\n \\"GroupId\\": \\"5\\",\\n \\"State\\": 500\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Query directional group information',
+ 'summary' => 'Queries the list of access addresses for a directional group.',
+ 'description' => '## Usage notes'."\n"
+ .'Only the new directional service menu supports the directional group feature. If you are using the legacy directional service menu, you cannot call this operation. For more information, see [Directional service](~~279455~~).',
+ 'changeSet' => [
+ ['createdAt' => '2023-01-09T08:10:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDirectionalAddress'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:ListDirectionalAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 9,\\n \\"Total\\": 90,\\n \\"List\\": [\\n {\\n \\"Address\\": \\"*.aliyun.com\\",\\n \\"AddressType\\": \\"Domain\\",\\n \\"Source\\": \\"user_defined\\",\\n \\"GroupId\\": \\"5\\",\\n \\"State\\": 500\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDirectionalAddressResponse>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <PageCount>9</PageCount>\\n <Total>90</Total>\\n <List>\\n <Address>*.aliyun.com</Address>\\n <AddressType>Domain</AddressType>\\n <Source>user_defined</Source>\\n <GroupId>5</GroupId>\\n <State>500</State>\\n </List>\\n </Data>\\n</ListDirectionalAddressResponse>","errorExample":""}]',
- 'title' => 'ListDirectionalAddress',
],
'ListDirectionalDetail' => [
- 'summary' => '通过ICCID查询卡下的定向分组详情及组下的域名',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'summary' => 'Queries the directional group and access address list of an IoT card.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -3585,222 +3109,160 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card or on the Card Management page of the IoT SIM Service console.', 'type' => 'string', 'required' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The page number to query. The value cannot be 0.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Valid values: 10, 15, 25, and 40.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
'description' => 'ListDirectionalDetailResponse',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '必填',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- 200: The call was successful.'."\n"
+ ."\n"
+ .'- Other codes: The call failed. For more information, see [Error codes](~~87387~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call failed.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language of the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The directional group information and the list of access addresses in the group.',
+ 'type' => 'object',
'properties' => [
- 'DirectionalGroupId' => [
- 'description' => '',
- 'example' => '5',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'DirectionalName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
+ 'DirectionalGroupId' => ['description' => 'The ID of the directional group.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'DirectionalName' => ['description' => 'The name of the directional group.', 'type' => 'string', 'example' => '测试分组', 'title' => ''],
'PaginationResult' => [
- 'description' => '',
+ 'description' => 'The list of access addresses in the directional group.',
+ 'type' => 'object',
'properties' => [
- 'PageNo' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'Total' => [
- 'description' => '',
- 'example' => '90',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageCount' => [
- 'description' => '',
- 'example' => '9',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
+ 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''],
+ 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''],
'List' => [
- 'description' => '',
+ 'description' => 'The list of directional addresses.',
+ 'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The list of directional addresses.',
+ 'type' => 'object',
'properties' => [
- 'GroupId' => [
- 'description' => '',
- 'example' => '5',
- 'type' => 'string',
- ],
- 'Address' => [
- 'description' => '',
- 'example' => '*.aliyun.com',
- 'type' => 'string',
- ],
- 'Source' => [
- 'description' => '',
- 'example' => 'user_defined',
- 'type' => 'string',
- ],
- 'AddressType' => [
- 'description' => '',
- 'example' => 'Domain',
- 'type' => 'string',
- ],
- 'State' => [
- 'description' => '',
- 'example' => '500',
- 'type' => 'string',
- ],
+ 'GroupId' => ['description' => 'The ID of the directional group.', 'type' => 'string', 'example' => '5', 'title' => ''],
+ 'Address' => ['description' => 'The directional access address.', 'type' => 'string', 'example' => '*.aliyun.com', 'title' => ''],
+ 'Source' => ['description' => 'The source of the address. Valid values:'."\n"
+ ."\n"
+ .'- **user_defined**: configured by the user.'."\n"
+ ."\n"
+ .'- **aliyun_defined**: preconfigured by Alibaba Cloud.', 'type' => 'string', 'example' => 'user_defined', 'title' => ''],
+ 'AddressType' => ['description' => 'The type of the address. Valid values:'."\n"
+ ."\n"
+ .'- **Ip**: IP address.'."\n"
+ ."\n"
+ .'- **Domain**: domain name.', 'type' => 'string', 'example' => 'Domain', 'title' => ''],
+ 'State' => ['description' => 'The status of the address. Valid values:'."\n"
+ ."\n"
+ .'- **100**: being added.'."\n"
+ ."\n"
+ .'- **200**: being deleted.'."\n"
+ ."\n"
+ .'- **300**: failed to add.'."\n"
+ ."\n"
+ .'- **400**: failed to delete.'."\n"
+ ."\n"
+ .'- **500**: added.', 'type' => 'string', 'example' => '500', 'title' => ''],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'ListDirectionalDetailResponse',
- 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.directional.notExist',
- 'errorMessage' => 'Can not find direction group.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardNotExist',
- 'errorMessage' => 'The card does not exist.',
- ],
- [
- 'errorCode' => 'CardDisabled',
- 'errorMessage' => 'The SIM card has been permanently disabled.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.directional.notExist', 'errorMessage' => 'Can not find direction group.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.CardNotExist', 'errorMessage' => 'The card does not exist.', 'description' => ''],
+ ['errorCode' => 'CardDisabled', 'errorMessage' => 'The SIM card has been permanently disabled.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny ',
- 'errorMessage' => 'You do not have the RAM permission. ',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"DirectionalGroupId\\": 5,\\n \\"DirectionalName\\": \\"测试分组\\",\\n \\"PaginationResult\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 90,\\n \\"PageCount\\": 9,\\n \\"List\\": [\\n {\\n \\"GroupId\\": \\"5\\",\\n \\"Address\\": \\"*.aliyun.com\\",\\n \\"Source\\": \\"user_defined\\",\\n \\"AddressType\\": \\"Domain\\",\\n \\"State\\": \\"500\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Query directional information of a card',
+ 'description' => '## Operation description'."\n"
+ .'Only the new directional service menu supports directional groups. If you use the legacy directional service menu, you cannot call this operation. For more information, see [Directional service](~~279455~~).',
+ 'requestParamsDescription' => 'When you invoke this operation, in addition to the operation-specific request parameters described in this topic, you must also specify common request parameters. For the metric description of common request parameters, see [Common parameters](~~30561~~).',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T07:56:27.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-03-21T11:00:37.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-10-28T11:23:14.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-08-09T12:00:23.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDirectionalDetail'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:ListDirectionalDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"DirectionalGroupId\\": 5,\\n \\"DirectionalName\\": \\"测试分组\\",\\n \\"PaginationResult\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 90,\\n \\"PageCount\\": 9,\\n \\"List\\": [\\n {\\n \\"GroupId\\": \\"5\\",\\n \\"Address\\": \\"*.aliyun.com\\",\\n \\"Source\\": \\"user_defined\\",\\n \\"AddressType\\": \\"Domain\\",\\n \\"State\\": \\"500\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDirectionalDetailResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <DirectionalGroupId>5</DirectionalGroupId>\\n <DirectionalName>测试分组</DirectionalName>\\n <PaginationResult>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Total>90</Total>\\n <PageCount>9</PageCount>\\n <List>\\n <GroupId>5</GroupId>\\n <Address>*.aliyun.com</Address>\\n <Source>user_defined</Source>\\n <AddressType>Domain</AddressType>\\n <State>500</State>\\n </List>\\n </PaginationResult>\\n </Data>\\n</ListDirectionalDetailResponse>","errorExample":""}]',
],
- 'VerifyIotCard' => [
- 'summary' => '判断是否是阿里云iot的定向卡',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ListOrder' => [
+ 'summary' => 'Queries a list of orders.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3808,158 +3270,75 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The order ID.', 'type' => 'string', 'required' => false, 'example' => '21450******0275', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'headers' => [],
- 'schema' => [
- 'description' => 'VerifyIotCardResponse',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '必填',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- ],
- 'title' => 'VerifyIotCardResponse',
- 'type' => 'object',
- ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The start date of the order purchase time range.'."\n"
+ ."\n"
+ .'Format: `YYYY-MM-dd`.', 'type' => 'string', 'required' => false, 'example' => '2022-04-05', 'title' => ''],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'linkcard.check.IccidCanNotEmpty',
- 'errorMessage' => 'Iccid cannot be empty.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
- [
- 'errorCode' => 'CardDisabled',
- 'errorMessage' => 'The SIM card has been permanently disabled.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardNotExist',
- 'errorMessage' => 'The card does not exist.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The end date of the order purchase time range.'."\n"
+ ."\n"
+ .'Format: `YYYY-MM-dd`.', 'type' => 'string', 'required' => false, 'example' => '2022-04-05', 'title' => ''],
],
- 403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny ',
- 'errorMessage' => 'You do not have the RAM permission. ',
- ],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The order type. Valid values:'."\n"
+ ."\n"
+ .'- **NEW**: new purchase.'."\n"
+ ."\n"
+ .'- **ADD_FLOW**: pool expansion.'."\n"
+ ."\n"
+ .'- **ADD_CARD**: card replacement.'."\n"
+ ."\n"
+ .'- **FUNCTION**: monthly feature fee purchase.'."\n"
+ ."\n"
+ .'- **FLOW_PLUS**: add-on package purchase.'."\n"
+ ."\n"
+ .'- **RENEW**: plan renewal.'."\n"
+ ."\n"
+ .'- **AUTO_RENEW**: automatic plan renewal.', 'type' => 'string', 'required' => false, 'example' => 'NEW', 'title' => ''],
],
- 500 => [
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ [
+ 'name' => 'OrderStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The order status. Valid values:'."\n"
+ ."\n"
+ .'- **processing**: being processed.'."\n"
+ ."\n"
+ .'- **failure**: failed.'."\n"
+ ."\n"
+ .'- **completed**: completed.'."\n"
+ ."\n"
+ .'- **unpaid**: pending payment.'."\n"
+ ."\n"
+ .'- **refunded**: refunded.', 'type' => 'string', 'required' => false, 'example' => 'processing', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": true\\n}","errorExample":""},{"type":"xml","example":"<VerifyIotCardResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>true</Data>\\n</VerifyIotCardResponse>","errorExample":""}]',
- 'title' => 'VerifyIotCard',
- ],
- 'AddTagsToCard' => [
- 'summary' => '卡添加标签(包含已存在的标签和不存在的标签)',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Use this parameter together with the `PageSize` parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '89860321******15668',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Valid values: 10, 15, 25, and 40.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'TagNameList',
+ 'name' => 'CredentialNo',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'required' => false,
- 'maxItems' => 4,
- ],
+ 'schema' => ['description' => 'The plan credential.', 'type' => 'string', 'required' => false, 'example' => 'CT-SF-M-2-100M', 'title' => ''],
],
],
'responses' => [
@@ -3967,272 +3346,294 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- **200**: success.'."\n"
+ .'- Other values: error codes. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ ."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language of the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TagName' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'Total' => ['description' => 'The total number of orders that meet the conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '48', 'title' => ''],
+ 'List' => [
+ 'description' => 'The order list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The order list.',
+ 'type' => 'object',
+ 'properties' => [
+ 'BillingCycle' => ['description' => 'The plan billing cycle. Valid values:'."\n"
+ ."\n"
+ .'- **1101**: monthly.'."\n"
+ ."\n"
+ .'- **1103**: quarterly.'."\n"
+ ."\n"
+ .'- **1106**: semi-annually.'."\n"
+ ."\n"
+ .'- **1112**: annually.', 'type' => 'string', 'example' => '1101', 'title' => ''],
+ 'BuyNum' => ['description' => 'The number of cards purchased.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'PoolCapacityUnit' => ['description' => 'The unit of the pool capacity.', 'type' => 'string', 'example' => 'GB', 'title' => ''],
+ 'CardPayCount' => ['description' => 'The payment time.', 'type' => 'integer', 'format' => 'int32', 'example' => '2022-04-11 16:43:00', 'title' => ''],
+ 'CredentialPackage' => ['description' => 'The plan credential.', 'type' => 'string', 'example' => 'AL-UPG-******3_beika4', 'title' => ''],
+ 'Vendor' => ['description' => 'The carrier. Valid values:'."\n"
+ ."\n"
+ .'- **CMCC**: China Mobile.'."\n"
+ ."\n"
+ .'- **CUCC**: China Unicom.'."\n"
+ ."\n"
+ .'- **CTCC**: China Telecom.'."\n"
+ ."\n"
+ .'- **VNO**: virtual network operator.', 'type' => 'string', 'example' => 'CMCC', 'title' => ''],
+ 'DataLevel' => ['description' => 'The data package tier.', 'type' => 'string', 'example' => '30MB', 'title' => ''],
+ 'PayDuration' => ['description' => 'The purchase duration.', 'type' => 'string', 'example' => '12月', 'title' => ''],
+ 'AliFee' => ['description' => 'The rate plan version.', 'type' => 'string', 'example' => 'ali_2', 'title' => ''],
+ 'OrderStatus' => ['description' => 'The order status. Valid values:'."\n"
+ ."\n"
+ .'- **processing**: being processed.'."\n"
+ ."\n"
+ .'- **failure**: failed.'."\n"
+ ."\n"
+ .'- **completed**: completed.'."\n"
+ ."\n"
+ .'- **unpaid**: pending payment.'."\n"
+ ."\n"
+ .'- **refunded**: refunded.', 'type' => 'string', 'example' => 'processing', 'title' => ''],
+ 'PoolNo' => ['description' => 'The pool number.', 'type' => 'string', 'example' => 'beika4', 'title' => ''],
+ 'FunctionFee' => ['description' => 'The number of monthly feature fee shares. This parameter is specific to unified payment pools.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''],
+ 'PayTime' => ['description' => 'The purchase time.', 'type' => 'string', 'example' => '2022-04-11 16:43:00', 'title' => ''],
+ 'FlowType' => ['description' => 'The traffic type. Valid values:'."\n"
+ ."\n"
+ .'- **singlecard**: single-card general traffic.'."\n"
+ ."\n"
+ .'- **directionalcard**: single-card directional traffic.'."\n"
+ ."\n"
+ .'- **sameflowcard**: same-tier pool shared traffic.'."\n"
+ ."\n"
+ .'- **directional_sameflowcard**: same-tier pool shared directional traffic.'."\n"
+ ."\n"
+ .'- **unityPayPool**: unified payment pool general traffic.'."\n"
+ ."\n"
+ .'- **GREcard**: unified payment pool directional traffic.', 'type' => 'string', 'example' => 'singlecard', 'title' => ''],
+ 'PoolCapacity' => ['description' => 'The pool capacity. For the unit, see the **PoolCapacityUnit** field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'OrderInfo' => ['description' => 'The order information.', 'type' => 'string', 'example' => '123123', 'title' => ''],
+ 'OrderType' => ['description' => 'The order type. Valid values:'."\n"
+ ."\n"
+ .'- **NEW**: new purchase.'."\n"
+ ."\n"
+ .'- **ADD_FLOW**: pool expansion.'."\n"
+ ."\n"
+ .'- **ADD_CARD**: card replacement.'."\n"
+ ."\n"
+ .'- **FUNCTION**: monthly feature fee purchase.'."\n"
+ ."\n"
+ .'- **FLOW_PLUS**: add-on package purchase.'."\n"
+ ."\n"
+ .'- **RENEW**: plan renewal.'."\n"
+ ."\n"
+ .'- **AUTO_RENEW**: automatic plan renewal.', 'type' => 'string', 'example' => 'NEW', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '21450******0275', 'title' => ''],
+ 'CredentialNo' => ['description' => 'The plan credential.', 'type' => 'string', 'example' => 'CM-***-*-2-**M', 'title' => ''],
+ 'ExpressNoList' => [
+ 'description' => 'The logistics information.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The logistics tracking number.', 'type' => 'string', 'example' => '123123123', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DeliveryInfo' => [
+ 'description' => 'The delivery information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ZipCode' => ['description' => 'The zip code in the delivery information.', 'type' => 'string', 'example' => '100000', 'title' => ''],
+ 'Address' => ['description' => 'The address in the delivery information.', 'type' => 'string', 'example' => '收货地址', 'title' => ''],
+ 'Mail' => ['description' => 'The email address in the delivery information.', 'type' => 'string', 'example' => 'xxx@xxx.com', 'title' => ''],
+ 'Receiver' => ['description' => 'The recipient in the delivery information.', 'type' => 'string', 'example' => '收件人', 'title' => ''],
+ 'BuyerMessage' => ['description' => 'The phone number in the delivery information.', 'type' => 'string', 'example' => '收件电话', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OrderDetailUrl' => ['description' => 'The URL of the order details.', 'type' => 'string', 'example' => 'https://us******60589', 'title' => ''],
+ 'ApnName' => ['description' => 'The APN name.', 'type' => 'string', 'example' => 'CMIOTCZHZA.JS', 'title' => ''],
+ 'ApnRegion' => ['description' => 'The APN region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'ResourceQuantity' => ['description' => 'The quantity of IP addresses purchased.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'NetworkType' => ['description' => 'The network type. Valid values: 4G and 5G.', 'type' => 'string', 'example' => '4G', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
],
- 'TagId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '14',
- ],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InstanceId cannot be empty.',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.check.IccidCanNotEmpty',
- 'errorMessage' => 'Iccid cannot be empty.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"TagId\\": \\"14\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddTagsToCardResponse>\\n <Code>200</Code>\\n <Data>\\n <TagName>测试标签</TagName>\\n <TagId>14</TagId>\\n </Data>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n</AddTagsToCardResponse>","errorExample":""}]',
- 'title' => 'AddTagsToCard',
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => 'linkcard.common.BusinessProcessError'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 5,\\n \\"Total\\": 48,\\n \\"List\\": [\\n {\\n \\"BillingCycle\\": \\"1101\\",\\n \\"BuyNum\\": 100,\\n \\"PoolCapacityUnit\\": \\"GB\\",\\n \\"CardPayCount\\": 0,\\n \\"CredentialPackage\\": \\"AL-UPG-******3_beika4\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"PayDuration\\": \\"12月\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"OrderStatus\\": \\"processing\\",\\n \\"PoolNo\\": \\"beika4\\",\\n \\"FunctionFee\\": 90,\\n \\"PayTime\\": \\"2022-04-11 16:43:00\\",\\n \\"FlowType\\": \\"singlecard\\",\\n \\"PoolCapacity\\": \\"200\\",\\n \\"OrderInfo\\": \\"123123\\",\\n \\"OrderType\\": \\"NEW\\",\\n \\"OrderId\\": \\"21450******0275\\",\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"ExpressNoList\\": [\\n \\"123123123\\"\\n ],\\n \\"DeliveryInfo\\": {\\n \\"ZipCode\\": \\"100000\\",\\n \\"Address\\": \\"收货地址\\",\\n \\"Mail\\": \\"xxx@xxx.com\\",\\n \\"Receiver\\": \\"收件人\\",\\n \\"BuyerMessage\\": \\"收件电话\\"\\n },\\n \\"OrderDetailUrl\\": \\"https://us******60589\\",\\n \\"ApnName\\": \\"CMIOTCZHZA.JS\\",\\n \\"ApnRegion\\": \\"cn-hangzhou\\",\\n \\"ResourceQuantity\\": 10000,\\n \\"NetworkType\\": \\"4G\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Query order list',
+ 'description' => '## Limits'."\n"
+ ."\n"
+ .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 20.'."\n"
+ ."\n"
+ .'> Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.',
+ 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you invoke this operation. For more information, see [Common parameters](~~375336~~).',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-03T02:45:20.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-04-12T04:59:35.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-28T11:23:14.000Z', 'description' => 'Error codes changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrder'],
+ ],
+ ],
+ 'ramActions' => [],
],
- 'GetSimCardStateDistribution' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RebindResumeSingleCard' => [
+ 'summary' => 'Changes the status of a card from "rebind deactivated" to "rebind reactivated".',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'CredentialNO',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'CT-SC-M-2-100M',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can find the ICCID on the IoT card, or view it on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'Date',
+ 'name' => 'OptMsisdns',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'example' => '202209',
- 'required' => true,
- 'type' => 'string',
+ 'description' => 'Specifies whether to perform the operation on a sub-card. Set this parameter to the MSISDN of the sub-card.'."\n"
+ ."\n"
+ .'- This parameter is not required for a standard single-network card.'."\n"
+ .'- For a virtual network operator:'."\n"
+ .' - If you specify this parameter, the operation is performed on the specified sub-card.'."\n"
+ .' - If you do not specify this parameter, the operation is performed on all sub-cards.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The MSISDN of the sub-card.', 'type' => 'string', 'required' => false, 'example' => '141******1111', 'title' => ''],
+ 'required' => false,
+ 'example' => ' ["1112******826","1112******827"] ',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Data' => [
- 'description' => '',
- 'properties' => [
- 'CardCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TestCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'UnusedCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'StopCount' => [
- 'description' => '',
- 'example' => '5',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'DestoryedCount' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'UsingCount' => [
- 'description' => '',
- 'example' => '50',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'ShutDownCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
+ 'Data' => ['description' => 'The execution result.'."\n"
+ ."\n"
+ .'- **true**: The operation is successful.'."\n"
+ ."\n"
+ .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID, which is the identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'Iccid cannot be empty. ', 'title' => ''],
+ 'Code' => ['description' => 'The return code of the operation.'."\n"
+ ."\n"
+ .'- **200**: success.'."\n"
+ .'- Other values: error codes. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.check.TimeFormatError',
- 'errorMessage' => 'Time format error.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.CredentialInstanceNotExist',
- 'errorMessage' => 'The credential instance does not exist.',
- ],
- [
- 'errorCode' => 'linkcard.common.CredentialNoNotExist',
- 'errorMessage' => 'The credentialNo does not exist',
- ],
+ ['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => 'Iccid cannot be empty.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CardCount\\": 100,\\n \\"TestCount\\": 20,\\n \\"UnusedCount\\": 10,\\n \\"StopCount\\": 5,\\n \\"DestoryedCount\\": 0,\\n \\"UsingCount\\": 50,\\n \\"ShutDownCount\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSimCardStateDistributionResponse>\\n <code>200</code>\\n <data>\\n <RequestId>5C06CF1A-959D-10A9-9C56-003EDF663BAF</RequestId>\\n <Data>\\n <StopCount>166</StopCount>\\n <TestCount>50098</TestCount>\\n <UnusedCount>426</UnusedCount>\\n <CardCount>902847</CardCount>\\n <DestoryedCount>340498</DestoryedCount>\\n <UsingCount>511007</UsingCount>\\n <ShutDownCount>652</ShutDownCount>\\n </Data>\\n <Success>true</Success>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>5C06CF1A-959D-10A9-9C56-003EDF663BAF</requestId>\\n <successResponse>true</successResponse>\\n</GetSimCardStateDistributionResponse>","errorExample":""}]',
- 'title' => 'GetSimCardStateDistribution',
- ],
- 'AddDirectionalAddress' => [
- 'summary' => '新增目标地址',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"Iccid cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Rebind and reactivate a card',
+ 'description' => '## Operation description'."\n"
+ ."\n\n"
+ .'An IoT card has a one-to-one relationship with a device. When an IoT card is first inserted into a device and generates traffic after being powered on, it is bound to that device. If the card is moved to a different device, the card is locked. You can call this operation to unlock the card.',
+ 'requestParamsDescription' => ' When you invoke this operation, you must specify the request parameters described in this topic and the common request parameters. For more information about common request metric description, see [Common parameters](~~375336~~).',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-28T11:23:14.000Z', 'description' => 'Error codes changed, Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:RebindResumeSingleCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebindResumeSingleCard'],
+ ],
],
+ ],
+ 'Renew' => [
+ 'summary' => 'Renews plan subscriptions and purchases add-on packages for IoT cards. This operation applies only to single-card plans and same-tier pool plans. For unified-payment pool plans, use the pool expansion and feature fee purchase functions in the console.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4240,307 +3641,251 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '10000002595',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'name' => 'ApiProduct',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The API code.', 'type' => 'string', 'required' => false, 'example' => 'linkcard', 'title' => ''],
],
[
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'user_defined',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'name' => 'ApiRevision',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The API version.', 'type' => 'string', 'required' => false, 'example' => '2021-05-20', 'title' => ''],
],
[
- 'name' => 'AddressType',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 'Domain',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can find the ICCID on the IoT card itself, or on the Card Management page of the IoT SIM Service console.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'Address',
+ 'name' => 'RechargeType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '*.aliyun.com',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The recharge type. Valid values:'."\n"
+ ."\n"
+ .'- STANDARD: renews a plan subscription.'."\n"
+ .'- OVERLAY: purchases an add-on package.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'STANDARD', 'title' => ''],
],
[
'name' => 'SerialNo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '123123',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The custom order number. The number must be unique and idempotent.'."\n"
+ ."\n"
+ .'If your recharge involves order management on your own platform, such as recharging for downstream customers, you can enter an external order number generated by your platform. After this operation is called successfully, an order number (OrderNo) is generated. This parameter helps you associate the generated order number with the external order number. If this scenario does not apply, enter any positive integer, such as 0.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '12345678', 'title' => ''],
],
[
- 'name' => 'MsgNotify',
+ 'name' => 'OfferCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => 'This parameter is required when the recharge type is set to add-on package purchase.'."\n"
+ ."\n"
+ .'Contact your technical support representative for the specific code.', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => 'COM***0203', 'title' => ''],
],
[
- 'name' => 'UrlInsecurityForce',
+ 'name' => 'BuyNum',
'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => 'The number of units to purchase. Select the number based on the plan type of the IoT card. Valid values:'."\n"
+ .'- Renew a monthly plan: 1, 2, 3, 6, 9, or 12.'."\n"
+ .'- Renew an annual plan: 1, 2, or 3.'."\n"
+ .'- Purchase an add-on package: 1, 2, or 3.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '12', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- **200**: success.'."\n"
+ .'- Other values: error codes. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
+ 'description' => 'The order number data returned.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderNo' => ['description' => 'The order number generated after the operation is called successfully.', 'type' => 'string', 'example' => '21450******0275', 'title' => ''],
+ 'SerialNo' => ['description' => 'The custom order number (SerialNo).', 'type' => 'string', 'example' => '12345678', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderNo\\": \\"21450******0275\\",\\n \\"SerialNo\\": \\"12345678\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Recharge',
+ 'description' => '## Limits'."\n"
+ ."\n"
+ .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 20.'."\n"
+ ."\n"
+ .'> Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.',
+ 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~375336~~).',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T07:56:27.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-11-07T06:18:54.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-04-19T01:49:12.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2022-04-19T01:49:12.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Renew'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:Renew',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<AddDirectionalAddressResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</AddDirectionalAddressResponse>","errorExample":""}]',
],
- 'DeleteDirectionalAddress' => [
- 'summary' => '删除定向地址',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ResumeSingleCard' => [
+ 'summary' => 'Resume a single card that is in the "Voluntarily Deactivated" or "Mass Deactivated" status to the "Reuse" state.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '10000002595',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'Address',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '*.aliyun.com',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'SerialNo',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '123123',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can find the ICCID on the IoT card, or view the ICCID on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'MsgNotify',
+ 'name' => 'OptMsisdns',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'example' => 'false',
+ 'description' => 'Specifies whether to perform the operation on sub-cards by entering the MSISDN of the sub-cards.'."\n"
+ ."\n"
+ .'- This parameter is not required for regular single network cards.'."\n"
+ .'- For virtual operators:'."\n"
+ .' - If this parameter is specified, the operation is performed on the specified sub-cards.'."\n"
+ .' - If this parameter is not specified, the operation is performed on all sub-cards.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The MSISDN of the sub-card.', 'type' => 'string', 'required' => false, 'example' => '141******1111', 'title' => ''],
'required' => false,
- 'type' => 'boolean',
+ 'example' => '["111******6826","11*******6827"]',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
+ 'Data' => ['description' => 'The execution result.'."\n"
+ ."\n"
+ .'- **true**: The execution was successful.'."\n"
+ ."\n"
+ .'- **false**: The execution failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID, which is the identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty. ', 'title' => ''],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- **200**: Success.'."\n"
+ .'- Others: Error code. For more information about error codes, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => 'Iccid cannot be empty.'],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Proactively resume a card',
+ 'description' => '## Usage Notes'."\n"
+ ."\n\n"
+ .'The maximum number of queries per second (QPS) for a single Alibaba Cloud account to call this API operation is 20.'."\n"
+ ."\n"
+ .'> RAM users share the quota of the Alibaba Cloud account.',
+ 'requestParamsDescription' => 'When you call this API operation, in addition to the request parameters described in this topic, you must also include common request parameters. For more information about common request parameters, see [Common parameters](~~375336~~).'."\n",
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-28T11:23:14.000Z', 'description' => 'Error codes changed, Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeSingleCard'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:ResumeSingleCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDirectionalAddressResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</DeleteDirectionalAddressResponse>","errorExample":""}]',
],
- 'DeleteDirectionalGroup' => [
- 'summary' => '删除定向分组',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'SendMessage' => [
+ 'summary' => 'Sends an SMS message from the platform.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -4548,785 +3893,342 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'GroupId',
- 'in' => 'query',
+ 'name' => 'TaskName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The custom task name. The name cannot contain special characters and can be up to 40 characters in length.', 'type' => 'string', 'required' => true, 'example' => '任务0912', 'title' => ''],
+ ],
+ [
+ 'name' => 'MessageTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the SMS template. You can view the template ID in the console.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '14'],
+ ],
+ [
+ 'name' => 'MessageVariableParam',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The replacement dynamic parameter for an SMS message, in the format {1}{2}.', 'type' => 'string', 'required' => false, 'example' => '{参数1}{参数2}{参数3}'],
+ ],
+ [
+ 'name' => 'MessageSendTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The timestamp, in seconds.'."\n"
+ ."\n"
+ .'If the specified time is earlier than the current time, the message is sent immediately. If the specified time is later than the current time, the message is sent at the scheduled time.'."\n"
+ ."\n"
+ .'The scheduled time cannot be more than one month from the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1694401634'],
+ ],
+ [
+ 'name' => 'Msisdns',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '10000002595',
- 'required' => true,
- 'type' => 'string',
+ 'description' => 'The list of destination MSISDNs to which the SMS message is sent.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The destination MSISDN to which the SMS message is sent.', 'type' => 'string', 'required' => false, 'example' => '1411234123412', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'ApiProduct',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Linkcard.', 'type' => 'string', 'required' => false, 'example' => 'Linkcard', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'SendMessageResponse',
+ 'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
+ 'RequestId' => ['description' => 'The request ID. An identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The call was successful.'."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'200: The call was successful.'."\n"
+ ."\n"
+ .'Other codes: The call failed. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language of the current region.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvokeError', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The error code message.', 'type' => 'string', 'example' => '入参不能为空,或不能包含空格', 'title' => ''],
+ 'Data' => ['description' => 'Indicates whether the address was added. Valid values:'."\n"
+ ."\n"
+ .'- true: The address was added.'."\n"
+ .'- false: The address failed to be added.', 'type' => 'integer', 'format' => 'int64', 'example' => 'true', 'title' => ''],
],
- 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny ',
- 'errorMessage' => 'You do not have the RAM permission. ',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDirectionalGroupResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</DeleteDirectionalGroupResponse>","errorExample":""}]',
- ],
- 'GetCardStatusStatistics' => [
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"DynamicCode\\": \\"InvokeError\\",\\n \\"DynamicMessage\\": \\"入参不能为空,或不能包含空格\\",\\n \\"Data\\": 0\\n}","type":"json"}]',
+ 'title' => 'SendMessage',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T07:56:27.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'https',
- 'http',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'headers' => [],
- 'schema' => [
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Data' => [
- 'description' => '',
- 'properties' => [
- 'UnbindResumeStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'PoolCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SingleCardCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SameFlowCardCount' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'FlowOutStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'PoolCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SingleCardCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SameFlowCardCount' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'ErrorStopStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'PoolCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SingleCardCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SameFlowCardCount' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'ExhaustStopStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'PoolCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SingleCardCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SameFlowCardCount' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'UnCertifiedStopStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'PoolCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SingleCardCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SameFlowCardCount' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'ManageStopStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'PoolCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SingleCardCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SameFlowCardCount' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'ExpireStopStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'PoolCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SingleCardCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SameFlowCardCount' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'WeekWarnStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'PoolCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SingleCardCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'SameFlowCardCount' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'RiskWaringStatisticsDTO' => [
- 'description' => '',
- 'properties' => [
- 'WarningCount' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'WaringTotalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'StopCount' => [
- 'description' => '',
- 'example' => '40',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'LeftFlowPercentageWarnCount' => [
- 'description' => '',
- 'example' => '40',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'SingCardPeriodLeftFlowWarnDTO' => [
- 'description' => '',
- 'properties' => [
- 'LessFlowPercentage10Count' => [
- 'description' => '',
- 'example' => '5',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'LessFlowPercentage30Count' => [
- 'description' => '',
- 'example' => '8',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- ],
- 'type' => 'object',
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:SendMessage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'type' => 'object',
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"UnbindResumeStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"FlowOutStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ErrorStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ExhaustStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"UnCertifiedStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ManageStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ExpireStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"WeekWarnStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"RiskWaringStatisticsDTO\\": {\\n \\"WarningCount\\": 20,\\n \\"WaringTotalCount\\": 100,\\n \\"StopCount\\": 40,\\n \\"LeftFlowPercentageWarnCount\\": 40\\n },\\n \\"SingCardPeriodLeftFlowWarnDTO\\": {\\n \\"LessFlowPercentage10Count\\": 5,\\n \\"LessFlowPercentage30Count\\": 8\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCardStatusStatisticsResponse>\\n <code>200</code>\\n <data>\\n <RequestId>DCBDCDBC-0E54-53AC-97A4-6194849CC6BC</RequestId>\\n <Data>\\n <ExhaustStopStatisticsDTO>\\n <TotalCount>8</TotalCount>\\n <SingleCardCount>0</SingleCardCount>\\n <SameFlowCardCount>4</SameFlowCardCount>\\n <PoolCount>4</PoolCount>\\n </ExhaustStopStatisticsDTO>\\n <WeekWarnStatisticsDTO>\\n <TotalCount>20</TotalCount>\\n <SingleCardCount>20</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>0</PoolCount>\\n </WeekWarnStatisticsDTO>\\n <FlowOutStatisticsDTO>\\n <TotalCount>12</TotalCount>\\n <SingleCardCount>7</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>5</PoolCount>\\n </FlowOutStatisticsDTO>\\n <SingCardPeriodLeftFlowWarnDTO>\\n <LessFlowPercentage10Count>15</LessFlowPercentage10Count>\\n <LessFlowPercentage30Count>0</LessFlowPercentage30Count>\\n </SingCardPeriodLeftFlowWarnDTO>\\n <ErrorStopStatisticsDTO>\\n <TotalCount>1</TotalCount>\\n <SingleCardCount>0</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>1</PoolCount>\\n </ErrorStopStatisticsDTO>\\n <ExpireStopStatisticsDTO>\\n <TotalCount>652</TotalCount>\\n <SingleCardCount>506</SingleCardCount>\\n <SameFlowCardCount>146</SameFlowCardCount>\\n <PoolCount>0</PoolCount>\\n </ExpireStopStatisticsDTO>\\n <UnbindResumeStatisticsDTO>\\n <TotalCount>1</TotalCount>\\n <SingleCardCount>0</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>1</PoolCount>\\n </UnbindResumeStatisticsDTO>\\n <UnCertifiedStopStatisticsDTO>\\n <TotalCount>1</TotalCount>\\n <SingleCardCount>0</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>1</PoolCount>\\n </UnCertifiedStopStatisticsDTO>\\n <RiskWaringStatisticsDTO>\\n <WarningCount>20</WarningCount>\\n <StopCount>825</StopCount>\\n <LeftFlowPercentageWarnCount>15</LeftFlowPercentageWarnCount>\\n <WaringTotalCount>860</WaringTotalCount>\\n </RiskWaringStatisticsDTO>\\n <ManageStopStatisticsDTO>\\n <TotalCount>150</TotalCount>\\n <SingleCardCount>57</SingleCardCount>\\n <SameFlowCardCount>31</SameFlowCardCount>\\n <PoolCount>62</PoolCount>\\n </ManageStopStatisticsDTO>\\n </Data>\\n <ErrorMessage/>\\n <Code/>\\n <Success>true</Success>\\n <LocalizedMessage/>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>DCBDCDBC-0E54-53AC-97A4-6194849CC6BC</requestId>\\n <successResponse>true</successResponse>\\n</GetCardStatusStatisticsResponse>","errorExample":""}]',
- 'title' => 'GetCardStatusStatistics',
],
- 'GetCardRealStatus' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'SetCardStopRule' => [
+ 'summary' => 'Sets the data cap suspension rule for a card. Only same-tier pool plans and unified payment pool plans are supported.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card or on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'Msisdn',
+ 'name' => 'FlowLimit',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '144******1111',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The data cap threshold for suspension. Only positive integers are supported. Unit: MB.'."\n"
+ ."\n"
+ .'When the monthly data usage reaches this value, the card is automatically suspended. You can manually resume the card.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''],
],
[
- 'name' => 'SerialNo',
+ 'name' => 'AutoRestore',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '4f84******7895',
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
- 'type' => 'array',
- ],
+ 'schema' => ['description' => 'Specifies whether to automatically resume the card in the following month after it is suspended due to reaching the data cap.'."\n"
+ ."\n"
+ .'- true (default): Automatically resume in the following month.'."\n"
+ ."\n"
+ .'- false: Do not automatically resume in the following month.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'GetCardRealStatusResponse',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '必填',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Data' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'SerialNo' => [
- 'description' => '',
- 'example' => '4f84******7895',
- 'type' => 'string',
- ],
- 'Iccid' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'type' => 'string',
- ],
- 'Gprs' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Online' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Status' => [
- 'description' => '',
- 'example' => 'SUCCESS',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
+ 'Data' => ['description' => 'The execution result.'."\n"
+ ."\n"
+ .'- **true**: The operation was successful.'."\n"
+ ."\n"
+ .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- **200**: The operation was successful.'."\n"
+ .'- Other values: An error occurred. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'title' => 'GetCardRealStatusResponse',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'linkcard.check.RuleMaxValueLimit', 'errorMessage' => 'The maximum value of Rule must be less than 9007199254740991.', 'description' => 'Rule max value must less than 9007199254740991.'],
+ ['errorCode' => 'linkcard.check.RuleMustBePositiveInteger', 'errorMessage' => 'The valid values of Rule are positive integers and zero.', 'description' => 'Rule must be positive integer and zero.'],
],
403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => 'linkcard.common.BusinessProcessError',
- 'errorMessage' => 'A business processing exception occurred.',
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Set data cap suspension rule for a card',
+ 'description' => '## Limits'."\n"
+ ."\n"
+ .'The maximum number of times that a single Alibaba Cloud account can invoke this operation per second (QPS) is 20.'."\n"
+ ."\n"
+ .'> Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.',
+ 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~375336~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCardStopRule'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:SetCardStopRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": [\\n {\\n \\"SerialNo\\": \\"4f84******7895\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Gprs\\": true,\\n \\"Online\\": true,\\n \\"Status\\": \\"SUCCESS\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetCardRealStatusResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <SerialNo>4f84b7a5-90******07895</SerialNo>\\n <Iccid>89860321******15668</Iccid>\\n <Gprs>true</Gprs>\\n <Online>true</Online>\\n <Status>SUCCESS</Status>\\n </Data>\\n</GetCardRealStatusResponse>","errorExample":""}]',
- 'title' => 'GetCardRealStatus',
],
- 'GetCardLatestFlow' => [
- 'summary' => '获取卡的最新周期累计流量',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'StopSingleCard' => [
+ 'summary' => 'Proactively deactivates a single card that is in the "In Use" state.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card, or on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
+ ],
+ [
+ 'name' => 'OptMsisdns',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'required' => true,
- 'title' => 'iccid',
- 'type' => 'string',
+ 'description' => 'Specifies whether to perform the operation on a sub-card. Set this parameter to the MSISDN of the sub-card.'."\n"
+ ."\n"
+ .'- This parameter is not required for a standard single-network card.'."\n"
+ .'- For a virtual network operator:'."\n"
+ .' - If you specify this parameter, the operation is performed on the specified sub-card.'."\n"
+ .' - If you do not specify this parameter, the operation is performed on all sub-cards.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The MSISDN of the sub-card.', 'type' => 'string', 'required' => false, 'example' => '141******1111', 'title' => ''],
+ 'required' => false,
+ 'example' => '["1112******826","1112******827"] ',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
- 'headers' => [],
'schema' => [
- 'description' => 'GetCardLatestFlowResponse',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '必填',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Data' => [
- 'description' => '',
- 'example' => '1.00MB',
- 'type' => 'string',
- ],
+ 'Data' => ['description' => 'The execution result.'."\n"
+ ."\n"
+ .'- **true**: The operation was successful.'."\n"
+ ."\n"
+ .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID, which is the identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty. ', 'title' => ''],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- **200**: success.'."\n"
+ .'- Other values: error codes. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'title' => 'GetCardLatestFlowResponse',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.InvalidAliyunPK',
- 'errorMessage' => 'AliyunPk is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
- [
- 'errorCode' => 'linkcard.common.IccidNotExist',
- 'errorMessage' => 'IccId does not exist.',
- ],
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
+ ['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => 'Iccid cannot be empty.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Proactively deactivate a card',
+ 'description' => '## Before you begin'."\n"
+ ."\n\n"
+ .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 20.'."\n"
+ ."\n"
+ .'> Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.',
+ 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~375336~~).',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-28T11:23:14.000Z', 'description' => 'Error codes changed, Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopSingleCard'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:StopSingleCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": \\"1.00MB\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCardLatestFlowResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>1.00MB</Data>\\n</GetCardLatestFlowResponse>","errorExample":""}]',
- 'title' => 'GetCardLatestFlow',
],
- 'AddCardToDirectionalGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'UpdateAutoRechargeSwitch' => [
+ 'summary' => 'Enables or disables the auto-renewal feature for a card. This operation applies only to single-card plans and same-tier pool plans.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5334,181 +4236,99 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'IccidList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'items' => [
- 'description' => 'ICCID。',
- 'example' => '1111****6225',
- 'required' => true,
- 'type' => 'string',
- ],
- 'maxItems' => 200,
- 'required' => true,
- 'type' => 'array',
- ],
- ],
- [
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '10000002595',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'SerialNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '123123',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'AddType',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'NEW',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card or on the Card Management page of the [IoT SIM Service console](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
[
- 'name' => 'MsgNotify',
+ 'name' => 'Open',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'type' => 'boolean',
- ],
- ],
- [
- 'name' => 'ApiProduct',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Linkcard',
- 'example' => 'Linkcard',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The auto-renewal switch.'."\n"
+ ."\n"
+ .'- **true**: Enables auto-renewal.'."\n"
+ ."\n"
+ .'- **false**: Disables auto-renewal.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'AddCardToDirectionalGroupResponse',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '必填',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Data' => [
- 'description' => '',
- 'properties' => [
- 'Result' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'SerialNo' => [
- 'description' => '',
- 'example' => '123213',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
+ 'Data' => ['description' => 'The execution result.'."\n"
+ ."\n"
+ .'- **true**: The operation is successful.'."\n"
+ ."\n"
+ .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '系统异常', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Code' => ['description' => 'The return code of the operation.'."\n"
+ ."\n"
+ .'- **200**: The operation is successful.'."\n"
+ .'- Other values: An error code is returned. For more information, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
],
- 'title' => 'AddCardToDirectionalGroupResponse',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IllegalParameter',
- 'errorMessage' => 'The request parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny ',
- 'errorMessage' => 'You do not have the RAM permission. ',
- ],
+ ['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
],
500 => [
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
+ ['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'An RPC invoking error occurred'],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'UpdateAutoRechargeSwitch',
+ 'description' => '## Limits'."\n"
+ ."\n"
+ .'The maximum number of queries per second (QPS) per Alibaba Cloud account for invoking this operation is 20.'."\n"
+ ."\n"
+ .'> Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.',
+ 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~375336~~).',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-28T11:23:14.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAutoRechargeSwitch'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:UpdateAutoRechargeSwitch',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"Result\\": true,\\n \\"SerialNo\\": \\"123213\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddCardToDirectionalGroupResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <Result>true</Result>\\n <SerialNo>123213</SerialNo>\\n </Data>\\n</AddCardToDirectionalGroupResponse>","errorExample":""}]',
],
- 'GetRealNameStatus' => [
- 'summary' => '查询卡的实名认证状态',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'VerifyIotCard' => [
+ 'summary' => 'Queries whether an IoT card is a directional card.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
@@ -5516,563 +4336,733 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '89860321******15668',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ListMsisdns',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '144******1111',
- 'required' => false,
- 'type' => 'string',
- ],
- 'maxItems' => 10,
- 'required' => false,
- 'type' => 'array',
- ],
+ 'schema' => ['description' => 'The ICCID of the IoT card.'."\n"
+ ."\n"
+ .'You can view the ICCID on the IoT card, or on the Card Management page of the IoT SIM Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668', 'title' => ''],
],
],
'responses' => [
200 => [
+ 'headers' => [],
'schema' => [
- 'description' => 'GetRealNameStatusResponse',
+ 'title' => '',
+ 'description' => 'VerifyIotCardResponse',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '必填',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '200',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'example' => 'InstanceId cannot be empty.',
- 'type' => 'string',
- ],
- 'Data' => [
- 'description' => '',
- 'properties' => [
- 'RealNameStatus' => [
- 'description' => '',
- 'example' => 'CERTIFIED',
- 'type' => 'string',
- ],
- 'Desc' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request.', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43', 'title' => ''],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => 'The response code.'."\n"
+ ."\n"
+ .'- 200: The call was successful.'."\n"
+ ."\n"
+ .'- Other codes: The call failed. For more information about error codes, see [Error codes](~~375339~~).', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the call failed.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'LocalizedMessage' => ['description' => 'The error message displayed in the language that corresponds to the current location.', 'type' => 'string', 'example' => 'InstanceId cannot be empty.', 'title' => ''],
+ 'Data' => ['description' => 'Indicates whether the card is a directional card.'."\n"
+ ."\n"
+ .'- **true**: The card is a directional card.'."\n"
+ ."\n"
+ .'- **false**: The card is not a directional card.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
- 'title' => 'GetRealNameStatusResponse',
- 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.common.InvalidAliyunPK',
- 'errorMessage' => 'AliyunPk is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.check.IccidCanNotEmpty',
- 'errorMessage' => 'Iccid cannot be empty.',
- ],
- [
- 'errorCode' => 'linkcard.common.CardDestroy',
- 'errorMessage' => 'The card do not exist or destroy.',
- ],
- [
- 'errorCode' => 'linkcard.common.IccidFormatError',
- 'errorMessage' => 'Iccid format error.',
- ],
- [
- 'errorCode' => 'linkcard.common.VnoCardNotSupported',
- 'errorMessage' => 'This function does not support vno card.',
- ],
+ ['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => 'Iccid cannot be empty.'],
+ ['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => 'The request parameter is invalid.'],
+ ['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
+ ['errorCode' => 'CardDisabled', 'errorMessage' => 'The SIM card has been permanently disabled.', 'description' => ''],
+ ['errorCode' => 'linkcard.common.CardNotExist', 'errorMessage' => 'The card does not exist.', 'description' => ''],
+ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'You do not have the RAM permission.'],
+ ['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
+ ['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"RealNameStatus\\": \\"CERTIFIED\\",\\n \\"Desc\\": \\"已认证\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRealNameStatusResponse>\\n <data>\\n <realNameStatus>NOT_CERTIFIED</realNameStatus>\\n <desc>未认证</desc>\\n </data>\\n <requestId>D3778AAD-6A0E-16F8-8074-C4AF604E21B3</requestId>\\n <success>true</success>\\n</GetRealNameStatusResponse>","errorExample":""}]',
- 'title' => 'GetRealNameStatus',
- ],
- 'SendMessage' => [
- 'summary' => '短信发送openApi',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": true\\n}","type":"json"}]',
+ 'title' => 'Query directional card',
+ 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call this API operation. For more information, see [Common parameters](~~30561~~).',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T07:56:26.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'https',
- 'http',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyIotCard'],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'TaskName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'MessageTemplateId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模版ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '14',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'MessageVariableParam',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '请求参数',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'MessageSendTime',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '单位:s',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1694401634',
- ],
- ],
- [
- 'name' => 'Msisdns',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1411234123412',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:VerifyIotCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'ApiProduct',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Linkcard',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Linkcard',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SendMessageResponse',
- 'description' => 'SendMessageResponse',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43',
- ],
- 'Success' => [
- 'title' => '必填',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InstanceId cannot be empty.',
- ],
- 'LocalizedMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InstanceId cannot be empty.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvokeError',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'linkcard.common.InvalidAliyunPK',
- 'errorMessage' => 'AliyunPk is invalid.',
- ],
- [
- 'errorCode' => 'linkcard.system.IllegalRequest',
- 'errorMessage' => 'The request parameter is invalid.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny',
- 'errorMessage' => 'You do not have the RAM permission.',
- ],
- [
- 'errorCode' => '%s.',
- 'errorMessage' => '%s.',
- ],
- [
- 'errorCode' => 'linkcard.common.RamActionPermissionDeny ',
- 'errorMessage' => 'You do not have the RAM permission. ',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'Service.InternalError',
- 'errorMessage' => 'An internal error occurred.',
- ],
- [
- 'errorCode' => 'linkcard.system.RPCInvokeError',
- 'errorMessage' => 'An RPC invoking error occurred',
- ],
- [
- 'errorCode' => '%s..',
- 'errorMessage' => '%s..',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"DynamicCode\\": \\"InvokeError\\",\\n \\"DynamicMessage\\": \\"入参不能为空,或不能包含空格\\",\\n \\"Data\\": 0\\n}","errorExample":""},{"type":"xml","example":"<SendMessageResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n</SendMessageResponse>","errorExample":""}]',
- 'title' => 'SendMessage',
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => '%s.', 'message' => '%s.', 'http_code' => 403, 'description' => ''],
+ ['code' => '%s..', 'message' => '%s..', 'http_code' => 500, 'description' => ''],
+ ['code' => 'BBC.FAIL', 'message' => 'A business processing exception occurred.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CardDisabled', 'message' => 'The SIM card has been permanently disabled.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'IdempotentParameterMismatch', 'message' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'IllegalParameter', 'message' => 'The request parameter %s is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.cha.PolicyAlreadyBound', 'message' => 'Cha policy has already been bound', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.cha.ResourceNotExist', 'message' => 'Cha resource does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'linkcard.check.DataLevelCanNotEmpty', 'message' => 'Data level cannot be empty.', 'http_code' => 400, 'description' => 'Data level cannot be empty.'],
+ ['code' => 'linkcard.check.DataTypeCanNotEmpty', 'message' => 'Data type cannot be empty.', 'http_code' => 400, 'description' => 'Data type cannot be empty.'],
+ ['code' => 'linkcard.check.ForceActivationSameFlowCard', 'message' => 'Only cards in the same flow support forced activation.', 'http_code' => 400, 'description' => 'Only same flow card can be force activation.'],
+ ['code' => 'linkcard.check.IccidCanNotEmpty', 'message' => 'Iccid cannot be empty.', 'http_code' => 400, 'description' => 'Iccid cannot be empty.'],
+ ['code' => 'linkcard.check.InstanceIdCanNotEmpty', 'message' => 'InstanceId cannot be empty.', 'http_code' => 400, 'description' => 'InstanceId cannot be empty.'],
+ ['code' => 'linkcard.check.NonCard', 'message' => 'The number of cards triggered by the condition is zero.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.check.OnlyUnusedCanForceActivation', 'message' => 'Only unused cards support forced activation.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.check.OssFileFormatError', 'message' => 'The file format is invalid.', 'http_code' => 400, 'description' => 'The format of file is invalid'],
+ ['code' => 'linkcard.check.OverCardCount', 'message' => 'The number of cards triggered by the condition exceeds the limit.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.check.OverExportCount', 'message' => 'The number of cards owned by the user exceeds the limit.', 'http_code' => 400, 'description' => 'The number of cards owned by the user exceeds the limit.'],
+ ['code' => 'linkcard.check.OverExportCount', 'message' => 'OverExportCount', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.check.OverRuleCount', 'message' => 'The number of rules owned by the user exceeds the limit.', 'http_code' => 400, 'description' => 'The number of rules owned by the user exceeds the limit.'],
+ ['code' => 'linkcard.check.OverThreshold', 'message' => 'The number of Trigger Condition Usage setting exceeds the limit.', 'http_code' => 400, 'description' => 'The number of Trigger Condition Usage setting exceeds the limit.'],
+ ['code' => 'linkcard.check.RuleMaxValueLimit', 'message' => 'The maximum value of Rule must be less than 9007199254740991.', 'http_code' => 400, 'description' => 'Rule max value must less than 9007199254740991.'],
+ ['code' => 'linkcard.check.RuleMustBePositiveInteger', 'message' => 'The valid values of Rule are positive integers and zero.', 'http_code' => 400, 'description' => 'Rule must be positive integer and zero.'],
+ ['code' => 'linkcard.check.SerialNoCanNotEmpty', 'message' => 'Serial Number cannot be empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.check.SerialNoNotExist', 'message' => 'Serial Number not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.check.StartTimeLessEndTime', 'message' => 'The StartTime must be earlier than the EndTime.', 'http_code' => 400, 'description' => 'StartTime must small than endTime'],
+ ['code' => 'linkcard.check.TagIdCanNotEmpty', 'message' => 'The TagId must not be empty.', 'http_code' => 400, 'description' => 'The TagId must not be empty.'],
+ ['code' => 'linkcard.check.TimeFormatError', 'message' => 'Time format error.', 'http_code' => 400, 'description' => 'Time format error.'],
+ ['code' => 'linkcard.check.UploadFileBeyondLimit', 'message' => 'The uploaded file exceeds the limit.', 'http_code' => 400, 'description' => 'Upload file beyond limit.'],
+ ['code' => 'linkcard.check.UploadFileDuplicateCard', 'message' => 'Iccid is duplicated.', 'http_code' => 400, 'description' => 'Iccid is duplicate'],
+ ['code' => 'linkcard.check.UploadFileInvalidCard', 'message' => 'Iccid is invalid.', 'http_code' => 400, 'description' => 'Iccid is invalid'],
+ ['code' => 'linkcard.common.Ambiguous', 'message' => 'The input value is ambiguous.', 'http_code' => 400, 'description' => 'The input value is ambiguous.'],
+ ['code' => 'linkcard.common.BusinessProcessError', 'message' => 'A business processing exception occurred.', 'http_code' => 500, 'description' => 'linkcard.common.BusinessProcessError'],
+ ['code' => 'linkcard.common.CardDestroy', 'message' => 'The card do not exist or destroy.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.common.CardNotExist', 'message' => 'The card does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.common.CredentialInstanceNotExist', 'message' => 'The credential instance does not exist.', 'http_code' => 400, 'description' => 'Credential instance not exist.'],
+ ['code' => 'linkcard.common.CredentialNoNotExist', 'message' => 'The credentialNo does not exist', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.common.IccidFormatError', 'message' => 'Iccid format error.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.common.IccidNotExist', 'message' => 'IccId does not exist.', 'http_code' => 400, 'description' => 'Iccid not exist.'],
+ ['code' => 'linkcard.common.InvalidAliyunPK', 'message' => 'AliyunPk is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.common.InvalidCallerTypeError', 'message' => 'This access mode is not supported.', 'http_code' => 400, 'description' => 'This access mode is not supported.'],
+ ['code' => 'linkcard.common.RamActionPermissionDeny', 'message' => 'You do not have the RAM permission.', 'http_code' => 403, 'description' => 'You do not have the RAM permission.'],
+ ['code' => 'linkcard.common.Retry', 'message' => 'Please try again later', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.common.SignVerificationFailed', 'message' => 'Sign verification failed.', 'http_code' => 400, 'description' => 'Sign verification failed'],
+ ['code' => 'linkcard.common.VnoCardNotSupported', 'message' => 'This function does not support vno card.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.directional.notExist', 'message' => 'Can not find direction group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.service.forbidden', 'message' => 'Please cancel agree write to RocketMq before delete', 'http_code' => 403, 'description' => ''],
+ ['code' => 'linkcard.system.BatchOperationFailed', 'message' => 'An internal error occurred. Try again later.', 'http_code' => 500, 'description' => 'An internal error occurred. Try again later.'],
+ ['code' => 'linkcard.system.CarrierNotSupport', 'message' => 'The carrier of the card does not support.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'linkcard.system.IllegalRequest', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => 'The request parameter is invalid.'],
+ ['code' => 'linkcard.system.RPCInvokeError', 'message' => 'An RPC invoking error occurred', 'http_code' => 500, 'description' => 'An RPC invoking error occurred'],
+ ['code' => 'RamActionPermissionDeny', 'message' => 'You do not have the RAM permission.', 'http_code' => 403, 'description' => 'You do not have RAM permissions.'],
+ ['code' => 'Service.InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'YX.BusinessError', 'message' => 'A business processing exception occurred.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'YX.RpcError', 'message' => 'An RPC invoking error occurred.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'YX.SystemInvokeError', 'message' => '%s.', 'http_code' => 500, 'description' => ''],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2-pop',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-pop',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-gov-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-nu16-b01',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-edge-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-fujian',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-haidian-cm12-c01',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-bj-b01',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-prod-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-2',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-3',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-test-306',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong-finance-pop',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote-nebula-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao-nebula',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et15-b01',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et2-b01',
- 'endpoint' => 'linkcard.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'AddCardToDirectionalGroup'],
+ ['description' => 'Error codes changed', 'api' => 'BatchAddDirectionalAddress'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteDirectionalGroup'],
+ ['description' => 'Error codes changed', 'api' => 'ForceActivation'],
+ ],
+ 'createdAt' => '2025-11-27T07:56:50.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-inner',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListCardInfo'],
+ ['description' => 'Response parameters changed', 'api' => 'ListOrder'],
+ ],
+ 'createdAt' => '2023-08-03T02:46:41.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-internal-test-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ForceActivation'],
+ ],
+ 'createdAt' => '2023-06-29T06:52:29.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddTagsToCard'],
+ ],
+ 'createdAt' => '2023-06-29T05:50:58.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetCredentialPoolStatistics'],
+ ],
+ 'createdAt' => '2023-06-28T06:33:04.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen-inner',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddDirectionalAddress'],
+ ],
+ 'createdAt' => '2023-05-15T08:05:05.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen-st4-d01',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListOrder'],
+ ],
+ 'createdAt' => '2023-04-12T04:59:49.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen-su18-b01',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetCardDetail'],
+ ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetCardFlowInfo'],
+ ],
+ 'createdAt' => '2023-03-24T08:24:58.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-wuhan',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetRealNameStatus'],
+ ],
+ 'createdAt' => '2023-03-24T08:24:17.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ListDirectionalDetail'],
+ ],
+ 'createdAt' => '2023-03-24T08:20:41.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-yushanfang',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListDirectionalAddress'],
+ ],
+ 'createdAt' => '2023-01-09T08:11:33.000Z',
+ 'description' => '定向组中地址列表增加限制条件',
],
[
- 'regionId' => 'cn-zhangbei',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetCardDetail'],
+ ],
+ 'createdAt' => '2022-12-08T06:04:54.000Z',
+ 'description' => '卡详情增加销户提示错误码',
],
[
- 'regionId' => 'cn-zhangbei-na61-b01',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'Renew'],
+ ],
+ 'createdAt' => '2022-11-07T06:20:21.000Z',
+ 'description' => '充值接口增加错误码',
],
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ForceActivation'],
+ ['description' => 'Error codes changed', 'api' => 'ListDirectionalDetail'],
+ ['description' => 'Error codes changed, Response parameters changed', 'api' => 'ListOrder'],
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'RebindResumeSingleCard'],
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ResumeSingleCard'],
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'StopSingleCard'],
+ ['description' => 'Error codes changed', 'api' => 'UpdateAutoRechargeSwitch'],
+ ],
+ 'createdAt' => '2022-10-28T11:23:46.000Z',
+ 'description' => '变更对外开放接口的格式',
],
[
- 'regionId' => 'cn-zhangjiakou-na62-a01',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListCardInfo'],
+ ],
+ 'createdAt' => '2022-09-29T01:48:49.000Z',
+ 'description' => '八月份迭代上线',
],
[
- 'regionId' => 'cn-zhengzhou-nebula-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'AddDirectionalGroup'],
+ ['description' => 'OpenAPI offline', 'api' => 'BatchAddDirectionalAddress'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListDirectionalDetail'],
+ ],
+ 'createdAt' => '2022-08-09T12:00:42.000Z',
+ 'description' => '定向网相关的api发布',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetMqConfig'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListMqService'],
+ ['description' => 'OpenAPI offline', 'api' => 'UpdateMqConfig'],
+ ],
+ 'createdAt' => '2022-06-16T08:05:03.000Z',
+ 'description' => 'MQ业务新增接口',
],
[
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'Renew'],
+ ],
+ 'createdAt' => '2022-04-20T06:14:10.000Z',
+ 'description' => '变更充值接口offerCode参数文档非必填',
],
[
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'Renew'],
+ ],
+ 'createdAt' => '2022-04-19T03:32:17.000Z',
+ 'description' => '增加充值接口',
],
[
- 'regionId' => 'me-east-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetCardDetail'],
+ ],
+ 'createdAt' => '2022-01-20T06:00:57.000Z',
+ 'description' => '发布接口,向上兼容, 开放平台SDK在本次迭代发布后才会上传',
],
- [
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAutoRechargeSwitch'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalGroup'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardLatestFlow'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebindResumeSingleCard'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalAddress'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeSingleCard'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDirectionalGroup'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardRealStatus'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCardStopRule'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalCard'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTagsToCard'],
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardFlowInfo'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCardInfo'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Renew'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDirectionalAddress'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopSingleCard'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealNameStatus'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrder'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSimCardStateDistribution'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ForceActivation'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDirectionalDetail'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardDetail'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardStatusStatistics'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyIotCard'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCardToDirectionalGroup'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCredentialPoolStatistics'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDirectionalAddress'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchAddDirectionalAddress'],
],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'Dyiot',
+ 'productName' => 'IoT Mobile Connection Package',
+ 'ramCodes' => ['linkcard', 'dyiot'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetCardDetail',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCardLatestFlow',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardLatestFlow',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:cardmanage/{#cardmanageId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ForceActivation',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:ForceActivation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SendMessage',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:SendMessage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RebindResumeSingleCard',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:RebindResumeSingleCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDirectionalDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:ListDirectionalDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResumeSingleCard',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:ResumeSingleCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'VerifyIotCard',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:VerifyIotCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDirectionalAddress',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:ListDirectionalAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDirectionalGroup',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:DeleteDirectionalGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDirectionalAddress',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:DeleteDirectionalAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BatchAddDirectionalAddress',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:BatchAddDirectionalAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopSingleCard',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:StopSingleCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddDirectionalAddress',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddDirectionalAddress',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Renew',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:Renew',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCardStatusStatistics',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardStatusStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCredentialPoolStatistics',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCredentialPoolStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCardRealStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardRealStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddTagsToCard',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddTagsToCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSimCardStateDistribution',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetSimCardStateDistribution',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetCardStopRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:SetCardStopRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateAutoRechargeSwitch',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'linkcard:UpdateAutoRechargeSwitch',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddCardToDirectionalGroup',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddCardToDirectionalGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard:*:{#accountId}:directionalmanage/{#DirectionalManageId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRealNameStatus',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetRealNameStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddDirectionalCard',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddDirectionalCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddDirectionalGroup',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'linkcard:AddDirectionalGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard::{#accountId}:directionalmanage/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCardFlowInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'linkcard:GetCardFlowInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'linkcard.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:*'],
+ ['validationType' => 'always', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:cardmanage/{#cardmanageId}'],
+ ['validationType' => 'always', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:cardmanage/*'],
+ ['validationType' => 'always', 'resourceType' => 'SmsManage', 'arn' => 'acs:linkcard:{#regionId}:{#accountId}:smsmanage/*'],
+ ['validationType' => 'always', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard::{#accountId}:directionalmanage/*'],
+ ['validationType' => 'always', 'resourceType' => 'DashboardManage', 'arn' => 'acs:linkcard::{#accountId}:dashboardmanage/*'],
+ ['validationType' => 'always', 'resourceType' => 'CredentialManage', 'arn' => 'acs:linkcard::{#accountId}:credentialmanage/*'],
+ ['validationType' => 'always', 'resourceType' => 'TagManage', 'arn' => 'acs:linkcard::{#accountId}:tagmanage/*'],
+ ['validationType' => 'always', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard:*:{#accountId}:directionalmanage/{#DirectionalManageId}'],
],
],
];