summaryrefslogtreecommitdiff
path: root/data/zh_cn/cc5g/2022-03-14/api-docs.php
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/zh_cn/cc5g/2022-03-14/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/cc5g/2022-03-14/api-docs.php')
-rw-r--r--data/zh_cn/cc5g/2022-03-14/api-docs.php11417
1 files changed, 5104 insertions, 6313 deletions
diff --git a/data/zh_cn/cc5g/2022-03-14/api-docs.php b/data/zh_cn/cc5g/2022-03-14/api-docs.php
index 6b35592..dc1f1f3 100644
--- a/data/zh_cn/cc5g/2022-03-14/api-docs.php
+++ b/data/zh_cn/cc5g/2022-03-14/api-docs.php
@@ -1,276 +1,120 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'CC5G',
- 'version' => '2022-03-14',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'CC5G', 'version' => '2022-03-14'],
'directories' => [
[
- 'id' => 169074,
- 'title' => '地域信息',
+ 'children' => ['OpenCc5gService', 'GetCreateCustomerInformation'],
'type' => 'directory',
- 'children' => [
- 'ListRegions',
- 'ListZones',
- ],
- ],
- [
- 'id' => 169077,
'title' => '权限管理',
- 'type' => 'directory',
- 'children' => [
- 'OpenCc5gService',
- 'GetCreateCustomerInformation',
- ],
+ 'id' => 300899,
],
[
- 'id' => 169080,
- 'title' => '5G上云实例',
+ 'children' => ['ListAPNs', 'CreateWirelessCloudConnector', 'DeleteWirelessCloudConnector', 'UpdateWirelessCloudConnector', 'ListWirelessCloudConnectors', 'AttachVpcToNetLink', 'DetachVpcFromNetLink', 'GetWirelessCloudConnector', 'ListDataPackages', 'CreateIoTCloudConnectorBackhaulRoute', 'DeleteIoTCloudConnectorBackhaulRoute', 'ModifyWirelessCloudConnectorFeature', 'ListIoTCloudConnectorBackhaulRoute', 'SwitchWirelessCloudConnectorToBusiness'],
'type' => 'directory',
- 'children' => [
- 'ListAPNs',
- 'CreateWirelessCloudConnector',
- 'DeleteWirelessCloudConnector',
- 'UpdateWirelessCloudConnector',
- 'ListWirelessCloudConnectors',
- 'AttachVpcToNetLink',
- 'DetachVpcFromNetLink',
- 'GetWirelessCloudConnector',
- 'ListDataPackages',
- 'CreateIoTCloudConnectorBackhaulRoute',
- 'DeleteIoTCloudConnectorBackhaulRoute',
- 'ModifyWirelessCloudConnectorFeature',
- 'ListIoTCloudConnectorBackhaulRoute',
- 'SwitchWirelessCloudConnectorToBusiness',
- ],
+ 'title' => '5G上云实例',
+ 'id' => 300902,
],
[
- 'id' => 169089,
- 'title' => '订单管理',
+ 'children' => ['LockCards', 'UnlockCards', 'StopCards', 'ResumeCards', 'UpdateCard', 'ListCards', 'ListCardUsages', 'GetCard', 'GetCardLockReason', 'FailCards', 'RebindCards', 'ListCardDayUsages', 'ResetAreaLimitCards', 'ListCardAreaLimitSupportArea'],
'type' => 'directory',
- 'children' => [
- 'ListOrders',
- ],
+ 'title' => '卡管理',
+ 'id' => 300919,
],
[
- 'id' => 169091,
- 'title' => '卡管理',
+ 'children' => ['CreateAuthorizationRule', 'DeleteAuthorizationRule', 'UpdateAuthorizationRule', 'AddDNSAuthorizationRule', 'UpdateDNSAuthorizationRule', 'ListAuthorizationRules'],
'type' => 'directory',
- 'children' => [
- 'LockCards',
- 'UnlockCards',
- 'StopCards',
- 'ResumeCards',
- 'UpdateCard',
- 'ListCards',
- 'ListCardUsages',
- 'GetCard',
- 'GetCardLockReason',
- 'FailCards',
- 'RebindCards',
- 'ListCardDayUsages',
- 'ResetAreaLimitCards',
- 'ListCardAreaLimitSupportArea',
- ],
+ 'title' => '授权规则',
+ 'id' => 300934,
],
[
- 'id' => 169100,
- 'title' => '授权规则',
+ 'children' => ['CreateBatchOperateCardsTask', 'DeleteBatchOperateCardsTask', 'UpdateBatchOperateCardsTask', 'ListBatchOperateCardsTasks'],
'type' => 'directory',
- 'children' => [
- 'CreateAuthorizationRule',
- 'DeleteAuthorizationRule',
- 'UpdateAuthorizationRule',
- 'AddDNSAuthorizationRule',
- 'UpdateDNSAuthorizationRule',
- 'ListAuthorizationRules',
- ],
+ 'title' => '卡批量操作',
+ 'id' => 300941,
],
[
- 'id' => 169103,
- 'title' => '卡批量操作',
+ 'children' => ['SubmitDiagnoseTaskForSingleCard', 'GetDiagnoseResultForSingleCard', 'ListDiagnoseInfoForSingleCard'],
'type' => 'directory',
- 'children' => [
- 'CreateBatchOperateCardsTask',
- 'DeleteBatchOperateCardsTask',
- 'UpdateBatchOperateCardsTask',
- 'ListBatchOperateCardsTasks',
- ],
+ 'title' => '网络诊断',
+ 'id' => 300949,
],
[
- 'id' => 172117,
- 'title' => '网络诊断',
+ 'children' => ['GrantNetLink', 'RevokeNetLink'],
'type' => 'directory',
- 'children' => [
- 'SubmitDiagnoseTaskForSingleCard',
- 'GetDiagnoseResultForSingleCard',
- 'ListDiagnoseInfoForSingleCard',
- ],
+ 'title' => '授权分享',
+ 'id' => 300946,
],
[
- 'id' => 172116,
- 'title' => '授权分享',
+ 'children' => ['CreateWirelessCloudConnectorGroup', 'UpdateWirelessCloudConnectorGroup', 'ListWirelessCloudConnectorGroups', 'DeleteWirelessCloudConnectorGroup', 'AddWirelessCloudConnectorToGroup', 'RemoveWirelessCloudConnectorFromGroup', 'CreateGroupAuthorizationRule', 'UpdateGroupAuthorizationRule', 'ListGroupAuthorizationRules', 'DeleteGroupAuthorizationRule', 'AddGroupDnsAuthorizationRule', 'UpdateGroupDnsAuthorizationRule'],
'type' => 'directory',
- 'children' => [
- 'GrantNetLink',
- 'RevokeNetLink',
- ],
+ 'title' => '实例组',
+ 'id' => 300953,
],
[
- 'id' => 172767,
- 'title' => '实例组',
+ 'children' => ['ListOrders', 'ListRegions', 'ListZones'],
+ 'title' => '其他',
'type' => 'directory',
- 'children' => [
- 'CreateWirelessCloudConnectorGroup',
- 'UpdateWirelessCloudConnectorGroup',
- 'ListWirelessCloudConnectorGroups',
- 'DeleteWirelessCloudConnectorGroup',
- 'AddWirelessCloudConnectorToGroup',
- 'RemoveWirelessCloudConnectorFromGroup',
- 'CreateGroupAuthorizationRule',
- 'UpdateGroupAuthorizationRule',
- 'ListGroupAuthorizationRules',
- 'DeleteGroupAuthorizationRule',
- 'AddGroupDnsAuthorizationRule',
- 'UpdateGroupDnsAuthorizationRule',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'ListRegions' => [
- 'summary' => '查询5G高速上云服务支持的地域列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddDNSAuthorizationRule' => [
+ 'summary' => '创建DNS授权规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'AcceptLanguage',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '支持的语言。取值：'."\n"
- ."\n"
- .'zh-CN：中文。'."\n"
- .'en-US：英文。'."\n"
- .'ja：日文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- 'default' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '名称，长度不超过128字符。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应对象',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '2DCFA69E-A161-512D-99A7-108022580719',
- ],
- 'Regions' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '地域信息。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '地域信息。',
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'title' => '资源一级ID',
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'LocalName' => [
- 'title' => '资源名称',
- 'description' => '地域名称。',
- 'type' => 'string',
- 'example' => '华东1（杭州）',
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '描述，长度不超过256字符。', 'type' => 'string', 'required' => false, 'example' => 'ar5g-test'],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1（杭州）\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRegionsResponse>\\n <RequestId>2DCFA69E-A161-512D-99A7-108022580719</RequestId>\\n <Regions>\\n <RegionId>cn-hangzhou</RegionId>\\n <LocalName>华东1（杭州）</LocalName>\\n <RegionEndpoint>cc5g.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n </Regions>\\n</ListRegionsResponse>","errorExample":""}]',
- 'title' => '查询可用地域列表',
- ],
- 'ListZones' => [
- 'summary' => '查询5G高速上云服务支持的可用区列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'SourceDNSIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'DNS服务器地址。', 'type' => 'string', 'required' => true, 'example' => '0.0.0.0'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
+ [
+ 'name' => 'DestinationIp',
+ 'in' => 'query',
+ 'schema' => ['description' => '需要重定向的DNS服务器地址。', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1'],
],
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
+ ],
+ [
+ 'name' => 'DryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后创建DNS授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -280,144 +124,89 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C2C1DE7C-E14C-53DE-920D-D63ACD7421A4',
- ],
- 'Zones' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '当前地域支持的可用区列表',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '可用区信息。',
- 'type' => 'object',
- 'properties' => [
- 'ZoneId' => [
- 'title' => '资源名称',
- 'description' => '可用区ID',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- ],
- 'LocalName' => [
- 'title' => '创建时间',
- 'description' => '可用区名称。',
- 'type' => 'string',
- 'example' => '杭州可用区h',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'AuthorizationRuleId' => ['description' => '生成的DNS授权规则id。', 'type' => 'string', 'example' => 'ar5g-xxxx'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2C1DE7C-E14C-53DE-920D-D63ACD7421A4\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"LocalName\\": \\"杭州可用区h\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询可用区的列表',
- 'description' => '此接口属于运维类接口，主要用于网络规划和特殊控制，暂时只开放了北京、杭州、上海，深圳，如果有特殊region需求，请联系客服。',
- ],
- 'OpenCc5gService' => [
- 'summary' => '开通5G高速上云服务。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"AuthorizationRuleId\\": \\"ar5g-xxxx\\"\\n}","type":"json"}]',
+ 'title' => '创建DNS授权规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDNSAuthorizationRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddDNSAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AddGroupDnsAuthorizationRule' => [
+ 'summary' => '实例组创建DNS授权规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisYFDH9T'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '区域ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '实例组实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应对象',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求iD',
- 'type' => 'string',
- 'example' => '2DCFA69E-A161-512D-99A7-108022580719',
- ],
- ],
- ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '名称，长度不超过128字符。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\"\\n}","type":"json"}]',
- 'title' => '开通服务',
- ],
- 'GetCreateCustomerInformation' => [
- 'summary' => '获取客户资料录入地址和录入状态。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '授权规则描述，长度不超过256字符。', 'type' => 'string', 'required' => false, 'example' => 'ar5gg-test'."\n"],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
+ [
+ 'name' => 'SourceDNSIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'DNS服务器地址。', 'type' => 'string', 'required' => true, 'example' => '114.114.114.114'],
],
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'DestinationIp',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '需要重定向的DNS服务器地址。', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1'],
],
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxx',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
+ ],
+ [
+ 'name' => 'DryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -427,38 +216,33 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求iD',
- 'type' => 'string',
- 'example' => 'AE0BA8E5-1E0C-5171-852F-826301C76BBE',
- ],
- 'URL' => [
- 'description' => '物联网卡客户资料登记URL地址。',
- 'type' => 'string',
- 'example' => 'https://*******',
- ],
- 'CanBuyCard' => [
- 'description' => '是否已经登记过标记，未登记资料，此字段无返回',
- 'type' => 'string',
- 'example' => 'True',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914'],
+ 'AuthorizationRuleId' => ['description' => '生成的DNS授权规则id。', 'type' => 'string', 'example' => 'ar5gg-12fnojjtkkre28t08j'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE0BA8E5-1E0C-5171-852F-826301C76BBE\\",\\n \\"URL\\": \\"https://*******\\",\\n \\"CanBuyCard\\": \\"True\\"\\n}","type":"json"}]',
- 'title' => '获取客户资料录入地址和录入状态',
- ],
- 'ListAPNs' => [
- 'summary' => '查询5G高速上云服务支持的APN列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\",\\n \\"AuthorizationRuleId\\": \\"ar5gg-12fnojjtkkre28t08j\\"\\n}","type":"json"}]',
+ 'title' => '创建分组DNS授权规则',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddGroupDnsAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AddWirelessCloudConnectorToGroup' => [
+ 'summary' => '给cc5g实例分组增加cc5g实例。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -467,66 +251,46 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '云连接器实例所在的地域ID，仅取值：cn-hangzhou。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '实例组实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****'],
],
[
- 'name' => 'APN',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '运营商接入点APN ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CMWAP',
+ 'description' => '5G上云实例的id列表，最多20个。',
+ 'type' => 'array',
+ 'items' => ['description' => '5g上云实例id。', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx'],
+ 'required' => true,
+ 'maxItems' => 20,
],
],
[
- 'name' => 'ISP',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '运营商ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'unicom',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n"
- ."\n"
- .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小，取值范围：1~50，默认为10。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -536,94 +300,37 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A175C091-3910-51AF-8D84-D5717B9B8D38',
- ],
- 'APNs' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '运营商APN列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '运营商APN列表项',
- 'type' => 'object',
- 'properties' => [
- 'ISP' => [
- 'title' => '资源一级ID',
- 'description' => '5G高速上云实例的运营商。取值：'."\n"
- .'- **telecom**：中国电信。'."\n"
- .'- **mobile**：中国移动。'."\n"
- .'- **unicom**：中国联通。',
- 'type' => 'string',
- 'example' => 'unicom',
- ],
- 'APN' => [
- 'title' => '资源名称',
- 'description' => '运营商接入点APN ID。',
- 'type' => 'string',
- 'example' => 'zjhzaliyun01s.5gjs.njiot',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '名称。'."\n"
- ."\n"
- .'当前现实APN支持网断。',
- 'type' => 'string',
- 'example' => '10.0.0.0/13',
- ],
- 'Description' => [
- 'description' => '描述。'."\n"
- ."\n"
- .'当前线上APN描述暂未使用此字段，此APN描述信息为空。',
- 'type' => 'string',
- 'example' => '空',
- ],
- 'Zones' => [
- 'description' => '可用区列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '可用区ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-i',
- ],
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '分页token，从返回结果中获取。',
- 'type' => 'string',
- 'example' => 'vhNxI+jwQfkLCUChCQ+iOoiRkyUbtAilGSvWuwktFBxF+bar2HpV0efI6n1+GkMv',
- ],
- 'MaxResults' => [
- 'description' => '分页大小，范围1-100。',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => '总条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A175C091-3910-51AF-8D84-D5717B9B8D38\\",\\n \\"APNs\\": [\\n {\\n \\"ISP\\": \\"unicom\\",\\n \\"APN\\": \\"zjhzaliyun01s.5gjs.njiot\\",\\n \\"Name\\": \\"10.0.0.0/13\\",\\n \\"Description\\": \\"空\\",\\n \\"Zones\\": [\\n \\"cn-hangzhou-i\\"\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"vhNxI+jwQfkLCUChCQ+iOoiRkyUbtAilGSvWuwktFBxF+bar2HpV0efI6n1+GkMv\\",\\n \\"MaxResults\\": \\"20\\",\\n \\"TotalCount\\": \\"2\\"\\n}","errorExample":""},{"type":"xml","example":"<ListAPNsResponse>\\n <APNs>\\n </APNs>\\n</ListAPNsResponse>","errorExample":""}]',
- 'title' => '查询APN列表',
- ],
- 'CreateWirelessCloudConnector' => [
- 'summary' => '创建5G高速上云服务实例。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '给分组增加cc5g实例',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddWirelessCloudConnectorToGroup'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddWirelessCloudConnectorToGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AttachVpcToNetLink' => [
+ 'summary' => '关联用户Vpc和Vswitch到5G高速上云实例。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -632,146 +339,55 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'ISP',
- 'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例的运营商。取值：'."\n"
- .'- **telecom**：中国电信。'."\n"
- .'- **mobile**：中国移动。'."\n"
- .'- **unicom**：中国联通。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'unicom',
- ],
- ],
- [
- 'name' => 'Name',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'Description',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '高速上云服务的描述信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '网络连接id。', 'type' => 'string', 'required' => true, 'example' => 'cciot-xxxx'],
],
[
- 'name' => 'UseCase',
- 'in' => 'query',
- 'schema' => [
- 'description' => '使用场景',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'RegionId',
+ 'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '专有网络id。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1etmgc4vooo5ahbkzou'],
],
[
- 'name' => 'NetLinks',
+ 'name' => 'VSwitches',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '已经建立的云连接器列表。',
+ 'description' => '客户的专有网络下的交换机，必须是2个进行主备，且交换机的可用区和和网络连接的可用区保持一致。',
'type' => 'array',
- 'items' => [
- 'description' => '已经建立的云连接器列表。',
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- 'VpcId' => [
- 'description' => '专有网络VPC ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc-xxx',
- ],
- 'VSwitchs' => [
- 'description' => '虚拟交换机id。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'vSwitch ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-xxxx',
- ],
- 'required' => true,
- 'maxItems' => 2,
- 'minItems' => 2,
- ],
- 'APN' => [
- 'description' => '运营商APN ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'zjalyjs01s.5gjs.njiot',
- ],
- ],
- 'required' => false,
- ],
+ 'items' => ['description' => '交换机id。', 'type' => 'string', 'required' => true, 'example' => 'vsw-xxxx'],
'required' => true,
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。更多详情，请参阅如何保证幂等性。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'DryRun',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建实例组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'BusinessType',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '业务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Business',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会关联用户Vpc和Vswitch。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后关联用户Vpc和Vswitch到5G高速上云实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -781,33 +397,32 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求iD',
- 'type' => 'string',
- 'example' => 'E1E237B1-EED7-55D5-AE5F-671E642DB3B5',
- ],
- 'WirelessCloudConnectorId' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1E237B1-EED7-55D5-AE5F-671E642DB3B5\\",\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\"\\n}","type":"json"}]',
- 'title' => '创建5G高速上云服务实例',
- ],
- 'DeleteWirelessCloudConnector' => [
- 'summary' => '删除5G高速上云实例。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '关联用户Vpc和Vswitch',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AttachVpcToNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#wirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateAuthorizationRule' => [
+ 'summary' => '创建授权规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -816,161 +431,84 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '授权规则名称，长度不超过128字符。', 'type' => 'string', 'required' => false, 'example' => 'Test'],
],
[
- 'name' => 'DryRun',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应对象',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- ],
- ],
+ 'schema' => ['description' => '授权规则描述，长度不超过256字符。', 'type' => 'string', 'required' => false, 'example' => 'ar5g-test'],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.ExistCards',
- 'errorMessage' => 'The operation is not allowed because of exist cards.',
- ],
- [
- 'errorCode' => 'OperationDenied.AttachedVpc',
- 'errorMessage' => 'The operation is not allowed because of exist vpc.',
- ],
- [
- 'errorCode' => 'OperationDenied.ExistCustomerAuthorizationRules',
- 'errorMessage' => 'The operation is not allowed because of exist customer authorizationRule.',
- ],
+ [
+ 'name' => 'SourceCidr',
+ 'in' => 'query',
+ 'schema' => ['description' => '源CIDR地址块。', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '删除5G高速上云实例',
- ],
- 'UpdateWirelessCloudConnector' => [
- 'summary' => '更新5G高速上云实例信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'DestinationType',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标类型，取值：'."\n"
+ .'- **Cidr**: 网段'."\n"
+ .'- **Domain**: 域名或泛域名', 'type' => 'string', 'required' => true, 'example' => 'Cidr'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => '协议类型。取值：'."\n"
+ ."\n"
+ .'- **icmp**：网络控制报文协议。'."\n"
+ .'- **tcp**：传输控制协议。'."\n"
+ .'- **udp**：用户数据报协议。'."\n"
+ .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
- ],
- 'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'DestinationPort',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '目标端口范围。取值范围：'."\n"
+ ."\n"
+ .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ ."\n"
+ .'- ICMP协议：-1/-1。'."\n"
+ ."\n"
+ .'- ALL：-1/-1。', 'type' => 'string', 'required' => false, 'example' => '-1/-1'],
],
[
- 'name' => 'Name',
+ 'name' => 'Destination',
'in' => 'query',
- 'schema' => [
- 'description' => '名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '目标地址或域名。', 'type' => 'string', 'required' => true, 'example' => '10.0.0.1'],
],
[
- 'name' => 'Description',
+ 'name' => 'Policy',
'in' => 'query',
- 'schema' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-test',
- ],
+ 'schema' => ['description' => '授权规则策略，取值：'."\n"
+ .'- **Permit**：允许'."\n"
+ .'- **Deny**：拒绝', 'type' => 'string', 'required' => true, 'example' => 'Permit'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接更新实例信息。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -980,28 +518,46 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '61202DF5-668B-5EDA-8177-F2D71F4737C1'],
+ 'AuthorizationRuleId' => ['description' => '授权规则id。', 'type' => 'string', 'example' => 'ar5g-12fnojjtkkre28t08j'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '更新5G高速上云实例',
- ],
- 'ListWirelessCloudConnectors' => [
- 'summary' => '查询5G高速上云实例列表。',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => '授权规则目的网段掩码设置过大。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61202DF5-668B-5EDA-8177-F2D71F4737C1\\",\\n \\"AuthorizationRuleId\\": \\"ar5g-12fnojjtkkre28t08j\\"\\n}","type":"json"}]',
+ 'title' => '创建授权规则',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-18T13:33:39.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-06-23T08:23:56.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAuthorizationRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateBatchOperateCardsTask' => [
+ 'summary' => '创建批量操作卡任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1010,367 +566,212 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '批量操作任务名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '批量操作任务描述。', 'type' => 'string', 'required' => false, 'example' => 'task- test'],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Statuses',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '实例状态列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例状态，取值：'."\n"
- ."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 有效的稳定状态'."\n"
- .'- **Pending**: 配置中'."\n"
- .'- **Deleting**: 删除中',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Available',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'WirelessCloudConnectorIds',
+ 'name' => 'DryRun',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '实例的id列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例的id列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查直接创建批量操作卡任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Names',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '实例的名称列表。',
+ 'description' => '5G上云实例的id列表，最多10个。',
'type' => 'array',
- 'items' => [
- 'description' => '名称列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '智慧工厂',
- ],
+ 'items' => ['type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx', 'description' => ''],
'required' => false,
],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
+ 'description' => '卡的iccid列表，最多200条。',
+ 'type' => 'array',
+ 'items' => ['description' => '卡的iccid。', 'type' => 'string', 'required' => false, 'example' => '890912389123'],
'required' => false,
- 'example' => 'iou001238joojjaere',
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'IccidsOssFilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'iccid文件存放路径。', 'type' => 'string', 'required' => false, 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***'],
],
[
- 'name' => 'BusinessType',
+ 'name' => 'OperateType',
'in' => 'query',
- 'schema' => [
- 'description' => '业务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Business',
- ],
+ 'schema' => ['description' => '限制类型，取值：'."\n"
+ ."\n"
+ .'- **BreakNetwork**: 达量断网'."\n"
+ .'- **LimitRate**: 达量限速'."\n"
+ .'- **Alarm**: 达量告警', 'type' => 'string', 'required' => true, 'example' => 'BreakNetwork'],
],
[
- 'name' => 'IsInGroup',
+ 'name' => 'Threshold',
'in' => 'query',
- 'schema' => [
- 'description' => '是否查询实例组中的实例。取值：'."\n"
- ."\n"
- .'- **true**：查询实例组中的实例。'."\n"
- ."\n"
- .'- **false**：不查询实例组中的实例。'."\n"
- ."\n"
- .'- **null**：全量查询实例，不区分实例是否在实例组中。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '达量阈值，单位MB。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'EffectType',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组实例id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => '生效类型，取值：'."\n"
+ ."\n"
+ .'- **CurrentMonth**：当月生效'."\n"
+ .'- **ContinualMonth**：连续生效', 'type' => 'string', 'required' => true, 'example' => 'CurrentMonth'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'WirelessCloudConnectors' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '5G高速上云实例列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorId' => [
- 'title' => '资源一级ID',
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '实例状态，取值：'."\n"
- ."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 有效的稳定状态'."\n"
- .'- **Pending**: 配置中'."\n"
- .'- **Deleting**: 删除中',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => 'cc5g-test',
- ],
- 'RegionId' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'UseCase' => [
- 'description' => '实例使用场景。',
- 'type' => 'string',
- 'example' => '智慧工厂',
- ],
- 'DataPackageId' => [
- 'description' => '流量包id。',
- 'type' => 'string',
- 'example' => 'dp-xxxx',
- ],
- 'DataPackageType' => [
- 'description' => '流量包档位，取值：'."\n"
- ."\n"
- .'- **200**: 200M/卡/月'."\n"
- .'- **1000**: 1G/卡/月'."\n"
- .'- **3000**: 3G/卡/月'."\n"
- .'- **30000**: 30G/卡/月',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'CardCount' => [
- 'description' => '卡数量。',
- 'type' => 'string',
- 'example' => '20000',
- ],
- 'CreateTime' => [
- 'description' => '实例创建时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 22:20:00',
- ],
- 'BusinessType' => [
- 'description' => '业务类型',
- 'type' => 'string',
- 'example' => 'Business',
- ],
- 'ServiceType' => [
- 'description' => '服务类型，返回：'."\n"
- ."\n"
- .'- **CC5G**：普通实例。'."\n"
- .'- **CC5GCCIoT**：过户实例。',
- 'type' => 'string',
- 'example' => 'CC5G',
- ],
- 'WirelessCloudConnectorGroupId' => [
- 'description' => '关联的实例组id',
- 'type' => 'string',
- 'example' => 'cc5gg-****',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '下一页查询所需值。',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '列表的条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'BatchOperateCardsTaskId' => ['description' => '批量操作任务id。', 'type' => 'string', 'example' => 'boct-xxxx'],
+ 'OperateResultOssFilePath' => ['description' => '批量操作结果的文件路径。', 'type' => 'string', 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"WirelessCloudConnectors\\": [\\n {\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"Status\\": \\"Available\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"cc5g-test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"UseCase\\": \\"智慧工厂\\",\\n \\"DataPackageId\\": \\"dp-xxxx\\",\\n \\"DataPackageType\\": \\"200\\",\\n \\"CardCount\\": \\"20000\\",\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\",\\n \\"BusinessType\\": \\"Business\\",\\n \\"ServiceType\\": \\"CC5G\\",\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-****\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '查询5G高速上云实例列表',
- ],
- 'AttachVpcToNetLink' => [
- 'summary' => '关联用户Vpc和Vswitch到5G高速上云实例。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"BatchOperateCardsTaskId\\": \\"boct-xxxx\\",\\n \\"OperateResultOssFilePath\\": \\"https://examplebucket.oss-eu-central-1.aliyuncs.com/***\\"\\n}","type":"json"}]',
+ 'title' => '创建批量操作卡任务',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateGroupAuthorizationRule' => [
+ 'summary' => '创建cc5g分组的授权规则。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '实例组实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****'],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => '名称，长度不超过128字符。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'VpcId',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '专有网络id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc-bp1etmgc4vooo5ahbkzou',
- ],
+ 'schema' => ['description' => '授权规则描述，长度不超过256字符。', 'type' => 'string', 'required' => false, 'example' => 'ar5gg-test'],
],
[
- 'name' => 'VSwitches',
+ 'name' => 'SourceCidr',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '客户的专有网络下的交换机，必须是2个进行主备，且交换机的可用区和和网络连接的可用区保持一致。',
- 'type' => 'array',
- 'items' => [
- 'description' => '交换机id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vsw-xxxx',
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => '源CIDR地址块。', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'DestinationType',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '目标类型，取值：'."\n"
+ .'- **Cidr**: 网段'."\n"
+ .'- **Domain**: 域名或泛域名'."\n"
+ .'- **IpPort**: IP重定向', 'type' => 'string', 'required' => true, 'example' => 'Cidr'],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => '协议类型。取值：'."\n"
+ ."\n"
+ .'- **icmp**：网络控制报文协议。'."\n"
+ .'- **tcp**：传输控制协议。'."\n"
+ .'- **udp**：用户数据报协议。'."\n"
+ .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'all'],
+ ],
+ [
+ 'name' => 'DestinationPort',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标端口范围。取值范围：'."\n"
+ ."\n"
+ .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ ."\n"
+ .'- ICMP协议：-1/-1。'."\n"
+ ."\n"
+ .'- ALL：-1/-1。', 'type' => 'string', 'required' => false, 'example' => '-1/-1'],
+ ],
+ [
+ 'name' => 'Destination',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标地址或域名。', 'type' => 'string', 'required' => true, 'example' => '106.14.175.4'],
+ ],
+ [
+ 'name' => 'Policy',
+ 'in' => 'query',
+ 'schema' => ['description' => '授权规则策略，取值：'."\n"
+ .'- **Permit**：允许'."\n"
+ .'- **Deny**：拒绝', 'type' => 'string', 'required' => true, 'example' => 'Permit'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会关联用户Vpc和Vswitch。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后关联用户Vpc和Vswitch到5G高速上云实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -1380,86 +781,74 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03'],
+ 'AuthorizationRuleId' => ['description' => '授权规则id。', 'type' => 'string', 'example' => 'ar5gg-xxxx'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '关联用户Vpc和Vswitch',
- ],
- 'DetachVpcFromNetLink' => [
- 'summary' => '取消用户Vpc和Vswitch的关联。',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => '授权规则目的网段掩码设置过大。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\",\\n \\"AuthorizationRuleId\\": \\"ar5gg-xxxx\\"\\n}","type":"json"}]',
+ 'title' => '创建分组授权规则',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateIoTCloudConnectorBackhaulRoute' => [
+ 'summary' => '开启了反向访问高级特性场景下，针对连接实例下发反向访问路由。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => '网络连接id。', 'type' => 'string', 'required' => false, 'example' => 'cciot-xxxx'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会取消关联。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接取消用户Vpc和Vswitch的关联。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建实例组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -1469,28 +858,34 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '取消关联Vpc和Vswitch',
- ],
- 'GetWirelessCloudConnector' => [
- 'summary' => '查询5G高速上云实例详细信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '创建5G高速上云实例反向访问路由',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-28T11:47:33.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateIoTCloudConnectorBackhaulRoute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateWirelessCloudConnector' => [
+ 'summary' => '创建5G高速上云服务实例。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1499,335 +894,84 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ISP',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '5G高速上云实例的运营商。取值：'."\n"
+ .'- **telecom**：中国电信。'."\n"
+ .'- **mobile**：中国移动。'."\n"
+ .'- **unicom**：中国联通。', 'type' => 'string', 'required' => true, 'example' => 'unicom'],
],
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => ' ',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'NetLinks' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '到用户VPC的连接列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => ' ',
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'description' => '地域ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'NetLinkId' => [
- 'title' => '资源名称',
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'example' => 'cciot-xxxx',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => '连接test',
- ],
- 'Status' => [
- 'description' => '状态，取值：'."\n"
- ."\n"
- .'- **Pending**: 配置中 '."\n"
- .'- **Attached**: 已绑定'."\n"
- .'- **Detached**: 已解绑',
- 'type' => 'string',
- 'example' => 'Attached',
- ],
- 'Type' => [
- 'description' => '类型，取值：'."\n"
- ."\n"
- .'- **Standard**: 标准版 '."\n"
- .'- **Basic**: 基础版',
- 'type' => 'string',
- 'example' => 'Standard',
- ],
- 'APN' => [
- 'description' => '运营商APN的id。',
- 'type' => 'string',
- 'example' => 'bjaliyun01s.5gbj.bjiot',
- ],
- 'ISP' => [
- 'description' => '卡所属运营商: '."\n"
- .'- **Telecom**: 电信'."\n"
- .'- **Mobile**: 移动'."\n"
- .'- **Unicom**: 联通',
- 'type' => 'string',
- 'example' => 'Telecom',
- ],
- 'VpcId' => [
- 'description' => '专有网络VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-xxxx',
- ],
- 'VSwitchs' => [
- 'description' => '绑定的交换机列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '交换机id。',
- 'type' => 'string',
- 'example' => 'vsw-xxxx',
- ],
- ],
- 'CreateTime' => [
- 'description' => '连接创建时间。',
- 'type' => 'string',
- 'example' => '2022-03-15 22:20:00',
- ],
- 'GrantAliUid' => [
- 'description' => '阿里云授权者UID。',
- 'type' => 'string',
- 'example' => '11111111111',
- ],
- ],
- ],
- ],
- 'WirelessCloudConnectorId' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'Status' => [
- 'description' => '实例状态，取值：'."\n"
- ."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 有效的稳定状态'."\n"
- .'- **Pending**: 配置中'."\n"
- .'- **Deleting**: 删除中',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Name' => [
- 'description' => '名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => 'cc5g-test',
- ],
- 'RegionId' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'UseCase' => [
- 'description' => '实例使用场景。',
- 'type' => 'string',
- 'example' => '智慧工厂',
- ],
- 'DataPackageId' => [
- 'description' => '流量包id。',
- 'type' => 'string',
- 'example' => 'dp-xxxx',
- ],
- 'DataPackageType' => [
- 'description' => '流量包档位，取值：'."\n"
- ."\n"
- .'- **200**: 200M/卡/月'."\n"
- .'- **1000**: 1G/卡/月'."\n"
- .'- **3000**: 3G/卡/月'."\n"
- .'- **30000**: 30G/卡/月',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'CardCount' => [
- 'description' => '卡数量。',
- 'type' => 'string',
- 'example' => '20000',
- ],
- 'CreateTime' => [
- 'description' => '实例创建时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 22:20:00',
- ],
- 'BusinessType' => [
- 'description' => '业务类型',
- 'type' => 'string',
- 'example' => 'Business',
- ],
- 'WirelessCloudConnectorGroupId' => [
- 'description' => '分组ID',
- 'type' => 'string',
- 'example' => 'cc5gg-****',
- ],
- 'Features' => [
- 'description' => '支持的功能特性列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '支持的功能特性列表。',
- 'type' => 'string',
- 'example' => '[\'DirectMode\']',
- ],
- ],
- 'ServiceType' => [
- 'description' => '服务类型，返回：'."\n"
- ."\n"
- .'- **CC5G**：普通实例。'."\n"
- .'- **CC5GCCIoT**：过户实例。',
- 'type' => 'string',
- 'example' => 'CC5GCCIoT',
- ],
- ],
- ],
+ 'schema' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"NetLinks\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"NetLinkId\\": \\"cciot-xxxx\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"连接test\\",\\n \\"Status\\": \\"Attached\\",\\n \\"Type\\": \\"Standard\\",\\n \\"APN\\": \\"bjaliyun01s.5gbj.bjiot\\",\\n \\"ISP\\": \\"Telecom\\",\\n \\"VpcId\\": \\"vpc-xxxx\\",\\n \\"VSwitchs\\": [\\n \\"vsw-xxxx\\"\\n ],\\n \\"CreateTime\\": \\"2022-03-15 22:20:00\\",\\n \\"GrantAliUid\\": \\"11111111111\\"\\n }\\n ],\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"Status\\": \\"Available\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"cc5g-test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"UseCase\\": \\"智慧工厂\\",\\n \\"DataPackageId\\": \\"dp-xxxx\\",\\n \\"DataPackageType\\": \\"200\\",\\n \\"CardCount\\": \\"20000\\",\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\",\\n \\"BusinessType\\": \\"Business\\",\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-****\\",\\n \\"Features\\": [\\n \\"[\'DirectMode\']\\"\\n ],\\n \\"ServiceType\\": \\"CC5GCCIoT\\"\\n}","type":"json"}]',
- 'title' => '查询5G高速上云实例详情',
- ],
- 'ListDataPackages' => [
- 'summary' => '查询流量包信息列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '高速上云服务的描述信息', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
- ],
- 'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'UseCase',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '使用场景', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'Statuses',
+ 'name' => 'RegionId',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '流量包状态列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '流量包状态，取值：'."\n"
- ."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 已生效'."\n"
- .'- **Expired**: 已过期',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Available',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'DataPackageIds',
+ 'name' => 'NetLinks',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '流量包id，最多20个。',
+ 'description' => '已经建立的云连接器列表。',
'type' => 'array',
'items' => [
- 'type' => 'string',
+ 'description' => '已经建立的云连接器列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ 'VpcId' => ['description' => '专有网络VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-xxx'],
+ 'VSwitchs' => [
+ 'description' => '虚拟交换机id。',
+ 'type' => 'array',
+ 'items' => ['description' => 'vSwitch ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxx'],
+ 'required' => true,
+ 'maxItems' => 2,
+ 'minItems' => 2,
+ ],
+ 'APN' => ['description' => '运营商APN ID。', 'type' => 'string', 'required' => true, 'example' => 'zjalyjs01s.5gjs.njiot'],
+ ],
'required' => false,
- 'example' => 'dp-xxxx',
],
- 'required' => false,
+ 'required' => true,
],
],
[
- 'name' => 'Names',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '流量包名称，最多20个',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-123',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。更多详情，请参阅如何保证幂等性。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建实例组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'BusinessType',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'Business'],
],
],
'responses' => [
@@ -1837,168 +981,88 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
- ],
- 'DataPackages' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '流量包列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'DataPackageId' => [
- 'description' => '流量包id。',
- 'type' => 'string',
- 'example' => 'dp-xxxx',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '流量包状态，取值：'."\n"
- ."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 已生效'."\n"
- .'- **Expired**: 已过期',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '流量包名称',
- 'type' => 'string',
- 'example' => '测试流量包',
- ],
- 'ISP' => [
- 'description' => '卡所属运营商：'."\n"
- ."\n"
- .'- **Telecom**: 电信'."\n"
- .'- **Mobile**: 移动'."\n"
- .'- **Unicom**: 联通',
- 'type' => 'string',
- 'example' => 'Telecom',
- ],
- 'Size' => [
- 'description' => '流量包档位，取值：'."\n"
- ."\n"
- .'- **200**: 200M/卡/月'."\n"
- .'- **1000**: 1G/卡/月'."\n"
- .'- **3000**: 3G/卡/月'."\n"
- .'- **30000**: 30G/卡/月',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'CardCount' => [
- 'description' => '卡数量。',
- 'type' => 'string',
- 'example' => '20000',
- ],
- 'CreateTime' => [
- 'description' => '开通时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 22:20:00',
- ],
- 'ExpiredTime' => [
- 'description' => '失效时间。',
- 'type' => 'string',
- 'example' => '2099-3-15 22:20:00',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '下一页查询所需值。',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '列表的条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求iD', 'type' => 'string', 'example' => 'E1E237B1-EED7-55D5-AE5F-671E642DB3B5'],
+ 'WirelessCloudConnectorId' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'example' => 'cc5g-xxxx'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\",\\n \\"DataPackages\\": [\\n {\\n \\"DataPackageId\\": \\"dp-xxxx\\",\\n \\"Status\\": \\"Available\\",\\n \\"Name\\": \\"测试流量包\\",\\n \\"ISP\\": \\"Telecom\\",\\n \\"Size\\": \\"200\\",\\n \\"CardCount\\": \\"20000\\",\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\",\\n \\"ExpiredTime\\": \\"2099-3-15 22:20:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '查询流量包信息',
- ],
- 'CreateIoTCloudConnectorBackhaulRoute' => [
- 'summary' => '开启了反向访问高级特性场景下，针对连接实例下发反向访问路由。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1E237B1-EED7-55D5-AE5F-671E642DB3B5\\",\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\"\\n}","type":"json"}]',
+ 'title' => '创建5G高速上云服务实例',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-23T07:55:15.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-10-27T08:34:24.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-20T09:15:37.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWirelessCloudConnector'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'ram:CreateServiceLinkedRole', 'validationType' => 'always'],
+ ],
+ ],
],
+ ],
+ 'CreateWirelessCloudConnectorGroup' => [
+ 'summary' => '创建cc5g实例分组。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '实例组名称，长度不超过128字符。', 'type' => 'string', 'required' => false, 'example' => 'test1'],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => '高速上云服务分组的描述信息。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'cc5gg-test'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建实例组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -2008,29 +1072,33 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'."\n"],
+ 'WirelessCloudConnectorGroupId' => ['description' => '实例组实例id。', 'type' => 'string', 'example' => 'cc5gg-****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '创建5G高速上云实例反向访问路由',
- ],
- 'DeleteIoTCloudConnectorBackhaulRoute' => [
- 'summary' => '开启了反向访问高级特性场景下，针对连接实例删除反向访问路由'."\n"
- .'。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88C2F32F-B641-5980-B7A5-6907050ABCD1\\\\n\\",\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-****\\"\\n}","type":"json"}]',
+ 'title' => '创建分组',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteAuthorizationRule' => [
+ 'summary' => '删除授权规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2042,53 +1110,31 @@
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => '授权规则id。', 'type' => 'string', 'required' => true, 'example' => 'ar5g-xxxx'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。'."\n", 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会删除授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接删除授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -2098,28 +1144,32 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\"\\n}","type":"json"}]',
- 'title' => '删除5G高速上云实例反向访问路由',
- ],
- 'ModifyWirelessCloudConnectorFeature' => [
- 'summary' => '修改5G高速上云实例高级属性，例如开启反向访问功能。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '删除授权规则',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteBatchOperateCardsTask' => [
+ 'summary' => '删除批量操作卡任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2128,70 +1178,34 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'FeatureName',
+ 'name' => 'BatchOperateCardsTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '功能特征名称。'."\n"
- .'- **DirectMode**：直通',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'DirectMode' => 'DirectMode',
- ],
- 'example' => 'DirectMode',
- ],
+ 'schema' => ['description' => '创建批量操作任务生成的id。', 'type' => 'string', 'required' => true, 'example' => 'boct-xxx'],
],
[
- 'name' => 'FeatureValue',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '功能特征值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'On',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会删除批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后删除批量操作卡任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'DryRun',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接更新实例信息。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen'],
],
],
'responses' => [
@@ -2201,73 +1215,75 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '999E0F64-9A10-567B-BB84-B7C46023BA3B',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"999E0F64-9A10-567B-BB84-B7C46023BA3B\\"\\n}","type":"json"}]',
- 'title' => '修改5G高速上云实例高级属性',
- ],
- 'ListIoTCloudConnectorBackhaulRoute' => [
- 'summary' => '开启了反向访问高级特性场景下，查询特定连接实例的反向访问路由列表。',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '删除批量操作卡任务',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T07:48:47.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBatchOperateCardsTask'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteGroupAuthorizationRule' => [
+ 'summary' => '删除cc5g分组授权规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '实例组实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****'],
],
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '授权规则id。', 'type' => 'string', 'required' => true, 'example' => 'ar5gg-12fnojjtkkre28t08j'],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
+ ],
+ [
+ 'name' => 'DryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -2277,98 +1293,38 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '94032572-8758-575E-B306-86F59D1B826E',
- ],
- 'NetLinkId' => [
- 'title' => 'Id of the request',
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'example' => 'cciot-xxxx',
- ],
- 'Routes' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '数组，返回示例目录。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'DestinationCidrBlock' => [
- 'title' => '资源名称',
- 'description' => '路由条目的目标网段。',
- 'type' => 'string',
- 'example' => '10.33.190.0/24',
- ],
- 'NextHopId' => [
- 'title' => '创建时间',
- 'description' => '下一跳实例ID。',
- 'type' => 'string',
- 'example' => 'eni-uf677iw3xihqxiz2ssir',
- ],
- 'NextHopType' => [
- 'title' => '创建时间',
- 'description' => '自定义路由条目的下一跳的类型，取值： '."\n"
- ."\n"
- .'- **Instance**（默认值）：ECS实例。'."\n"
- ."\n"
- .'- **HaVip**：高可用虚拟IP。 '."\n"
- ."\n"
- .'- **RouterInterface**：路由器接口。'."\n"
- ."\n"
- .'- **NetworkInterface**：弹性网卡。'."\n"
- ."\n"
- .'- **VpnGateway**：VPN网关。'."\n"
- ."\n"
- .'- **IPv6Gateway**：IPv6网关。'."\n"
- ."\n"
- .'- **NatGateway**：NAT网关。'."\n"
- ."\n"
- .'- **Attachment**：转发路由器。'."\n"
- ."\n"
- .'- **VpcPeer**：VPC对等连接。',
- 'type' => 'string',
- 'example' => 'NetworkInterface',
- ],
- 'Description' => [
- 'title' => '创建时间',
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'full cidr block route',
- ],
- 'Status' => [
- 'title' => '创建时间',
- 'description' => '路由状态，取值：'."\n"
- ."\n"
- .'- **init**: 初始态'."\n"
- .'- **published**: 已下发',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'published',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => 'A175C091-3910-51AF-8D84-D5717B9B8D38'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94032572-8758-575E-B306-86F59D1B826E\\",\\n \\"NetLinkId\\": \\"cciot-xxxx\\",\\n \\"Routes\\": [\\n {\\n \\"DestinationCidrBlock\\": \\"10.33.190.0/24\\",\\n \\"NextHopId\\": \\"eni-uf677iw3xihqxiz2ssir\\",\\n \\"NextHopType\\": \\"NetworkInterface\\",\\n \\"Description\\": \\"full cidr block route\\",\\n \\"Status\\": \\"published\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询5G高速上云实例反向访问路由',
- ],
- 'SwitchWirelessCloudConnectorToBusiness' => [
- 'summary' => '用于把5G上云服务测试实例切换到商业实例。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A175C091-3910-51AF-8D84-D5717B9B8D38\\"\\n}","type":"json"}]',
+ 'title' => '删除分组授权规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupAuthorizationRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteIoTCloudConnectorBackhaulRoute' => [
+ 'summary' => '开启了反向访问高级特性场景下，针对连接实例删除反向访问路由'."\n"
+ .'。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2377,46 +1333,34 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
+ ],
+ [
+ 'name' => 'NetLinkId',
+ 'in' => 'query',
+ 'schema' => ['description' => '网络连接id。', 'type' => 'string', 'required' => false, 'example' => 'cciot-xxxx'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -2426,125 +1370,70 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '74ADDCF3-E3FE-5200-9290-1320125D71DC',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74ADDCF3-E3FE-5200-9290-1320125D71DC\\"\\n}","type":"json"}]',
- 'title' => '切换5G上云服务实例到商业模式',
- ],
- 'ListOrders' => [
- 'summary' => '查询订单列表。',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\"\\n}","type":"json"}]',
+ 'title' => '删除5G高速上云实例反向访问路由',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-28T11:47:33.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIoTCloudConnectorBackhaulRoute'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteIoTCloudConnectorBackhaulRoute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteWirelessCloudConnector' => [
+ 'summary' => '删除5G高速上云实例。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'Statuses',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '订单状态列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '订单状态，取值：'."\n"
- ."\n"
- .'- **Pending**: 待发货'."\n"
- .'- **Posting**: 已发货'."\n"
- .'- **Finished**: 已完成',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Pending',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'OrderIds',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '订单id列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '订单id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890******',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'OrderAction',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '订单类型，取值：'."\n"
- .'- **NewBuy**: 新购'."\n"
- .'- **ScaleOut**: 扩容'."\n"
- .'- **ScaleIn**: 缩容'."\n"
- .'- **BuyCard**: 购卡'."\n"
- .'- **Renewal**: 续期',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NewBuy',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
- ],
- [
- 'name' => 'MaxResults',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -2554,178 +1443,47 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'."\n",
- ],
- 'Orders' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '订单列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'OrderId' => [
- 'description' => '订单id。',
- 'type' => 'string',
- 'example' => '89************',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '订单状态，取值：'."\n"
- ."\n"
- .'- **Pending**: 待发货'."\n"
- .'- **Posting**: 已发货'."\n"
- .'- **Finished**: 已完成',
- 'type' => 'string',
- 'example' => 'Pending',
- ],
- 'Action' => [
- 'title' => '创建时间',
- 'description' => '订单类型，取值：'."\n"
- .'- **NewBuy**: 新购'."\n"
- .'- **ScaleOut**: 扩容'."\n"
- .'- **ScaleIn**: 缩容'."\n"
- .'- **BuyCard**: 购卡'."\n"
- .'- **Renewal**: 续期',
- 'type' => 'string',
- 'example' => 'NewBuy',
- ],
- 'Description' => [
- 'description' => '订单描述。',
- 'type' => 'string',
- 'example' => 'order-test',
- ],
- 'LogisticsId' => [
- 'description' => '物流单号。',
- 'type' => 'string',
- 'example' => 'SF14*********',
- ],
- 'LogisticsStatus' => [
- 'description' => '物流状态，取值：'."\n"
- .'- **Transporting**: 运送中'."\n"
- .'- **Delivering**: 派件中'."\n"
- .'- **Delivered**: 已送达'."\n"
- .'- **Signed**: 已签收',
- 'type' => 'string',
- 'example' => 'Signed',
- ],
- 'LogisticsType' => [
- 'description' => '物流公司，取值：'."\n"
- .'- **SF**: 顺丰'."\n"
- .'- **ZTO**: 中通'."\n",
- 'type' => 'string',
- 'example' => 'SF',
- ],
- 'LogisticsUpdateTime' => [
- 'description' => '物流最新更新时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 22:20:00',
- ],
- 'CardCount' => [
- 'description' => '卡数量。',
- 'type' => 'string',
- 'example' => '20000',
- ],
- 'ContactName' => [
- 'description' => '邮寄联系人。',
- 'type' => 'string',
- 'example' => '张三',
- ],
- 'ContactPhone' => [
- 'description' => '邮寄联系电话。',
- 'type' => 'string',
- 'example' => '139000*******',
- ],
- 'PostAddress' => [
- 'description' => '邮寄地址。',
- 'type' => 'string',
- 'example' => '某公司',
- ],
- 'CreateTime' => [
- 'description' => '订单创建时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 21:20:00',
- ],
- 'PayTime' => [
- 'description' => '订单支付时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 21:30:00',
- ],
- 'RegionId' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'CardType' => [
- 'description' => '卡的规格，取值：'."\n"
- ."\n"
- .'- **CONSUMER\\_THREE\\_IN\\_ONE:** 消费电子级物联网卡\\_三合一'."\n"
- .'- **INDUSTRY\\_PATCH**'."\n"
- .': 工业级物联网贴片卡'."\n"
- .'- **CONSUMER\\_PATCH**'."\n"
- .':消费电子级物联网贴片卡'."\n"
- .'- **INDUSTRY\\_GENERAL**'."\n"
- .':工业级物联网卡\\_普通'."\n"
- .'- **INDUSTRY\\_MICRO**'."\n"
- .':工业级物联网卡\\_Micro'."\n"
- .'- **CONSUMER\\_GENERAL**'."\n"
- .':消费电子级物联网卡_普通'."\n"
- .'- **CONSUMER\\_TWO\\_IN\\_ONE**'."\n"
- .'：消费电子级物联网卡\\_二合一'."\n"
- .'- **INDUSTRY\\_NANO**'."\n"
- .'：工业级物联网卡\\_Nano'."\n"
- .'- **CAR\\_PATCH**'."\n"
- .':车规级物联网贴片卡',
- 'type' => 'string',
- 'example' => 'CONSUMER_THREE_IN_ONE',
- ],
- 'CardNetType' => [
- 'description' => '卡的网络类型，取值：'."\n"
- ."\n"
- .'- **4G**'."\n"
- .'- **5G**',
- 'type' => 'string',
- 'example' => '5G',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '下一页查询所需值。',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '列表的条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88C2F32F-B641-5980-B7A5-6907050ABCD1\\\\n\\",\\n \\"Orders\\": [\\n {\\n \\"OrderId\\": \\"89************\\",\\n \\"Status\\": \\"Pending\\",\\n \\"Action\\": \\"NewBuy\\",\\n \\"Description\\": \\"order-test\\",\\n \\"LogisticsId\\": \\"SF14*********\\",\\n \\"LogisticsStatus\\": \\"Signed\\",\\n \\"LogisticsType\\": \\"SF\\",\\n \\"LogisticsUpdateTime\\": \\"2022-3-15 22:20:00\\",\\n \\"CardCount\\": \\"20000\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"ContactPhone\\": \\"139000*******\\",\\n \\"PostAddress\\": \\"某公司\\",\\n \\"CreateTime\\": \\"2022-3-15 21:20:00\\",\\n \\"PayTime\\": \\"2022-3-15 21:30:00\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CardType\\": \\"CONSUMER_THREE_IN_ONE\\",\\n \\"CardNetType\\": \\"5G\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '查询订单列表',
- ],
- 'LockCards' => [
- 'summary' => '批量锁定卡。',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.ExistCards', 'errorMessage' => 'The operation is not allowed because of exist cards.', 'description' => 'cc5g实例下仍存在卡，不允许删除该实例。'],
+ ['errorCode' => 'OperationDenied.AttachedVpc', 'errorMessage' => 'The operation is not allowed because of exist vpc.', 'description' => '此操作被拒绝，原因是存在绑定VPC。'],
+ ['errorCode' => 'OperationDenied.ExistCustomerAuthorizationRules', 'errorMessage' => 'The operation is not allowed because of exist customer authorizationRule.', 'description' => '此操作不允许，原因是当前实例下存在自定义授权规则。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '删除5G高速上云实例',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-30T09:09:34.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-11-29T08:53:36.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWirelessCloudConnector'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteWirelessCloudConnectorGroup' => [
+ 'summary' => '删除cc5g实例分组。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2734,63 +1492,29 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccids',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '物联网SIM卡卡号，每次最大500条',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
- ],
- [
- 'name' => 'RegionId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '要删除的实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会批量锁定。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后批量锁定卡。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -2800,93 +1524,73 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '2E759287-F208-589B-82D8-6D7A30F417E3'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
- 'title' => '批量锁定卡',
- ],
- 'UnlockCards' => [
- 'summary' => '批量解锁卡。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E759287-F208-589B-82D8-6D7A30F417E3\\"\\n}","type":"json"}]',
+ 'title' => '删除分组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWirelessCloudConnectorGroup'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DetachVpcFromNetLink' => [
+ 'summary' => '取消用户Vpc和Vswitch的关联。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccids',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '物联网SIM卡卡号，每次最大500条',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '网络连接id。', 'type' => 'string', 'required' => true, 'example' => 'cciot-xxxx'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会批量解锁。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后进行批量解锁操作。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会取消关联。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接取消用户Vpc和Vswitch的关联。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -2896,36 +1600,37 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '81CB64DF-E328-50A3-B386-03CAD604C114',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CardsSimStatusNotUnlock',
- 'errorMessage' => 'The operation is not allowed because of card status not support to unlock.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '取消关联Vpc和Vswitch',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachVpcFromNetLink'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DetachVpcFromNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81CB64DF-E328-50A3-B386-03CAD604C114\\"\\n}","type":"json"}]',
- 'title' => '批量解锁卡',
],
- 'StopCards' => [
- 'summary' => '单卡停机，支持批量操作。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'FailCards' => [
+ 'summary' => '销卡。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2937,9 +1642,7 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
@@ -2947,15 +1650,19 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '物联网SIM卡卡号，每次最大500条',
+ 'description' => '卡的iccid列表，最多200条。',
'type' => 'array',
'items' => [
+ 'description' => '物联网卡的iccid。',
'type' => 'string',
'required' => false,
- 'example' => '890912389123',
+ 'enumValueTitles' => [],
+ 'example' => '8986*******',
],
'required' => true,
- 'maxItems' => 1000,
+ 'enumValueTitles' => [],
+ 'example' => 'FailCards',
+ 'maxItems' => 50,
'minItems' => 1,
],
],
@@ -2963,9 +1670,10 @@
'name' => 'RegionId',
'in' => 'query',
'schema' => [
- 'description' => '地域id。',
+ 'description' => '地域ID',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'cn-hangzhou',
],
],
@@ -2973,11 +1681,14 @@
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
+ 'description' => '保证请求幂等性。'."\n"
+ .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
+ ."\n"
+ .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'enumValueTitles' => [],
+ 'example' => 'TF-CreateServerlessDBInstance-1639649079-51d933f6-0251-4057-9276',
],
],
[
@@ -2985,11 +1696,12 @@
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会进行停机操作。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接进行卡停机操作。',
+ .'- **true**：发送检查请求，不会激活/恢复卡状态。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后激活/恢复卡状态。',
'type' => 'boolean',
'required' => false,
- 'example' => 'true',
+ 'enumValueTitles' => [],
+ 'example' => 'false',
],
],
],
@@ -3000,213 +1712,171 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '186B6E37-D9D1-5E64-ACDE-E89F7E68A37B'],
],
+ 'enumValueTitles' => [],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
- 'title' => '卡停机操作',
- 'description' => '如单卡被劫持或者其他原因做主动运维，可在此实现运营商侧卡停机。',
- ],
- 'ResumeCards' => [
- 'summary' => '激活单卡，或恢复运营商侧卡状态，支持批量操作。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"186B6E37-D9D1-5E64-ACDE-E89F7E68A37B\\"\\n}","type":"json"}]',
+ 'title' => '销卡',
+ 'description' => '**销卡操作需谨慎，对卡进行销卡行为不可逆。**。',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-04T13:01:19.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FailCards'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:FailCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetCard' => [
+ 'summary' => '获取单卡信息。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccids',
- 'in' => 'query',
- 'allowEmptyValue' => false,
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '物联网SIM卡卡号，每次最大500条',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
- ],
- [
- 'name' => 'DryRun',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会激活/恢复卡状态。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后激活/恢复卡状态。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '物联网卡的iccid。', 'type' => 'string', 'required' => true, 'example' => '11111111111'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应对象',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
- 'description' => '请求id。',
+ 'description' => '请求iD',
'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'enumValueTitles' => [],
+ 'example' => '0B28B72A-BD16-51F7-AAEE-55247FE02729',
],
+ 'Iccid' => ['description' => '物联网卡的iccid。', 'type' => 'string', 'example' => '111111111'],
+ 'NetType' => ['description' => '网络类型，取值：'."\n"
+ ."\n"
+ .'- **4G**'."\n"
+ .'- **5G**', 'type' => 'string', 'example' => '5G'],
+ 'APN' => ['description' => '运营商APN的id。', 'type' => 'string', 'example' => 'zjalyjs01s.5gjs.njiot'],
+ 'ISP' => ['description' => '5G高速上云实例的运营商。取值：'."\n"
+ .'- **telecom**：中国电信。'."\n"
+ .'- **mobile**：中国移动。'."\n"
+ .'- **unicom**：中国联通。', 'type' => 'string', 'example' => 'Unicom'],
+ 'IpAddress' => ['description' => '物联网卡的固定IP地址。', 'type' => 'string', 'example' => '172.24.2.121'],
+ 'Imsi' => ['description' => '物联网卡的IMSI。', 'type' => 'string', 'example' => '12123123'],
+ 'Imei' => ['description' => '设备IMEI。', 'type' => 'string', 'example' => '23412313513512'],
+ 'Lock' => ['description' => '卡是否锁定。', 'type' => 'string', 'example' => 'true'],
+ 'Spec' => ['description' => '规格', 'type' => 'string', 'example' => 'CONSUMER_THREE_IN_ONE'],
+ 'SimStatus' => ['description' => '卡的状态，取值：'."\n"
+ ."\n"
+ .'- **Testable**: 可测试'."\n"
+ .'- **Activatable**: 可激活'."\n"
+ .'- **Activated**: 已激活'."\n"
+ .'- **Deactivated**: 已停用'."\n"
+ .'- **Failed**: 已失效'."\n"
+ .'- **Cleared**: 已清除'."\n"
+ .'- **Replaced**: 已更换'."\n"
+ .'- **Resuming**: 恢复中'."\n"
+ .'- **ShutDown**: 已停机', 'type' => 'string', 'example' => 'Deactivated'],
+ 'Status' => ['description' => '实例状态，取值：'."\n"
+ ."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 有效的稳定状态'."\n"
+ .'- **UnAvailable**: 无效状态'."\n"
+ .'- **Pending**: 配置中'."\n"
+ .'- **Deleting**: 删除中', 'type' => 'string', 'example' => 'Available'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'task-test'],
+ 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'],
+ 'WirelessCloudConnectorId' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'example' => 'cc5g-xxxxxxx'],
+ 'CloudConnectorId' => ['description' => '云连接id。', 'type' => 'string', 'example' => 'iotcc-xxxxxxxx'],
+ 'UsageDataMonth' => ['description' => '本月已用流量，单位MB。'."\n"
+ .'本字段信息存在一些外部条件等影响，会出现信息同步滞后，建议使用[ListCardUsages](https://help.aliyun.com/document_detail/472077.html?spm=a2c4g.438976.0.0.8bbc1711r5XXDT)查询单卡流量信息。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'OrderId' => ['description' => '订单id。', 'type' => 'string', 'example' => '12312341234124'],
+ 'ActivatedTime' => ['description' => '激活时间。', 'type' => 'string', 'example' => '2022-08-25 17:34:57'],
+ 'Msisdn' => ['description' => '物联网卡的MSISDN。', 'type' => 'string', 'example' => '2312341231235'],
+ 'UsageDataTotal' => ['description' => '单卡总使用量，单位MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'LimitThreshold' => ['description' => '达量限速阈值，单位MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'StopThreshold' => ['description' => '达量停机阈值，单位MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '4096'],
+ 'AlarmThreshold' => ['description' => '告警阈值，单位MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CardsSimStatusNotResume',
- 'errorMessage' => 'The operation is not allowed because of card status not support to resume.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B28B72A-BD16-51F7-AAEE-55247FE02729\\",\\n \\"Iccid\\": \\"111111111\\",\\n \\"NetType\\": \\"5G\\",\\n \\"APN\\": \\"zjalyjs01s.5gjs.njiot\\",\\n \\"ISP\\": \\"Unicom\\",\\n \\"IpAddress\\": \\"172.24.2.121\\",\\n \\"Imsi\\": \\"12123123\\",\\n \\"Imei\\": \\"23412313513512\\",\\n \\"Lock\\": \\"true\\",\\n \\"Spec\\": \\"CONSUMER_THREE_IN_ONE\\",\\n \\"SimStatus\\": \\"Deactivated\\",\\n \\"Status\\": \\"Available\\",\\n \\"Description\\": \\"task-test\\",\\n \\"Name\\": \\"test\\",\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxxxxx\\",\\n \\"CloudConnectorId\\": \\"iotcc-xxxxxxxx\\",\\n \\"UsageDataMonth\\": 50,\\n \\"OrderId\\": \\"12312341234124\\",\\n \\"ActivatedTime\\": \\"2022-08-25 17:34:57\\",\\n \\"Msisdn\\": \\"2312341231235\\",\\n \\"UsageDataTotal\\": 1000,\\n \\"LimitThreshold\\": 50,\\n \\"StopThreshold\\": 4096,\\n \\"AlarmThreshold\\": 1000\\n}","type":"json"}]',
+ 'title' => '获取单卡信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-09T11:30:42.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCard'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '激活/恢复卡状态',
- 'description' => '运营商卡切换终端或者因为频繁拨号等原因导致锁卡可在此恢复。',
],
- 'UpdateCard' => [
- 'summary' => '更新卡实例的名称和描述。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetCardLockReason' => [
+ 'summary' => '获取锁卡原因。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'card-test',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
- ],
- [
- 'name' => 'DryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会更新卡信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后更新卡信息。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '物联网卡的iccid。', 'type' => 'string', 'required' => true, 'example' => '*********11111'],
],
],
'responses' => [
@@ -3216,28 +1886,45 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => 'F32C0BBE-5025-5561-8976-7BD096BA21FB'],
+ 'LockReason' => [
+ 'description' => '锁定原因。',
'type' => 'string',
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
+ 'enumValueTitles' => ['CreditTwoWayStop' => 'CreditTwoWayStop', 'ExpireStop' => 'ExpireStop', 'ActiveTwoWayStop' => 'ActiveTwoWayStop', 'LocationStop' => 'LocationStop', 'NoReasonStop' => 'NoReasonStop', 'SeparationStop' => 'SeparationStop', 'M2MStop' => 'M2MStop', 'ForceTwoWayStop' => 'ForceTwoWayStop'],
+ 'example' => 'ForceTwoWayStop',
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
- 'title' => '更新卡信息',
- ],
- 'ListCards' => [
- 'summary' => '查询5G高速上云实例下的卡信息列表。',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F32C0BBE-5025-5561-8976-7BD096BA21FB\\",\\n \\"LockReason\\": \\"ForceTwoWayStop\\"\\n}","type":"json"}]',
+ 'title' => '获取锁卡原因',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-20T06:47:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardLockReason'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCardLockReason',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetCreateCustomerInformation' => [
+ 'summary' => '获取客户资料录入地址和录入状态。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3249,154 +1936,18 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'Statuses',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '卡的状态列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '卡的状态，取值：'."\n"
- ."\n"
- .'- **Testable**: 可测试'."\n"
- .'- **Activatable**: 可激活'."\n"
- .'- **Activated**: 已激活'."\n"
- .'- **Deactivated**: 已停用'."\n"
- .'- **Failed**: 已失效'."\n"
- .'- **Cleared**: 已清除'."\n"
- .'- **Replaced**: 已更换'."\n"
- .'- **Resuming**: 恢复中'."\n"
- .'- **ShutDown**: 已停机',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Activated',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Iccids',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '物联网卡的iccid列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '89091231231219123',
- ],
- 'required' => false,
- 'enumValueTitles' => [],
- ],
- ],
- [
- 'name' => 'IpAddress',
- 'in' => 'query',
- 'schema' => [
- 'description' => '物联网卡的固定IP地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
- ],
- [
- 'name' => 'Lock',
- 'in' => 'query',
- 'schema' => [
- 'description' => '卡是否锁定。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'Online',
- 'in' => 'query',
- 'schema' => [
- 'description' => '卡是否在线。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'NetLinkId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-xxxx',
- ],
- ],
- [
- 'name' => 'Apn',
- 'in' => 'query',
- 'schema' => [
- 'description' => '运营商APN的id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bjaliyun01s.5gbj.bjiot',
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Iccid',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '卡的iccid的前缀，如果后缀包含字符会去除字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8909123123121912',
- ],
+ 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Msisdn',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '物联网卡的MSISDN。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1441204374591',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxx'],
],
],
'responses' => [
@@ -3406,180 +1957,42 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1',
- ],
- 'Cards' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '卡列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'Iccid' => [
- 'title' => '资源一级ID',
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'example' => '89091231231219123',
- ],
- 'NetType' => [
- 'title' => '资源名称',
- 'description' => '网络类型，取值：'."\n"
- ."\n"
- .'- **4G**'."\n"
- .'- **5G**',
- 'type' => 'string',
- 'example' => '5G',
- ],
- 'APN' => [
- 'title' => '创建时间',
- 'description' => '运营商APN的id。',
- 'type' => 'string',
- 'example' => 'bjaliyun01s.5gbj.bjiot',
- ],
- 'ISP' => [
- 'description' => '5G高速上云实例的运营商。取值：'."\n"
- .'- **Telecom**：中国电信'."\n"
- .'- **Mobile**：中国移动'."\n"
- .'- **Unicom**：中国联通',
- 'type' => 'string',
- 'example' => 'Telecom',
- ],
- 'IpAddress' => [
- 'description' => '卡的静态IP地址。',
- 'type' => 'string',
- 'example' => '10.0.0.118',
- ],
- 'Imsi' => [
- 'description' => '物联网卡的IMSI。',
- 'type' => 'string',
- 'example' => '8912039123',
- ],
- 'Imei' => [
- 'description' => '物联网卡的IMEI。',
- 'type' => 'string',
- 'example' => '7896129300',
- ],
- 'Lock' => [
- 'description' => '卡是否锁定。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Spec' => [
- 'description' => '卡的规格，取值：'."\n"
- ."\n"
- .'- **CONSUMER\\_THREE\\_IN\\_ONE:** 消费电子级物联网卡\\_三合一'."\n"
- .'- **INDUSTRY\\_PATCH:** 工业级物联网贴片卡'."\n"
- .'- **CONSUMER\\_PATCH:** 消费电子级物联网贴片卡'."\n"
- .'- **INDUSTRY\\_GENERAL:** 工业级物联网卡\\_普通'."\n"
- .'- **INDUSTRY\\_MICRO:** 工业级物联网卡\\_Micro'."\n"
- .'- **CONSUMER\\_GENERAL:** 消费电子级物联网卡_普通'."\n"
- .'- **CONSUMER\\_TWO\\_IN\\_ONE:** 消费电子级物联网卡\\_二合一'."\n"
- .'- **INDUSTRY\\_NANO:** 工业级物联网卡\\_Nano'."\n"
- .'- **CAR\\_PATCH:** 车规级物联网贴片卡',
- 'type' => 'string',
- 'example' => 'CONSUMER_THREE_IN_ONE',
- ],
- 'Status' => [
- 'description' => '卡的状态，取值：'."\n"
- ."\n"
- .'- **Testable**: 可测试'."\n"
- .'- **Activatable**: 可激活'."\n"
- .'- **Activated**: 已激活'."\n"
- .'- **Deactivated**: 已停用'."\n"
- .'- **Failed**: 已失效'."\n"
- .'- **Cleared**: 已清除'."\n"
- .'- **Replaced**: 已更换'."\n"
- .'- **Resuming**: 恢复中'."\n"
- .'- **ShutDown**: 已停机',
- 'type' => 'string',
- 'example' => 'Activated',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Name' => [
- 'description' => '名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'UsageDataMonth' => [
- 'description' => '本月已用流量，单位MB。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'OrderId' => [
- 'description' => '订单号。',
- 'type' => 'string',
- 'example' => '89099123012',
- ],
- 'ActivatedTime' => [
- 'description' => '激活时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 22:20:00',
- ],
- 'BusinessStatus' => [
- 'description' => '业务状态，取值：'."\n"
- ."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 稳定状态，有效'."\n"
- .'- **Configuring**: 配置中'."\n"
- .'- **Deleting**: 删除中',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Msisdn' => [
- 'description' => '物联网卡的MSISDN。',
- 'type' => 'string',
- 'example' => '1441204374591',
- ],
- 'UsageDataTotal' => [
- 'description' => '单卡总使用量',
- 'type' => 'string',
- 'example' => '50',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '下一页查询所需值。',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '列表的条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求iD', 'type' => 'string', 'example' => 'AE0BA8E5-1E0C-5171-852F-826301C76BBE'],
+ 'URL' => ['description' => '物联网卡客户资料登记URL地址。', 'type' => 'string', 'example' => 'https://*******'],
+ 'CanBuyCard' => ['description' => '是否已经登记过标记，未登记资料，此字段无返回', 'type' => 'string', 'example' => 'True'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88C2F32F-B641-5980-B7A5-6907050ABCD1\\",\\n \\"Cards\\": [\\n {\\n \\"Iccid\\": \\"89091231231219123\\",\\n \\"NetType\\": \\"5G\\",\\n \\"APN\\": \\"bjaliyun01s.5gbj.bjiot\\",\\n \\"ISP\\": \\"Telecom\\",\\n \\"IpAddress\\": \\"10.0.0.118\\",\\n \\"Imsi\\": \\"8912039123\\",\\n \\"Imei\\": \\"7896129300\\",\\n \\"Lock\\": false,\\n \\"Spec\\": \\"CONSUMER_THREE_IN_ONE\\",\\n \\"Status\\": \\"Activated\\",\\n \\"Description\\": \\"test\\",\\n \\"Name\\": \\"test\\",\\n \\"UsageDataMonth\\": 20,\\n \\"OrderId\\": \\"89099123012\\",\\n \\"ActivatedTime\\": \\"2022-3-15 22:20:00\\",\\n \\"BusinessStatus\\": \\"Available\\",\\n \\"Msisdn\\": \\"1441204374591\\",\\n \\"UsageDataTotal\\": \\"50\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '查询5G高速上云实例下的卡信息',
- ],
- 'ListCardUsages' => [
- 'summary' => '查询物联网卡流量使用信息。',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE0BA8E5-1E0C-5171-852F-826301C76BBE\\",\\n \\"URL\\": \\"https://*******\\",\\n \\"CanBuyCard\\": \\"True\\"\\n}","type":"json"}]',
+ 'title' => '获取客户资料录入地址和录入状态',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-02T06:21:08.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-11T12:28:50.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCreateCustomerInformation'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCreateCustomerInformation',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetDiagnoseResultForSingleCard' => [
+ 'summary' => '查询单张物联网卡的网络诊断结果。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3591,299 +2004,180 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'DiagnoseTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例ID 。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '网络诊断任务ID。', 'type' => 'string', 'required' => true, 'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****'],
],
[
- 'name' => 'Iccids',
+ 'name' => 'RegionNo',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '物联网SIM卡卡号，每次最大50条',
- 'type' => 'array',
- 'items' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => false,
- 'maxItems' => 50,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '186B6E37-D9D1-5E64-ACDE-E89F7E68A37B',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '94032572-8758-575E-B306-86F59D1B826E'],
+ 'WirelessCloudConnectorId' => ['description' => '5G高速上云实例ID。', 'type' => 'string', 'example' => 'cc5g-xxxx'],
+ 'CardIp' => ['description' => '网络诊断的源端卡的IP地址。', 'type' => 'string', 'example' => '10.176.78.61'],
+ 'IccId' => ['description' => '网络诊断的源端卡的ID。', 'type' => 'string', 'example' => '89860477102170127555'],
+ 'Destination' => ['description' => '网络诊断目的地址或域名。', 'type' => 'string', 'example' => '106.14.175.4'],
+ 'DestinationType' => ['description' => '网路诊断的目的类型。取值：'."\n"
+ ."\n"
+ .'- **IP**：表示诊断的目的类型是IP类型。'."\n"
+ ."\n"
+ .'- **Domain**：表示诊断的目的类型是域名类型。'."\n", 'type' => 'string', 'example' => 'Domain'],
+ 'BeginTime' => ['description' => '网络诊断的开始时间戳。单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1646100223024'],
+ 'EndTime' => ['description' => '网络诊断的结束时间戳。单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1646100223264'],
+ 'Status' => ['description' => '网络诊断任务的状态。取值：'."\n"
+ ."\n"
+ .'- **success**：表示诊断成功。'."\n"
+ .'- **failed**：表示诊断失败。'."\n"
+ .'- **diagnosing**：表示诊断中。', 'type' => 'string', 'example' => 'failed'],
+ 'ErrorResult' => [
+ 'description' => '诊断结果列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '诊断结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorLevel' => ['description' => '诊断问题的级别。取值：'."\n"
+ ."\n"
+ .'- **Error**：表示错误。'."\n"
+ ."\n"
+ .'- **Warning**：表示警告。', 'type' => 'string', 'example' => 'Warning'],
+ 'ErrorPart' => ['description' => '诊断问题的组件。取值：'."\n"
+ ."\n"
+ .'- **CCIOT**：表示诊断的问题为云连接器的问题。'."\n"
+ ."\n"
+ .'- **Card**：表示诊断的问题为物联网卡的问题。'."\n"
+ ."\n"
+ .'- **Terminal**：表示诊断的问题为终端的问题。'."\n"
+ ."\n"
+ .'- **Server**：表示诊断的问题为服务器的问题。'."\n"
+ ."\n"
+ .'- **Apn**：表示诊断的问题为APN的问题。', 'type' => 'string', 'example' => 'Terminal'],
+ 'ErrorItem' => ['description' => '诊断部件对应的诊断指标项，详见 **返回参数补充说明**。', 'type' => 'string', 'example' => 'CardStatus'],
+ 'ErrorDesc' => ['description' => '诊断问题的描述。', 'type' => 'string', 'example' => 'Terminal abnormal'],
+ 'ErrorSuggestion' => ['description' => '诊断问题的解决建议。', 'type' => 'string', 'example' => 'Please check whether the terminal and card are compatible or whether the terminal can send messages'],
+ ],
+ ],
],
- 'Cards' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '卡信息列表。',
+ 'DiagnoseItem' => [
+ 'description' => '诊断项信息列表。',
'type' => 'array',
'items' => [
- 'title' => 'RegionItemType',
- 'description' => '卡信息项',
+ 'description' => '诊断项信息。',
'type' => 'object',
'properties' => [
- 'Iccid' => [
- 'title' => '资源一级ID',
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'example' => '89091231231219123',
- ],
- 'UsageDataMonth' => [
- 'description' => '本月已用流量，单位MB。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
+ 'Part' => ['description' => '诊断的部件名称。取值：'."\n"
+ ."\n"
+ .'- **CCIOT**：云连接器。'."\n"
+ .'- **Card**：物联网卡。'."\n"
+ .'- **Terminal**：终端。'."\n"
+ .'- **Server**：服务器。'."\n"
+ .'- **Apn**：APN。', 'type' => 'string', 'example' => 'Terminal'],
+ 'Status' => ['description' => '诊断部件的状态。取值：'."\n"
+ ."\n"
+ .'- **Normal**：表示诊断状态正常。'."\n"
+ .'- **Wrong**：表示诊断状态错误。'."\n"
+ .'- **Unknown**：表示诊断状态未知。', 'type' => 'string', 'example' => 'Wrong'],
+ 'SubItems' => [
+ 'description' => '诊断部件的诊断指标列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '诊断部件的诊断指标。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SubItem' => ['description' => '诊断部件对应的诊断指标项，详见 **返回参数补充说明**。', 'type' => 'string', 'example' => 'CardStatus'],
+ 'SubItemStatus' => ['description' => '诊断指标的状态。取值：'."\n"
+ ."\n"
+ .'- **Normal**：表示诊断状态正常。'."\n"
+ .'- **Warnning**：表示诊断状态为提示级别错误。'."\n"
+ .'- **Minor**: 表示诊断状态为一般级别错误。'."\n"
+ .'- **Major**: 表示诊断状态为严重级别错误。'."\n"
+ .'- **Unknown**：表示诊断状态未知。', 'type' => 'string', 'example' => 'Normal'],
+ 'SubItemInfo' => ['description' => '诊断指标的附加信息。', 'type' => 'string', 'example' => 'Card status is real-time'],
+ ],
+ ],
],
],
],
- ],
- 'TotalCount' => [
- 'description' => '返回总量',
- 'type' => 'string',
- 'example' => '2',
+ 'enumValueTitles' => [],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"186B6E37-D9D1-5E64-ACDE-E89F7E68A37B\\",\\n \\"Cards\\": [\\n {\\n \\"Iccid\\": \\"89091231231219123\\",\\n \\"UsageDataMonth\\": 20\\n }\\n ],\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '查询卡流量使用信息',
- 'description' => '当月流量信息是本月1号0点开始到月底结束。',
- ],
- 'GetCard' => [
- 'summary' => '获取单卡信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => '子账号未获取5G上云服务RAM权限。'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94032572-8758-575E-B306-86F59D1B826E\\",\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"CardIp\\": \\"10.176.78.61\\",\\n \\"IccId\\": \\"89860477102170127555\\",\\n \\"Destination\\": \\"106.14.175.4\\",\\n \\"DestinationType\\": \\"Domain\\",\\n \\"BeginTime\\": 1646100223024,\\n \\"EndTime\\": 1646100223264,\\n \\"Status\\": \\"failed\\",\\n \\"ErrorResult\\": [\\n {\\n \\"ErrorLevel\\": \\"Warning\\",\\n \\"ErrorPart\\": \\"Terminal\\",\\n \\"ErrorItem\\": \\"CardStatus\\",\\n \\"ErrorDesc\\": \\"Terminal abnormal\\",\\n \\"ErrorSuggestion\\": \\"Please check whether the terminal and card are compatible or whether the terminal can send messages\\"\\n }\\n ],\\n \\"DiagnoseItem\\": [\\n {\\n \\"Part\\": \\"Terminal\\",\\n \\"Status\\": \\"Wrong\\",\\n \\"SubItems\\": [\\n {\\n \\"SubItem\\": \\"CardStatus\\",\\n \\"SubItemStatus\\": \\"Normal\\",\\n \\"SubItemInfo\\": \\"Card status is real-time\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询单卡诊断结果',
+ 'responseParamsDescription' => '诊断部件的诊断指标项。取值: '."\n"
+ ."\n"
+ .'**Part**: Card'."\n"
+ .'- **CardStatus**: 卡状态'."\n"
+ .'- **CardOnlineStatus**: 卡会话状态'."\n"
+ ."\n"
+ .'**Part**: Apn'."\n"
+ .'- **GreTunnelStatus**: 运营商隧道状态'."\n"
+ ."\n"
+ .'**Part**: CCIOT'."\n"
+ .'- **CciotInstanceStatus**: 云连接器实例状态'."\n"
+ .'- **CciotConnectionPoolConfiged**: 云连接器连接池配置状态'."\n"
+ .'- **CciotAuthorizationRulesConfiged**: 云连接器授权规则配置状态'."\n"
+ .'- **CardInCciotConnectionPool**: 卡在云连接器实例连接池中'."\n"
+ .'- **DestinationInCciotAuthorizationRules**: 目的地址在云连接器实例授权规则中'."\n"
+ .'- **DefaultDnsInCciotDnsServiceRules**: 默认的DNS服务地址在授权规则中'."\n"
+ .'- **DestinationConflictWithIpMapping**: 目的地址与IP映射冲突'."\n"
+ .'- **CciotAssociateWithVswitch**: 云连接器实例关联VPC'."\n"
+ .'- **BackhaulRoutePublishedInVpc**: 云连接器实例回程路由发布状态'."\n"
+ .'- **BackhaulRouteExsited**: 云连接器实例回程路由存在状态'."\n"
+ .'- **DnsParseStatus**: 云连接器实例DNS解析状态'."\n"
+ .'- **AccessLogFromCardToDestination**: 卡到目的地址的访问记录'."\n"
+ .'- **AccessLogFromDestinationToCard**: 目的地址到卡的访问记录'."\n"
+ .'- **AccessLogOfCard**: 卡的访问记录'."\n"
+ .'- **AccessLogOfDesination**: 目的地址到访问记录'."\n"
+ .'- **DropLogOfCard**: 卡的丢包记录'."\n"
+ .'- **DropLogOfDestination**: 目的地址的丢包记录'."\n"
+ .'- **CciotCardOnlineStatus**: 卡在线状态',
+ 'changeSet' => [
+ ['createdAt' => '2024-03-07T09:19:39.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2023-01-05T02:02:59.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
],
- 'parameters' => [
- [
- 'name' => 'Iccid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '11111111111',
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDiagnoseResultForSingleCard'],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求iD',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => '0B28B72A-BD16-51F7-AAEE-55247FE02729',
- ],
- 'Iccid' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'example' => '111111111',
- ],
- 'NetType' => [
- 'description' => '网络类型，取值：'."\n"
- ."\n"
- .'- **4G**'."\n"
- .'- **5G**',
- 'type' => 'string',
- 'example' => '5G',
- ],
- 'APN' => [
- 'description' => '运营商APN的id。',
- 'type' => 'string',
- 'example' => 'zjalyjs01s.5gjs.njiot',
- ],
- 'ISP' => [
- 'description' => '5G高速上云实例的运营商。取值：'."\n"
- .'- **telecom**：中国电信。'."\n"
- .'- **mobile**：中国移动。'."\n"
- .'- **unicom**：中国联通。',
- 'type' => 'string',
- 'example' => 'Unicom',
- ],
- 'IpAddress' => [
- 'description' => '物联网卡的固定IP地址。',
- 'type' => 'string',
- 'example' => '172.24.2.121',
- ],
- 'Imsi' => [
- 'description' => '物联网卡的IMSI。',
- 'type' => 'string',
- 'example' => '12123123',
- ],
- 'Imei' => [
- 'description' => '设备IMEI。',
- 'type' => 'string',
- 'example' => '23412313513512',
- ],
- 'Lock' => [
- 'description' => '卡是否锁定。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Spec' => [
- 'description' => '规格',
- 'type' => 'string',
- 'example' => 'CONSUMER_THREE_IN_ONE',
- ],
- 'SimStatus' => [
- 'description' => '卡的状态，取值：'."\n"
- ."\n"
- .'- **Testable**: 可测试'."\n"
- .'- **Activatable**: 可激活'."\n"
- .'- **Activated**: 已激活'."\n"
- .'- **Deactivated**: 已停用'."\n"
- .'- **Failed**: 已失效'."\n"
- .'- **Cleared**: 已清除'."\n"
- .'- **Replaced**: 已更换'."\n"
- .'- **Resuming**: 恢复中'."\n"
- .'- **ShutDown**: 已停机',
- 'type' => 'string',
- 'example' => 'Deactivated',
- ],
- 'Status' => [
- 'description' => '实例状态，取值：'."\n"
- ."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 有效的稳定状态'."\n"
- .'- **UnAvailable**: 无效状态'."\n"
- .'- **Pending**: 配置中'."\n"
- .'- **Deleting**: 删除中',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => 'task-test',
- ],
- 'Name' => [
- 'description' => '名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'WirelessCloudConnectorId' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'example' => 'cc5g-xxxxxxx',
- ],
- 'CloudConnectorId' => [
- 'description' => '云连接id。',
- 'type' => 'string',
- 'example' => 'iotcc-xxxxxxxx',
- ],
- 'UsageDataMonth' => [
- 'description' => '本月已用流量，单位MB。'."\n"
- .'本字段信息存在一些外部条件等影响，会出现信息同步滞后，建议使用[ListCardUsages](https://help.aliyun.com/document_detail/472077.html?spm=a2c4g.438976.0.0.8bbc1711r5XXDT)查询单卡流量信息。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'OrderId' => [
- 'description' => '订单id。',
- 'type' => 'string',
- 'example' => '12312341234124',
- ],
- 'ActivatedTime' => [
- 'description' => '激活时间。',
- 'type' => 'string',
- 'example' => '2022-08-25 17:34:57',
- ],
- 'Msisdn' => [
- 'description' => '物联网卡的MSISDN。',
- 'type' => 'string',
- 'example' => '2312341231235',
- ],
- 'UsageDataTotal' => [
- 'description' => '单卡总使用量，单位MB。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'LimitThreshold' => [
- 'description' => '达量限速阈值，单位MB。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'StopThreshold' => [
- 'description' => '达量停机阈值，单位MB。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4096',
- ],
- 'AlarmThreshold' => [
- 'description' => '告警阈值，单位MB。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'iotcc:GetDiagnoseResultForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B28B72A-BD16-51F7-AAEE-55247FE02729\\",\\n \\"Iccid\\": \\"111111111\\",\\n \\"NetType\\": \\"5G\\",\\n \\"APN\\": \\"zjalyjs01s.5gjs.njiot\\",\\n \\"ISP\\": \\"Unicom\\",\\n \\"IpAddress\\": \\"172.24.2.121\\",\\n \\"Imsi\\": \\"12123123\\",\\n \\"Imei\\": \\"23412313513512\\",\\n \\"Lock\\": \\"true\\",\\n \\"Spec\\": \\"CONSUMER_THREE_IN_ONE\\",\\n \\"SimStatus\\": \\"Deactivated\\",\\n \\"Status\\": \\"Available\\",\\n \\"Description\\": \\"task-test\\",\\n \\"Name\\": \\"test\\",\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxxxxx\\",\\n \\"CloudConnectorId\\": \\"iotcc-xxxxxxxx\\",\\n \\"UsageDataMonth\\": 50,\\n \\"OrderId\\": \\"12312341234124\\",\\n \\"ActivatedTime\\": \\"2022-08-25 17:34:57\\",\\n \\"Msisdn\\": \\"2312341231235\\",\\n \\"UsageDataTotal\\": 1000,\\n \\"LimitThreshold\\": 50,\\n \\"StopThreshold\\": 4096,\\n \\"AlarmThreshold\\": 1000\\n}","type":"json"}]',
- 'title' => '获取单卡信息',
],
- 'GetCardLockReason' => [
- 'summary' => '获取锁卡原因。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetWirelessCloudConnector' => [
+ 'summary' => '查询5G高速上云实例详细信息。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3895,126 +2189,177 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '*********11111',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'WirelessCloudConnectorId',
+ 'in' => 'query',
+ 'schema' => ['description' => '5G高速上云实例id。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应对象',
+ 'description' => ' ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'F32C0BBE-5025-5561-8976-7BD096BA21FB',
- ],
- 'LockReason' => [
- 'description' => '锁定原因。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'CreditTwoWayStop' => 'CreditTwoWayStop',
- 'ExpireStop' => 'ExpireStop',
- 'ActiveTwoWayStop' => 'ActiveTwoWayStop',
- 'LocationStop' => 'LocationStop',
- 'NoReasonStop' => 'NoReasonStop',
- 'SeparationStop' => 'SeparationStop',
- 'M2MStop' => 'M2MStop',
- 'ForceTwoWayStop' => 'ForceTwoWayStop',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'NetLinks' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '到用户VPC的连接列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => ' ',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'NetLinkId' => ['title' => '资源名称', 'description' => '网络连接id。', 'type' => 'string', 'example' => 'cciot-xxxx'],
+ 'Name' => ['title' => '创建时间', 'description' => '名称。', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => '连接test'],
+ 'Status' => ['description' => '状态，取值：'."\n"
+ ."\n"
+ .'- **Pending**: 配置中 '."\n"
+ .'- **Attached**: 已绑定'."\n"
+ .'- **Detached**: 已解绑', 'type' => 'string', 'example' => 'Attached'],
+ 'Type' => ['description' => '类型，取值：'."\n"
+ ."\n"
+ .'- **Standard**: 标准版 '."\n"
+ .'- **Basic**: 基础版', 'type' => 'string', 'example' => 'Standard'],
+ 'APN' => ['description' => '运营商APN的id。', 'type' => 'string', 'example' => 'bjaliyun01s.5gbj.bjiot'],
+ 'ISP' => ['description' => '卡所属运营商: '."\n"
+ .'- **Telecom**: 电信'."\n"
+ .'- **Mobile**: 移动'."\n"
+ .'- **Unicom**: 联通', 'type' => 'string', 'example' => 'Telecom'],
+ 'VpcId' => ['description' => '专有网络VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxx'],
+ 'VSwitchs' => [
+ 'description' => '绑定的交换机列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '交换机id。', 'type' => 'string', 'example' => 'vsw-xxxx'],
+ ],
+ 'CreateTime' => ['description' => '连接创建时间。', 'type' => 'string', 'example' => '2022-03-15 22:20:00'],
+ 'GrantAliUid' => ['description' => '阿里云授权者UID。', 'type' => 'string', 'example' => '11111111111'],
+ ],
],
- 'example' => 'ForceTwoWayStop',
],
+ 'WirelessCloudConnectorId' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'example' => 'cc5g-xxxx'],
+ 'Status' => ['description' => '实例状态，取值：'."\n"
+ ."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 有效的稳定状态'."\n"
+ .'- **Pending**: 配置中'."\n"
+ .'- **Deleting**: 删除中', 'type' => 'string', 'example' => 'Available'],
+ 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'cc5g-test'],
+ 'RegionId' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'UseCase' => ['description' => '实例使用场景。', 'type' => 'string', 'example' => '智慧工厂'],
+ 'DataPackageId' => ['description' => '流量包id。', 'type' => 'string', 'example' => 'dp-xxxx'],
+ 'DataPackageType' => ['description' => '流量包档位，取值：'."\n"
+ ."\n"
+ .'- **200**: 200M/卡/月'."\n"
+ .'- **1000**: 1G/卡/月'."\n"
+ .'- **3000**: 3G/卡/月'."\n"
+ .'- **30000**: 30G/卡/月', 'type' => 'string', 'example' => '200'],
+ 'CardCount' => ['description' => '卡数量。', 'type' => 'string', 'example' => '20000'],
+ 'CreateTime' => ['description' => '实例创建时间。', 'type' => 'string', 'example' => '2022-3-15 22:20:00'],
+ 'BusinessType' => ['description' => '业务类型', 'type' => 'string', 'example' => 'Business'],
+ 'WirelessCloudConnectorGroupId' => ['description' => '分组ID', 'type' => 'string', 'example' => 'cc5gg-****'],
+ 'Features' => [
+ 'description' => '支持的功能特性列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '支持的功能特性列表。', 'type' => 'string', 'example' => '[\'DirectMode\']'],
+ ],
+ 'ServiceType' => ['description' => '服务类型，返回：'."\n"
+ ."\n"
+ .'- **CC5G**：普通实例。'."\n"
+ .'- **CC5GCCIoT**：过户实例。', 'type' => 'string', 'example' => 'CC5GCCIoT'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F32C0BBE-5025-5561-8976-7BD096BA21FB\\",\\n \\"LockReason\\": \\"ForceTwoWayStop\\"\\n}","type":"json"}]',
- 'title' => '获取锁卡原因',
- ],
- 'FailCards' => [
- 'summary' => '销卡。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"NetLinks\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"NetLinkId\\": \\"cciot-xxxx\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"连接test\\",\\n \\"Status\\": \\"Attached\\",\\n \\"Type\\": \\"Standard\\",\\n \\"APN\\": \\"bjaliyun01s.5gbj.bjiot\\",\\n \\"ISP\\": \\"Telecom\\",\\n \\"VpcId\\": \\"vpc-xxxx\\",\\n \\"VSwitchs\\": [\\n \\"vsw-xxxx\\"\\n ],\\n \\"CreateTime\\": \\"2022-03-15 22:20:00\\",\\n \\"GrantAliUid\\": \\"11111111111\\"\\n }\\n ],\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"Status\\": \\"Available\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"cc5g-test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"UseCase\\": \\"智慧工厂\\",\\n \\"DataPackageId\\": \\"dp-xxxx\\",\\n \\"DataPackageType\\": \\"200\\",\\n \\"CardCount\\": \\"20000\\",\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\",\\n \\"BusinessType\\": \\"Business\\",\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-****\\",\\n \\"Features\\": [\\n \\"[\'DirectMode\']\\"\\n ],\\n \\"ServiceType\\": \\"CC5GCCIoT\\"\\n}","type":"json"}]',
+ 'title' => '查询5G高速上云实例详情',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-04T02:45:47.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-10-27T08:34:23.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-09-04T10:43:17.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWirelessCloudConnector'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GrantNetLink' => [
+ 'summary' => '授权云连接器给第三方客户。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccids',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'style' => 'repeatList',
'schema' => [
- 'description' => '卡的iccid列表，最多200条。',
- 'type' => 'array',
- 'items' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => '8986*******',
- ],
+ 'description' => '5G高速上云实例id。',
+ 'type' => 'string',
'required' => true,
'enumValueTitles' => [],
- 'example' => 'FailCards',
- 'maxItems' => 50,
- 'minItems' => 1,
+ 'example' => 'cc5g-xxxx',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'NetLinkId',
'in' => 'query',
'schema' => [
- 'description' => '地域ID',
+ 'description' => '网络连接id。',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'enumValueTitles' => [],
- 'example' => 'cn-hangzhou',
+ 'example' => 'cciot-xxxx',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
- 'description' => '保证请求幂等性。'."\n"
- .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
- ."\n"
- .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
+ 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
- 'example' => 'TF-CreateServerlessDBInstance-1639649079-51d933f6-0251-4057-9276',
+ 'example' => 'f0ba469f-de7f-4dde-8390-0966a1a0ef9a',
],
],
[
@@ -4022,12 +2367,24 @@
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会激活/恢复卡状态。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后激活/恢复卡状态。',
+ .'- **true**：发送检查请求，不会删除授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接删除授权规则。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => [],
- 'example' => 'false',
+ 'example' => 'False',
+ ],
+ ],
+ [
+ 'name' => 'GrantAliUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '阿里云授权者UID。',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => '11111111111',
],
],
],
@@ -4040,147 +2397,163 @@
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
- 'description' => '请求ID。',
+ 'description' => '请求iD',
'type' => 'string',
- 'example' => '186B6E37-D9D1-5E64-ACDE-E89F7E68A37B',
+ 'enumValueTitles' => [],
+ 'example' => 'E6B58AF9-F1BF-5894-B898-6CE2108463C5',
],
],
'enumValueTitles' => [],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"186B6E37-D9D1-5E64-ACDE-E89F7E68A37B\\"\\n}","type":"json"}]',
- 'title' => '销卡',
- 'description' => '**销卡操作需谨慎，对卡进行销卡行为不可逆。**。',
- ],
- 'RebindCards' => [
- 'summary' => '换绑解锁单卡。',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.GrantUidNotHaveCcIotSlr', 'errorMessage' => 'The operation is not allowed because of GrantUid not have AliyunServiceRoleForCCIoT.', 'description' => '被授权的账号没有AliyunServiceRoleForCCIoT权限。'],
+ ['errorCode' => 'OperationDenied.NotSupportGrantToSelf', 'errorMessage' => 'The operation is not allowed because of not support grant self.', 'description' => '不允许授权给自己。'],
+ ['errorCode' => 'OperationDenied.ExistCustomerAuthorizationRules', 'errorMessage' => 'The operation is not allowed because of exist customer authorization rules.', 'description' => '5G上云服务下有自定义授权规则存在，不允许过户。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6B58AF9-F1BF-5894-B898-6CE2108463C5\\"\\n}","type":"json"}]',
+ 'title' => '授权云连接器',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-14T03:05:37.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-09-14T03:05:37.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantNetLink'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GrantNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListAPNs' => [
+ 'summary' => '查询5G高速上云服务支持的APN列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccids',
+ 'name' => 'RegionId',
'in' => 'query',
- 'allowEmptyValue' => false,
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '物联网SIM卡卡号，每次最大500条',
- 'type' => 'array',
- 'items' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456789',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => '云连接器实例所在的地域ID，仅取值：cn-hangzhou。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'APN',
'in' => 'query',
- 'schema' => [
- 'description' => '区域ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '运营商接入点APN ID。', 'type' => 'string', 'required' => false, 'example' => 'CMWAP'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ISP',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '运营商ID', 'type' => 'string', 'required' => false, 'example' => 'unicom'],
],
[
- 'name' => 'DryRun',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会删除批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后删除批量操作卡任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n"
+ ."\n"
+ .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小，取值范围：1~50，默认为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应体',
+ 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'D2A9864E-BB8D-5A5C-90FC-E2FBD5D0BF9B',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A175C091-3910-51AF-8D84-D5717B9B8D38'],
+ 'APNs' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '运营商APN列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => '运营商APN列表项',
+ 'type' => 'object',
+ 'properties' => [
+ 'ISP' => ['title' => '资源一级ID', 'description' => '5G高速上云实例的运营商。取值：'."\n"
+ .'- **telecom**：中国电信。'."\n"
+ .'- **mobile**：中国移动。'."\n"
+ .'- **unicom**：中国联通。', 'type' => 'string', 'example' => 'unicom'],
+ 'APN' => ['title' => '资源名称', 'description' => '运营商接入点APN ID。', 'type' => 'string', 'example' => 'zjhzaliyun01s.5gjs.njiot'],
+ 'Name' => ['title' => '创建时间', 'description' => '名称。'."\n"
+ ."\n"
+ .'当前现实APN支持网断。', 'type' => 'string', 'example' => '10.0.0.0/13'],
+ 'Description' => ['description' => '描述。'."\n"
+ ."\n"
+ .'当前线上APN描述暂未使用此字段，此APN描述信息为空。', 'type' => 'string', 'example' => '空'],
+ 'Zones' => [
+ 'description' => '可用区列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'],
+ ],
+ ],
+ ],
],
+ 'NextToken' => ['description' => '分页token，从返回结果中获取。', 'type' => 'string', 'example' => 'vhNxI+jwQfkLCUChCQ+iOoiRkyUbtAilGSvWuwktFBxF+bar2HpV0efI6n1+GkMv'],
+ 'MaxResults' => ['description' => '分页大小，范围1-100。', 'type' => 'string', 'example' => '20'],
+ 'TotalCount' => ['description' => '总条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CardsSimStatusNotReBind',
- 'errorMessage' => 'The operation is not allowed because of card status not support to rebind.',
- ],
- [
- 'errorCode' => 'OperationDenied.TestCardFlowExceedQuota',
- 'errorMessage' => 'The operation is not allowed because of test card flow exceed quota.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.IccID',
- 'errorMessage' => 'The specified resource of iccid is not found.',
- ],
- [
- 'errorCode' => 'OperationDenied.SingCardOneMonthRebindExceeded',
- 'errorMessage' => 'The operation is not allowed because of the number of times per card per month exceed quota.',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A175C091-3910-51AF-8D84-D5717B9B8D38\\",\\n \\"APNs\\": [\\n {\\n \\"ISP\\": \\"unicom\\",\\n \\"APN\\": \\"zjhzaliyun01s.5gjs.njiot\\",\\n \\"Name\\": \\"10.0.0.0/13\\",\\n \\"Description\\": \\"空\\",\\n \\"Zones\\": [\\n \\"cn-hangzhou-i\\"\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"vhNxI+jwQfkLCUChCQ+iOoiRkyUbtAilGSvWuwktFBxF+bar2HpV0efI6n1+GkMv\\",\\n \\"MaxResults\\": \\"20\\",\\n \\"TotalCount\\": \\"2\\"\\n}","errorExample":""},{"type":"xml","example":"<ListAPNsResponse>\\n <APNs>\\n </APNs>\\n</ListAPNsResponse>","errorExample":""}]',
+ 'title' => '查询APN列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAPNs'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListAPNs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2A9864E-BB8D-5A5C-90FC-E2FBD5D0BF9B\\"\\n}","type":"json"}]',
- 'title' => '换绑解锁单卡',
- 'description' => '物联网卡在换绑设备时，运营商会锁定此卡，为了能够正常使用，一般需要对此卡进行换绑解锁，注意：单卡单月换绑解锁部分运营商只能支持2次。',
],
- 'ListCardDayUsages' => [
- 'summary' => '查询单卡单日流量。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListAuthorizationRules' => [
+ 'summary' => '查询授权规则列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4189,226 +2562,278 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
+ ],
+ [
+ 'name' => 'Statuses',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '5G高速上云实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
+ 'description' => '授权规则状态列表',
+ 'type' => 'array',
+ 'items' => ['description' => ' 授权规则状态，取值：'."\n"
+ .'- **Creating**:创建中'."\n"
+ .'- **Pending**:配置中'."\n"
+ .'- **Available**:有效的稳定状态'."\n"
+ .'- **Invalid**: 无效'."\n"
+ .'- **Deleting**:删除中', 'type' => 'string', 'required' => false, 'example' => 'Creating'],
+ 'required' => false,
],
],
[
- 'name' => 'Iccids',
+ 'name' => 'AuthorizationRuleIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '物联网SIM卡卡号，每次最大50条',
+ 'description' => '授权规则id列表。',
'type' => 'array',
- 'items' => [
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => true,
- 'maxItems' => 50,
- 'minItems' => 1,
+ 'items' => ['description' => '授权规则id', 'type' => 'string', 'required' => false, 'example' => 'ar5g-xxxx'],
+ 'required' => false,
],
],
[
- 'name' => 'LatestMonthNum',
+ 'name' => 'Names',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '查询最近几个月卡流量数据，默认两个月，包含当月。参数范围[1,6]',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '授权规则名称列表',
+ 'type' => 'array',
+ 'items' => ['description' => '名称，长度不超过128字符。', 'type' => 'string', 'required' => false, 'example' => 'Test'],
'required' => false,
- 'maximum' => '6',
- 'minimum' => '1',
- 'enumValueTitles' => [],
- 'example' => '1',
],
],
+ [
+ 'name' => 'DestinationType',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标类型，取值：'."\n"
+ .'- **Cidr**: 网段'."\n"
+ .'- **Domain**: 域名或泛域名'."\n"
+ .'- **IpPort**: IP重定向', 'type' => 'string', 'required' => false, 'example' => 'Cidr'],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => '协议类型。取值：'."\n"
+ ."\n"
+ .'- **tcp**。'."\n"
+ .'- **udp**。'."\n"
+ .'- **icmp**。'."\n"
+ .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'all'],
+ ],
+ [
+ 'name' => 'DestinationPort',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标端口范围。取值范围：'."\n"
+ ."\n"
+ .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ ."\n"
+ .'- ICMP协议：-1/-1。'."\n"
+ ."\n"
+ .'- ALL：-1/-1。', 'type' => 'string', 'required' => false, 'example' => '-1/-1'],
+ ],
+ [
+ 'name' => 'Destination',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标地址、域名或泛域名，前缀匹配。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1'],
+ ],
+ [
+ 'name' => 'Policy',
+ 'in' => 'query',
+ 'schema' => ['description' => '授权规则策略，取值：'."\n"
+ .'- **Permit**：允许'."\n"
+ .'- **Deny**：拒绝'."\n"
+ .'- **Mapping**：重定向', 'type' => 'string', 'required' => false, 'example' => 'Permit'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => '类型，取值：'."\n"
+ .'- **System**: 系统'."\n"
+ .'- **Default**: 默认'."\n"
+ .'- **Customer**: 自定义', 'type' => 'string', 'required' => false, 'example' => 'System'],
+ ],
+ [
+ 'name' => 'Dns',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否为DNS。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应体',
+ 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03',
- ],
- 'Cards' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '207F9929-806E-5622-8E4F-8484F7000C22'],
+ 'AuthorizationRules' => [
'title' => '数组，返回示例目录。',
- 'description' => '卡流量信息',
+ 'description' => '授权规则列表。',
'type' => 'array',
'items' => [
'title' => 'RegionItemType',
- 'description' => '卡流量信息',
+ 'description' => 'RegionItemType',
'type' => 'object',
'properties' => [
- 'Iccid' => [
- 'title' => '资源一级ID',
- 'description' => '物联网卡的iccid。',
- 'type' => 'string',
- 'example' => '89091231231219123',
- ],
- 'UsageDataMonths' => [
- 'description' => '卡单月流量信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '卡单月流量信息',
- 'type' => 'object',
- 'properties' => [
- 'UsageDataMonth' => [
- 'description' => '月已用流量，单位MB。',
- 'type' => 'string',
- 'example' => '1030',
- ],
- 'Month' => [
- 'description' => '月份',
- 'type' => 'string',
- 'example' => '202207',
- ],
- 'CardDayUsages' => [
- 'description' => '卡天级别流量信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '卡天级别流量信息',
- 'type' => 'object',
- 'properties' => [
- 'Day' => [
- 'description' => '日',
- 'type' => 'string',
- 'example' => '20220701',
- ],
- 'UsageData' => [
- 'description' => '日已用流量，单位MB。',
- 'type' => 'string',
- 'example' => '40',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'AuthorizationRuleId' => ['title' => '资源一级ID', 'description' => '授权规则id。', 'type' => 'string', 'example' => 'ar5g-xxxx'],
+ 'Status' => ['title' => '资源名称', 'description' => '授权规则状态，取值：'."\n"
+ .'- **Creating**: 创建中 '."\n"
+ .'- **Pending**: 配置中'."\n"
+ .'- **Available**: 有效的稳定状态'."\n"
+ .'- **Invalid**: 无效'."\n"
+ .'- **Deleting**: 删除中', 'type' => 'string', 'example' => 'Pending'],
+ 'Name' => ['title' => '创建时间', 'description' => '授权规则名称。', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => '授权规则描述。', 'type' => 'string', 'example' => 'ar5g-test'],
+ 'Type' => ['description' => '类型，取值：'."\n"
+ .'- **System**: 系统'."\n"
+ .'- **Default**: 默认'."\n"
+ .'- **Customer**: 自定义', 'type' => 'string', 'example' => 'Default'],
+ 'SourceCidr' => ['description' => '源CIDR地址块。', 'type' => 'string', 'example' => '0.0.0.0/0'],
+ 'DestinationType' => ['description' => '目标类型，取值：'."\n"
+ .'- **Cidr**: 网段'."\n"
+ .'- **Domain**: 域名或泛域名'."\n"
+ .'- **IpPort**: IP重定向', 'type' => 'string', 'example' => 'Cidr'],
+ 'Protocol' => ['description' => '协议类型。取值：'."\n"
+ ."\n"
+ .'- **tcp**。'."\n"
+ .'- **udp**。'."\n"
+ .'- **icmp**。'."\n"
+ .'- **all**：支持所有协议。', 'type' => 'string', 'example' => 'all'],
+ 'DestinationPort' => ['description' => '目标端口范围。取值范围：'."\n"
+ ."\n"
+ .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ .'- ICMP协议：-1/-1。'."\n"
+ .'- ALL：-1/-1。', 'type' => 'string', 'example' => '0-65535'],
+ 'Destination' => ['description' => '目标地址、域名或泛域名，前缀匹配。', 'type' => 'string', 'example' => '10.0.0.0/24'],
+ 'Policy' => ['description' => '授权规则策略，取值：'."\n"
+ .'- **Permit**：允许'."\n"
+ .'- **Deny**：拒绝'."\n"
+ .'- **Mapping**：重定向', 'type' => 'string', 'example' => 'Permit'],
+ 'Dns' => ['description' => '是否为DNS。', 'type' => 'boolean', 'example' => 'true'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-3-15 22:20:00'],
],
],
],
+ 'NextToken' => ['description' => '下一次查询的起始token。', 'type' => 'string', 'example' => 'iou001238joojjaere'],
+ 'MaxResults' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '列表的条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"207F9929-806E-5622-8E4F-8484F7000C22\\",\\n \\"AuthorizationRules\\": [\\n {\\n \\"AuthorizationRuleId\\": \\"ar5g-xxxx\\",\\n \\"Status\\": \\"Pending\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"ar5g-test\\",\\n \\"Type\\": \\"Default\\",\\n \\"SourceCidr\\": \\"0.0.0.0/0\\",\\n \\"DestinationType\\": \\"Cidr\\",\\n \\"Protocol\\": \\"all\\",\\n \\"DestinationPort\\": \\"0-65535\\",\\n \\"Destination\\": \\"10.0.0.0/24\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"Dns\\": true,\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '查询授权规则',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-18T13:33:38.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\",\\n \\"Cards\\": [\\n {\\n \\"Iccid\\": \\"89091231231219123\\",\\n \\"UsageDataMonths\\": [\\n {\\n \\"UsageDataMonth\\": \\"1030\\",\\n \\"Month\\": \\"202207\\",\\n \\"CardDayUsages\\": [\\n {\\n \\"Day\\": \\"20220701\\",\\n \\"UsageData\\": \\"40\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询单卡单日流量',
- 'description' => '返回参数如果没有此卡或者有此卡但是某些天没有，说明这些未返回的天此卡没有使用流量。',
- ],
- 'ResetAreaLimitCards' => [
- 'summary' => '物联网卡区域限制解锁',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAuthorizationRules'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListAuthorizationRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListBatchOperateCardsTasks' => [
+ 'summary' => '列出批量操作卡任务。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccids',
+ 'name' => 'RegionId',
'in' => 'query',
- 'allowEmptyValue' => false,
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '物联网SIM卡卡号，每次最大50条',
- 'type' => 'array',
- 'items' => [
- 'description' => '物联网SIM卡卡号，每次最大50条',
- 'type' => 'string',
- 'required' => false,
- 'example' => '898606*******',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Statuses',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '地域ID',
- 'type' => 'string',
+ 'description' => '批量操作任务的状态。',
+ 'type' => 'array',
+ 'items' => ['description' => '任务状态，取值：'."\n"
+ .'- **Creating**: 创建中 '."\n"
+ .'- **Pending**: 待生效'."\n"
+ .'- **Available**: 全部成功'."\n"
+ .'- **PartialAvailable**: 部分成功'."\n"
+ .'- **UnAvailable**: 已失效'."\n"
+ .'- **Fail**: 全部失败', 'type' => 'string', 'required' => false, 'example' => 'Creating'],
'required' => false,
- 'example' => 'cn-hangzhou',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'BatchOperateCardsTaskIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '保证请求幂等性。'."\n"
- .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
- ."\n"
- .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
- 'type' => 'string',
+ 'description' => '批量操作任务的id列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '批量操作任务id。', 'type' => 'string', 'required' => false, 'example' => 'boct-xxxx'],
'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
],
],
[
- 'name' => 'DryRun',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查直接创建批量操作卡任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'],
],
[
- 'name' => 'Province',
+ 'name' => 'MaxResults',
'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Names',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '省份。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '湖南省',
+ 'description' => '批量操作的名称。',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => 'xxxx工厂实例批量限速', 'description' => ''],
+ 'required' => false,
],
],
],
@@ -4416,39 +2841,99 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应返回体',
+ 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'BatchOperateCardsTasks' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '卡批量操作任务列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => '任务项',
+ 'type' => 'object',
+ 'properties' => [
+ 'BatchOperateCardsTaskId' => ['title' => '资源一级ID', 'description' => '批量操作任务ID。', 'type' => 'string', 'example' => 'boct-xxxx'],
+ 'Status' => ['description' => '任务状态，取值：'."\n"
+ .'- **Creating**: 创建中 '."\n"
+ .'- **Pending**: 待生效'."\n"
+ .'- **Available**: 全部成功'."\n"
+ .'- **PartialAvailable**: 部分成功'."\n"
+ .'- **UnAvailable**: 已失效'."\n"
+ .'- **Fail**: 全部失败', 'type' => 'string', 'example' => 'Available'],
+ 'OperateType' => ['title' => '创建时间', 'description' => '限制类型，枚举值：'."\n"
+ ."\n"
+ .'- **BreakNetwork**: 达量断网'."\n"
+ .'- **LimitRate**: 达量限速'."\n"
+ .'- **Alarm**: 达量告警', 'type' => 'string', 'example' => 'BreakNetwork'],
+ 'Threshold' => ['description' => '达量阈值，单位MB。', 'type' => 'string', 'example' => '100'],
+ 'EffectType' => ['description' => '生效类型，枚举值：'."\n"
+ ."\n"
+ .'- **CurrentMonth**'."\n"
+ .'- **ContinualMonth**', 'type' => 'string', 'example' => 'CurrentMonth'],
+ 'IccidsOssFilePath' => ['description' => 'iccid文件存放路径。', 'type' => 'string', 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***'],
+ 'WirelessCloudConnectors' => [
+ 'description' => '5G高速上云的实例ID和状态列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorId' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'example' => 'cc5g-xxxx'],
+ 'Status' => ['description' => '状态，枚举值：'."\n"
+ ."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 有效的稳定状态'."\n"
+ .'- **Pending**: 配置中'."\n"
+ .'- **Deleting**: 删除中'."\n"
+ .'- **Deleted**: 已删除', 'type' => 'string', 'example' => 'Deleted'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'OperateResultOssFilePath' => ['description' => '批量操作结果的文件路径。', 'type' => 'string', 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***'],
+ 'Description' => ['description' => '批量操作描述。', 'type' => 'string', 'example' => 'task-test'],
+ 'Name' => ['description' => '批量操作名称。', 'type' => 'string', 'example' => 'test'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-3-15 22:20:00'],
+ ],
+ ],
],
+ 'NextToken' => ['description' => '下一次查询的起始token。', 'type' => 'string', 'example' => 'iou001238joojjaere'],
+ 'MaxResults' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '列表的条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CardsSimStatusNotResume',
- 'errorMessage' => 'The operation is not allowed because of card status not support to resume.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"BatchOperateCardsTasks\\": [\\n {\\n \\"BatchOperateCardsTaskId\\": \\"boct-xxxx\\",\\n \\"Status\\": \\"Available\\",\\n \\"OperateType\\": \\"BreakNetwork\\",\\n \\"Threshold\\": \\"100\\",\\n \\"EffectType\\": \\"CurrentMonth\\",\\n \\"IccidsOssFilePath\\": \\"https://examplebucket.oss-eu-central-1.aliyuncs.com/***\\",\\n \\"WirelessCloudConnectors\\": [\\n {\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"Status\\": \\"Deleted\\"\\n }\\n ],\\n \\"OperateResultOssFilePath\\": \\"https://examplebucket.oss-eu-central-1.aliyuncs.com/***\\",\\n \\"Description\\": \\"task-test\\",\\n \\"Name\\": \\"test\\",\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '列出批量操作卡任务',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-11T07:13:13.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-05-30T07:48:47.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBatchOperateCardsTasks'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListBatchOperateCardsTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '区域限制解锁',
],
'ListCardAreaLimitSupportArea' => [
'summary' => '查询卡区域解锁支持的省份。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4460,47 +2945,29 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => '返回信息的语言类型：'."\n"
- ."\n"
- .'- zh：中文'."\n"
- .'- en：英文'."\n"
- ."\n"
- .'默认不填中文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- ],
+ 'schema' => ['description' => '返回信息的语言类型：'."\n"
+ ."\n"
+ .'- zh：中文'."\n"
+ .'- en：英文'."\n"
+ ."\n"
+ .'默认不填中文', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '区域ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- 'default' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '区域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou'],
],
[
'name' => 'ProvinceName',
'in' => 'query',
- 'schema' => [
- 'description' => '省份名称（非必填）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '浙江省',
- ],
+ 'schema' => ['description' => '省份名称（非必填）。', 'type' => 'string', 'required' => false, 'example' => '浙江省'],
],
],
'responses' => [
@@ -4510,21 +2977,12 @@
'description' => '返回结构体',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求iD',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求iD', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
'Provinces' => [
'title' => '数组，返回示例目录。',
'description' => '数组，返回示例目录。',
'type' => 'array',
- 'items' => [
- 'description' => '支持的中国省份。',
- 'type' => 'string',
- 'example' => '江苏省',
- ],
+ 'items' => ['description' => '支持的中国省份。', 'type' => 'string', 'example' => '江苏省'],
],
],
],
@@ -4532,158 +2990,72 @@
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"Provinces\\": [\\n \\"江苏省\\"\\n ]\\n}","type":"json"}]',
'title' => '查询卡区域解锁支持的省份',
- ],
- 'CreateAuthorizationRule' => [
- 'summary' => '创建授权规则。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardAreaLimitSupportArea',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListCardDayUsages' => [
+ 'summary' => '查询单卡单日流量。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '授权规则名称，长度不超过128字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '授权规则描述，长度不超过256字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5g-test',
- ],
- ],
- [
- 'name' => 'SourceCidr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '源CIDR地址块。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0/0',
- ],
- ],
- [
- 'name' => 'DestinationType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目标类型，取值：'."\n"
- .'- **Cidr**: 网段'."\n"
- .'- **Domain**: 域名或泛域名',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Cidr',
- ],
- ],
- [
- 'name' => 'Protocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协议类型。取值：'."\n"
- ."\n"
- .'- **icmp**：网络控制报文协议。'."\n"
- .'- **tcp**：传输控制协议。'."\n"
- .'- **udp**：用户数据报协议。'."\n"
- .'- **all**：支持所有协议。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
- ],
- [
- 'name' => 'DestinationPort',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目标端口范围。取值范围：'."\n"
- ."\n"
- .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- ."\n"
- .'- ICMP协议：-1/-1。'."\n"
- ."\n"
- .'- ALL：-1/-1。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-1/-1',
- ],
- ],
- [
- 'name' => 'Destination',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目标地址或域名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => '5G高速上云实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'Policy',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '授权规则策略，取值：'."\n"
- .'- **Permit**：允许'."\n"
- .'- **Deny**：拒绝',
- 'type' => 'string',
+ 'description' => '物联网SIM卡卡号，每次最大50条',
+ 'type' => 'array',
+ 'items' => ['description' => '物联网卡的iccid。', 'type' => 'string', 'required' => false, 'example' => '890912389123'],
'required' => true,
- 'example' => 'Permit',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'maxItems' => 50,
+ 'minItems' => 1,
],
],
[
- 'name' => 'DryRun',
+ 'name' => 'LatestMonthNum',
'in' => 'query',
'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。',
- 'type' => 'boolean',
+ 'description' => '查询最近几个月卡流量数据，默认两个月，包含当月。参数范围[1,6]',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => 'true',
+ 'maximum' => '6',
+ 'minimum' => '1',
+ 'enumValueTitles' => [],
+ 'example' => '1',
],
],
],
@@ -4691,101 +3063,111 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应对象',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '61202DF5-668B-5EDA-8177-F2D71F4737C1',
- ],
- 'AuthorizationRuleId' => [
- 'description' => '授权规则id。',
- 'type' => 'string',
- 'example' => 'ar5g-12fnojjtkkre28t08j',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03'],
+ 'Cards' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '卡流量信息',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => '卡流量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Iccid' => ['title' => '资源一级ID', 'description' => '物联网卡的iccid。', 'type' => 'string', 'example' => '89091231231219123'],
+ 'UsageDataMonths' => [
+ 'description' => '卡单月流量信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '卡单月流量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'UsageDataMonth' => ['description' => '月已用流量，单位MB。', 'type' => 'string', 'example' => '1030'],
+ 'Month' => ['description' => '月份', 'type' => 'string', 'example' => '202207'],
+ 'CardDayUsages' => [
+ 'description' => '卡天级别流量信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '卡天级别流量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Day' => ['description' => '日', 'type' => 'string', 'example' => '20220701'],
+ 'UsageData' => ['description' => '日已用流量，单位MB。', 'type' => 'string', 'example' => '40'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
- 'errorMessage' => 'The operation is not allowed because of CIDR too large.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\",\\n \\"Cards\\": [\\n {\\n \\"Iccid\\": \\"89091231231219123\\",\\n \\"UsageDataMonths\\": [\\n {\\n \\"UsageDataMonth\\": \\"1030\\",\\n \\"Month\\": \\"202207\\",\\n \\"CardDayUsages\\": [\\n {\\n \\"Day\\": \\"20220701\\",\\n \\"UsageData\\": \\"40\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询单卡单日流量',
+ 'description' => '返回参数如果没有此卡或者有此卡但是某些天没有，说明这些未返回的天此卡没有使用流量。',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-27T09:15:23.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCardDayUsages'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardDayUsages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61202DF5-668B-5EDA-8177-F2D71F4737C1\\",\\n \\"AuthorizationRuleId\\": \\"ar5g-12fnojjtkkre28t08j\\"\\n}","type":"json"}]',
- 'title' => '创建授权规则',
],
- 'DeleteAuthorizationRule' => [
- 'summary' => '删除授权规则。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCardUsages' => [
+ 'summary' => '查询物联网卡流量使用信息。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '5G高速上云实例ID 。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'AuthorizationRuleId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '授权规则id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ar5g-xxxx',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
- ],
- [
- 'name' => 'DryRun',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会删除授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接删除授权规则。',
- 'type' => 'boolean',
+ 'description' => '物联网SIM卡卡号，每次最大50条',
+ 'type' => 'array',
+ 'items' => ['description' => '物联网卡的iccid。', 'type' => 'string', 'required' => false, 'example' => '890912389123'],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 50,
+ 'minItems' => 1,
],
],
],
@@ -4793,172 +3175,154 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应对象',
+ 'description' => '响应',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '186B6E37-D9D1-5E64-ACDE-E89F7E68A37B'],
+ 'Cards' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '卡信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => '卡信息项',
+ 'type' => 'object',
+ 'properties' => [
+ 'Iccid' => ['title' => '资源一级ID', 'description' => '物联网卡的iccid。', 'type' => 'string', 'example' => '89091231231219123'],
+ 'UsageDataMonth' => ['description' => '本月已用流量，单位MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ ],
+ ],
],
+ 'TotalCount' => ['description' => '返回总量', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '删除授权规则',
- ],
- 'UpdateAuthorizationRule' => [
- 'summary' => '更新授权规则。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"186B6E37-D9D1-5E64-ACDE-E89F7E68A37B\\",\\n \\"Cards\\": [\\n {\\n \\"Iccid\\": \\"89091231231219123\\",\\n \\"UsageDataMonth\\": 20\\n }\\n ],\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '查询卡流量使用信息',
+ 'description' => '当月流量信息是本月1号0点开始到月底结束。',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-26T07:35:16.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCardUsages'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardUsages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListCards' => [
+ 'summary' => '查询5G高速上云实例下的卡信息列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'AuthorizationRuleId',
+ 'name' => 'Statuses',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '授权规则id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ar5g-xxxx',
+ 'description' => '卡的状态列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '卡的状态，取值：'."\n"
+ ."\n"
+ .'- **Testable**: 可测试'."\n"
+ .'- **Activatable**: 可激活'."\n"
+ .'- **Activated**: 已激活'."\n"
+ .'- **Deactivated**: 已停用'."\n"
+ .'- **Failed**: 已失效'."\n"
+ .'- **Cleared**: 已清除'."\n"
+ .'- **Replaced**: 已更换'."\n"
+ .'- **Resuming**: 恢复中'."\n"
+ .'- **ShutDown**: 已停机', 'type' => 'string', 'required' => false, 'example' => 'Activated'],
+ 'required' => false,
],
],
[
- 'name' => 'Name',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '名称，长度不超过128字符。',
- 'type' => 'string',
+ 'description' => '物联网卡的iccid列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '物联网卡的iccid。', 'type' => 'string', 'required' => false, 'example' => '89091231231219123'],
'required' => false,
- 'example' => 'Test',
+ 'enumValueTitles' => [],
],
],
[
- 'name' => 'Description',
+ 'name' => 'IpAddress',
'in' => 'query',
- 'schema' => [
- 'description' => '描述，长度不超过256字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5g-test',
- ],
+ 'schema' => ['description' => '物联网卡的固定IP地址。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1'],
],
[
- 'name' => 'SourceCidr',
+ 'name' => 'Lock',
'in' => 'query',
- 'schema' => [
- 'description' => '源CIDR地址块。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0/0',
- ],
+ 'schema' => ['description' => '卡是否锁定。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Destination',
+ 'name' => 'Online',
'in' => 'query',
- 'schema' => [
- 'description' => '目标地址或域名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => '卡是否在线。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Protocol',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '协议类型。取值：'."\n"
- ."\n"
- .'- **tcp**。'."\n"
- .'- **udp**。'."\n"
- .'- **icmp**。'."\n"
- .'- **all**：支持所有协议。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
+ 'schema' => ['description' => '网络连接id。', 'type' => 'string', 'required' => false, 'example' => 'cciot-xxxx'],
],
[
- 'name' => 'DestinationPort',
+ 'name' => 'Apn',
'in' => 'query',
- 'schema' => [
- 'description' => '目标端口范围。取值范围：'."\n"
- ."\n"
- .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- ."\n"
- .'- ICMP协议：-1/-1。'."\n"
- ."\n"
- .'- ALL：-1/-1。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-1/-1',
- ],
+ 'schema' => ['description' => '运营商APN的id。', 'type' => 'string', 'required' => false, 'example' => 'bjaliyun01s.5gbj.bjiot'],
],
[
- 'name' => 'Policy',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则策略，取值：'."\n"
- .'- **Permit**：允许'."\n"
- .'- **Deny**：拒绝',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Permit',
- ],
+ 'schema' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'DryRun',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会更新授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后更新授权规则。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '卡的iccid的前缀，如果后缀包含字符会去除字符。', 'type' => 'string', 'required' => false, 'example' => '8909123123121912'],
+ ],
+ [
+ 'name' => 'Msisdn',
+ 'in' => 'query',
+ 'schema' => ['description' => '物联网卡的MSISDN。', 'type' => 'string', 'required' => false, 'example' => '1441204374591'],
],
],
'responses' => [
@@ -4968,124 +3332,172 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'],
+ 'Cards' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '卡列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'Iccid' => ['title' => '资源一级ID', 'description' => '物联网卡的iccid。', 'type' => 'string', 'example' => '89091231231219123'],
+ 'NetType' => ['title' => '资源名称', 'description' => '网络类型，取值：'."\n"
+ ."\n"
+ .'- **4G**'."\n"
+ .'- **5G**', 'type' => 'string', 'example' => '5G'],
+ 'APN' => ['title' => '创建时间', 'description' => '运营商APN的id。', 'type' => 'string', 'example' => 'bjaliyun01s.5gbj.bjiot'],
+ 'ISP' => ['description' => '5G高速上云实例的运营商。取值：'."\n"
+ .'- **Telecom**：中国电信'."\n"
+ .'- **Mobile**：中国移动'."\n"
+ .'- **Unicom**：中国联通', 'type' => 'string', 'example' => 'Telecom'],
+ 'IpAddress' => ['description' => '卡的静态IP地址。', 'type' => 'string', 'example' => '10.0.0.118'],
+ 'Imsi' => ['description' => '物联网卡的IMSI。', 'type' => 'string', 'example' => '8912039123'],
+ 'Imei' => ['description' => '物联网卡的IMEI。', 'type' => 'string', 'example' => '7896129300'],
+ 'Lock' => ['description' => '卡是否锁定。', 'type' => 'boolean', 'example' => 'false'],
+ 'Spec' => ['description' => '卡的规格，取值：'."\n"
+ ."\n"
+ .'- **CONSUMER\\_THREE\\_IN\\_ONE:** 消费电子级物联网卡\\_三合一'."\n"
+ .'- **INDUSTRY\\_PATCH:** 工业级物联网贴片卡'."\n"
+ .'- **CONSUMER\\_PATCH:** 消费电子级物联网贴片卡'."\n"
+ .'- **INDUSTRY\\_GENERAL:** 工业级物联网卡\\_普通'."\n"
+ .'- **INDUSTRY\\_MICRO:** 工业级物联网卡\\_Micro'."\n"
+ .'- **CONSUMER\\_GENERAL:** 消费电子级物联网卡_普通'."\n"
+ .'- **CONSUMER\\_TWO\\_IN\\_ONE:** 消费电子级物联网卡\\_二合一'."\n"
+ .'- **INDUSTRY\\_NANO:** 工业级物联网卡\\_Nano'."\n"
+ .'- **CAR\\_PATCH:** 车规级物联网贴片卡', 'type' => 'string', 'example' => 'CONSUMER_THREE_IN_ONE'],
+ 'Status' => ['description' => '卡的状态，取值：'."\n"
+ ."\n"
+ .'- **Testable**: 可测试'."\n"
+ .'- **Activatable**: 可激活'."\n"
+ .'- **Activated**: 已激活'."\n"
+ .'- **Deactivated**: 已停用'."\n"
+ .'- **Failed**: 已失效'."\n"
+ .'- **Cleared**: 已清除'."\n"
+ .'- **Replaced**: 已更换'."\n"
+ .'- **Resuming**: 恢复中'."\n"
+ .'- **ShutDown**: 已停机', 'type' => 'string', 'example' => 'Activated'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'test'],
+ 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'],
+ 'UsageDataMonth' => ['description' => '本月已用流量，单位MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'OrderId' => ['description' => '订单号。', 'type' => 'string', 'example' => '89099123012'],
+ 'ActivatedTime' => ['description' => '激活时间。', 'type' => 'string', 'example' => '2022-3-15 22:20:00'],
+ 'BusinessStatus' => ['description' => '业务状态，取值：'."\n"
+ ."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 稳定状态，有效'."\n"
+ .'- **Configuring**: 配置中'."\n"
+ .'- **Deleting**: 删除中', 'type' => 'string', 'example' => 'Available'],
+ 'Msisdn' => ['description' => '物联网卡的MSISDN。', 'type' => 'string', 'example' => '1441204374591'],
+ 'UsageDataTotal' => ['description' => '单卡总使用量', 'type' => 'string', 'example' => '50'],
+ ],
+ ],
],
+ 'NextToken' => ['description' => '下一页查询所需值。', 'type' => 'string', 'example' => 'iou001238joojjaere'],
+ 'MaxResults' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '列表的条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
- 'errorMessage' => 'The operation is not allowed because of CIDR too large.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88C2F32F-B641-5980-B7A5-6907050ABCD1\\",\\n \\"Cards\\": [\\n {\\n \\"Iccid\\": \\"89091231231219123\\",\\n \\"NetType\\": \\"5G\\",\\n \\"APN\\": \\"bjaliyun01s.5gbj.bjiot\\",\\n \\"ISP\\": \\"Telecom\\",\\n \\"IpAddress\\": \\"10.0.0.118\\",\\n \\"Imsi\\": \\"8912039123\\",\\n \\"Imei\\": \\"7896129300\\",\\n \\"Lock\\": false,\\n \\"Spec\\": \\"CONSUMER_THREE_IN_ONE\\",\\n \\"Status\\": \\"Activated\\",\\n \\"Description\\": \\"test\\",\\n \\"Name\\": \\"test\\",\\n \\"UsageDataMonth\\": 20,\\n \\"OrderId\\": \\"89099123012\\",\\n \\"ActivatedTime\\": \\"2022-3-15 22:20:00\\",\\n \\"BusinessStatus\\": \\"Available\\",\\n \\"Msisdn\\": \\"1441204374591\\",\\n \\"UsageDataTotal\\": \\"50\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '查询5G高速上云实例下的卡信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-29T12:41:40.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-07-18T10:03:51.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-07-11T08:49:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-06-13T06:21:48.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-30T07:48:47.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCards'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\"\\n}","type":"json"}]',
- 'title' => '更新授权规则',
],
- 'AddDNSAuthorizationRule' => [
- 'summary' => '创建DNS授权规则。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDataPackages' => [
+ 'summary' => '查询流量包信息列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'Name',
+ 'name' => 'Statuses',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '名称，长度不超过128字符。',
- 'type' => 'string',
+ 'description' => '流量包状态列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '流量包状态，取值：'."\n"
+ ."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 已生效'."\n"
+ .'- **Expired**: 已过期', 'type' => 'string', 'required' => false, 'example' => 'Available'],
'required' => false,
- 'example' => 'test',
],
],
[
- 'name' => 'Description',
+ 'name' => 'DataPackageIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '描述，长度不超过256字符。',
- 'type' => 'string',
+ 'description' => '流量包id，最多20个。',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => 'dp-xxxx', 'description' => ''],
'required' => false,
- 'example' => 'ar5g-test',
- ],
- ],
- [
- 'name' => 'SourceDNSIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'DNS服务器地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0.0.0.0',
],
],
[
- 'name' => 'DestinationIp',
+ 'name' => 'Names',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '需要重定向的DNS服务器地址。',
- 'type' => 'string',
+ 'description' => '流量包名称，最多20个',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => 'cciot-123', 'description' => ''],
'required' => false,
- 'example' => '1.1.1.1',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'],
],
[
- 'name' => 'DryRun',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后创建DNS授权规则。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
],
'responses' => [
@@ -5095,162 +3507,217 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'AuthorizationRuleId' => [
- 'description' => '生成的DNS授权规则id。',
- 'type' => 'string',
- 'example' => 'ar5g-xxxx',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE'],
+ 'DataPackages' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '流量包列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataPackageId' => ['description' => '流量包id。', 'type' => 'string', 'example' => 'dp-xxxx'],
+ 'Status' => ['title' => '资源名称', 'description' => '流量包状态，取值：'."\n"
+ ."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 已生效'."\n"
+ .'- **Expired**: 已过期', 'type' => 'string', 'example' => 'Available'],
+ 'Name' => ['title' => '创建时间', 'description' => '流量包名称', 'type' => 'string', 'example' => '测试流量包'],
+ 'ISP' => ['description' => '卡所属运营商：'."\n"
+ ."\n"
+ .'- **Telecom**: 电信'."\n"
+ .'- **Mobile**: 移动'."\n"
+ .'- **Unicom**: 联通', 'type' => 'string', 'example' => 'Telecom'],
+ 'Size' => ['description' => '流量包档位，取值：'."\n"
+ ."\n"
+ .'- **200**: 200M/卡/月'."\n"
+ .'- **1000**: 1G/卡/月'."\n"
+ .'- **3000**: 3G/卡/月'."\n"
+ .'- **30000**: 30G/卡/月', 'type' => 'string', 'example' => '200'],
+ 'CardCount' => ['description' => '卡数量。', 'type' => 'string', 'example' => '20000'],
+ 'CreateTime' => ['description' => '开通时间。', 'type' => 'string', 'example' => '2022-3-15 22:20:00'],
+ 'ExpiredTime' => ['description' => '失效时间。', 'type' => 'string', 'example' => '2099-3-15 22:20:00'],
+ ],
+ ],
],
+ 'NextToken' => ['description' => '下一页查询所需值。', 'type' => 'string', 'example' => 'iou001238joojjaere'],
+ 'MaxResults' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '列表的条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"AuthorizationRuleId\\": \\"ar5g-xxxx\\"\\n}","type":"json"}]',
- 'title' => '创建DNS授权规则',
- ],
- 'UpdateDNSAuthorizationRule' => [
- 'summary' => '更新DNS授权规则。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\",\\n \\"DataPackages\\": [\\n {\\n \\"DataPackageId\\": \\"dp-xxxx\\",\\n \\"Status\\": \\"Available\\",\\n \\"Name\\": \\"测试流量包\\",\\n \\"ISP\\": \\"Telecom\\",\\n \\"Size\\": \\"200\\",\\n \\"CardCount\\": \\"20000\\",\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\",\\n \\"ExpiredTime\\": \\"2099-3-15 22:20:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '查询流量包信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataPackages'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListDataPackages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListDiagnoseInfoForSingleCard' => [
+ 'summary' => '查询5G上云实例的历史诊断信息（不包含诊断结果）。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'AuthorizationRuleId',
+ 'name' => 'RegionNo',
'in' => 'query',
'schema' => [
- 'description' => 'DNS授权规则ID。',
+ 'description' => '5G高速上云实例所在的地域ID。',
'type' => 'string',
- 'required' => true,
- 'example' => 'ar5g-xxxx',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'cn-hangzhou',
],
],
[
- 'name' => 'Name',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '名称，长度不超过128字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '5G高速上云实例ID 。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'Description',
+ 'name' => 'SourceType',
'in' => 'query',
- 'schema' => [
- 'description' => '描述，长度不超过256字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5g-test',
- ],
+ 'schema' => ['description' => '网络诊断的源类型。取值：'."\n"
+ ."\n"
+ .'- **Ip**：表示通过物联网卡的卡IP进行网络诊断。'."\n"
+ ."\n"
+ .'- **Iccid**：表示通过物联网卡的卡ID进行网络诊断。', 'type' => 'string', 'required' => false, 'example' => 'Iccid'],
],
[
- 'name' => 'SourceDNSIp',
+ 'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => 'DNS服务器地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0',
- ],
+ 'schema' => ['description' => '网络诊断的源端卡的ID', 'type' => 'string', 'required' => false, 'example' => '89860477102170127555'],
],
[
- 'name' => 'DestinationIp',
+ 'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => '需要重定向的DNS服务器地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => '网络诊断任务的状态。取值：'."\n"
+ .'- **success**：表示诊断成功。'."\n"
+ .'- **failed**：表示诊断失败。'."\n"
+ .'- **diagnosing**：表示诊断中。', 'type' => 'string', 'required' => false, 'example' => 'success'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n"
+ .'- 如果**NextToken**为空表示没有下一次查询。'."\n"
+ .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'],
],
[
- 'name' => 'DryRun',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会更新DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后更新DNS授权规则。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '分批次查询时每次显示的条目数。取值范围：1~100。默认值：20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'E1E237B1-EED7-55D5-AE5F-671E642DB3B5'],
+ 'NextToken' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n"
+ ."\n"
+ .'- 如果**NextToken**为空表示没有下一次查询。'."\n"
+ .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'."\n"],
+ 'MaxResults' => ['description' => '分批次查询时每次显示的条目数。取值范围：1~100。默认值：20。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'DiagnoseInfo' => [
+ 'description' => '诊断任务列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorId' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'example' => 'cc5g-xxxx'],
+ 'CardIp' => ['description' => '网络诊断的源端卡的IP地址。', 'type' => 'string', 'example' => '10.176.78.61'],
+ 'IccId' => ['description' => '网络诊断的源端卡的ID。', 'type' => 'string', 'example' => '89860477102170127555'],
+ 'SourceType' => ['description' => '网络诊断的源类型。', 'type' => 'string', 'example' => 'Iccid'],
+ 'Source' => ['description' => '网络诊断的源端卡IP或者卡ID。', 'type' => 'string', 'example' => '89860477102170127555'],
+ 'DestinationType' => ['description' => '网路诊断的目的类型。取值：'."\n"
+ ."\n"
+ .'- **IP**：表示诊断的目的类型是IP类型。'."\n"
+ ."\n"
+ .'- **Domain**：表示诊断的目的类型是域名类型。', 'type' => 'string', 'example' => 'Domain'],
+ 'Destination' => ['description' => '网络诊断的目的IP或者域名。', 'type' => 'string', 'example' => 'www.xxx.com'],
+ 'BeginTime' => ['description' => '网络诊断的开始时间戳。单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1662307200000'],
+ 'EndTime' => ['description' => '网络诊断的结束时间戳。单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1662307201200'],
+ 'Status' => ['description' => '网络诊断任务的状态。取值：'."\n"
+ ."\n"
+ .'- **success**：表示诊断成功。'."\n"
+ .'- **failed**：表示诊断失败。'."\n"
+ .'- **diagnosing**：表示诊断中。', 'type' => 'string', 'example' => 'failed'],
+ 'DiagnoseTime' => ['description' => '诊断任务入库的时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1662307202400'],
+ 'DiagnoseTaskId' => ['description' => '网络诊断任务ID。', 'type' => 'string', 'example' => 'diagnoseTask-bp2x7tzkdl655liw3mhbg'],
+ ],
+ 'description' => '',
+ ],
],
+ 'TotalCount' => ['description' => '总列表条目数。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '更新DNS授权规则',
- ],
- 'ListAuthorizationRules' => [
- 'summary' => '查询授权规则列表。',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => '子账号未获取5G上云服务RAM权限。'],
+ ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => '实例ID参数不合法'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1E237B1-EED7-55D5-AE5F-671E642DB3B5\\",\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\\\n\\",\\n \\"MaxResults\\": 20,\\n \\"DiagnoseInfo\\": [\\n {\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"CardIp\\": \\"10.176.78.61\\",\\n \\"IccId\\": \\"89860477102170127555\\",\\n \\"SourceType\\": \\"Iccid\\",\\n \\"Source\\": \\"89860477102170127555\\",\\n \\"DestinationType\\": \\"Domain\\",\\n \\"Destination\\": \\"www.xxx.com\\",\\n \\"BeginTime\\": 1662307200000,\\n \\"EndTime\\": 1662307201200,\\n \\"Status\\": \\"failed\\",\\n \\"DiagnoseTime\\": 1662307202400,\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2x7tzkdl655liw3mhbg\\"\\n }\\n ],\\n \\"TotalCount\\": 50\\n}","type":"json"}]',
+ 'title' => '查询历史诊断记录',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseInfoForSingleCard'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'iotcc:ListDiagnoseInfoForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListGroupAuthorizationRules' => [
+ 'summary' => '查询分组的授权规则列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5258,24 +3725,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '实例组实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****'],
],
[
'name' => 'Statuses',
@@ -5284,17 +3739,13 @@
'schema' => [
'description' => '授权规则状态列表',
'type' => 'array',
- 'items' => [
- 'description' => ' 授权规则状态，取值：'."\n"
- .'- **Creating**:创建中'."\n"
- .'- **Pending**:配置中'."\n"
- .'- **Available**:有效的稳定状态'."\n"
- .'- **Invalid**: 无效'."\n"
- .'- **Deleting**:删除中',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Creating',
- ],
+ 'items' => ['description' => '授权规则状态，取值：'."\n"
+ ."\n"
+ .'- **Creating**：创建中'."\n"
+ .'- **Available**：有效的稳定状态'."\n"
+ .'- **Pending**：配置中 '."\n"
+ .'- **Deleting**：删除中'."\n"
+ .'- **UnAvailable**：无效，此规则暂时不生效', 'type' => 'string', 'required' => false, 'example' => 'Creating'],
'required' => false,
],
],
@@ -5305,12 +3756,8 @@
'schema' => [
'description' => '授权规则id列表。',
'type' => 'array',
- 'items' => [
- 'description' => '授权规则id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5g-xxxx',
- ],
+ 'items' => ['description' => '授权规则id'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'ar5gg-xxxx'],
'required' => false,
],
],
@@ -5321,125 +3768,74 @@
'schema' => [
'description' => '授权规则名称列表',
'type' => 'array',
- 'items' => [
- 'description' => '名称，长度不超过128字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test',
- ],
+ 'items' => ['description' => '名称，长度不超过128字符。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'Test'],
'required' => false,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
- 'schema' => [
- 'description' => '目标类型，取值：'."\n"
- .'- **Cidr**: 网段'."\n"
- .'- **Domain**: 域名或泛域名'."\n"
- .'- **IpPort**: IP重定向',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cidr',
- ],
+ 'schema' => ['description' => '目标类型，取值：'."\n"
+ .'1. Cidr'."\n"
+ .'2. Domain'."\n"
+ .'3. IpPort', 'type' => 'string', 'required' => false, 'example' => 'Cidr'],
],
[
'name' => 'Protocol',
'in' => 'query',
- 'schema' => [
- 'description' => '协议类型。取值：'."\n"
- ."\n"
- .'- **tcp**。'."\n"
- .'- **udp**。'."\n"
- .'- **icmp**。'."\n"
- .'- **all**：支持所有协议。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
+ 'schema' => ['description' => '协议类型。取值：'."\n"
+ ."\n"
+ .'- **tcp**。'."\n"
+ .'- **udp**。'."\n"
+ .'- **icmp**。'."\n"
+ .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
'name' => 'DestinationPort',
'in' => 'query',
- 'schema' => [
- 'description' => '目标端口范围。取值范围：'."\n"
- ."\n"
- .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- ."\n"
- .'- ICMP协议：-1/-1。'."\n"
- ."\n"
- .'- ALL：-1/-1。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-1/-1',
- ],
+ 'schema' => ['description' => '目标端口范围。取值范围：'."\n"
+ ."\n"
+ .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ ."\n"
+ .'- ICMP协议：-1/-1。'."\n"
+ ."\n"
+ .'- ALL：-1/-1。', 'type' => 'string', 'required' => false, 'example' => '-1/-1'],
],
[
'name' => 'Destination',
'in' => 'query',
- 'schema' => [
- 'description' => '目标地址、域名或泛域名，前缀匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => '目标地址、域名或泛域名，前缀匹配。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1'],
],
[
'name' => 'Policy',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则策略，取值：'."\n"
- .'- **Permit**：允许'."\n"
- .'- **Deny**：拒绝'."\n"
- .'- **Mapping**：重定向',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Permit',
- ],
+ 'schema' => ['description' => '授权规则策略，取值：'."\n"
+ .'- **Permit**：允许'."\n"
+ .'- **Deny**：拒绝', 'type' => 'string', 'required' => false, 'example' => 'Permit'],
],
[
'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '类型，取值：'."\n"
- .'- **System**: 系统'."\n"
- .'- **Default**: 默认'."\n"
- .'- **Customer**: 自定义',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'System',
- ],
+ 'schema' => ['description' => '类型，取值：'."\n"
+ .'- **System**: 系统'."\n"
+ .'- **Default**: 默认'."\n"
+ .'- **Customer**: 自定义', 'type' => 'string', 'required' => false, 'example' => 'System'],
],
[
'name' => 'Dns',
'in' => 'query',
- 'schema' => [
- 'description' => '是否为DNS。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否为DNS。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
+ 'schema' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
],
'responses' => [
@@ -5449,146 +3845,91 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '207F9929-806E-5622-8E4F-8484F7000C22',
- ],
- 'AuthorizationRules' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'GroupAuthorizationRules' => [
'title' => '数组，返回示例目录。',
- 'description' => '授权规则列表。',
+ 'description' => '授权规则列表。'."\n"
+ ."\n",
'type' => 'array',
'items' => [
'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
+ 'description' => '授权规则列表。',
'type' => 'object',
'properties' => [
- 'AuthorizationRuleId' => [
- 'title' => '资源一级ID',
- 'description' => '授权规则id。',
- 'type' => 'string',
- 'example' => 'ar5g-xxxx',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '授权规则状态，取值：'."\n"
- .'- **Creating**: 创建中 '."\n"
- .'- **Pending**: 配置中'."\n"
- .'- **Available**: 有效的稳定状态'."\n"
- .'- **Invalid**: 无效'."\n"
- .'- **Deleting**: 删除中',
- 'type' => 'string',
- 'example' => 'Pending',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '授权规则名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '授权规则描述。',
- 'type' => 'string',
- 'example' => 'ar5g-test',
- ],
- 'Type' => [
- 'description' => '类型，取值：'."\n"
- .'- **System**: 系统'."\n"
- .'- **Default**: 默认'."\n"
- .'- **Customer**: 自定义',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'SourceCidr' => [
- 'description' => '源CIDR地址块。',
- 'type' => 'string',
- 'example' => '0.0.0.0/0',
- ],
- 'DestinationType' => [
- 'description' => '目标类型，取值：'."\n"
- .'- **Cidr**: 网段'."\n"
- .'- **Domain**: 域名或泛域名'."\n"
- .'- **IpPort**: IP重定向',
- 'type' => 'string',
- 'example' => 'Cidr',
- ],
- 'Protocol' => [
- 'description' => '协议类型。取值：'."\n"
- ."\n"
- .'- **tcp**。'."\n"
- .'- **udp**。'."\n"
- .'- **icmp**。'."\n"
- .'- **all**：支持所有协议。',
- 'type' => 'string',
- 'example' => 'all',
- ],
- 'DestinationPort' => [
- 'description' => '目标端口范围。取值范围：'."\n"
- ."\n"
- .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- .'- ICMP协议：-1/-1。'."\n"
- .'- ALL：-1/-1。',
- 'type' => 'string',
- 'example' => '0-65535',
- ],
- 'Destination' => [
- 'description' => '目标地址、域名或泛域名，前缀匹配。',
- 'type' => 'string',
- 'example' => '10.0.0.0/24',
- ],
- 'Policy' => [
- 'description' => '授权规则策略，取值：'."\n"
- .'- **Permit**：允许'."\n"
- .'- **Deny**：拒绝'."\n"
- .'- **Mapping**：重定向',
- 'type' => 'string',
- 'example' => 'Permit',
- ],
- 'Dns' => [
- 'description' => '是否为DNS。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 22:20:00',
- ],
+ 'AuthorizationRuleId' => ['title' => '资源一级ID', 'description' => '授权规则id。', 'type' => 'string', 'example' => 'ar5gg-y5g4rp2w1tl1w7zg59'],
+ 'Status' => ['title' => '资源名称', 'description' => '授权规则状态，取值：'."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 有效的稳定状态'."\n"
+ .'- **Pending**: 配置中'."\n"
+ .'- **Deleting**: 删除中'."\n"
+ .'- **UnAvailable**: 无效', 'type' => 'string', 'example' => 'Creating'],
+ 'Name' => ['title' => '创建时间', 'description' => '授权规则名称', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => '授权规则描述，长度不超过256字符。', 'type' => 'string', 'example' => 'ar5gg-test'."\n"],
+ 'Type' => ['description' => '类型，取值：'."\n"
+ .'- **System**: 系统'."\n"
+ .'- **Default**: 默认'."\n"
+ .'- **Customer**: 自定义', 'type' => 'string', 'example' => 'Default'],
+ 'SourceCidr' => ['description' => '源CIDR地址块。', 'type' => 'string', 'example' => '0.0.0.0/0'],
+ 'DestinationType' => ['description' => '目标类型，取值：'."\n"
+ .'1. Cidr'."\n"
+ .'2. Domain'."\n"
+ .'3. IpPort', 'type' => 'string', 'example' => 'Cidr'],
+ 'Protocol' => ['description' => '协议类型。取值：'."\n"
+ ."\n"
+ .'- **tcp**。'."\n"
+ .'- **udp**。'."\n"
+ .'- **icmp**。'."\n"
+ .'- **all**：支持所有协议。', 'type' => 'string', 'example' => 'all'],
+ 'DestinationPort' => ['description' => '目标端口范围。取值范围：'."\n"
+ ."\n"
+ .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ ."\n"
+ .'- ICMP协议：-1/-1。'."\n"
+ ."\n"
+ .'- ALL：-1/-1。', 'type' => 'string', 'example' => '0-65535'],
+ 'Destination' => ['description' => '目标地址、域名或泛域名，前缀匹配。', 'type' => 'string', 'example' => '47.103.184.100/32'],
+ 'Policy' => ['description' => '授权规则策略，取值：'."\n"
+ .'- **Permit**：允许'."\n"
+ .'- **Deny**：拒绝', 'type' => 'string', 'example' => 'Permit'],
+ 'Dns' => ['description' => '是否为DNS。', 'type' => 'boolean', 'example' => 'true'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-06-21 15:27:24'],
],
],
],
- 'NextToken' => [
- 'description' => '下一次查询的起始token。',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '列表的条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'NextToken' => ['description' => '下一次查询的起始token。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'iou001238joojjaere'."\n"],
+ 'MaxResults' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '列表的条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"207F9929-806E-5622-8E4F-8484F7000C22\\",\\n \\"AuthorizationRules\\": [\\n {\\n \\"AuthorizationRuleId\\": \\"ar5g-xxxx\\",\\n \\"Status\\": \\"Pending\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"ar5g-test\\",\\n \\"Type\\": \\"Default\\",\\n \\"SourceCidr\\": \\"0.0.0.0/0\\",\\n \\"DestinationType\\": \\"Cidr\\",\\n \\"Protocol\\": \\"all\\",\\n \\"DestinationPort\\": \\"0-65535\\",\\n \\"Destination\\": \\"10.0.0.0/24\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"Dns\\": true,\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '查询授权规则',
- ],
- 'CreateBatchOperateCardsTask' => [
- 'summary' => '创建批量操作卡任务。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"GroupAuthorizationRules\\": [\\n {\\n \\"AuthorizationRuleId\\": \\"ar5gg-y5g4rp2w1tl1w7zg59\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"ar5gg-test\\\\n\\",\\n \\"Type\\": \\"Default\\",\\n \\"SourceCidr\\": \\"0.0.0.0/0\\",\\n \\"DestinationType\\": \\"Cidr\\",\\n \\"Protocol\\": \\"all\\",\\n \\"DestinationPort\\": \\"0-65535\\",\\n \\"Destination\\": \\"47.103.184.100/32\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"Dns\\": true,\\n \\"CreateTime\\": \\"2022-06-21 15:27:24\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\\\n\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '查询分组授权规则列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupAuthorizationRules'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListGroupAuthorizationRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListIoTCloudConnectorBackhaulRoute' => [
+ 'summary' => '开启了反向访问高级特性场景下，查询特定连接实例的反向访问路由列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5597,145 +3938,177 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '批量操作任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'Description',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '批量操作任务描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'task- test',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'NetLinkId',
'in' => 'query',
+ 'schema' => ['description' => '网络连接id。', 'type' => 'string', 'required' => true, 'example' => 'cciot-xxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'title' => 'Schema of Response',
+ 'description' => '响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '94032572-8758-575E-B306-86F59D1B826E'],
+ 'NetLinkId' => ['title' => 'Id of the request', 'description' => '网络连接id。', 'type' => 'string', 'example' => 'cciot-xxxx'],
+ 'Routes' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '数组，返回示例目录。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'DestinationCidrBlock' => ['title' => '资源名称', 'description' => '路由条目的目标网段。', 'type' => 'string', 'example' => '10.33.190.0/24'],
+ 'NextHopId' => ['title' => '创建时间', 'description' => '下一跳实例ID。', 'type' => 'string', 'example' => 'eni-uf677iw3xihqxiz2ssir'],
+ 'NextHopType' => ['title' => '创建时间', 'description' => '自定义路由条目的下一跳的类型，取值： '."\n"
+ ."\n"
+ .'- **Instance**（默认值）：ECS实例。'."\n"
+ ."\n"
+ .'- **HaVip**：高可用虚拟IP。 '."\n"
+ ."\n"
+ .'- **RouterInterface**：路由器接口。'."\n"
+ ."\n"
+ .'- **NetworkInterface**：弹性网卡。'."\n"
+ ."\n"
+ .'- **VpnGateway**：VPN网关。'."\n"
+ ."\n"
+ .'- **IPv6Gateway**：IPv6网关。'."\n"
+ ."\n"
+ .'- **NatGateway**：NAT网关。'."\n"
+ ."\n"
+ .'- **Attachment**：转发路由器。'."\n"
+ ."\n"
+ .'- **VpcPeer**：VPC对等连接。', 'type' => 'string', 'example' => 'NetworkInterface'],
+ 'Description' => ['title' => '创建时间', 'description' => '描述信息。', 'type' => 'string', 'example' => 'full cidr block route'],
+ 'Status' => [
+ 'title' => '创建时间',
+ 'description' => '路由状态，取值：'."\n"
+ ."\n"
+ .'- **init**: 初始态'."\n"
+ .'- **published**: 已下发',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'published',
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94032572-8758-575E-B306-86F59D1B826E\\",\\n \\"NetLinkId\\": \\"cciot-xxxx\\",\\n \\"Routes\\": [\\n {\\n \\"DestinationCidrBlock\\": \\"10.33.190.0/24\\",\\n \\"NextHopId\\": \\"eni-uf677iw3xihqxiz2ssir\\",\\n \\"NextHopType\\": \\"NetworkInterface\\",\\n \\"Description\\": \\"full cidr block route\\",\\n \\"Status\\": \\"published\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询5G高速上云实例反向访问路由',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-28T11:47:33.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorBackhaulRoute'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListIoTCloudConnectorBackhaulRoute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ListOrders' => [
+ 'summary' => '查询订单列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查直接创建批量操作卡任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'WirelessCloudConnectorIds',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '5G上云实例的id列表，最多10个。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'Iccids',
+ 'name' => 'Statuses',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '卡的iccid列表，最多200条。',
+ 'description' => '订单状态列表。',
'type' => 'array',
- 'items' => [
- 'description' => '卡的iccid。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
+ 'items' => ['description' => '订单状态，取值：'."\n"
+ ."\n"
+ .'- **Pending**: 待发货'."\n"
+ .'- **Posting**: 已发货'."\n"
+ .'- **Finished**: 已完成', 'type' => 'string', 'required' => false, 'example' => 'Pending'],
'required' => false,
],
],
[
- 'name' => 'IccidsOssFilePath',
+ 'name' => 'OrderIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'iccid文件存放路径。',
- 'type' => 'string',
+ 'description' => '订单id列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '订单id。', 'type' => 'string', 'required' => false, 'example' => '890******'],
'required' => false,
- 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***',
],
],
[
- 'name' => 'OperateType',
+ 'name' => 'OrderAction',
'in' => 'query',
- 'schema' => [
- 'description' => '限制类型，取值：'."\n"
- ."\n"
- .'- **BreakNetwork**: 达量断网'."\n"
- .'- **LimitRate**: 达量限速'."\n"
- .'- **Alarm**: 达量告警',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BreakNetwork',
- ],
+ 'schema' => ['description' => '订单类型，取值：'."\n"
+ .'- **NewBuy**: 新购'."\n"
+ .'- **ScaleOut**: 扩容'."\n"
+ .'- **ScaleIn**: 缩容'."\n"
+ .'- **BuyCard**: 购卡'."\n"
+ .'- **Renewal**: 续期', 'type' => 'string', 'required' => false, 'example' => 'NewBuy'],
],
[
- 'name' => 'Threshold',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '达量阈值，单位MB。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '100',
- ],
+ 'schema' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'],
],
[
- 'name' => 'EffectType',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '生效类型，取值：'."\n"
- ."\n"
- .'- **CurrentMonth**：当月生效'."\n"
- .'- **ContinualMonth**：连续生效',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CurrentMonth',
- ],
+ 'schema' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
],
'responses' => [
@@ -5745,96 +4118,133 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'BatchOperateCardsTaskId' => [
- 'description' => '批量操作任务id。',
- 'type' => 'string',
- 'example' => 'boct-xxxx',
- ],
- 'OperateResultOssFilePath' => [
- 'description' => '批量操作结果的文件路径。',
- 'type' => 'string',
- 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'."\n"],
+ 'Orders' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '订单列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => '订单id。', 'type' => 'string', 'example' => '89************'],
+ 'Status' => ['title' => '资源名称', 'description' => '订单状态，取值：'."\n"
+ ."\n"
+ .'- **Pending**: 待发货'."\n"
+ .'- **Posting**: 已发货'."\n"
+ .'- **Finished**: 已完成', 'type' => 'string', 'example' => 'Pending'],
+ 'Action' => ['title' => '创建时间', 'description' => '订单类型，取值：'."\n"
+ .'- **NewBuy**: 新购'."\n"
+ .'- **ScaleOut**: 扩容'."\n"
+ .'- **ScaleIn**: 缩容'."\n"
+ .'- **BuyCard**: 购卡'."\n"
+ .'- **Renewal**: 续期', 'type' => 'string', 'example' => 'NewBuy'],
+ 'Description' => ['description' => '订单描述。', 'type' => 'string', 'example' => 'order-test'],
+ 'LogisticsId' => ['description' => '物流单号。', 'type' => 'string', 'example' => 'SF14*********'],
+ 'LogisticsStatus' => ['description' => '物流状态，取值：'."\n"
+ .'- **Transporting**: 运送中'."\n"
+ .'- **Delivering**: 派件中'."\n"
+ .'- **Delivered**: 已送达'."\n"
+ .'- **Signed**: 已签收', 'type' => 'string', 'example' => 'Signed'],
+ 'LogisticsType' => ['description' => '物流公司，取值：'."\n"
+ .'- **SF**: 顺丰'."\n"
+ .'- **ZTO**: 中通'."\n", 'type' => 'string', 'example' => 'SF'],
+ 'LogisticsUpdateTime' => ['description' => '物流最新更新时间。', 'type' => 'string', 'example' => '2022-3-15 22:20:00'],
+ 'CardCount' => ['description' => '卡数量。', 'type' => 'string', 'example' => '20000'],
+ 'ContactName' => ['description' => '邮寄联系人。', 'type' => 'string', 'example' => '张三'],
+ 'ContactPhone' => ['description' => '邮寄联系电话。', 'type' => 'string', 'example' => '139000*******'],
+ 'PostAddress' => ['description' => '邮寄地址。', 'type' => 'string', 'example' => '某公司'],
+ 'CreateTime' => ['description' => '订单创建时间。', 'type' => 'string', 'example' => '2022-3-15 21:20:00'],
+ 'PayTime' => ['description' => '订单支付时间。', 'type' => 'string', 'example' => '2022-3-15 21:30:00'],
+ 'RegionId' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'CardType' => ['description' => '卡的规格，取值：'."\n"
+ ."\n"
+ .'- **CONSUMER\\_THREE\\_IN\\_ONE:** 消费电子级物联网卡\\_三合一'."\n"
+ .'- **INDUSTRY\\_PATCH**'."\n"
+ .': 工业级物联网贴片卡'."\n"
+ .'- **CONSUMER\\_PATCH**'."\n"
+ .':消费电子级物联网贴片卡'."\n"
+ .'- **INDUSTRY\\_GENERAL**'."\n"
+ .':工业级物联网卡\\_普通'."\n"
+ .'- **INDUSTRY\\_MICRO**'."\n"
+ .':工业级物联网卡\\_Micro'."\n"
+ .'- **CONSUMER\\_GENERAL**'."\n"
+ .':消费电子级物联网卡_普通'."\n"
+ .'- **CONSUMER\\_TWO\\_IN\\_ONE**'."\n"
+ .'：消费电子级物联网卡\\_二合一'."\n"
+ .'- **INDUSTRY\\_NANO**'."\n"
+ .'：工业级物联网卡\\_Nano'."\n"
+ .'- **CAR\\_PATCH**'."\n"
+ .':车规级物联网贴片卡', 'type' => 'string', 'example' => 'CONSUMER_THREE_IN_ONE'],
+ 'CardNetType' => ['description' => '卡的网络类型，取值：'."\n"
+ ."\n"
+ .'- **4G**'."\n"
+ .'- **5G**', 'type' => 'string', 'example' => '5G'],
+ ],
+ ],
],
+ 'NextToken' => ['description' => '下一页查询所需值。', 'type' => 'string', 'example' => 'iou001238joojjaere'],
+ 'MaxResults' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '列表的条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"BatchOperateCardsTaskId\\": \\"boct-xxxx\\",\\n \\"OperateResultOssFilePath\\": \\"https://examplebucket.oss-eu-central-1.aliyuncs.com/***\\"\\n}","type":"json"}]',
- 'title' => '创建批量操作卡任务',
- ],
- 'DeleteBatchOperateCardsTask' => [
- 'summary' => '删除批量操作卡任务。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88C2F32F-B641-5980-B7A5-6907050ABCD1\\\\n\\",\\n \\"Orders\\": [\\n {\\n \\"OrderId\\": \\"89************\\",\\n \\"Status\\": \\"Pending\\",\\n \\"Action\\": \\"NewBuy\\",\\n \\"Description\\": \\"order-test\\",\\n \\"LogisticsId\\": \\"SF14*********\\",\\n \\"LogisticsStatus\\": \\"Signed\\",\\n \\"LogisticsType\\": \\"SF\\",\\n \\"LogisticsUpdateTime\\": \\"2022-3-15 22:20:00\\",\\n \\"CardCount\\": \\"20000\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"ContactPhone\\": \\"139000*******\\",\\n \\"PostAddress\\": \\"某公司\\",\\n \\"CreateTime\\": \\"2022-3-15 21:20:00\\",\\n \\"PayTime\\": \\"2022-3-15 21:30:00\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CardType\\": \\"CONSUMER_THREE_IN_ONE\\",\\n \\"CardNetType\\": \\"5G\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '查询订单列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrders'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListOrders',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListRegions' => [
+ 'summary' => '查询5G高速上云服务支持的地域列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'BatchOperateCardsTaskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '创建批量操作任务生成的id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'boct-xxx',
- ],
- ],
- [
- 'name' => 'ClientToken',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
- ],
- [
- 'name' => 'DryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会删除批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后删除批量操作卡任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '支持的语言。取值：'."\n"
+ ."\n"
+ .'zh-CN：中文。'."\n"
+ .'en-US：英文。'."\n"
+ .'ja：日文。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shenzhen',
- ],
+ 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou'],
],
],
'responses' => [
@@ -5844,28 +4254,53 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '2DCFA69E-A161-512D-99A7-108022580719'],
+ 'Regions' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '地域信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => '地域信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['title' => '资源一级ID', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'LocalName' => ['title' => '资源名称', 'description' => '地域名称。', 'type' => 'string', 'example' => '华东1（杭州）'],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '删除批量操作卡任务',
- ],
- 'UpdateBatchOperateCardsTask' => [
- 'summary' => '更新批量操作卡任务。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1（杭州）\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRegionsResponse>\\n <RequestId>2DCFA69E-A161-512D-99A7-108022580719</RequestId>\\n <Regions>\\n <RegionId>cn-hangzhou</RegionId>\\n <LocalName>华东1（杭州）</LocalName>\\n <RegionEndpoint>cc5g.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n </Regions>\\n</ListRegionsResponse>","errorExample":""}]',
+ 'title' => '查询可用地域列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-06T08:12:24.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListRegions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListWirelessCloudConnectorGroups' => [
+ 'summary' => '查询cc5g实例分组。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5874,158 +4309,68 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'task-test',
- ],
- ],
- [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'DryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会更新批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后更新批量操作卡任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'WirelessCloudConnectorIds',
+ 'name' => 'WirelessCloudConnectorGroupStatus',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '5G高速上云实例的id列表，最多10个。',
+ 'description' => '实例组的状态列表。最多支持10个实例组的状态。',
'type' => 'array',
- 'items' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
+ 'items' => ['description' => '实例组的状态。取值：'."\n"
+ ."\n"
+ .'1. Creating: 创建中 '."\n"
+ .'2. Available: 有效的稳定状态'."\n"
+ .'3. Pending: 配置中 '."\n"
+ .'4. Deleting: 删除中', 'type' => 'string', 'required' => false, 'example' => 'Creating'],
'required' => false,
],
],
[
- 'name' => 'Iccids',
+ 'name' => 'WirelessCloudConnectorGroupIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '卡的iccid列表，最多200条。',
+ 'description' => '实例组的ID列表。最多支持10个实例组的ID列表。'."\n"
+ ."\n",
'type' => 'array',
- 'items' => [
- 'description' => '卡的iccid。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
+ 'items' => ['description' => '实例组的ID。'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'cc5gg-xxxx'],
'required' => false,
],
],
[
- 'name' => 'IccidsOssFilePath',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'iccid文件存放路径。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-cn-hangzhou/127859184306****/***.csv',
- ],
- ],
- [
- 'name' => 'OperateType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '限制类型，取值: '."\n"
- ."\n"
- .'- **BreakNetwork**: 达量断网'."\n"
- .'- **LimitRate**: 达量限速'."\n"
- .'- **Alarm**: 达量告警',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'BreakNetwork',
- ],
- ],
- [
- 'name' => 'Threshold',
+ 'name' => 'WirelessCloudConnectorGroupNames',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '达量阈值，单位MB。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '实例组的名称列表。最多支持10个实例组的名称。'."\n"
+ ."\n",
+ 'type' => 'array',
+ 'items' => ['description' => '实例组的名称。'."\n"
+ .'名称长度为2~128个英文或中文字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'required' => false,
- 'example' => '100',
],
],
[
- 'name' => 'EffectType',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '生效类型，取值：'."\n"
- ."\n"
- .'- **CurrentMonth**'."\n"
- .'- **ContinualMonth**',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'CurrentMonth',
- ],
+ 'schema' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'."\n"],
],
[
- 'name' => 'BatchOperateCardsTaskId',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '批量操作任务id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'boct-xxxx',
- ],
+ 'schema' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
],
'responses' => [
@@ -6035,28 +4380,100 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914'],
+ 'WirelessCloudConnectorGroups' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '实例组列表信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => '实例组列表项信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorGroupId' => ['title' => '资源一级ID', 'description' => '实例组ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'cc5gg-xxxx'],
+ 'Status' => ['title' => '资源名称', 'description' => '实例组的状态。取值：'."\n"
+ ."\n"
+ .'1. Creating: 创建中 '."\n"
+ .'2. Available: 有效的稳定状态'."\n"
+ .'3. Pending: 配置中 '."\n"
+ .'4. Deleting: 删除中'."\n"
+ ."\n", 'type' => 'string', 'example' => 'Creating'],
+ 'Name' => ['title' => '创建时间', 'description' => '名称。', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'cc5gg-test'."\n"],
+ 'RegionId' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-shenzhen'],
+ 'CreateTime' => ['description' => '实例创建时间。', 'type' => 'string', 'example' => '2022-07-04 19:19:14'],
+ 'WirelessCloudConnectors' => [
+ 'description' => '5G高速上云实例列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorId' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'example' => 'cc5g-62eb02o7lz1w5aurl3'],
+ 'Status' => ['description' => '实例状态，取值：'."\n"
+ ."\n"
+ .'Creating: 创建中'."\n"
+ .'Available: 有效的稳定状态'."\n"
+ .'Pending: 配置中'."\n"
+ .'Deleting: 删除中', 'type' => 'string', 'example' => 'Available'],
+ 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'cc5g-test'],
+ 'RegionId' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-shenzhen'],
+ 'UseCase' => ['description' => '实例使用场景。', 'type' => 'string', 'example' => '智慧工厂'."\n"],
+ 'DataPackageId' => ['description' => '流量包id。', 'type' => 'string', 'example' => 'dp-xxxx'."\n"],
+ 'DataPackageType' => ['description' => '流量包档位，取值：'."\n"
+ ."\n"
+ .'- **200**: 200M/卡/月'."\n"
+ .'- **1000**: 1G/卡/月'."\n"
+ .'- **3000**: 3G/卡/月'."\n"
+ .'- **30000**: 30G/卡/月', 'type' => 'string', 'example' => '200'],
+ 'CardCount' => ['description' => '卡数量。', 'type' => 'string', 'example' => '115'],
+ 'CreateTime' => ['description' => '实例创建时间。', 'type' => 'string', 'example' => '2022-04-28 17:40:53'],
+ 'BusinessType' => ['description' => '业务类型', 'type' => 'string', 'example' => 'Business'],
+ 'ServiceType' => ['description' => '服务类型，返回：'."\n"
+ ."\n"
+ .'- **CC5G**：普通实例。'."\n"
+ .'- **CC5GCCIoT**：过户实例。', 'type' => 'string', 'example' => 'CC5G'],
+ ],
+ ],
+ ],
+ ],
+ ],
],
+ 'NextToken' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'example' => 'iou001238joojjaere'],
+ 'MaxResults' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '列表的条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '更新批量操作卡任务',
- ],
- 'ListBatchOperateCardsTasks' => [
- 'summary' => '列出批量操作卡任务。',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\",\\n \\"WirelessCloudConnectorGroups\\": [\\n {\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-xxxx\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"cc5gg-test\\\\n\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"CreateTime\\": \\"2022-07-04 19:19:14\\",\\n \\"WirelessCloudConnectors\\": [\\n {\\n \\"WirelessCloudConnectorId\\": \\"cc5g-62eb02o7lz1w5aurl3\\",\\n \\"Status\\": \\"Available\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"cc5g-test\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"UseCase\\": \\"智慧工厂\\\\n\\",\\n \\"DataPackageId\\": \\"dp-xxxx\\\\n\\",\\n \\"DataPackageType\\": \\"200\\",\\n \\"CardCount\\": \\"115\\",\\n \\"CreateTime\\": \\"2022-04-28 17:40:53\\",\\n \\"BusinessType\\": \\"Business\\",\\n \\"ServiceType\\": \\"CC5G\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '查询分组信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWirelessCloudConnectorGroups'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListWirelessCloudConnectorGroups',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListWirelessCloudConnectors' => [
+ 'summary' => '查询5G高速上云实例列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6068,654 +4485,413 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Statuses',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '批量操作任务的状态。',
+ 'description' => '实例状态列表。',
'type' => 'array',
- 'items' => [
- 'description' => '任务状态，取值：'."\n"
- .'- **Creating**: 创建中 '."\n"
- .'- **Pending**: 待生效'."\n"
- .'- **Available**: 全部成功'."\n"
- .'- **PartialAvailable**: 部分成功'."\n"
- .'- **UnAvailable**: 已失效'."\n"
- .'- **Fail**: 全部失败',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Creating',
- ],
+ 'items' => ['description' => '实例状态，取值：'."\n"
+ ."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 有效的稳定状态'."\n"
+ .'- **Pending**: 配置中'."\n"
+ .'- **Deleting**: 删除中', 'type' => 'string', 'required' => false, 'example' => 'Available'],
'required' => false,
],
],
[
- 'name' => 'BatchOperateCardsTaskIds',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '批量操作任务的id列表。',
+ 'description' => '实例的id列表。',
'type' => 'array',
- 'items' => [
- 'description' => '批量操作任务id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'boct-xxxx',
- ],
+ 'items' => ['description' => '实例的id列表。', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx'],
'required' => false,
],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Names',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
+ 'description' => '实例的名称列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '名称列表。', 'type' => 'string', 'required' => false, 'example' => '智慧工厂'],
'required' => false,
- 'example' => 'iou001238joojjaere',
],
],
[
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '上一页的查询返回的值，首页查询不传值。', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'],
+ ],
+ [
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'Names',
+ 'name' => 'BusinessType',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '批量操作的名称。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx工厂实例批量限速',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'Business'],
+ ],
+ [
+ 'name' => 'IsInGroup',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否查询实例组中的实例。取值：'."\n"
+ ."\n"
+ .'- **true**：查询实例组中的实例。'."\n"
+ ."\n"
+ .'- **false**：不查询实例组中的实例。'."\n"
+ ."\n"
+ .'- **null**：全量查询实例，不区分实例是否在实例组中。'."\n", 'type' => 'string', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'WirelessCloudConnectorGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '实例组实例id。', 'type' => 'string', 'required' => false, 'example' => 'cc5gg-****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应对象',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'BatchOperateCardsTasks' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'WirelessCloudConnectors' => [
'title' => '数组，返回示例目录。',
- 'description' => '卡批量操作任务列表。',
+ 'description' => '5G高速上云实例列表。',
'type' => 'array',
'items' => [
'title' => 'RegionItemType',
- 'description' => '任务项',
+ 'description' => 'RegionItemType',
'type' => 'object',
'properties' => [
- 'BatchOperateCardsTaskId' => [
- 'title' => '资源一级ID',
- 'description' => '批量操作任务ID。',
- 'type' => 'string',
- 'example' => 'boct-xxxx',
- ],
- 'Status' => [
- 'description' => '任务状态，取值：'."\n"
- .'- **Creating**: 创建中 '."\n"
- .'- **Pending**: 待生效'."\n"
- .'- **Available**: 全部成功'."\n"
- .'- **PartialAvailable**: 部分成功'."\n"
- .'- **UnAvailable**: 已失效'."\n"
- .'- **Fail**: 全部失败',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'OperateType' => [
- 'title' => '创建时间',
- 'description' => '限制类型，枚举值：'."\n"
- ."\n"
- .'- **BreakNetwork**: 达量断网'."\n"
- .'- **LimitRate**: 达量限速'."\n"
- .'- **Alarm**: 达量告警',
- 'type' => 'string',
- 'example' => 'BreakNetwork',
- ],
- 'Threshold' => [
- 'description' => '达量阈值，单位MB。',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'EffectType' => [
- 'description' => '生效类型，枚举值：'."\n"
- ."\n"
- .'- **CurrentMonth**'."\n"
- .'- **ContinualMonth**',
- 'type' => 'string',
- 'example' => 'CurrentMonth',
- ],
- 'IccidsOssFilePath' => [
- 'description' => 'iccid文件存放路径。',
- 'type' => 'string',
- 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***',
- ],
- 'WirelessCloudConnectors' => [
- 'description' => '5G高速上云的实例ID和状态列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorId' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'Status' => [
- 'description' => '状态，枚举值：'."\n"
- ."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 有效的稳定状态'."\n"
- .'- **Pending**: 配置中'."\n"
- .'- **Deleting**: 删除中'."\n"
- .'- **Deleted**: 已删除',
- 'type' => 'string',
- 'example' => 'Deleted',
- ],
- ],
- ],
- ],
- 'OperateResultOssFilePath' => [
- 'description' => '批量操作结果的文件路径。',
- 'type' => 'string',
- 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***',
- ],
- 'Description' => [
- 'description' => '批量操作描述。',
- 'type' => 'string',
- 'example' => 'task-test',
- ],
- 'Name' => [
- 'description' => '批量操作名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2022-3-15 22:20:00',
- ],
+ 'WirelessCloudConnectorId' => ['title' => '资源一级ID', 'description' => '5G高速上云实例id。', 'type' => 'string', 'example' => 'cc5g-xxxx'],
+ 'Status' => ['title' => '资源名称', 'description' => '实例状态，取值：'."\n"
+ ."\n"
+ .'- **Creating**: 创建中'."\n"
+ .'- **Available**: 有效的稳定状态'."\n"
+ .'- **Pending**: 配置中'."\n"
+ .'- **Deleting**: 删除中', 'type' => 'string', 'example' => 'Available'],
+ 'Name' => ['title' => '创建时间', 'description' => '名称。', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'cc5g-test'],
+ 'RegionId' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'UseCase' => ['description' => '实例使用场景。', 'type' => 'string', 'example' => '智慧工厂'],
+ 'DataPackageId' => ['description' => '流量包id。', 'type' => 'string', 'example' => 'dp-xxxx'],
+ 'DataPackageType' => ['description' => '流量包档位，取值：'."\n"
+ ."\n"
+ .'- **200**: 200M/卡/月'."\n"
+ .'- **1000**: 1G/卡/月'."\n"
+ .'- **3000**: 3G/卡/月'."\n"
+ .'- **30000**: 30G/卡/月', 'type' => 'string', 'example' => '200'],
+ 'CardCount' => ['description' => '卡数量。', 'type' => 'string', 'example' => '20000'],
+ 'CreateTime' => ['description' => '实例创建时间。', 'type' => 'string', 'example' => '2022-3-15 22:20:00'],
+ 'BusinessType' => ['description' => '业务类型', 'type' => 'string', 'example' => 'Business'],
+ 'ServiceType' => ['description' => '服务类型，返回：'."\n"
+ ."\n"
+ .'- **CC5G**：普通实例。'."\n"
+ .'- **CC5GCCIoT**：过户实例。', 'type' => 'string', 'example' => 'CC5G'],
+ 'WirelessCloudConnectorGroupId' => ['description' => '关联的实例组id', 'type' => 'string', 'example' => 'cc5gg-****'],
],
],
],
- 'NextToken' => [
- 'description' => '下一次查询的起始token。',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '列表的条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'NextToken' => ['description' => '下一页查询所需值。', 'type' => 'string', 'example' => 'iou001238joojjaere'],
+ 'MaxResults' => ['description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。', 'type' => 'string', 'example' => '10'],
+ 'TotalCount' => ['description' => '列表的条目数。', 'type' => 'string', 'example' => '2'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"BatchOperateCardsTasks\\": [\\n {\\n \\"BatchOperateCardsTaskId\\": \\"boct-xxxx\\",\\n \\"Status\\": \\"Available\\",\\n \\"OperateType\\": \\"BreakNetwork\\",\\n \\"Threshold\\": \\"100\\",\\n \\"EffectType\\": \\"CurrentMonth\\",\\n \\"IccidsOssFilePath\\": \\"https://examplebucket.oss-eu-central-1.aliyuncs.com/***\\",\\n \\"WirelessCloudConnectors\\": [\\n {\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"Status\\": \\"Deleted\\"\\n }\\n ],\\n \\"OperateResultOssFilePath\\": \\"https://examplebucket.oss-eu-central-1.aliyuncs.com/***\\",\\n \\"Description\\": \\"task-test\\",\\n \\"Name\\": \\"test\\",\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '列出批量操作卡任务',
- ],
- 'SubmitDiagnoseTaskForSingleCard' => [
- 'summary' => '发起单张物联网卡的网络诊断。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"WirelessCloudConnectors\\": [\\n {\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"Status\\": \\"Available\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"cc5g-test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"UseCase\\": \\"智慧工厂\\",\\n \\"DataPackageId\\": \\"dp-xxxx\\",\\n \\"DataPackageType\\": \\"200\\",\\n \\"CardCount\\": \\"20000\\",\\n \\"CreateTime\\": \\"2022-3-15 22:20:00\\",\\n \\"BusinessType\\": \\"Business\\",\\n \\"ServiceType\\": \\"CC5G\\",\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-****\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
+ 'title' => '查询5G高速上云实例列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWirelessCloudConnectors'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListWirelessCloudConnectors',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListZones' => [
+ 'summary' => '查询5G高速上云服务支持的可用区列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
+ 'title' => 'Schema of Response',
+ 'description' => '响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C2C1DE7C-E14C-53DE-920D-D63ACD7421A4'],
+ 'Zones' => [
+ 'title' => '数组，返回示例目录。',
+ 'description' => '当前地域支持的可用区列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => '可用区信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['title' => '资源名称', 'description' => '可用区ID', 'type' => 'string', 'example' => 'cn-hangzhou-h'],
+ 'LocalName' => ['title' => '创建时间', 'description' => '可用区名称。', 'type' => 'string', 'example' => '杭州可用区h'],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2C1DE7C-E14C-53DE-920D-D63ACD7421A4\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"LocalName\\": \\"杭州可用区h\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询可用区的列表',
+ 'description' => '此接口属于运维类接口，主要用于网络规划和特殊控制，暂时只开放了北京、杭州、上海，深圳，如果有特殊region需求，请联系客服。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListZones'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'description' => '网络诊断的源物联网卡ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '89860477102170127555',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListZones',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'LockCards' => [
+ 'summary' => '批量锁定卡。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Destination',
- 'in' => 'query',
- 'schema' => [
- 'description' => '网络诊断的目的IP或者域名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '106.14.175.4',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'BeginTime',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '网络诊断的开始时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '物联网SIM卡卡号，每次最大500条',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => '890912389123', 'description' => ''],
'required' => true,
- 'example' => '1662307201200',
+ 'maxItems' => 1000,
+ 'minItems' => 1,
],
],
[
- 'name' => 'EndTime',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '网络诊断的结束时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1662307201200',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'RegionNo',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例所在的地域ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'ResourceUid',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '云连接器实例使用者的阿里云账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '253460731706911258',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会批量锁定。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后批量锁定卡。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'DiagnoseTaskId' => [
- 'description' => '网络诊断任务ID。',
- 'type' => 'string',
- 'example' => 'diagnoseTask-bp2n6rgaj49qcs34jyzo8',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Forbidden.RAM',
- 'errorMessage' => 'Ram user does not have permission to perform this operation.',
- ],
- [
- 'errorCode' => 'cardIdNotExist',
- 'errorMessage' => 'diagnose task iccid not exist',
- ],
- [
- 'errorCode' => 'CardIPNotBind',
- 'errorMessage' => 'card ip not bind',
- ],
- [
- 'errorCode' => 'CardIPAndIccIdNotMatch',
- 'errorMessage' => 'card ip and iccid not match',
- ],
- [
- 'errorCode' => 'CardIPNotExist',
- 'errorMessage' => 'card ip not exist',
- ],
- [
- 'errorCode' => 'ResourceNotFound.IoTCloudConnector',
- 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
+ 'title' => '批量锁定卡',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-20T02:37:47.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockCards'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:LockCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2n6rgaj49qcs34jyzo8\\"\\n}","type":"json"}]',
- 'title' => '发起单卡网络诊断',
],
- 'GetDiagnoseResultForSingleCard' => [
- 'summary' => '查询单张物联网卡的网络诊断结果。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ModifyWirelessCloudConnectorFeature' => [
+ 'summary' => '修改5G高速上云实例高级属性，例如开启反向访问功能。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'DiagnoseTaskId',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '网络诊断任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'RegionNo',
+ 'name' => 'FeatureName',
'in' => 'query',
'schema' => [
- 'description' => '地域ID。',
+ 'description' => '功能特征名称。'."\n"
+ .'- **DirectMode**：直通',
'type' => 'string',
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'enumValueTitles' => ['DirectMode' => 'DirectMode'],
+ 'example' => 'DirectMode',
],
],
+ [
+ 'name' => 'FeatureValue',
+ 'in' => 'query',
+ 'schema' => ['description' => '功能特征值。', 'type' => 'string', 'required' => false, 'example' => 'On'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
+ ],
+ [
+ 'name' => 'DryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接更新实例信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '94032572-8758-575E-B306-86F59D1B826E',
- ],
- 'WirelessCloudConnectorId' => [
- 'description' => '5G高速上云实例ID。',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'CardIp' => [
- 'description' => '网络诊断的源端卡的IP地址。',
- 'type' => 'string',
- 'example' => '10.176.78.61',
- ],
- 'IccId' => [
- 'description' => '网络诊断的源端卡的ID。',
- 'type' => 'string',
- 'example' => '89860477102170127555',
- ],
- 'Destination' => [
- 'description' => '网络诊断目的地址或域名。',
- 'type' => 'string',
- 'example' => '106.14.175.4',
- ],
- 'DestinationType' => [
- 'description' => '网路诊断的目的类型。取值：'."\n"
- ."\n"
- .'- **IP**：表示诊断的目的类型是IP类型。'."\n"
- ."\n"
- .'- **Domain**：表示诊断的目的类型是域名类型。'."\n",
- 'type' => 'string',
- 'example' => 'Domain',
- ],
- 'BeginTime' => [
- 'description' => '网络诊断的开始时间戳。单位：秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1646100223024',
- ],
- 'EndTime' => [
- 'description' => '网络诊断的结束时间戳。单位：秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1646100223264',
- ],
- 'Status' => [
- 'description' => '网络诊断任务的状态。取值：'."\n"
- ."\n"
- .'- **success**：表示诊断成功。'."\n"
- .'- **failed**：表示诊断失败。'."\n"
- .'- **diagnosing**：表示诊断中。',
- 'type' => 'string',
- 'example' => 'failed',
- ],
- 'ErrorResult' => [
- 'description' => '诊断结果列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '诊断结果。',
- 'type' => 'object',
- 'properties' => [
- 'ErrorLevel' => [
- 'description' => '诊断问题的级别。取值：'."\n"
- ."\n"
- .'- **Error**：表示错误。'."\n"
- ."\n"
- .'- **Warning**：表示警告。',
- 'type' => 'string',
- 'example' => 'Warning',
- ],
- 'ErrorPart' => [
- 'description' => '诊断问题的组件。取值：'."\n"
- ."\n"
- .'- **CCIOT**：表示诊断的问题为云连接器的问题。'."\n"
- ."\n"
- .'- **Card**：表示诊断的问题为物联网卡的问题。'."\n"
- ."\n"
- .'- **Terminal**：表示诊断的问题为终端的问题。'."\n"
- ."\n"
- .'- **Server**：表示诊断的问题为服务器的问题。'."\n"
- ."\n"
- .'- **Apn**：表示诊断的问题为APN的问题。',
- 'type' => 'string',
- 'example' => 'Terminal',
- ],
- 'ErrorItem' => [
- 'description' => '诊断部件对应的诊断指标项，详见 **返回参数补充说明**。',
- 'type' => 'string',
- 'example' => 'CardStatus',
- ],
- 'ErrorDesc' => [
- 'description' => '诊断问题的描述。',
- 'type' => 'string',
- 'example' => 'Terminal abnormal',
- ],
- 'ErrorSuggestion' => [
- 'description' => '诊断问题的解决建议。',
- 'type' => 'string',
- 'example' => 'Please check whether the terminal and card are compatible or whether the terminal can send messages',
- ],
- ],
- ],
- ],
- 'DiagnoseItem' => [
- 'description' => '诊断项信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '诊断项信息。',
- 'type' => 'object',
- 'properties' => [
- 'Part' => [
- 'description' => '诊断的部件名称。取值：'."\n"
- ."\n"
- .'- **CCIOT**：云连接器。'."\n"
- .'- **Card**：物联网卡。'."\n"
- .'- **Terminal**：终端。'."\n"
- .'- **Server**：服务器。'."\n"
- .'- **Apn**：APN。',
- 'type' => 'string',
- 'example' => 'Terminal',
- ],
- 'Status' => [
- 'description' => '诊断部件的状态。取值：'."\n"
- ."\n"
- .'- **Normal**：表示诊断状态正常。'."\n"
- .'- **Wrong**：表示诊断状态错误。'."\n"
- .'- **Unknown**：表示诊断状态未知。',
- 'type' => 'string',
- 'example' => 'Wrong',
- ],
- 'SubItems' => [
- 'description' => '诊断部件的诊断指标列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '诊断部件的诊断指标。',
- 'type' => 'object',
- 'properties' => [
- 'SubItem' => [
- 'description' => '诊断部件对应的诊断指标项，详见 **返回参数补充说明**。',
- 'type' => 'string',
- 'example' => 'CardStatus',
- ],
- 'SubItemStatus' => [
- 'description' => '诊断指标的状态。取值：'."\n"
- ."\n"
- .'- **Normal**：表示诊断状态正常。'."\n"
- .'- **Warnning**：表示诊断状态为提示级别错误。'."\n"
- .'- **Minor**: 表示诊断状态为一般级别错误。'."\n"
- .'- **Major**: 表示诊断状态为严重级别错误。'."\n"
- .'- **Unknown**：表示诊断状态未知。',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'SubItemInfo' => [
- 'description' => '诊断指标的附加信息。',
- 'type' => 'string',
- 'example' => 'Card status is real-time',
- ],
- ],
- ],
- ],
- ],
- ],
- 'enumValueTitles' => [],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '999E0F64-9A10-567B-BB84-B7C46023BA3B'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Forbidden.RAM',
- 'errorMessage' => 'Ram user does not have permission to perform this operation.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"999E0F64-9A10-567B-BB84-B7C46023BA3B\\"\\n}","type":"json"}]',
+ 'title' => '修改5G高速上云实例高级属性',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-28T11:47:33.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyWirelessCloudConnectorFeature'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ModifyWirelessCloudConnectorFeature',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94032572-8758-575E-B306-86F59D1B826E\\",\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"CardIp\\": \\"10.176.78.61\\",\\n \\"IccId\\": \\"89860477102170127555\\",\\n \\"Destination\\": \\"106.14.175.4\\",\\n \\"DestinationType\\": \\"Domain\\",\\n \\"BeginTime\\": 1646100223024,\\n \\"EndTime\\": 1646100223264,\\n \\"Status\\": \\"failed\\",\\n \\"ErrorResult\\": [\\n {\\n \\"ErrorLevel\\": \\"Warning\\",\\n \\"ErrorPart\\": \\"Terminal\\",\\n \\"ErrorItem\\": \\"CardStatus\\",\\n \\"ErrorDesc\\": \\"Terminal abnormal\\",\\n \\"ErrorSuggestion\\": \\"Please check whether the terminal and card are compatible or whether the terminal can send messages\\"\\n }\\n ],\\n \\"DiagnoseItem\\": [\\n {\\n \\"Part\\": \\"Terminal\\",\\n \\"Status\\": \\"Wrong\\",\\n \\"SubItems\\": [\\n {\\n \\"SubItem\\": \\"CardStatus\\",\\n \\"SubItemStatus\\": \\"Normal\\",\\n \\"SubItemInfo\\": \\"Card status is real-time\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询单卡诊断结果',
- 'responseParamsDescription' => '诊断部件的诊断指标项。取值: '."\n"
- ."\n"
- .'**Part**: Card'."\n"
- .'- **CardStatus**: 卡状态'."\n"
- .'- **CardOnlineStatus**: 卡会话状态'."\n"
- ."\n"
- .'**Part**: Apn'."\n"
- .'- **GreTunnelStatus**: 运营商隧道状态'."\n"
- ."\n"
- .'**Part**: CCIOT'."\n"
- .'- **CciotInstanceStatus**: 云连接器实例状态'."\n"
- .'- **CciotConnectionPoolConfiged**: 云连接器连接池配置状态'."\n"
- .'- **CciotAuthorizationRulesConfiged**: 云连接器授权规则配置状态'."\n"
- .'- **CardInCciotConnectionPool**: 卡在云连接器实例连接池中'."\n"
- .'- **DestinationInCciotAuthorizationRules**: 目的地址在云连接器实例授权规则中'."\n"
- .'- **DefaultDnsInCciotDnsServiceRules**: 默认的DNS服务地址在授权规则中'."\n"
- .'- **DestinationConflictWithIpMapping**: 目的地址与IP映射冲突'."\n"
- .'- **CciotAssociateWithVswitch**: 云连接器实例关联VPC'."\n"
- .'- **BackhaulRoutePublishedInVpc**: 云连接器实例回程路由发布状态'."\n"
- .'- **BackhaulRouteExsited**: 云连接器实例回程路由存在状态'."\n"
- .'- **DnsParseStatus**: 云连接器实例DNS解析状态'."\n"
- .'- **AccessLogFromCardToDestination**: 卡到目的地址的访问记录'."\n"
- .'- **AccessLogFromDestinationToCard**: 目的地址到卡的访问记录'."\n"
- .'- **AccessLogOfCard**: 卡的访问记录'."\n"
- .'- **AccessLogOfDesination**: 目的地址到访问记录'."\n"
- .'- **DropLogOfCard**: 卡的丢包记录'."\n"
- .'- **DropLogOfDestination**: 目的地址的丢包记录'."\n"
- .'- **CciotCardOnlineStatus**: 卡在线状态',
],
- 'ListDiagnoseInfoForSingleCard' => [
- 'summary' => '查询5G上云实例的历史诊断信息（不包含诊断结果）。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'OpenCc5gService' => [
+ 'summary' => '开通5G高速上云服务。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6724,234 +4900,150 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'RegionNo',
+ 'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => '区域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '5G高速上云实例所在的地域ID。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'cn-hangzhou',
+ 'title' => 'Schema of Response',
+ 'description' => '响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求iD', 'type' => 'string', 'example' => '2DCFA69E-A161-512D-99A7-108022580719'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\"\\n}","type":"json"}]',
+ 'title' => '开通服务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenCc5gService'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'WirelessCloudConnectorId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例ID 。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:OpenCc5gService',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'RebindCards' => [
+ 'summary' => '换绑解锁单卡。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'SourceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '网络诊断的源类型。取值：'."\n"
- ."\n"
- .'- **Ip**：表示通过物联网卡的卡IP进行网络诊断。'."\n"
- ."\n"
- .'- **Iccid**：表示通过物联网卡的卡ID进行网络诊断。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Iccid',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'Source',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '网络诊断的源端卡的ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '89860477102170127555',
+ 'description' => '物联网SIM卡卡号，每次最大500条',
+ 'type' => 'array',
+ 'items' => ['description' => '物联网卡的iccid。', 'type' => 'string', 'required' => false, 'example' => '123456789'],
+ 'required' => true,
+ 'maxItems' => 1000,
+ 'minItems' => 1,
],
],
[
- 'name' => 'Status',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '网络诊断任务的状态。取值：'."\n"
- .'- **success**：表示诊断成功。'."\n"
- .'- **failed**：表示诊断失败。'."\n"
- .'- **diagnosing**：表示诊断中。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'success',
- ],
+ 'schema' => ['description' => '区域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n"
- .'- 如果**NextToken**为空表示没有下一次查询。'."\n"
- .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '分批次查询时每次显示的条目数。取值范围：1~100。默认值：20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会删除批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后删除批量操作卡任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'E1E237B1-EED7-55D5-AE5F-671E642DB3B5',
- ],
- 'NextToken' => [
- 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n"
- ."\n"
- .'- 如果**NextToken**为空表示没有下一次查询。'."\n"
- .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。',
- 'type' => 'string',
- 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'."\n",
- ],
- 'MaxResults' => [
- 'description' => '分批次查询时每次显示的条目数。取值范围：1~100。默认值：20。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'DiagnoseInfo' => [
- 'description' => '诊断任务列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorId' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'CardIp' => [
- 'description' => '网络诊断的源端卡的IP地址。',
- 'type' => 'string',
- 'example' => '10.176.78.61',
- ],
- 'IccId' => [
- 'description' => '网络诊断的源端卡的ID。',
- 'type' => 'string',
- 'example' => '89860477102170127555',
- ],
- 'SourceType' => [
- 'description' => '网络诊断的源类型。',
- 'type' => 'string',
- 'example' => 'Iccid',
- ],
- 'Source' => [
- 'description' => '网络诊断的源端卡IP或者卡ID。',
- 'type' => 'string',
- 'example' => '89860477102170127555',
- ],
- 'DestinationType' => [
- 'description' => '网路诊断的目的类型。取值：'."\n"
- ."\n"
- .'- **IP**：表示诊断的目的类型是IP类型。'."\n"
- ."\n"
- .'- **Domain**：表示诊断的目的类型是域名类型。',
- 'type' => 'string',
- 'example' => 'Domain',
- ],
- 'Destination' => [
- 'description' => '网络诊断的目的IP或者域名。',
- 'type' => 'string',
- 'example' => 'www.xxx.com',
- ],
- 'BeginTime' => [
- 'description' => '网络诊断的开始时间戳。单位：秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1662307200000',
- ],
- 'EndTime' => [
- 'description' => '网络诊断的结束时间戳。单位：秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1662307201200',
- ],
- 'Status' => [
- 'description' => '网络诊断任务的状态。取值：'."\n"
- ."\n"
- .'- **success**：表示诊断成功。'."\n"
- .'- **failed**：表示诊断失败。'."\n"
- .'- **diagnosing**：表示诊断中。',
- 'type' => 'string',
- 'example' => 'failed',
- ],
- 'DiagnoseTime' => [
- 'description' => '诊断任务入库的时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1662307202400',
- ],
- 'DiagnoseTaskId' => [
- 'description' => '网络诊断任务ID。',
- 'type' => 'string',
- 'example' => 'diagnoseTask-bp2x7tzkdl655liw3mhbg',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '总列表条目数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'D2A9864E-BB8D-5A5C-90FC-E2FBD5D0BF9B'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Forbidden.RAM',
- 'errorMessage' => 'Ram user does not have permission to perform this operation.',
- ],
- [
- 'errorCode' => 'ResourceNotFound.IoTCloudConnector',
- 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
- ],
+ ['errorCode' => 'OperationDenied.CardsSimStatusNotReBind', 'errorMessage' => 'The operation is not allowed because of card status not support to rebind.', 'description' => '解锁的卡未处于锁定状态，无需解锁。'],
+ ['errorCode' => 'OperationDenied.TestCardFlowExceedQuota', 'errorMessage' => 'The operation is not allowed because of test card flow exceed quota.', 'description' => '测试卡流量超过配额额度，此操作不被允许。'],
+ ['errorCode' => 'ResourceNotFound.IccID', 'errorMessage' => 'The specified resource of iccid is not found.', 'description' => '此卡非您所有，请检查物联网卡号参数。'],
+ ['errorCode' => 'OperationDenied.SingCardOneMonthRebindExceeded', 'errorMessage' => 'The operation is not allowed because of the number of times per card per month exceed quota.', 'description' => '单卡单月解绑次数超过配额。'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1E237B1-EED7-55D5-AE5F-671E642DB3B5\\",\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\\\n\\",\\n \\"MaxResults\\": 20,\\n \\"DiagnoseInfo\\": [\\n {\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\",\\n \\"CardIp\\": \\"10.176.78.61\\",\\n \\"IccId\\": \\"89860477102170127555\\",\\n \\"SourceType\\": \\"Iccid\\",\\n \\"Source\\": \\"89860477102170127555\\",\\n \\"DestinationType\\": \\"Domain\\",\\n \\"Destination\\": \\"www.xxx.com\\",\\n \\"BeginTime\\": 1662307200000,\\n \\"EndTime\\": 1662307201200,\\n \\"Status\\": \\"failed\\",\\n \\"DiagnoseTime\\": 1662307202400,\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2x7tzkdl655liw3mhbg\\"\\n }\\n ],\\n \\"TotalCount\\": 50\\n}","type":"json"}]',
- 'title' => '查询历史诊断记录',
- ],
- 'GrantNetLink' => [
- 'summary' => '授权云连接器给第三方客户。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2A9864E-BB8D-5A5C-90FC-E2FBD5D0BF9B\\"\\n}","type":"json"}]',
+ 'title' => '换绑解锁单卡',
+ 'description' => '物联网卡在换绑设备时，运营商会锁定此卡，为了能够正常使用，一般需要对此卡进行换绑解锁，注意：单卡单月换绑解锁部分运营商只能支持2次。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebindCards'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RebindCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RemoveWirelessCloudConnectorFromGroup' => [
+ 'summary' => '从cc5g实例分组移除cc5g实例。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6963,176 +5055,223 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****'],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '网络连接id。',
- 'type' => 'string',
+ 'description' => '5G上云实例的id列表，最多20个。',
+ 'type' => 'array',
+ 'items' => ['description' => '5G上云实例id。', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx'],
'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'cciot-xxxx',
+ 'maxItems' => 20,
],
],
[
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'f0ba469f-de7f-4dde-8390-0966a1a0ef9a',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接更新实例信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会删除授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接删除授权规则。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'False',
+ 'title' => 'Schema of Response',
+ 'description' => '响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '2DCFA69E-A161-512D-99A7-108022580719'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\"\\n}","type":"json"}]',
+ 'title' => '从分组中移除cc5g实例',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveWirelessCloudConnectorFromGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RemoveWirelessCloudConnectorFromGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ResetAreaLimitCards' => [
+ 'summary' => '物联网卡区域限制解锁',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'GrantAliUid',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Iccids',
'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '阿里云授权者UID。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '物联网SIM卡卡号，每次最大50条',
+ 'type' => 'array',
+ 'items' => ['description' => '物联网SIM卡卡号，每次最大50条', 'type' => 'string', 'required' => false, 'example' => '898606*******'],
'required' => true,
- 'enumValueTitles' => [],
- 'example' => '11111111111',
+ 'maxItems' => 1000,
+ 'minItems' => 1,
],
],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '保证请求幂等性。'."\n"
+ .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
+ ."\n"
+ .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
+ ],
+ [
+ 'name' => 'DryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查直接创建批量操作卡任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'Province',
+ 'in' => 'query',
+ 'schema' => ['description' => '省份。', 'type' => 'string', 'required' => true, 'example' => '湖南省'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应对象',
+ 'description' => '响应返回体',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求iD',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'E6B58AF9-F1BF-5894-B898-6CE2108463C5',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
- 'enumValueTitles' => [],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'OperationDenied.GrantUidNotHaveCcIotSlr',
- 'errorMessage' => 'The operation is not allowed because of GrantUid not have AliyunServiceRoleForCCIoT.',
- ],
- [
- 'errorCode' => 'OperationDenied.NotSupportGrantToSelf',
- 'errorMessage' => 'The operation is not allowed because of not support grant self.',
- ],
- [
- 'errorCode' => 'OperationDenied.ExistCustomerAuthorizationRules',
- 'errorMessage' => 'The operation is not allowed because of exist customer authorization rules.',
+ ['errorCode' => 'OperationDenied.CardsSimStatusNotResume', 'errorMessage' => 'The operation is not allowed because of card status not support to resume.', 'description' => '当前卡状态不支持此操作（复机）。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '区域限制解锁',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ResetAreaLimitCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6B58AF9-F1BF-5894-B898-6CE2108463C5\\"\\n}","type":"json"}]',
- 'title' => '授权云连接器',
],
- 'RevokeNetLink' => [
- 'summary' => '主动撤销之前授权动作。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ResumeCards' => [
+ 'summary' => '激活单卡，或恢复运营商侧卡状态，支持批量操作。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
+ 'description' => '物联网SIM卡卡号，每次最大500条',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => '890912389123', 'description' => ''],
'required' => true,
- 'example' => 'cc5g-xxxx',
+ 'maxItems' => 1000,
+ 'minItems' => 1,
],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '网络连接id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'iotcc-ua6xy4vpmi24y114ws',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '8278082c-0b8c-412c-b0ad-876a3cf0d0f8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会取消关联。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接取消用户Vpc和Vswitch的关联。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会激活/恢复卡状态。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后激活/恢复卡状态。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7142,29 +5281,46 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求iD',
- 'type' => 'string',
- 'example' => '1E781588-69D4-56C3-93BA-DEFECF2596B8',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E781588-69D4-56C3-93BA-DEFECF2596B8\\"\\n}","type":"json"}]',
- 'title' => '撤销授权',
- 'description' => '被授权客户如果已经接受授权，此时不能被撤销，只能在未接受之前撤销',
- ],
- 'CreateWirelessCloudConnectorGroup' => [
- 'summary' => '创建cc5g实例分组。',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CardsSimStatusNotResume', 'errorMessage' => 'The operation is not allowed because of card status not support to resume.', 'description' => '当前卡状态不支持此操作（复机）。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '激活/恢复卡状态',
+ 'description' => '运营商卡切换终端或者因为频繁拨号等原因导致锁卡可在此恢复。',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-10T17:21:04.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-05-20T02:37:47.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeCards'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ResumeCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RevokeNetLink' => [
+ 'summary' => '主动撤销之前授权动作。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7173,68 +5329,34 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实例组名称，长度不超过128字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test1',
- ],
- ],
- [
- 'name' => 'Description',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '高速上云服务分组的描述信息。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5gg-test',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '网络连接id。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-ua6xy4vpmi24y114ws'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。'."\n", 'type' => 'string', 'required' => false, 'example' => '8278082c-0b8c-412c-b0ad-876a3cf0d0f8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会取消关联。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接取消用户Vpc和Vswitch的关联。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7244,33 +5366,40 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'."\n",
- ],
- 'WirelessCloudConnectorGroupId' => [
- 'description' => '实例组实例id。',
- 'type' => 'string',
- 'example' => 'cc5gg-****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求iD', 'type' => 'string', 'example' => '1E781588-69D4-56C3-93BA-DEFECF2596B8'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88C2F32F-B641-5980-B7A5-6907050ABCD1\\\\n\\",\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-****\\"\\n}","type":"json"}]',
- 'title' => '创建分组',
- ],
- 'UpdateWirelessCloudConnectorGroup' => [
- 'summary' => '修改cc5g实例分组信息。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E781588-69D4-56C3-93BA-DEFECF2596B8\\"\\n}","type":"json"}]',
+ 'title' => '撤销授权',
+ 'description' => '被授权客户如果已经接受授权，此时不能被撤销，只能在未接受之前撤销',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-04T10:43:43.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeNetLink'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RevokeNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StopCards' => [
+ 'summary' => '单卡停机，支持批量操作。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7282,72 +5411,39 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
+ 'description' => '物联网SIM卡卡号，每次最大500条',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'example' => '890912389123', 'description' => ''],
'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'cc5gg-****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '要修改的实例组的实例名称。'."\n"
- ."\n"
- .'长度为2-128个英文或中文字符，必须以大小字母或中文开头，可包含数字，半角句号（.），下划线（_）和短划线（-）。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'test',
+ 'maxItems' => 1000,
+ 'minItems' => 1,
],
],
[
- 'name' => 'Description',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '要修改的实例组的描述信息。'."\n"
- ."\n"
- .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为http://或https://。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'description',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接更新实例信息。',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会进行停机操作。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接进行卡停机操作。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7357,314 +5453,140 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE'],
],
- 'enumValueTitles' => [],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
- 'title' => '更新分组信息',
- ],
- 'ListWirelessCloudConnectorGroups' => [
- 'summary' => '查询cc5g实例分组。',
- 'methods' => [
- 'get',
+ 'title' => '卡停机操作',
+ 'description' => '如单卡被劫持或者其他原因做主动运维，可在此实现运营商侧卡停机。',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-20T02:37:47.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopCards'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:StopCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SubmitDiagnoseTaskForSingleCard' => [
+ 'summary' => '发起单张物联网卡的网络诊断。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'WirelessCloudConnectorGroupStatus',
+ 'name' => 'Source',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '实例组的状态列表。最多支持10个实例组的状态。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组的状态。取值：'."\n"
- ."\n"
- .'1. Creating: 创建中 '."\n"
- .'2. Available: 有效的稳定状态'."\n"
- .'3. Pending: 配置中 '."\n"
- .'4. Deleting: 删除中',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Creating',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '网络诊断的源物联网卡ID。', 'type' => 'string', 'required' => true, 'example' => '89860477102170127555'],
],
[
- 'name' => 'WirelessCloudConnectorGroupIds',
+ 'name' => 'Destination',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '实例组的ID列表。最多支持10个实例组的ID列表。'."\n"
- ."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组的ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5gg-xxxx',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '网络诊断的目的IP或者域名。', 'type' => 'string', 'required' => false, 'example' => '106.14.175.4'],
],
[
- 'name' => 'WirelessCloudConnectorGroupNames',
+ 'name' => 'BeginTime',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '实例组的名称列表。最多支持10个实例组的名称。'."\n"
- ."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '实例组的名称。'."\n"
- .'名称长度为2~128个英文或中文字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '网络诊断的开始时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1662307201200'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere'."\n",
- ],
+ 'schema' => ['description' => '网络诊断的结束时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1662307201200'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'RegionNo',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '5G高速上云实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
+ ],
+ [
+ 'name' => 'ResourceUid',
+ 'in' => 'query',
+ 'schema' => ['description' => '云连接器实例使用者的阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '253460731706911258'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914',
- ],
- 'WirelessCloudConnectorGroups' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '实例组列表信息。',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '实例组列表项信息',
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorGroupId' => [
- 'title' => '资源一级ID',
- 'description' => '实例组ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'cc5gg-xxxx',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '实例组的状态。取值：'."\n"
- ."\n"
- .'1. Creating: 创建中 '."\n"
- .'2. Available: 有效的稳定状态'."\n"
- .'3. Pending: 配置中 '."\n"
- .'4. Deleting: 删除中'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'Creating',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => 'cc5gg-test'."\n",
- ],
- 'RegionId' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
- 'CreateTime' => [
- 'description' => '实例创建时间。',
- 'type' => 'string',
- 'example' => '2022-07-04 19:19:14',
- ],
- 'WirelessCloudConnectors' => [
- 'description' => '5G高速上云实例列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorId' => [
- 'description' => '5G高速上云实例id。',
- 'type' => 'string',
- 'example' => 'cc5g-62eb02o7lz1w5aurl3',
- ],
- 'Status' => [
- 'description' => '实例状态，取值：'."\n"
- ."\n"
- .'Creating: 创建中'."\n"
- .'Available: 有效的稳定状态'."\n"
- .'Pending: 配置中'."\n"
- .'Deleting: 删除中',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Name' => [
- 'description' => '名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '描述。',
- 'type' => 'string',
- 'example' => 'cc5g-test',
- ],
- 'RegionId' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
- 'UseCase' => [
- 'description' => '实例使用场景。',
- 'type' => 'string',
- 'example' => '智慧工厂'."\n",
- ],
- 'DataPackageId' => [
- 'description' => '流量包id。',
- 'type' => 'string',
- 'example' => 'dp-xxxx'."\n",
- ],
- 'DataPackageType' => [
- 'description' => '流量包档位，取值：'."\n"
- ."\n"
- .'- **200**: 200M/卡/月'."\n"
- .'- **1000**: 1G/卡/月'."\n"
- .'- **3000**: 3G/卡/月'."\n"
- .'- **30000**: 30G/卡/月',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'CardCount' => [
- 'description' => '卡数量。',
- 'type' => 'string',
- 'example' => '115',
- ],
- 'CreateTime' => [
- 'description' => '实例创建时间。',
- 'type' => 'string',
- 'example' => '2022-04-28 17:40:53',
- ],
- 'BusinessType' => [
- 'description' => '业务类型',
- 'type' => 'string',
- 'example' => 'Business',
- ],
- 'ServiceType' => [
- 'description' => '服务类型，返回：'."\n"
- ."\n"
- .'- **CC5G**：普通实例。'."\n"
- .'- **CC5GCCIoT**：过户实例。',
- 'type' => 'string',
- 'example' => 'CC5G',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '列表的条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'DiagnoseTaskId' => ['description' => '网络诊断任务ID。', 'type' => 'string', 'example' => 'diagnoseTask-bp2n6rgaj49qcs34jyzo8'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\",\\n \\"WirelessCloudConnectorGroups\\": [\\n {\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-xxxx\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"cc5gg-test\\\\n\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"CreateTime\\": \\"2022-07-04 19:19:14\\",\\n \\"WirelessCloudConnectors\\": [\\n {\\n \\"WirelessCloudConnectorId\\": \\"cc5g-62eb02o7lz1w5aurl3\\",\\n \\"Status\\": \\"Available\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"cc5g-test\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"UseCase\\": \\"智慧工厂\\\\n\\",\\n \\"DataPackageId\\": \\"dp-xxxx\\\\n\\",\\n \\"DataPackageType\\": \\"200\\",\\n \\"CardCount\\": \\"115\\",\\n \\"CreateTime\\": \\"2022-04-28 17:40:53\\",\\n \\"BusinessType\\": \\"Business\\",\\n \\"ServiceType\\": \\"CC5G\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '查询分组信息',
- ],
- 'DeleteWirelessCloudConnectorGroup' => [
- 'summary' => '删除cc5g实例分组。',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => '子账号未获取5G上云服务RAM权限。'],
+ ['errorCode' => 'cardIdNotExist', 'errorMessage' => 'diagnose task iccid not exist', 'description' => '诊断任务中ICCID不存在。'],
+ ['errorCode' => 'CardIPNotBind', 'errorMessage' => 'card ip not bind', 'description' => '卡和卡地址IP服务端未绑定。'],
+ ['errorCode' => 'CardIPAndIccIdNotMatch', 'errorMessage' => 'card ip and iccid not match', 'description' => '卡IP和卡ICCID未对应。'],
+ ['errorCode' => 'CardIPNotExist', 'errorMessage' => 'card ip not exist', 'description' => '卡IP不存在。'],
+ ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => '实例ID参数不合法'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2n6rgaj49qcs34jyzo8\\"\\n}","type":"json"}]',
+ 'title' => '发起单卡网络诊断',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-28T07:22:13.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDiagnoseTaskForSingleCard'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'iotcc:SubmitDiagnoseTaskForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SwitchWirelessCloudConnectorToBusiness' => [
+ 'summary' => '用于把5G上云服务测试实例切换到商业实例。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7673,46 +5595,29 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '要删除的实例组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7722,103 +5627,83 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '2E759287-F208-589B-82D8-6D7A30F417E3',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '74ADDCF3-E3FE-5200-9290-1320125D71DC'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E759287-F208-589B-82D8-6D7A30F417E3\\"\\n}","type":"json"}]',
- 'title' => '删除分组',
- ],
- 'AddWirelessCloudConnectorToGroup' => [
- 'summary' => '给cc5g实例分组增加cc5g实例。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74ADDCF3-E3FE-5200-9290-1320125D71DC\\"\\n}","type":"json"}]',
+ 'title' => '切换5G上云服务实例到商业模式',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-20T06:47:52.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchWirelessCloudConnectorToBusiness'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:SwitchWirelessCloudConnectorToBusiness',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UnlockCards' => [
+ 'summary' => '批量解锁卡。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '实例组实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
- ],
- [
- 'name' => 'WirelessCloudConnectorIds',
+ 'name' => 'Iccids',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '5G上云实例的id列表，最多20个。',
+ 'description' => '物联网SIM卡卡号，每次最大500条',
'type' => 'array',
- 'items' => [
- 'description' => '5g上云实例id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
+ 'items' => ['type' => 'string', 'required' => false, 'example' => '890912389123', 'description' => ''],
'required' => true,
- 'maxItems' => 20,
+ 'maxItems' => 1000,
+ 'minItems' => 1,
],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会批量解锁。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后进行批量解锁操作。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7828,103 +5713,129 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '81CB64DF-E328-50A3-B386-03CAD604C114'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- 'title' => '给分组增加cc5g实例',
- ],
- 'RemoveWirelessCloudConnectorFromGroup' => [
- 'summary' => '从cc5g实例分组移除cc5g实例。',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CardsSimStatusNotUnlock', 'errorMessage' => 'The operation is not allowed because of card status not support to unlock.', 'description' => '当前卡状态不支持此操作（解锁）。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81CB64DF-E328-50A3-B386-03CAD604C114\\"\\n}","type":"json"}]',
+ 'title' => '批量解锁卡',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-13T02:36:20.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-05-20T02:37:47.000Z', 'description' => 'OpenAPI 下线'],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockCards'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UnlockCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateAuthorizationRule' => [
+ 'summary' => '更新授权规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'WirelessCloudConnectorIds',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '5G上云实例的id列表，最多20个。',
- 'type' => 'array',
- 'items' => [
- 'description' => '5G上云实例id。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
- 'required' => true,
- 'maxItems' => 20,
- ],
+ 'schema' => ['description' => '授权规则id。', 'type' => 'string', 'required' => true, 'example' => 'ar5g-xxxx'],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '地域id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => '名称，长度不超过128字符。', 'type' => 'string', 'required' => false, 'example' => 'Test'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '描述，长度不超过256字符。', 'type' => 'string', 'required' => false, 'example' => 'ar5g-test'],
+ ],
+ [
+ 'name' => 'SourceCidr',
+ 'in' => 'query',
+ 'schema' => ['description' => '源CIDR地址块。', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'],
+ ],
+ [
+ 'name' => 'Destination',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标地址或域名。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1'],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => '协议类型。取值：'."\n"
+ ."\n"
+ .'- **tcp**。'."\n"
+ .'- **udp**。'."\n"
+ .'- **icmp**。'."\n"
+ .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'all'],
+ ],
+ [
+ 'name' => 'DestinationPort',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标端口范围。取值范围：'."\n"
+ ."\n"
+ .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ ."\n"
+ .'- ICMP协议：-1/-1。'."\n"
+ ."\n"
+ .'- ALL：-1/-1。', 'type' => 'string', 'required' => false, 'example' => '-1/-1'],
+ ],
+ [
+ 'name' => 'Policy',
+ 'in' => 'query',
+ 'schema' => ['description' => '授权规则策略，取值：'."\n"
+ .'- **Permit**：允许'."\n"
+ .'- **Deny**：拒绝', 'type' => 'string', 'required' => false, 'example' => 'Permit'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接更新实例信息。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会更新授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后更新授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -7934,173 +5845,152 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '2DCFA69E-A161-512D-99A7-108022580719',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\"\\n}","type":"json"}]',
- 'title' => '从分组中移除cc5g实例',
- ],
- 'CreateGroupAuthorizationRule' => [
- 'summary' => '创建cc5g分组的授权规则。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => '授权规则目的网段掩码设置过大。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\"\\n}","type":"json"}]',
+ 'title' => '更新授权规则',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-18T13:33:38.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-06-23T08:23:56.000Z', 'description' => '错误码发生变更'],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAuthorizationRule'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateBatchOperateCardsTask' => [
+ 'summary' => '更新批量操作卡任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'Name',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '名称，长度不超过128字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '任务描述。', 'type' => 'string', 'required' => false, 'example' => 'task-test'],
],
[
- 'name' => 'Description',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则描述，长度不超过256字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5gg-test',
- ],
+ 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
- 'name' => 'SourceCidr',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '源CIDR地址块。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0/0',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'DestinationType',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '目标类型，取值：'."\n"
- .'- **Cidr**: 网段'."\n"
- .'- **Domain**: 域名或泛域名'."\n"
- .'- **IpPort**: IP重定向',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Cidr',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会更新批量操作卡任务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后更新批量操作卡任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Protocol',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '协议类型。取值：'."\n"
- ."\n"
- .'- **icmp**：网络控制报文协议。'."\n"
- .'- **tcp**：传输控制协议。'."\n"
- .'- **udp**：用户数据报协议。'."\n"
- .'- **all**：支持所有协议。',
- 'type' => 'string',
+ 'description' => '5G高速上云实例的id列表，最多10个。',
+ 'type' => 'array',
+ 'items' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx'],
'required' => false,
- 'example' => 'all',
],
],
[
- 'name' => 'DestinationPort',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '目标端口范围。取值范围：'."\n"
- ."\n"
- .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- ."\n"
- .'- ICMP协议：-1/-1。'."\n"
- ."\n"
- .'- ALL：-1/-1。',
- 'type' => 'string',
+ 'description' => '卡的iccid列表，最多200条。',
+ 'type' => 'array',
+ 'items' => ['description' => '卡的iccid。', 'type' => 'string', 'required' => false, 'example' => '890912389123'],
'required' => false,
- 'example' => '-1/-1',
],
],
[
- 'name' => 'Destination',
+ 'name' => 'IccidsOssFilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '目标地址或域名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '106.14.175.4',
- ],
+ 'schema' => ['description' => 'iccid文件存放路径。', 'type' => 'string', 'required' => false, 'example' => 'cciot-cn-hangzhou/127859184306****/***.csv'],
],
[
- 'name' => 'Policy',
+ 'name' => 'OperateType',
'in' => 'query',
'schema' => [
- 'description' => '授权规则策略，取值：'."\n"
- .'- **Permit**：允许'."\n"
- .'- **Deny**：拒绝',
+ 'description' => '限制类型，取值: '."\n"
+ ."\n"
+ .'- **BreakNetwork**: 达量断网'."\n"
+ .'- **LimitRate**: 达量限速'."\n"
+ .'- **Alarm**: 达量告警',
'type' => 'string',
- 'required' => true,
- 'example' => 'Permit',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'BreakNetwork',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Threshold',
+ 'in' => 'query',
+ 'schema' => ['description' => '达量阈值，单位MB。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
+ ],
+ [
+ 'name' => 'EffectType',
'in' => 'query',
'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
+ 'description' => '生效类型，取值：'."\n"
+ ."\n"
+ .'- **CurrentMonth**'."\n"
+ .'- **ContinualMonth**',
'type' => 'string',
'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'enumValueTitles' => [],
+ 'example' => 'CurrentMonth',
],
],
[
- 'name' => 'DryRun',
+ 'name' => 'BatchOperateCardsTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '批量操作任务id。', 'type' => 'string', 'required' => true, 'example' => 'boct-xxxx'],
],
],
'responses' => [
@@ -8110,42 +6000,39 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03',
- ],
- 'AuthorizationRuleId' => [
- 'description' => '授权规则id。',
- 'type' => 'string',
- 'example' => 'ar5gg-xxxx',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
- 'errorMessage' => 'The operation is not allowed because of CIDR too large.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '更新批量操作卡任务',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-08T10:39:02.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBatchOperateCardsTask'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\",\\n \\"AuthorizationRuleId\\": \\"ar5gg-xxxx\\"\\n}","type":"json"}]',
- 'title' => '创建分组授权规则',
],
- 'UpdateGroupAuthorizationRule' => [
- 'summary' => '修改cc5g实例组的授权规则。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateCard' => [
+ 'summary' => '更新卡实例的名称和描述。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8157,136 +6044,137 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'AuthorizationRuleId',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ar5gg-xxxx',
- ],
+ 'schema' => ['description' => '物联网卡的iccid。', 'type' => 'string', 'required' => false, 'example' => '890912389123'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则描述，长度不超过256字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'card-test'],
],
[
- 'name' => 'SourceCidr',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '源CIDR地址块。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.0.1',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'Destination',
+ 'name' => 'DryRun',
'in' => 'query',
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会更新卡信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后更新卡信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '访问目标。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.XX.XX',
+ 'title' => 'Schema of Response',
+ 'description' => '响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
+ 'title' => '更新卡信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCard'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Protocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协议类型。取值：'."\n"
- ."\n"
- .'- **tcp**。'."\n"
- .'- **udp**。'."\n"
- .'- **icmp**。'."\n"
- .'- **all**：支持所有协议。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'UpdateDNSAuthorizationRule' => [
+ 'summary' => '更新DNS授权规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DestinationPort',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '目标端口范围。取值范围：'."\n"
- ."\n"
- .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- ."\n"
- .'- ICMP协议：-1/-1。'."\n"
- ."\n"
- .'- ALL：-1/-1。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '80/80'."\n",
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
- 'name' => 'Policy',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则策略，取值：'."\n"
- .'- **Permit**：允许'."\n"
- .'- **Deny**：拒绝',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Permit',
- ],
+ 'schema' => ['description' => 'DNS授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'ar5g-xxxx'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '名称，长度不超过128字符。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '描述，长度不超过256字符。', 'type' => 'string', 'required' => false, 'example' => 'ar5g-test'],
+ ],
+ [
+ 'name' => 'SourceDNSIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'DNS服务器地址。', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0'],
+ ],
+ [
+ 'name' => 'DestinationIp',
+ 'in' => 'query',
+ 'schema' => ['description' => '需要重定向的DNS服务器地址。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会更新DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后更新DNS授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -8296,224 +6184,123 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '79B01B1A-7089-552F-9798-DEDFFBAAED5F',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
- 'errorMessage' => 'The operation is not allowed because of CIDR too large.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '更新DNS授权规则',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-02T09:57:54.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDNSAuthorizationRule'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateDNSAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79B01B1A-7089-552F-9798-DEDFFBAAED5F\\"\\n}","type":"json"}]',
- 'title' => '更新分组授权规则',
],
- 'ListGroupAuthorizationRules' => [
- 'summary' => '查询分组的授权规则列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateGroupAuthorizationRule' => [
+ 'summary' => '修改cc5g实例组的授权规则。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => '实例组id。', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****'],
],
[
- 'name' => 'Statuses',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '授权规则状态列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '授权规则状态，取值：'."\n"
- ."\n"
- .'- **Creating**：创建中'."\n"
- .'- **Available**：有效的稳定状态'."\n"
- .'- **Pending**：配置中 '."\n"
- .'- **Deleting**：删除中'."\n"
- .'- **UnAvailable**：无效，此规则暂时不生效',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Creating',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'AuthorizationRuleIds',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '授权规则id列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '授权规则id'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5gg-xxxx',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Names',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '授权规则名称列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '名称，长度不超过128字符。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '授权规则id。', 'type' => 'string', 'required' => true, 'example' => 'ar5gg-xxxx'],
],
[
- 'name' => 'DestinationType',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '目标类型，取值：'."\n"
- .'1. Cidr'."\n"
- .'2. Domain'."\n"
- .'3. IpPort',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cidr',
- ],
+ 'schema' => ['description' => '授权规则名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'Protocol',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '协议类型。取值：'."\n"
- ."\n"
- .'- **tcp**。'."\n"
- .'- **udp**。'."\n"
- .'- **icmp**。'."\n"
- .'- **all**：支持所有协议。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
+ 'schema' => ['description' => '授权规则描述，长度不超过256字符。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'DestinationPort',
+ 'name' => 'SourceCidr',
'in' => 'query',
- 'schema' => [
- 'description' => '目标端口范围。取值范围：'."\n"
- ."\n"
- .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- ."\n"
- .'- ICMP协议：-1/-1。'."\n"
- ."\n"
- .'- ALL：-1/-1。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-1/-1',
- ],
+ 'schema' => ['description' => '源CIDR地址块。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1'],
],
[
'name' => 'Destination',
'in' => 'query',
- 'schema' => [
- 'description' => '目标地址、域名或泛域名，前缀匹配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => '访问目标。', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'],
],
[
- 'name' => 'Policy',
+ 'name' => 'Protocol',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则策略，取值：'."\n"
- .'- **Permit**：允许'."\n"
- .'- **Deny**：拒绝',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Permit',
- ],
+ 'schema' => ['description' => '协议类型。取值：'."\n"
+ ."\n"
+ .'- **tcp**。'."\n"
+ .'- **udp**。'."\n"
+ .'- **icmp**。'."\n"
+ .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'all'],
],
[
- 'name' => 'Type',
+ 'name' => 'DestinationPort',
'in' => 'query',
- 'schema' => [
- 'description' => '类型，取值：'."\n"
- .'- **System**: 系统'."\n"
- .'- **Default**: 默认'."\n"
- .'- **Customer**: 自定义',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'System',
- ],
+ 'schema' => ['description' => '目标端口范围。取值范围：'."\n"
+ ."\n"
+ .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
+ ."\n"
+ .'- ICMP协议：-1/-1。'."\n"
+ ."\n"
+ .'- ALL：-1/-1。', 'type' => 'string', 'required' => false, 'example' => '80/80'."\n"],
],
[
- 'name' => 'Dns',
+ 'name' => 'Policy',
'in' => 'query',
- 'schema' => [
- 'description' => '是否为DNS。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '授权规则策略，取值：'."\n"
+ .'- **Permit**：允许'."\n"
+ .'- **Deny**：拒绝', 'type' => 'string', 'required' => false, 'example' => 'Permit'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '上一页的查询返回的值，首页查询不传值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -8523,149 +6310,42 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'GroupAuthorizationRules' => [
- 'title' => '数组，返回示例目录。',
- 'description' => '授权规则列表。'."\n"
- ."\n",
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '授权规则列表。',
- 'type' => 'object',
- 'properties' => [
- 'AuthorizationRuleId' => [
- 'title' => '资源一级ID',
- 'description' => '授权规则id。',
- 'type' => 'string',
- 'example' => 'ar5gg-y5g4rp2w1tl1w7zg59',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '授权规则状态，取值：'."\n"
- .'- **Creating**: 创建中'."\n"
- .'- **Available**: 有效的稳定状态'."\n"
- .'- **Pending**: 配置中'."\n"
- .'- **Deleting**: 删除中'."\n"
- .'- **UnAvailable**: 无效',
- 'type' => 'string',
- 'example' => 'Creating',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '授权规则名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '授权规则描述，长度不超过256字符。',
- 'type' => 'string',
- 'example' => 'ar5gg-test'."\n",
- ],
- 'Type' => [
- 'description' => '类型，取值：'."\n"
- .'- **System**: 系统'."\n"
- .'- **Default**: 默认'."\n"
- .'- **Customer**: 自定义',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'SourceCidr' => [
- 'description' => '源CIDR地址块。',
- 'type' => 'string',
- 'example' => '0.0.0.0/0',
- ],
- 'DestinationType' => [
- 'description' => '目标类型，取值：'."\n"
- .'1. Cidr'."\n"
- .'2. Domain'."\n"
- .'3. IpPort',
- 'type' => 'string',
- 'example' => 'Cidr',
- ],
- 'Protocol' => [
- 'description' => '协议类型。取值：'."\n"
- ."\n"
- .'- **tcp**。'."\n"
- .'- **udp**。'."\n"
- .'- **icmp**。'."\n"
- .'- **all**：支持所有协议。',
- 'type' => 'string',
- 'example' => 'all',
- ],
- 'DestinationPort' => [
- 'description' => '目标端口范围。取值范围：'."\n"
- ."\n"
- .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n"
- ."\n"
- .'- ICMP协议：-1/-1。'."\n"
- ."\n"
- .'- ALL：-1/-1。',
- 'type' => 'string',
- 'example' => '0-65535',
- ],
- 'Destination' => [
- 'description' => '目标地址、域名或泛域名，前缀匹配。',
- 'type' => 'string',
- 'example' => '47.103.184.100/32',
- ],
- 'Policy' => [
- 'description' => '授权规则策略，取值：'."\n"
- .'- **Permit**：允许'."\n"
- .'- **Deny**：拒绝',
- 'type' => 'string',
- 'example' => 'Permit',
- ],
- 'Dns' => [
- 'description' => '是否为DNS。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2022-06-21 15:27:24',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '下一次查询的起始token。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'iou001238joojjaere'."\n",
- ],
- 'MaxResults' => [
- 'description' => '分页查询时每页的行数，最大值为**50**，默认值为**10**。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '列表的条目数。',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '79B01B1A-7089-552F-9798-DEDFFBAAED5F'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"GroupAuthorizationRules\\": [\\n {\\n \\"AuthorizationRuleId\\": \\"ar5gg-y5g4rp2w1tl1w7zg59\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"ar5gg-test\\\\n\\",\\n \\"Type\\": \\"Default\\",\\n \\"SourceCidr\\": \\"0.0.0.0/0\\",\\n \\"DestinationType\\": \\"Cidr\\",\\n \\"Protocol\\": \\"all\\",\\n \\"DestinationPort\\": \\"0-65535\\",\\n \\"Destination\\": \\"47.103.184.100/32\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"Dns\\": true,\\n \\"CreateTime\\": \\"2022-06-21 15:27:24\\"\\n }\\n ],\\n \\"NextToken\\": \\"iou001238joojjaere\\\\n\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\"\\n}","type":"json"}]',
- 'title' => '查询分组授权规则列表',
- ],
- 'DeleteGroupAuthorizationRule' => [
- 'summary' => '删除cc5g分组授权规则。',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => '授权规则目的网段掩码设置过大。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79B01B1A-7089-552F-9798-DEDFFBAAED5F\\"\\n}","type":"json"}]',
+ 'title' => '更新分组授权规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupAuthorizationRule'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateGroupDnsAuthorizationRule' => [
+ 'summary' => '修改实例组的DNS授权规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8674,21 +6354,20 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
'schema' => [
- 'description' => '实例组实例id。',
+ 'description' => '实例组id。',
'type' => 'string',
'required' => true,
+ 'enumValueTitles' => [],
'example' => 'cc5gg-****',
],
],
@@ -8696,34 +6375,53 @@
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
- 'description' => '授权规则id。',
+ 'description' => 'DNS授权规则id。'."\n"
+ ."\n",
'type' => 'string',
'required' => true,
- 'example' => 'ar5gg-12fnojjtkkre28t08j',
+ 'enumValueTitles' => [],
+ 'example' => 'ar5gg-xxxx',
],
],
[
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'DNS授权规则名称。'."\n"
+ ."\n"
+ .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'DNS授权规则描述。'."\n"
+ ."\n"
+ .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为http://或https://。', 'type' => 'string', 'required' => false, 'example' => 'description'],
+ ],
+ [
+ 'name' => 'SourceDNSIp',
+ 'in' => 'query',
+ 'schema' => ['description' => '源DNS授权规则IP地址。包括但不限于以下取值：'."\n"
+ ."\n"
+ .'100.100.2.136，100.100.2.137，100.100.2.138，114.114.114.114，8.8.8.8，8.8.4.4，223.5.5.5，223.6.6.6，221.5.88.88，116.116.116.116，221.228.15.26，61.139.2.69，218.6.200.139，119.29.29.29，218.2.2.2，208.67.220.220，208.67.222.222，218.4.4.4。'."\n"
+ ."\n\n", 'type' => 'string', 'required' => false, 'example' => '100.100.2.136'."\n"],
+ ],
+ [
+ 'name' => 'DestinationIp',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标DNS授权规则IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.2'."\n"],
+ ],
+ [
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求。取值：'."\n"
+ .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -8733,28 +6431,38 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'A175C091-3910-51AF-8D84-D5717B9B8D38',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '207F9929-806E-5622-8E4F-8484F7000C22'],
],
+ 'enumValueTitles' => [],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A175C091-3910-51AF-8D84-D5717B9B8D38\\"\\n}","type":"json"}]',
- 'title' => '删除分组授权规则',
- ],
- 'AddGroupDnsAuthorizationRule' => [
- 'summary' => '实例组创建DNS授权规则。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"207F9929-806E-5622-8E4F-8484F7000C22\\"\\n}","type":"json"}]',
+ 'title' => '更新分组DNS授权规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupDnsAuthorizationRule'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateGroupDnsAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateWirelessCloudConnector' => [
+ 'summary' => '更新5G高速上云实例信息。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8763,86 +6471,39 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisYFDH9T',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '实例组实例id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => '5G高速上云实例id。', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '名称，长度不超过128字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '授权规则描述，长度不超过256字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5gg-test'."\n",
- ],
- ],
- [
- 'name' => 'SourceDNSIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'DNS服务器地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '114.114.114.114',
- ],
- ],
- [
- 'name' => 'DestinationIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '需要重定向的DNS服务器地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.1.1.1',
- ],
+ 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'cc5g-test'],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
- .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。'."\n"
+ .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8'],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '是否只预检此次请求，取值：'."\n"
- .'- **true**：发送检查请求，不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除实例。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接更新实例信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -8852,33 +6513,37 @@
'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id。',
- 'type' => 'string',
- 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914',
- ],
- 'AuthorizationRuleId' => [
- 'description' => '生成的DNS授权规则id。',
- 'type' => 'string',
- 'example' => 'ar5gg-12fnojjtkkre28t08j',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\",\\n \\"AuthorizationRuleId\\": \\"ar5gg-12fnojjtkkre28t08j\\"\\n}","type":"json"}]',
- 'title' => '创建分组DNS授权规则',
- ],
- 'UpdateGroupDnsAuthorizationRule' => [
- 'summary' => '修改实例组的DNS授权规则。',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => '更新5G高速上云实例',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWirelessCloudConnector'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateWirelessCloudConnectorGroup' => [
+ 'summary' => '修改cc5g实例分组信息。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8890,16 +6555,14 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
'schema' => [
- 'description' => '实例组id。',
+ 'description' => '实例组ID。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
@@ -8907,26 +6570,15 @@
],
],
[
- 'name' => 'AuthorizationRuleId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'DNS授权规则id。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'ar5gg-xxxx',
- ],
- ],
- [
'name' => 'Name',
'in' => 'query',
'schema' => [
- 'description' => 'DNS授权规则名称。'."\n"
+ 'description' => '要修改的实例组的实例名称。'."\n"
."\n"
- .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。',
+ .'长度为2-128个英文或中文字符，必须以大小字母或中文开头，可包含数字，半角句号（.），下划线（_）和短划线（-）。',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'test',
],
],
@@ -8934,38 +6586,16 @@
'name' => 'Description',
'in' => 'query',
'schema' => [
- 'description' => 'DNS授权规则描述。'."\n"
+ 'description' => '要修改的实例组的描述信息。'."\n"
."\n"
.'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为http://或https://。',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'description',
],
],
[
- 'name' => 'SourceDNSIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '源DNS授权规则IP地址。包括但不限于以下取值：'."\n"
- ."\n"
- .'100.100.2.136，100.100.2.137，100.100.2.138，114.114.114.114，8.8.8.8，8.8.4.4，223.5.5.5，223.6.6.6，221.5.88.88，116.116.116.116，221.228.15.26，61.139.2.69，218.6.200.139，119.29.29.29，218.2.2.2，208.67.220.220，208.67.222.222，218.4.4.4。'."\n"
- ."\n\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '100.100.2.136'."\n",
- ],
- ],
- [
- 'name' => 'DestinationIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '目标DNS授权规则IP地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.0.2'."\n",
- ],
- ],
- [
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
@@ -8973,6 +6603,7 @@
.'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
],
],
@@ -8980,11 +6611,12 @@
'name' => 'DryRun',
'in' => 'query',
'schema' => [
- 'description' => '是否只预检此次请求。取值：'."\n"
- .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
- .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。',
+ 'description' => '是否只预检此次请求，取值：'."\n"
+ .'- **true**：发送检查请求，不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n"
+ .'- **false**（默认值）：发送正常请求，通过检查后直接更新实例信息。',
'type' => 'boolean',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'true',
],
],
@@ -9000,53 +6632,1212 @@
'title' => 'Id of the request',
'description' => '请求id。',
'type' => 'string',
- 'example' => '207F9929-806E-5622-8E4F-8484F7000C22',
+ 'enumValueTitles' => [],
+ 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
],
],
'enumValueTitles' => [],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"207F9929-806E-5622-8E4F-8484F7000C22\\"\\n}","type":"json"}]',
- 'title' => '更新分组DNS授权规则',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
+ 'title' => '更新分组信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWirelessCloudConnectorGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
],
'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => 'cc5g-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'cardIdNotExist', 'message' => 'diagnose task iccid not exist', 'http_code' => 400, 'description' => '诊断任务中ICCID不存在。'],
+ ['code' => 'CardIPAndIccIdNotMatch', 'message' => 'card ip and iccid not match', 'http_code' => 400, 'description' => '卡IP和卡ICCID未对应。'],
+ ['code' => 'CardIPNotBind', 'message' => 'card ip not bind', 'http_code' => 400, 'description' => '卡和卡地址IP服务端未绑定。'],
+ ['code' => 'CardIPNotExist', 'message' => 'card ip not exist', 'http_code' => 400, 'description' => '卡IP不存在。'],
+ ['code' => 'Forbidden.RAM', 'message' => 'Ram user does not have permission to perform this operation.', 'http_code' => 400, 'description' => '子账号未获取5G上云服务RAM权限。'],
+ ['code' => 'OperationDenied.AttachedVpc', 'message' => 'The operation is not allowed because of exist vpc.', 'http_code' => 400, 'description' => '此操作被拒绝，原因是存在绑定VPC。'],
+ ['code' => 'OperationDenied.CardsSimStatusNotReBind', 'message' => 'The operation is not allowed because of card status not support to rebind.', 'http_code' => 400, 'description' => '解锁的卡未处于锁定状态，无需解锁。'],
+ ['code' => 'OperationDenied.CardsSimStatusNotReBind', 'message' => 'The card cannot be unbound when it is in the current state.', 'http_code' => 400, 'description' => '卡状态不支持解绑。'],
+ ['code' => 'OperationDenied.CardsSimStatusNotResume', 'message' => 'The operation is not allowed because of card status not support to resume.', 'http_code' => 400, 'description' => '当前卡状态不支持此操作（复机）。'],
+ ['code' => 'OperationDenied.CardsSimStatusNotUnlock', 'message' => 'The operation is not allowed because of card status not support to unlock.', 'http_code' => 400, 'description' => '当前卡状态不支持此操作（解锁）。'],
+ ['code' => 'OperationDenied.CIDRMaskTooLarge', 'message' => 'The operation is not allowed because of CIDR too large.', 'http_code' => 400, 'description' => '授权规则目的网段掩码设置过大。'],
+ ['code' => 'OperationDenied.ExistCards', 'message' => 'The operation is not allowed because of exist cards.', 'http_code' => 400, 'description' => 'cc5g实例下仍存在卡，不允许删除该实例。'],
+ ['code' => 'OperationDenied.ExistCustomerAuthorizationRules', 'message' => 'The operation is not allowed because of exist customer authorization rules.', 'http_code' => 400, 'description' => '5G上云服务下有自定义授权规则存在，不允许过户。'],
+ ['code' => 'OperationDenied.ExistCustomerAuthorizationRules', 'message' => 'The operation is not allowed because of exist customer authorizationRule.', 'http_code' => 400, 'description' => '此操作不允许，原因是当前实例下存在自定义授权规则。'],
+ ['code' => 'OperationDenied.GrantUidNotHaveCcIotSlr', 'message' => 'The operation is not allowed because of GrantUid not have AliyunServiceRoleForCCIoT.', 'http_code' => 400, 'description' => '被授权的账号没有AliyunServiceRoleForCCIoT权限。'],
+ ['code' => 'OperationDenied.NotSupportGrantToSelf', 'message' => 'The operation is not allowed because of not support grant self.', 'http_code' => 400, 'description' => '不允许授权给自己。'],
+ ['code' => 'OperationDenied.SingCardOneMonthRebindExceeded', 'message' => 'The operation is not allowed because of the number of times per card per month exceed quota.', 'http_code' => 400, 'description' => '单卡单月解绑次数超过配额。'],
+ ['code' => 'OperationDenied.TestCardFlowExceedQuota', 'message' => 'The operation is not allowed because of test card flow exceed quota.', 'http_code' => 400, 'description' => '测试卡流量超过配额额度，此操作不被允许。'],
+ ['code' => 'ResourceNotFound.IccID', 'message' => 'The specified resource of iccid is not found.', 'http_code' => 400, 'description' => '此卡非您所有，请检查物联网卡号参数。'],
+ ['code' => 'ResourceNotFound.IoTCloudConnector', 'message' => 'The param of IoTCloudConnectorId is illegal.', 'http_code' => 400, 'description' => '实例ID参数不合法'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'GetCreateCustomerInfomation'],
+ ],
+ 'createdAt' => '2024-07-16T07:39:05.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetDiagnoseResultForSingleCard'],
+ ],
+ 'createdAt' => '2024-03-07T09:19:48.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'DeleteWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2023-05-30T09:09:43.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2023-05-04T02:45:56.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ListCardDayUsages'],
+ ],
+ 'createdAt' => '2023-04-27T09:15:32.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2023-04-23T07:55:25.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'GetDiagnoseResultForSingleCard'],
+ ],
+ 'createdAt' => '2023-01-06T07:30:55.000Z',
+ 'description' => '5G高速上云获取单卡诊断结果的API GetDiagnoseResultForSingleCard返回结果中新增诊断子项信息，用于更加详细的展示诊断结果。',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ListCardUsages'],
+ ],
+ 'createdAt' => '2022-12-26T07:36:49.000Z',
+ 'description' => '增加iccid入参数量1～50',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'ListRegions'],
+ ],
+ 'createdAt' => '2022-12-06T08:13:01.000Z',
+ 'description' => '下线显示endpoint',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'DeleteWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2022-11-29T08:55:05.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'UpdateDNSAuthorizationRule'],
+ ],
+ 'createdAt' => '2022-11-02T09:58:39.000Z',
+ 'description' => 'dns更新接口实例id必填',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateWirelessCloudConnector'],
+ ['description' => '响应参数发生变更', 'api' => 'GetWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2022-10-27T08:43:25.000Z',
+ 'description' => 'cc5g分组相关api发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateBatchOperateCardsTask'],
+ ],
+ 'createdAt' => '2022-10-17T02:12:04.000Z',
+ 'description' => 'inner api publish',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'CreateAuthorizationRule'],
+ ['description' => '错误码发生变更', 'api' => 'UpdateAuthorizationRule'],
+ ],
+ 'createdAt' => '2022-10-17T02:12:03.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'UnlockCards'],
+ ],
+ 'createdAt' => '2022-10-13T02:36:53.000Z',
+ 'description' => '错误码发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'ResumeCards'],
+ ],
+ 'createdAt' => '2022-10-10T17:21:21.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-09-29T12:42:11.000Z',
+ 'description' => 'ListCards接口增加按MSISDN搜索参数',
+ ],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'SubmitDiagnoseTaskForSingleCard'],
+ ],
+ 'createdAt' => '2022-09-28T07:23:41.000Z',
+ 'description' => '新增CC5G单卡诊断功能相关接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2022-09-20T09:17:20.000Z',
+ 'description' => '创建5G高速上云服务接口RegionID参数改成必填',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'GrantNetLink'],
+ ['description' => '错误码发生变更', 'api' => 'GrantNetLink'],
+ ],
+ 'createdAt' => '2022-09-14T03:05:47.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'FailCards'],
+ ],
+ 'createdAt' => '2022-09-04T13:01:36.000Z',
+ 'description' => '发布卡失效接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetWirelessCloudConnector'],
+ ['description' => 'OpenAPI 下线', 'api' => 'RevokeNetLink'],
+ ],
+ 'createdAt' => '2022-09-04T10:44:00.000Z',
+ 'description' => 'cc5g过户',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateAuthorizationRule'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAuthorizationRules'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateAuthorizationRule'],
+ ],
+ 'createdAt' => '2022-08-19T02:34:01.000Z',
+ 'description' => '支持端口级别白名单规则',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetCard'],
+ ],
+ 'createdAt' => '2022-08-09T11:31:03.000Z',
+ 'description' => '发布GetCard接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'GetCreateCustomerInformation'],
+ ],
+ 'createdAt' => '2022-08-02T06:21:50.000Z',
+ 'description' => '客户资料录入可以传入cc5gid来判断这个cc5gid下面是否需要录入资料',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteIoTCloudConnectorBackhaulRoute'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListIoTCloudConnectorBackhaulRoute'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ModifyWirelessCloudConnectorFeature'],
+ ],
+ 'createdAt' => '2022-07-28T11:48:11.000Z',
+ 'description' => '新增CC5G支持反向访问能力相关API',
],
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetCardLockReason'],
+ ['description' => 'OpenAPI 下线', 'api' => 'SwitchWirelessCloudConnectorToBusiness'],
+ ],
+ 'createdAt' => '2022-07-20T06:48:12.000Z',
+ 'description' => '测试卡功能发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-07-18T10:04:22.000Z',
+ 'description' => '添加MSISDN字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetCreateCustomerInformation'],
+ ],
+ 'createdAt' => '2022-07-11T12:29:07.000Z',
+ 'description' => '改下接口名',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-07-11T08:50:18.000Z',
+ 'description' => '更新',
],
[
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'ListBatchOperateCardsTasks'],
+ ],
+ 'createdAt' => '2022-07-11T07:13:26.000Z',
+ 'description' => '字段类型调整',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'InnerLimitRateCards'],
+ ['description' => 'OpenAPI 下线', 'api' => 'InnerStopCards'],
+ ],
+ 'createdAt' => '2022-06-20T09:00:07.000Z',
+ 'description' => '添加INNER接口',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-06-13T06:32:55.000Z',
+ 'description' => '新增相应的iccid字段',
],
[
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetCreateCustomerInfomation'],
+ ],
+ 'createdAt' => '2022-06-09T07:41:06.000Z',
+ 'description' => '发布接口',
],
[
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'UpdateBatchOperateCardsTask'],
+ ],
+ 'createdAt' => '2022-06-08T10:40:05.000Z',
+ 'description' => 'ram调整',
],
[
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateBatchOperateCardsTask'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteBatchOperateCardsTask'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListBatchOperateCardsTasks'],
+ ['description' => '响应参数发生变更', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-05-30T07:50:03.000Z',
+ 'description' => '新增批量操作和RAM相关API',
],
[
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'LockCards'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ResumeCards'],
+ ['description' => 'OpenAPI 下线', 'api' => 'StopCards'],
+ ['description' => 'OpenAPI 下线', 'api' => 'UnlockCards'],
+ ],
+ 'createdAt' => '2022-05-20T02:38:31.000Z',
+ 'description' => 'cc5g 停卡复卡接口发布',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupDnsAuthorizationRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddGroupDnsAuthorizationRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachVpcFromNetLink'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebindCards'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBatchOperateCardsTasks'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAPNs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDNSAuthorizationRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListZones'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenCc5gService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWirelessCloudConnectorGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWirelessCloudConnector'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockCards'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupAuthorizationRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIoTCloudConnectorBackhaulRoute'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachVpcToNetLink'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockCards'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWirelessCloudConnector'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddWirelessCloudConnectorToGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAuthorizationRule'],
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCards'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupAuthorizationRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWirelessCloudConnectorGroup'],
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCardDayUsages'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyWirelessCloudConnectorFeature'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchWirelessCloudConnectorToBusiness'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeCards'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBatchOperateCardsTask'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWirelessCloudConnector'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCard'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupAuthorizationRules'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCreateCustomerInformation'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWirelessCloudConnectors'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAuthorizationRules'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWirelessCloudConnectorGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCard'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDNSAuthorizationRule'],
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseInfoForSingleCard'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAuthorizationRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrders'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWirelessCloudConnectorGroups'],
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDiagnoseTaskForSingleCard'],
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDiagnoseResultForSingleCard'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataPackages'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FailCards'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBatchOperateCardsTask'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopCards'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupAuthorizationRule'],
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCardUsages'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWirelessCloudConnector'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBatchOperateCardsTask'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAuthorizationRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorBackhaulRoute'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveWirelessCloudConnectorFromGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeNetLink'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantNetLink'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardLockReason'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'UIS',
+ 'productName' => '云连接器',
+ 'ramCodes' => ['fivegcc', 'iotcc'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'UnlockCards',
+ 'description' => '批量解锁卡',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UnlockCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateGroupAuthorizationRule',
+ 'description' => '更新分组授权规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListGroupAuthorizationRules',
+ 'description' => '查询分组授权规则列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListGroupAuthorizationRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopCards',
+ 'description' => '卡停机操作',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:StopCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResetAreaLimitCards',
+ 'description' => '区域限制解锁',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ResetAreaLimitCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListBatchOperateCardsTasks',
+ 'description' => '列出批量操作卡任务',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListBatchOperateCardsTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetWirelessCloudConnector',
+ 'description' => '查询5G高速上云实例详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DetachVpcFromNetLink',
+ 'description' => '取消关联Vpc和Vswitch',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DetachVpcFromNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteBatchOperateCardsTask',
+ 'description' => '删除批量操作卡任务',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddGroupDnsAuthorizationRule',
+ 'description' => '创建分组DNS授权规则',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddGroupDnsAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCard',
+ 'description' => '获取单卡信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWirelessCloudConnectorGroup',
+ 'description' => '删除分组',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWirelessCloudConnectorGroup',
+ 'description' => '创建分组',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCardDayUsages',
+ 'description' => '查询单卡单日流量',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardDayUsages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GrantNetLink',
+ 'description' => '授权云连接器',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GrantNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAuthorizationRules',
+ 'description' => '查询授权规则',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListAuthorizationRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListZones',
+ 'description' => '查询可用区的列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListZones',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCardUsages',
+ 'description' => '查询卡流量使用信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardUsages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWirelessCloudConnectorGroups',
+ 'description' => '查询分组信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListWirelessCloudConnectorGroups',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataPackages',
+ 'description' => '查询流量包信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListDataPackages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWirelessCloudConnector',
+ 'description' => '更新5G高速上云实例',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIoTCloudConnectorBackhaulRoute',
+ 'description' => '查询5G高速上云实例反向访问路由',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListIoTCloudConnectorBackhaulRoute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'OpenCc5gService',
+ 'description' => '开通服务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:OpenCc5gService',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateBatchOperateCardsTask',
+ 'description' => '更新批量操作卡任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FailCards',
+ 'description' => '销卡',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:FailCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddWirelessCloudConnectorToGroup',
+ 'description' => '给分组增加cc5g实例',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddWirelessCloudConnectorToGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SwitchWirelessCloudConnectorToBusiness',
+ 'description' => '切换5G上云服务实例到商业模式',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:SwitchWirelessCloudConnectorToBusiness',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateAuthorizationRule',
+ 'description' => '更新授权规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCards',
+ 'description' => '查询5G高速上云实例下的卡信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListOrders',
+ 'description' => '查询订单列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListOrders',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateCard',
+ 'description' => '更新卡信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWirelessCloudConnector',
+ 'description' => '创建5G高速上云服务实例',
+ 'operationType' => 'create',
+ 'additionalActions' => [
+ ['action' => 'ram:CreateServiceLinkedRole', 'validationType' => 'always'],
+ ],
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRegions',
+ 'description' => '查询可用地域列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListRegions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteGroupAuthorizationRule',
+ 'description' => '删除分组授权规则',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddDNSAuthorizationRule',
+ 'description' => '创建DNS授权规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddDNSAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCreateCustomerInformation',
+ 'description' => '获取客户资料录入地址和录入状态',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCreateCustomerInformation',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateBatchOperateCardsTask',
+ 'description' => '创建批量操作卡任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCardLockReason',
+ 'description' => '获取锁卡原因',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCardLockReason',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AttachVpcToNetLink',
+ 'description' => '关联用户Vpc和Vswitch',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AttachVpcToNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#wirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWirelessCloudConnector',
+ 'description' => '删除5G高速上云实例',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWirelessCloudConnectors',
+ 'description' => '查询5G高速上云实例列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListWirelessCloudConnectors',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyWirelessCloudConnectorFeature',
+ 'description' => '修改5G高速上云实例高级属性',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ModifyWirelessCloudConnectorFeature',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateGroupAuthorizationRule',
+ 'description' => '创建分组授权规则',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResumeCards',
+ 'description' => '激活/恢复卡状态',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ResumeCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAuthorizationRule',
+ 'description' => '创建授权规则',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RevokeNetLink',
+ 'description' => '撤销授权',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RevokeNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateIoTCloudConnectorBackhaulRoute',
+ 'description' => '创建5G高速上云实例反向访问路由',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateIoTCloudConnectorBackhaulRoute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCardAreaLimitSupportArea',
+ 'description' => '查询卡区域解锁支持的省份',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardAreaLimitSupportArea',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWirelessCloudConnectorGroup',
+ 'description' => '更新分组信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteIoTCloudConnectorBackhaulRoute',
+ 'description' => '删除5G高速上云实例反向访问路由',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteIoTCloudConnectorBackhaulRoute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateGroupDnsAuthorizationRule',
+ 'description' => '更新分组DNS授权规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateGroupDnsAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAPNs',
+ 'description' => '查询APN列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListAPNs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDNSAuthorizationRule',
+ 'description' => '更新DNS授权规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateDNSAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAuthorizationRule',
+ 'description' => '删除授权规则',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RebindCards',
+ 'description' => '换绑解锁单卡',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RebindCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveWirelessCloudConnectorFromGroup',
+ 'description' => '从分组中移除cc5g实例',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RemoveWirelessCloudConnectorFromGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LockCards',
+ 'description' => '批量锁定卡',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:LockCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitDiagnoseTaskForSingleCard',
+ 'description' => '发起单卡网络诊断',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'iotcc:SubmitDiagnoseTaskForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDiagnoseInfoForSingleCard',
+ 'description' => '查询历史诊断记录',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'iotcc:ListDiagnoseInfoForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDiagnoseResultForSingleCard',
+ 'description' => '查询单卡诊断结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'iotcc:GetDiagnoseResultForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc::{#accountId}:wirelesscloudconnector/*'],
+ ['validationType' => 'always', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ['validationType' => 'always', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/*'],
+ ['validationType' => 'always', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc::{#accountId}:wirelesscloudconnector/{#wirelessCloudConnectorId}'],
+ ['validationType' => 'always', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:fivegcc::{#accountId}:authorizationrule/*'],
+ ['validationType' => 'always', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:fivegcc::{#accountId}:authorizationrule/{#AuthorizationRuleId}'],
+ ['validationType' => 'always', 'resourceType' => 'VPC', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vpc/{#vpcId}'],
+ ['validationType' => 'always', 'resourceType' => 'Switch', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:switch/{#vswitchId}'],
+ ['validationType' => 'always', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc::{#accountId}:wirelesscloudconnector/{#wirelessCloudConnector}'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:42:46 +0000