summaryrefslogtreecommitdiff
path: root/data/en_us/cc5g/2022-03-14/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/cc5g/2022-03-14/api-docs.php')
-rw-r--r--data/en_us/cc5g/2022-03-14/api-docs.php11130
1 files changed, 5471 insertions, 5659 deletions
diff --git a/data/en_us/cc5g/2022-03-14/api-docs.php b/data/en_us/cc5g/2022-03-14/api-docs.php
index 206b97a..cfdc0a2 100644
--- a/data/en_us/cc5g/2022-03-14/api-docs.php
+++ b/data/en_us/cc5g/2022-03-14/api-docs.php
@@ -1,455 +1,247 @@
<?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' => null,
+ 'children' => ['OpenCc5gService', 'GetCreateCustomerInformation'],
'type' => 'directory',
- 'children' => [
- 'ListRegions',
- 'ListZones',
- ],
+ 'title' => 'Permission management',
],
[
- 'id' => 169077,
- 'title' => null,
+ 'children' => ['ListAPNs', 'CreateWirelessCloudConnector', 'DeleteWirelessCloudConnector', 'UpdateWirelessCloudConnector', 'ListWirelessCloudConnectors', 'AttachVpcToNetLink', 'DetachVpcFromNetLink', 'GetWirelessCloudConnector', 'ListDataPackages', 'CreateIoTCloudConnectorBackhaulRoute', 'DeleteIoTCloudConnectorBackhaulRoute', 'ModifyWirelessCloudConnectorFeature', 'ListIoTCloudConnectorBackhaulRoute', 'SwitchWirelessCloudConnectorToBusiness'],
'type' => 'directory',
- 'children' => [
- 'OpenCc5gService',
- 'GetCreateCustomerInformation',
- ],
+ 'title' => '5G cloud-connected instances',
],
[
- 'id' => 169080,
- 'title' => null,
+ 'children' => ['LockCards', 'UnlockCards', 'StopCards', 'ResumeCards', 'UpdateCard', 'ListCards', 'ListCardUsages', 'GetCard', 'GetCardLockReason', 'FailCards', 'RebindCards', 'ListCardDayUsages', 'ResetAreaLimitCards', 'ListCardAreaLimitSupportArea'],
'type' => 'directory',
- 'children' => [
- 'ListAPNs',
- 'CreateWirelessCloudConnector',
- 'DeleteWirelessCloudConnector',
- 'UpdateWirelessCloudConnector',
- 'ListWirelessCloudConnectors',
- 'AttachVpcToNetLink',
- 'DetachVpcFromNetLink',
- 'GetWirelessCloudConnector',
- 'ListDataPackages',
- 'CreateIoTCloudConnectorBackhaulRoute',
- 'DeleteIoTCloudConnectorBackhaulRoute',
- 'ModifyWirelessCloudConnectorFeature',
- 'ListIoTCloudConnectorBackhaulRoute',
- 'SwitchWirelessCloudConnectorToBusiness',
- ],
+ 'title' => 'Card management',
],
[
- 'id' => 169089,
- 'title' => null,
+ 'children' => ['CreateAuthorizationRule', 'DeleteAuthorizationRule', 'UpdateAuthorizationRule', 'AddDNSAuthorizationRule', 'UpdateDNSAuthorizationRule', 'ListAuthorizationRules'],
'type' => 'directory',
- 'children' => [
- 'ListOrders',
- ],
+ 'title' => 'Authorization rules',
],
[
- 'id' => 169091,
- 'title' => null,
+ 'children' => ['CreateBatchOperateCardsTask', 'DeleteBatchOperateCardsTask', 'UpdateBatchOperateCardsTask', 'ListBatchOperateCardsTasks'],
'type' => 'directory',
- 'children' => [
- 'LockCards',
- 'UnlockCards',
- 'StopCards',
- 'ResumeCards',
- 'UpdateCard',
- 'ListCards',
- 'ListCardUsages',
- 'GetCard',
- 'GetCardLockReason',
- 'FailCards',
- 'RebindCards',
- 'ListCardDayUsages',
- 'ResetAreaLimitCards',
- 'ListCardAreaLimitSupportArea',
- ],
+ 'title' => 'Batch card operations',
],
[
- 'id' => 169100,
- 'title' => null,
+ 'children' => ['SubmitDiagnoseTaskForSingleCard', 'GetDiagnoseResultForSingleCard', 'ListDiagnoseInfoForSingleCard'],
'type' => 'directory',
- 'children' => [
- 'CreateAuthorizationRule',
- 'DeleteAuthorizationRule',
- 'UpdateAuthorizationRule',
- 'AddDNSAuthorizationRule',
- 'UpdateDNSAuthorizationRule',
- 'ListAuthorizationRules',
- ],
+ 'title' => 'Network diagnostics',
],
[
- 'id' => 169103,
- 'title' => null,
+ 'children' => ['GrantNetLink', 'RevokeNetLink'],
'type' => 'directory',
- 'children' => [
- 'CreateBatchOperateCardsTask',
- 'DeleteBatchOperateCardsTask',
- 'UpdateBatchOperateCardsTask',
- 'ListBatchOperateCardsTasks',
- ],
+ 'title' => 'Authorization sharing',
],
[
- 'id' => 172117,
- 'title' => null,
+ 'children' => ['CreateWirelessCloudConnectorGroup', 'UpdateWirelessCloudConnectorGroup', 'ListWirelessCloudConnectorGroups', 'DeleteWirelessCloudConnectorGroup', 'AddWirelessCloudConnectorToGroup', 'RemoveWirelessCloudConnectorFromGroup', 'CreateGroupAuthorizationRule', 'UpdateGroupAuthorizationRule', 'ListGroupAuthorizationRules', 'DeleteGroupAuthorizationRule', 'AddGroupDnsAuthorizationRule', 'UpdateGroupDnsAuthorizationRule'],
'type' => 'directory',
- 'children' => [
- 'SubmitDiagnoseTaskForSingleCard',
- 'GetDiagnoseResultForSingleCard',
- 'ListDiagnoseInfoForSingleCard',
- ],
+ 'title' => 'Instance groups',
],
[
- 'id' => 172116,
- 'title' => null,
+ 'children' => ['ListOrders', 'ListRegions', 'ListZones'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'GrantNetLink',
- 'RevokeNetLink',
- ],
- ],
- [
- 'id' => 172767,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'CreateWirelessCloudConnectorGroup',
- 'UpdateWirelessCloudConnectorGroup',
- 'ListWirelessCloudConnectorGroups',
- 'DeleteWirelessCloudConnectorGroup',
- 'AddWirelessCloudConnectorToGroup',
- 'RemoveWirelessCloudConnectorFromGroup',
- 'CreateGroupAuthorizationRule',
- 'UpdateGroupAuthorizationRule',
- 'ListGroupAuthorizationRules',
- 'DeleteGroupAuthorizationRule',
- 'AddGroupDnsAuthorizationRule',
- 'UpdateGroupDnsAuthorizationRule',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'ListRegions' => [
- 'summary' => '查询5G高速上云服务支持的REGION',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddDNSAuthorizationRule' => [
+ 'summary' => 'Create a DNS authorization rule.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- 'default' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Name, with a maximum length of 128 characters.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '',
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Description, with a maximum length of 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'ar5g-test', 'title' => ''],
],
- ],
- '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":""}]',
- ],
- 'ListZones' => [
- 'summary' => '查询5G高速上云服务支持的可用区',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'SourceDNSIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DNS server address.', 'type' => 'string', 'required' => true, 'example' => '0.0.0.0', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
+ [
+ 'name' => 'DestinationIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DNS server address to be redirected.', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1', 'title' => ''],
],
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
+ ],
+ [
+ 'name' => 'DryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating a DNS authorization rule. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, a DNS authorization rule is created.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C2C1DE7C-E14C-53DE-920D-D63ACD7421A4',
- ],
- 'Zones' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ZoneId' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- ],
- 'LocalName' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'AuthorizationRuleId' => ['description' => 'The ID of the generated DNS authorization rule.', 'type' => 'string', 'example' => 'ar5g-xxxx', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'OpenCc5gService' => [
- 'summary' => '开通5G高速上云服务',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"AuthorizationRuleId\\": \\"ar5g-xxxx\\"\\n}","type":"json"}]',
+ 'title' => 'Create a DNS authorization rule',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDNSAuthorizationRule'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddDNSAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AddGroupDnsAuthorizationRule' => [
+ 'summary' => 'Create a DNS authorization rule for an instance group.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the instance group.', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2DCFA69E-A161-512D-99A7-108022580719',
- ],
- ],
- ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Name, which can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\"\\n}","type":"json"}]',
- ],
- 'GetCreateCustomerInformation' => [
- 'summary' => '获取录入客户资料的相关信息',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Description of the authorization rule. The description can be up to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ar5gg-test'."\n", 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
+ [
+ 'name' => 'SourceDNSIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DNS server address.', 'type' => 'string', 'required' => true, 'example' => '114.114.114.114', 'title' => ''],
],
- ],
- 'parameters' => [
[
- 'name' => 'RegionId',
+ 'name' => 'DestinationIp',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The DNS server address to which traffic is redirected.', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxx',
- ],
+ 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. Generate a unique value from your client for each request. The value must contain only ASCII characters and cannot exceed 64 characters in length.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
+ ],
+ [
+ 'name' => 'DryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating the instance. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the system returns an HTTP 2xx status code and creates the instance.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AE0BA8E5-1E0C-5171-852F-826301C76BBE',
- ],
- 'URL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://*******',
- ],
- 'CanBuyCard' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'True',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914'],
+ 'AuthorizationRuleId' => ['description' => 'The ID of the generated DNS authorization rule.', 'type' => 'string', 'example' => 'ar5gg-12fnojjtkkre28t08j', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE0BA8E5-1E0C-5171-852F-826301C76BBE\\",\\n \\"URL\\": \\"https://*******\\",\\n \\"CanBuyCard\\": \\"True\\"\\n}","type":"json"}]',
- ],
- 'ListAPNs' => [
- 'summary' => '查询5G高速上云服务支持的APN列表',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\",\\n \\"AuthorizationRuleId\\": \\"ar5gg-12fnojjtkkre28t08j\\"\\n}","type":"json"}]',
+ 'title' => 'Create a Group DNS Authorization Rule',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddGroupDnsAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddGroupDnsAuthorizationRule'],
+ ],
],
+ ],
+ 'AddWirelessCloudConnectorToGroup' => [
+ 'summary' => 'Add a CC5G instance to a CC5G instance group.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -458,153 +250,89 @@
'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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the instance group.', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****', 'title' => ''],
],
[
- 'name' => 'APN',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CMWAP',
+ 'description' => 'A list of IDs of cloud instances for 5G, with a maximum of 20 IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of a cloud instance for 5G.', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 20,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ISP',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'unicom',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without adding the instance. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the instance is added and an HTTP 2xx status code is returned.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A175C091-3910-51AF-8D84-D5717B9B8D38',
- ],
- 'APNs' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ISP' => [
- 'title' => '资源一级ID',
- 'description' => '代表资源一级ID的资源属性字段',
- 'type' => 'string',
- 'example' => 'unicom',
- ],
- 'APN' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'zjhzaliyun01s.5gjs.njiot',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Zones' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vhNxI+jwQfkLCUChCQ+iOoiRkyUbtAilGSvWuwktFBxF+bar2HpV0efI6n1+GkMv',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- '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":""}]',
- ],
- 'CreateWirelessCloudConnector' => [
- 'summary' => '创建5G高速上云服务实例',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => 'Add a CC5G instance to a group',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddWirelessCloudConnectorToGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddWirelessCloudConnectorToGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AttachVpcToNetLink' => [
+ 'summary' => 'Associate the user\'s virtual private cloud (VPC) and vSwitch with a 5G high-speed cloud instance. ',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -613,176 +341,98 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'ISP',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'unicom',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'Description',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The ID of the 5G high-speed cloud instance. ', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'UseCase',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The network connectivity ID. ', 'type' => 'string', 'required' => true, 'example' => 'cciot-xxxx', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the virtual private cloud (VPC). ', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1etmgc4vooo5ahbkzou', 'title' => ''],
],
[
- 'name' => 'NetLinks',
+ 'name' => 'VSwitches',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'The vSwitches under the customer\'s virtual private cloud (VPC). You must specify two vSwitches for active-standby redundancy, and their zones must match the zone of the network connectivity. ',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc-xxx',
- ],
- 'VSwitchs' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => 'vSwitch ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vsw-xxxx',
- ],
- 'required' => true,
- 'maxItems' => 2,
- 'minItems' => 2,
- ],
- 'APN' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'zjalyjs01s.5gjs.njiot',
- ],
- ],
- 'required' => false,
- ],
+ 'items' => ['description' => 'The ID of the vSwitch. ', 'type' => 'string', 'required' => true, 'example' => 'vsw-xxxx', 'title' => ''],
'required' => true,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'The region ID. ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters. '."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken identity. The RequestId may differ for each API request. ', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'BusinessType',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Business',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform only a dry run of the request. Valid values: '."\n"
+ .'- **true**: Sends a dry run request without associating the user\'s VPC and vSwitch. The system checks whether required parameters are provided, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned. '."\n"
+ .'- **false** (default): Sends a normal request. After passing the checks, the user\'s VPC and vSwitch are associated with the 5G high-speed cloud instance. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E1E237B1-EED7-55D5-AE5F-671E642DB3B5',
- ],
- 'WirelessCloudConnectorId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1E237B1-EED7-55D5-AE5F-671E642DB3B5\\",\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\"\\n}","type":"json"}]',
- ],
- 'DeleteWirelessCloudConnector' => [
- 'summary' => '删除5G高速上云服务实例',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => 'Associate user VPC and 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}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachVpcToNetLink'],
+ ],
],
+ ],
+ 'CreateAuthorizationRule' => [
+ 'summary' => 'Create an authorization rule.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -791,184 +441,133 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'The Name of the authorization rule. The name can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- ],
- ],
+ 'schema' => ['description' => 'The description of the authorization rule. The description can be up to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ar5g-test', 'title' => ''],
],
- ],
- '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' => 'The source CIDR block.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'UpdateWirelessCloudConnector' => [
- 'summary' => '修改5G高速上云服务实例',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'DestinationType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type of the destination. Valid values:'."\n"
+ .'- **Cidr**: CIDR block'."\n"
+ .'- **Domain**: Domain name or wildcard domain name', 'type' => 'string', 'required' => true, 'example' => 'Cidr', 'title' => ''],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The protocol type. Valid values:'."\n"
+ .'- **icmp**: Internet Control Message Protocol.'."\n"
+ .'- **tcp**: Transmission Control Protocol.'."\n"
+ .'- **udp**: User Datagram Protocol.'."\n"
+ .'- **all**: All protocols are supported.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''],
],
- ],
- 'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'DestinationPort',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'The destination port range. Valid values:'."\n"
+ ."\n"
+ .'- For TCP and UDP protocols: 1 to 65535. Separate the start port and stop port with a forward slash (/). Example: 1/200.'."\n"
+ ."\n"
+ .'- For ICMP protocol: -1/-1.'."\n"
+ ."\n"
+ .'- For ALL: -1/-1.', 'type' => 'string', 'required' => false, 'example' => '-1/-1', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'Destination',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The destination IP address or domain name.', 'type' => 'string', 'required' => true, 'example' => '10.0.0.1', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'Policy',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-test',
- ],
+ 'schema' => ['description' => 'The policy of the authorization rule. Valid values:'."\n"
+ .'- **Permit**: Allow'."\n"
+ .'- **Deny**: Deny', 'type' => 'string', 'required' => true, 'example' => 'Permit', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. Generate a unique value from your client for this parameter across different requests. The value must contain only ASCII characters and cannot exceed 64 characters in length.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating the authorization rule. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the authorization rule is created immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '61202DF5-668B-5EDA-8177-F2D71F4737C1'],
+ 'AuthorizationRuleId' => ['description' => 'The authorization rule ID.', 'type' => 'string', 'example' => 'ar5g-12fnojjtkkre28t08j', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- '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' => 'Create an authorization rule',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-18T13:33:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-06-23T08:23:56.000Z', 'description' => 'Error codes changed'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateBatchOperateCardsTask' => [
+ 'summary' => 'Creates a batch card operation task.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -977,454 +576,356 @@
'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' => 'The name of the batch operation task.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the batch operation task.', 'type' => 'string', 'required' => false, 'example' => 'task- test', 'title' => ''],
+ ],
+ [
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Statuses',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Available',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Ensures the idempotence of the request. Generate a parameter value from your client to make sure that the value is unique among different requests. This parameter supports only ASCII characters and cannot exceed 64 characters in length.'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorIds',
+ 'name' => 'DryRun',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run for this request. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Sends a check request without creating a batch card operation task. The system checks for required parameters, request format, and service limits. If the check fails, the system returns a corresponding error. If the check passes, the system returns the `DryRunOperation` error code.'."\n"
+ ."\n"
+ .'- **false** (default): Sends a normal request and creates a batch card operation task after the check passes.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'Names',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'A list of IDs of 5G cloud connectors. You can specify up to 10 IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cc5g-xxxx', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'A list of Integrated Circuit Card Identifiers (ICCIDs) of the cards. You can specify up to 200 ICCIDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ICCID of a card.', 'type' => 'string', 'required' => false, 'example' => '890912389123', 'title' => ''],
'required' => false,
- 'example' => 'iou001238joojjaere',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'IccidsOssFilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The path where the ICCID file is stored.', 'type' => 'string', 'required' => false, 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***', 'title' => ''],
],
[
- 'name' => 'BusinessType',
+ 'name' => 'OperateType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Business',
- ],
+ 'schema' => ['description' => 'The restriction type. Valid values:'."\n"
+ ."\n"
+ .'- **BreakNetwork**: Disconnects the network when the data usage threshold is reached.'."\n"
+ ."\n"
+ .'- **LimitRate**: Throttles the network speed when the data usage threshold is reached.'."\n"
+ ."\n"
+ .'- **Alarm**: Sends an alert when the data usage threshold is reached.', 'type' => 'string', 'required' => true, 'example' => 'BreakNetwork', 'title' => ''],
],
[
- 'name' => 'IsInGroup',
+ 'name' => 'Threshold',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The data usage threshold. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'EffectType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => 'The effective type. Valid values:'."\n"
+ ."\n"
+ .'- **CurrentMonth**: Takes effect in the current month.'."\n"
+ ."\n"
+ .'- **ContinualMonth**: Takes effect for consecutive months.', 'type' => 'string', 'required' => true, 'example' => 'CurrentMonth', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'WirelessCloudConnectors' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorId' => [
- 'title' => '资源一级ID',
- 'description' => '代表资源一级ID的资源属性字段',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-test',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'UseCase' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DataPackageId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dp-xxxx',
- ],
- 'DataPackageType' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'CC5G',
- ],
- 'WirelessCloudConnectorGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5gg-****',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'BatchOperateCardsTaskId' => ['description' => 'The ID of the batch operation task.', 'type' => 'string', 'example' => 'boct-xxxx', 'title' => ''],
+ 'OperateResultOssFilePath' => ['description' => 'The file path of the batch operation result.', 'type' => 'string', 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'AttachVpcToNetLink' => [
- 'summary' => '创建5G高速上云服务实例下的网络连接',
- 'methods' => [
- 'post',
+ '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' => 'Create a batch operation card job ',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-27T13:14:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-05-30T07:48:47.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBatchOperateCardsTask'],
+ ],
],
+ ],
+ 'CreateGroupAuthorizationRule' => [
+ 'summary' => 'Create an authorization rule for a CC5G group.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the Wireless Cloud Connector group instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****', 'title' => ''],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => 'Name, which can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'VpcId',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc-bp1etmgc4vooo5ahbkzou',
- ],
+ 'schema' => ['description' => 'The description of the authorization rule. The description can be up to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ar5gg-test', 'title' => ''],
],
[
- 'name' => 'VSwitches',
+ 'name' => 'SourceCidr',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vsw-xxxx',
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => 'The source CIDR block.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'DestinationType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The type of the destination. Valid values:'."\n"
+ .'- **Cidr**: CIDR block'."\n"
+ .'- **Domain**: Domain name or wildcard domain name'."\n"
+ .'- **IpPort**: IP redirection', 'type' => 'string', 'required' => true, 'example' => 'Cidr', 'title' => ''],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The protocol type. Valid values:'."\n"
+ .'- **icmp**: Internet Control Message Protocol'."\n"
+ .'- **tcp**: Transmission Control Protocol'."\n"
+ .'- **udp**: User Datagram Protocol'."\n"
+ .'- **all**: All protocols are supported', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''],
+ ],
+ [
+ 'name' => 'DestinationPort',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Target port range. Valid values:'."\n"
+ ."\n"
+ .'- For TCP and UDP protocols: 1 to 65535. Separate the start port and stop port with a forward slash (/). Example: 1/200.'."\n"
+ ."\n"
+ .'- For ICMP protocol: -1/-1.'."\n"
+ ."\n"
+ .'- For ALL: -1/-1.', 'type' => 'string', 'required' => false, 'example' => '-1/-1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Destination',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination address or domain name.', 'type' => 'string', 'required' => true, 'example' => '106.14.175.4', 'title' => ''],
+ ],
+ [
+ 'name' => 'Policy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The policy of the authorization rule. Valid values:'."\n"
+ .'- **Permit**: Allow'."\n"
+ .'- **Deny**: Deny', 'type' => 'string', 'required' => true, 'example' => 'Permit', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. Generate a unique value from your client for this parameter to differentiate between requests. The value must contain only ASCII characters and cannot exceed 64 characters in length.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating the instance. The system checks whether required parameters are specified, whether the request format is valid, and whether the request complies with business limits. If the check fails, the corresponding error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, an HTTP 2xx status code is returned and the instance is created.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03'],
+ 'AuthorizationRuleId' => ['description' => 'The authorization rule ID.', 'type' => 'string', 'example' => 'ar5gg-xxxx', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'DetachVpcFromNetLink' => [
- 'summary' => '解除5G高速上云服务实例下的网络连接和VPC的绑定',
- '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' => 'Create Group Authorization Rule',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupAuthorizationRule'],
+ ],
],
+ ],
+ 'CreateIoTCloudConnectorBackhaulRoute' => [
+ 'summary' => 'In scenarios where the reverse access advanced feature is enabled, configure reverse access routing for the connected instance.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'ID of the 5G high-speed cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => 'Network connectivity ID.', 'type' => 'string', 'required' => false, 'example' => 'cciot-xxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken identity. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating the instance group. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, an HTTP 2xx status code is returned and the operation is performed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'GetWirelessCloudConnector' => [
- 'summary' => '查询5G高速上云服务实例详情',
- 'methods' => [
- 'get',
+ 'title' => 'Create reverse access routing for a 5G high-speed cloud instance',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-28T11:47:33.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateIoTCloudConnectorBackhaulRoute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'],
+ ],
],
+ ],
+ 'CreateWirelessCloudConnector' => [
+ 'summary' => 'Create an Express Cloud Connect instance for 5G.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1433,491 +934,223 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The carrier of the Express Cloud Connect instance for 5G. Valid values:'."\n"
+ .'- **telecom**: China Telecom.'."\n"
+ .'- **mobile**: China Mobile.'."\n"
+ .'- **unicom**: China Unicom.', 'type' => 'string', 'required' => true, 'example' => 'unicom', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'NetLinks' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => ' ',
- 'type' => 'object',
- 'properties' => [
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'NetLinkId' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'cciot-xxxx',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Attached',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Standard',
- ],
- 'APN' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bjaliyun01s.5gbj.bjiot',
- ],
- 'ISP' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Telecom',
- ],
- 'VpcId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vpc-xxxx',
- ],
- 'VSwitchs' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vsw-xxxx',
- ],
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'GrantAliUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '11111111111',
- ],
- ],
- ],
- ],
- 'WirelessCloudConnectorId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-test',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'UseCase' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DataPackageId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dp-xxxx',
- ],
- 'DataPackageType' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'cc5gg-****',
- ],
- 'Features' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[\'DirectMode\']',
- ],
- ],
- 'ServiceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CC5GCCIoT',
- ],
- ],
- ],
+ 'schema' => ['description' => 'Name', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
- ],
- '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"}]',
- ],
- 'ListDataPackages' => [
- 'summary' => '查询5G高速上云服务实例下的带宽包列表',
- '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' => 'Description of the Express Cloud Connect service.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
- ],
- 'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'UseCase',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'Scenarios', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'Statuses',
+ 'name' => 'RegionId',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Available',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'DataPackageIds',
+ 'name' => 'NetLinks',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'List of established cloud connectors.',
'type' => 'array',
'items' => [
- 'type' => 'string',
+ 'description' => 'List of established cloud connectors.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ 'VpcId' => ['description' => 'Virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-xxx', 'title' => ''],
+ 'VSwitchs' => [
+ 'description' => 'Virtual switch ID.',
+ 'type' => 'array',
+ 'items' => ['description' => 'vSwitch ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxx', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 2,
+ 'minItems' => 2,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'APN' => ['description' => 'Carrier APN ID.', 'type' => 'string', 'required' => true, 'example' => 'zjalyjs01s.5gjs.njiot', 'title' => ''],
+ ],
'required' => false,
- 'example' => 'dp-xxxx',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
+ 'required' => true,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Names',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-123',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters. For more information, see How to ensure idempotence.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating the instance group. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, the corresponding error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, an HTTP 2xx status code is returned and the operation is performed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'BusinessType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'Business type', 'type' => 'string', 'required' => false, 'example' => 'Business', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
- ],
- 'DataPackages' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'DataPackageId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dp-xxxx',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ISP' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Telecom',
- ],
- 'Size' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'E1E237B1-EED7-55D5-AE5F-671E642DB3B5'],
+ 'WirelessCloudConnectorId' => ['description' => 'The ID of the Express Cloud Connect instance for 5G.', 'type' => 'string', 'example' => 'cc5g-xxxx', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'CreateIoTCloudConnectorBackhaulRoute' => [
- 'summary' => '下发iotcc实例的回程路由',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1E237B1-EED7-55D5-AE5F-671E642DB3B5\\",\\n \\"WirelessCloudConnectorId\\": \\"cc5g-xxxx\\"\\n}","type":"json"}]',
+ 'title' => 'Create an Express Cloud Connect instance for 5G',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-23T07:55:15.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-27T08:34:24.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-20T09:15:37.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWirelessCloudConnector'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [
+ ['action' => 'ram:CreateServiceLinkedRole', 'validationType' => 'always'],
+ ],
+ ],
],
+ ],
+ 'CreateWirelessCloudConnectorGroup' => [
+ 'summary' => 'Create a CC5G instance group.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'The name of the instance group. The name can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => 'The description of the Express Cloud Connect group.', 'type' => 'string', 'required' => false, 'example' => 'cc5gg-test', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating the instance. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, an HTTP 2xx status code is returned and the instance is created.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'."\n"],
+ 'WirelessCloudConnectorGroupId' => ['description' => 'The ID of the instance group.', 'type' => 'string', 'example' => 'cc5gg-****', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'DeleteIoTCloudConnectorBackhaulRoute' => [
- 'summary' => '删除iotcc实例的回程路由',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88C2F32F-B641-5980-B7A5-6907050ABCD1\\\\n\\",\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-****\\"\\n}","type":"json"}]',
+ 'title' => 'Create Group',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWirelessCloudConnectorGroup'],
+ ],
],
+ ],
+ 'DeleteAuthorizationRule' => [
+ 'summary' => 'Delete an authorization rule.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1929,80 +1162,72 @@
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the authorization rule.', 'type' => 'string', 'required' => true, 'example' => 'ar5g-xxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without deleting the authorization rule. The system checks whether required parameters are specified, whether the request format is valid, and whether the request complies with business limits. If the check fails, the corresponding error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the authorization rule is deleted immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\"\\n}","type":"json"}]',
- ],
- 'ModifyWirelessCloudConnectorFeature' => [
- 'summary' => '修改5G高速上云服务实例属性',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => 'Delete an authorization rule',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAuthorizationRule'],
+ ],
],
+ ],
+ 'DeleteBatchOperateCardsTask' => [
+ 'summary' => 'Delete a batch operations card job. ',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2011,220 +1236,77 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'FeatureName',
+ 'name' => 'BatchOperateCardsTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'DirectMode' => 'DirectMode',
- ],
- 'example' => 'DirectMode',
- ],
+ 'schema' => ['description' => 'The ID generated when creating the batch operations job. ', 'type' => 'string', 'required' => true, 'example' => 'boct-xxx', 'title' => ''],
],
[
- 'name' => 'FeatureValue',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'On',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters. '."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken identity. The RequestId may differ for each API request. ', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values: '."\n"
+ .'- **true**: Sends a dry run request without deleting the batch operations card job. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned. '."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the batch operations card job is deleted. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The region ID. ', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '999E0F64-9A10-567B-BB84-B7C46023BA3B',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"999E0F64-9A10-567B-BB84-B7C46023BA3B\\"\\n}","type":"json"}]',
- ],
- 'ListIoTCloudConnectorBackhaulRoute' => [
- 'summary' => '查询iotcc实例回程路由',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a batch operations card job ',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-30T07:48:47.000Z', 'description' => 'OpenAPI offline'],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBatchOperateCardsTask'],
],
],
- 'parameters' => [
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
- ],
- [
- 'name' => 'WirelessCloudConnectorId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'NetLinkId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cciot-xxxx',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '94032572-8758-575E-B306-86F59D1B826E',
- ],
- 'NetLinkId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'eni-uf677iw3xihqxiz2ssir',
- ],
- 'NextHopType' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'NetworkInterface',
- ],
- 'Description' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'full cidr block route',
- ],
- 'Status' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'published',
- ],
- ],
- ],
- ],
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- '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"}]',
],
- 'SwitchWirelessCloudConnectorToBusiness' => [
- 'summary' => '切换cc5g实例商业类型到商业版',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteGroupAuthorizationRule' => [
+ 'summary' => 'Delete the CC5G group authorization rule.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2233,305 +1315,154 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'The instance ID of the instance group.', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****', 'title' => ''],
+ ],
+ [
+ 'name' => 'AuthorizationRuleId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'ar5gg-12fnojjtkkre28t08j', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken identity. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating the authorization rule. The system checks whether required parameters are specified, whether the request format is valid, and whether the request complies with business limits. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the authorization rule is created immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'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' => 'The request ID.', 'type' => 'string', 'example' => 'A175C091-3910-51AF-8D84-D5717B9B8D38'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74ADDCF3-E3FE-5200-9290-1320125D71DC\\"\\n}","type":"json"}]',
- ],
- 'ListOrders' => [
- 'summary' => '查询5G高速上云服务实例下的订单列表',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A175C091-3910-51AF-8D84-D5717B9B8D38\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Group Authorization Rule',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupAuthorizationRule'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteIoTCloudConnectorBackhaulRoute' => [
+ 'summary' => 'In scenarios where the reverse access advanced feature is enabled, delete the reverse access route for the connected instance.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'Statuses',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Pending',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the 5G high-speed cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'OrderIds',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890******',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the network connectivity.', 'type' => 'string', 'required' => false, 'example' => 'cciot-xxxx', 'title' => ''],
],
[
- 'name' => 'OrderAction',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NewBuy',
- ],
- ],
- [
- 'name' => 'NextToken',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating an authorization rule. The system checks whether required parameters are specified, whether the request format is valid, and whether the request complies with service limits. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the authorization rule is created immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'."\n",
- ],
- 'Orders' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89************',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'Pending',
- ],
- 'Action' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'NewBuy',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'order-test',
- ],
- 'LogisticsId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SF14*********',
- ],
- 'LogisticsStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Signed',
- ],
- 'LogisticsType' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'CardType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CONSUMER_THREE_IN_ONE',
- ],
- 'CardNetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5G',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03'],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'LockCards' => [
- 'summary' => '运营商侧卡停机',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\"\\n}","type":"json"}]',
+ 'title' => 'Delete the reverse access route of a 5G high-speed cloud instance',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-28T11:47:33.000Z', 'description' => 'OpenAPI offline'],
],
- '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' => 'Delete a 5G high-speed cloud instance.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2540,90 +1471,80 @@
'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' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
- ],
- [
- 'name' => 'RegionId',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the 5G high-speed cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken identity. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform only a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without deleting the instance. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the system returns an HTTP 2xx status code and deletes the instance.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
- ],
- 'UnlockCards' => [
- 'summary' => '批量解锁卡',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.ExistCards', 'errorMessage' => 'The operation is not allowed because of exist cards.', 'description' => ''],
+ ['errorCode' => 'OperationDenied.AttachedVpc', 'errorMessage' => 'The operation is not allowed because of exist vpc.', 'description' => 'The operation is denied because a bound VPC exists.'],
+ ['errorCode' => 'OperationDenied.ExistCustomerAuthorizationRules', 'errorMessage' => 'The operation is not allowed because of exist customer authorizationRule.', 'description' => 'The operation is denied because a custom authorization rule exists in the current instance.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a 5G high-speed cloud instance',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-30T09:09:34.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-11-29T08:53:36.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteWirelessCloudConnectorGroup' => [
+ 'summary' => 'Delete a CC5G instance group.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2632,190 +1553,147 @@
'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' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
- ],
- [
- 'name' => 'RegionId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the instance group to delete.', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without deleting the instance. The system checks whether required parameters are specified, whether the request format is valid, and whether the request complies with business limits. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, an HTTP 2xx status code is returned and the instance is deleted.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '81CB64DF-E328-50A3-B386-03CAD604C114',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2E759287-F208-589B-82D8-6D7A30F417E3'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CardsSimStatusNotUnlock',
- 'errorMessage' => 'The operation is not allowed because of card status not support to unlock.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E759287-F208-589B-82D8-6D7A30F417E3\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Group',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWirelessCloudConnectorGroup'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81CB64DF-E328-50A3-B386-03CAD604C114\\"\\n}","type":"json"}]',
],
- 'StopCards' => [
- 'summary' => '运营商侧卡停机',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DetachVpcFromNetLink' => [
+ 'summary' => 'Cancel the association between the user\'s VPC and 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' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The network connectivity ID.', 'type' => 'string', 'required' => true, 'example' => 'cciot-xxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter across different requests. The value must contain only ASCII characters and cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without canceling the association. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the association between the user\'s VPC and VSwitch is canceled immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
- ],
- 'ResumeCards' => [
- 'summary' => '激活单卡运营商侧卡状态恢复',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => 'Cancel the association between VPC and 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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'FailCards' => [
+ 'summary' => 'Cancel card.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2827,57 +1705,71 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'Iccids',
'in' => 'query',
- 'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'List of ICCIDs of the cards. A maximum of 200 ICCIDs are allowed.',
'type' => 'array',
'items' => [
+ 'description' => 'ICCID of the Internet of Things card.',
'type' => 'string',
'required' => false,
- 'example' => '890912389123',
+ 'enumValueTitles' => [],
+ 'example' => '8986*******',
+ 'title' => '',
],
'required' => true,
- 'maxItems' => 1000,
+ 'enumValueTitles' => [],
+ 'example' => 'FailCards',
+ 'maxItems' => 50,
'minItems' => 1,
+ 'title' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Region ID',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'cn-hangzhou',
+ 'title' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Ensures idempotence of the request. '."\n"
+ .'Generate a unique value for this parameter from your client to guarantee uniqueness across different requests. ClientToken supports only ASCII characters.'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the system automatically uses the **RequestId** of the API request as the **ClientToken**. The **RequestId** may differ for each API request.',
'type' => 'string',
'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'enumValueTitles' => [],
+ 'example' => 'TF-CreateServerlessDBInstance-1639649079-51d933f6-0251-4057-9276',
+ 'title' => '',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Specifies whether to only perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without activating or recovering the card status. The system checks whether required parameters are provided, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. After passing the checks, the card status is activated or recovered.',
'type' => 'boolean',
'required' => false,
- 'example' => 'true',
+ 'enumValueTitles' => [],
+ 'example' => 'false',
+ 'title' => '',
],
],
],
@@ -2885,143 +1777,158 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '186B6E37-D9D1-5E64-ACDE-E89F7E68A37B'],
],
+ 'enumValueTitles' => [],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'OperationDenied.CardsSimStatusNotResume',
- 'errorMessage' => 'The operation is not allowed because of card status not support to resume.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"186B6E37-D9D1-5E64-ACDE-E89F7E68A37B\\"\\n}","type":"json"}]',
+ 'title' => 'Cancel Card',
+ 'description' => '**The card cancellation operation is irreversible. Exercise caution when performing this action.**',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-04T13:01:19.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
],
- 'UpdateCard' => [
- 'summary' => '修改5G高速上云服务实例的连接描述和名称信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetCard' => [
+ 'summary' => 'Obtain information about a single SIM card.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
- ],
- [
- 'name' => 'DryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'ICCID of the IoT SIM card.', 'type' => 'string', 'required' => true, 'example' => '11111111111', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
- 'description' => '',
+ 'description' => 'Request ID',
'type' => 'string',
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
+ 'enumValueTitles' => [],
+ 'example' => '0B28B72A-BD16-51F7-AAEE-55247FE02729',
],
+ 'Iccid' => ['description' => 'ICCID of the IoT SIM card.', 'type' => 'string', 'example' => '111111111', 'title' => ''],
+ 'NetType' => ['description' => 'Network type. Valid values:'."\n"
+ ."\n"
+ .'- **4G**'."\n"
+ .'- **5G**', 'type' => 'string', 'example' => '5G', 'title' => ''],
+ 'APN' => ['description' => 'ID of the carrier\'s APN.', 'type' => 'string', 'example' => 'zjalyjs01s.5gjs.njiot', 'title' => ''],
+ 'ISP' => ['description' => 'Carrier of the 5G high-speed cloud instance. Valid values:'."\n"
+ .'- **telecom**: China Telecom'."\n"
+ .'- **mobile**: China Mobile'."\n"
+ .'- **unicom**: China Unicom', 'type' => 'string', 'example' => 'Unicom', 'title' => ''],
+ 'IpAddress' => ['description' => 'Static IP address of the IoT SIM card.', 'type' => 'string', 'example' => '172.24.2.121', 'title' => ''],
+ 'Imsi' => ['description' => 'International Mobile Subscriber Identity (IMSI) of the IoT SIM card.', 'type' => 'string', 'example' => '12123123', 'title' => ''],
+ 'Imei' => ['description' => 'International Mobile Equipment Identity (IMEI) of the device.', 'type' => 'string', 'example' => '23412313513512', 'title' => ''],
+ 'Lock' => ['description' => 'Indicates whether the SIM card is locked.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'Spec' => ['description' => 'Specification', 'type' => 'string', 'example' => 'CONSUMER_THREE_IN_ONE', 'title' => ''],
+ 'SimStatus' => ['description' => 'SIM card status. Valid values:'."\n"
+ ."\n"
+ .'- **Testable**: Testing'."\n"
+ .'- **Activatable**: Activatable'."\n"
+ .'- **Activated**: Activated'."\n"
+ .'- **Deactivated**: Deactivated'."\n"
+ .'- **Failed**: Out Of Effect'."\n"
+ .'- **Cleared**: Purged'."\n"
+ .'- **Replaced**: Replaced'."\n"
+ .'- **Resuming**: Recovering'."\n"
+ .'- **ShutDown**: Shut down', 'type' => 'string', 'example' => 'Deactivated', 'title' => ''],
+ 'Status' => ['description' => 'Instance status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creation in progress'."\n"
+ .'- **Available**: Valid and stable state'."\n"
+ .'- **UnAvailable**: Invalid state'."\n"
+ .'- **Pending**: Configuration in progress'."\n"
+ .'- **Deleting**: Deletion in progress', 'type' => 'string', 'example' => 'Available', 'title' => ''],
+ 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'task-test', 'title' => ''],
+ 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'WirelessCloudConnectorId' => ['description' => 'ID of the 5G high-speed cloud instance.', 'type' => 'string', 'example' => 'cc5g-xxxxxxx', 'title' => ''],
+ 'CloudConnectorId' => ['description' => 'Cloud connector ID.', 'type' => 'string', 'example' => 'iotcc-xxxxxxxx', 'title' => ''],
+ 'UsageDataMonth' => ['description' => 'Traffic used this month, in MB. '."\n"
+ .'Due to certain external factors, synchronization delays may occur for this field. We recommend that you use [ListCardUsages](https://help.aliyun.com/document_detail/472077.html?spm=a2c4g.438976.0.0.8bbc1711r5XXDT) to query traffic information for a single SIM card.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'OrderId' => ['description' => 'Order ID.', 'type' => 'string', 'example' => '12312341234124', 'title' => ''],
+ 'ActivatedTime' => ['description' => 'Activation time.', 'type' => 'string', 'example' => '2022-08-25 17:34:57', 'title' => ''],
+ 'Msisdn' => ['description' => 'MSISDN of the IoT SIM card.', 'type' => 'string', 'example' => '2312341231235', 'title' => ''],
+ 'UsageDataTotal' => ['description' => 'Total usage of the SIM card, in MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'LimitThreshold' => ['description' => 'Data usage threshold for throttling, in MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
+ 'StopThreshold' => ['description' => 'Data usage threshold for suspending the service, in MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''],
+ 'AlarmThreshold' => ['description' => 'Alert threshold, in MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
- ],
- 'ListCards' => [
- 'summary' => '查询5G高速上云服务实例的连接列表',
- 'methods' => [
- 'get',
+ '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' => 'Retrieve single SIM card information',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-09T11:30:42.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetCardLockReason' => [
+ 'summary' => 'Obtain the Edit Lock reason.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3033,295 +1940,63 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'Statuses',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Activated',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Iccids',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '89091231231219123',
- ],
- 'required' => false,
- 'enumValueTitles' => [],
- ],
- ],
- [
- 'name' => 'IpAddress',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-xxxx',
- ],
- ],
- [
- 'name' => 'Apn',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8909123123121912',
- ],
- ],
- [
- 'name' => 'Msisdn',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1441204374591',
- ],
+ 'schema' => ['description' => 'ICCID of the Internet of Things card.', 'type' => 'string', 'required' => true, 'example' => '*********11111', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '代表资源一级ID的资源属性字段',
- 'type' => 'string',
- 'example' => '89091231231219123',
- ],
- 'NetType' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => '5G',
- ],
- 'APN' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'bjaliyun01s.5gbj.bjiot',
- ],
- 'ISP' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Telecom',
- ],
- 'IpAddress' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10.0.0.118',
- ],
- 'Imsi' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '8912039123',
- ],
- 'Imei' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7896129300',
- ],
- 'Lock' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Spec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CONSUMER_THREE_IN_ONE',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'UsageDataMonth' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Msisdn' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1441204374591',
- ],
- 'UsageDataTotal' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'F32C0BBE-5025-5561-8976-7BD096BA21FB'],
+ 'LockReason' => [
+ 'description' => 'Edit Lock reason.',
'type' => 'string',
- 'example' => '2',
+ 'enumValueTitles' => ['CreditTwoWayStop' => 'CreditTwoWayStop', 'ExpireStop' => 'ExpireStop', 'ActiveTwoWayStop' => 'ActiveTwoWayStop', 'LocationStop' => 'LocationStop', 'NoReasonStop' => 'NoReasonStop', 'SeparationStop' => 'SeparationStop', 'M2MStop' => 'M2MStop', 'ForceTwoWayStop' => 'ForceTwoWayStop'],
+ 'example' => 'ForceTwoWayStop',
+ 'title' => '',
],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'ListCardUsages' => [
- 'summary' => '查询5G高速上云服务实例的流量信息列表',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F32C0BBE-5025-5561-8976-7BD096BA21FB\\",\\n \\"LockReason\\": \\"ForceTwoWayStop\\"\\n}","type":"json"}]',
+ 'title' => 'Obtain the Edit Lock reason',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-20T06:47:52.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetCreateCustomerInformation' => [
+ 'summary' => 'Obtain the Customer information entry URL and entry status. ',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3333,97 +2008,64 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'Region ID ', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Iccids',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => false,
- 'maxItems' => 50,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => '5G Cloud Connector instance ID. ', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '186B6E37-D9D1-5E64-ACDE-E89F7E68A37B',
- ],
- 'Cards' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Iccid' => [
- 'title' => '资源一级ID',
- 'description' => '代表资源一级ID的资源属性字段',
- 'type' => 'string',
- 'example' => '89091231231219123',
- ],
- 'UsageDataMonth' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID ', 'type' => 'string', 'example' => 'AE0BA8E5-1E0C-5171-852F-826301C76BBE'],
+ 'URL' => ['description' => 'URL for Internet of Things SIM card customer information registration. ', 'type' => 'string', 'example' => 'https://*******', 'title' => ''],
+ 'CanBuyCard' => ['description' => 'Indicates whether the mark has already been registered. If customer information has not been registered, this field is not returned. ', 'type' => 'string', 'example' => 'True', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'GetCard' => [
- 'summary' => '查询5G高速上云服务实例的详细连接信息',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE0BA8E5-1E0C-5171-852F-826301C76BBE\\",\\n \\"URL\\": \\"https://*******\\",\\n \\"CanBuyCard\\": \\"True\\"\\n}","type":"json"}]',
+ 'title' => 'Obtain the Customer information entry URL and entry status ',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-02T06:21:08.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-07-11T12:28:50.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetDiagnoseResultForSingleCard' => [
+ 'summary' => 'Query the network diagnosis result of a single Internet of Things card. ',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3435,171 +2077,194 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'DiagnoseTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '11111111111',
- ],
+ 'schema' => ['description' => 'The Network diagnostic task ID.', 'type' => 'string', 'required' => true, 'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => '0B28B72A-BD16-51F7-AAEE-55247FE02729',
- ],
- 'Iccid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '111111111',
- ],
- 'NetType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5G',
- ],
- 'APN' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'zjalyjs01s.5gjs.njiot',
- ],
- 'ISP' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Unicom',
- ],
- 'IpAddress' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '172.24.2.121',
- ],
- 'Imsi' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12123123',
- ],
- 'Imei' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '23412313513512',
- ],
- 'Lock' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Spec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CONSUMER_THREE_IN_ONE',
- ],
- 'SimStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Deactivated',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-test',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'WirelessCloudConnectorId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-xxxxxxx',
- ],
- 'CloudConnectorId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iotcc-xxxxxxxx',
- ],
- 'UsageDataMonth' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12312341234124',
- ],
- 'ActivatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-08-25 17:34:57',
- ],
- 'Msisdn' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2312341231235',
- ],
- 'UsageDataTotal' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'LimitThreshold' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'StopThreshold' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4096',
+ 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => '94032572-8758-575E-B306-86F59D1B826E', 'title' => ''],
+ 'WirelessCloudConnectorId' => ['description' => '5G cloud access instance ID. ', 'type' => 'string', 'example' => 'cc5g-xxxx', 'title' => ''],
+ 'CardIp' => ['description' => 'The IP address of the source IoT card used for network diagnosis. ', 'type' => 'string', 'example' => '10.176.78.61', 'title' => ''],
+ 'IccId' => ['description' => 'The ID of the source IoT card used for network diagnosis. ', 'type' => 'string', 'example' => '89860477102170127555', 'title' => ''],
+ 'Destination' => ['description' => 'The destination address or domain name for network diagnosis. ', 'type' => 'string', 'example' => '106.14.175.4', 'title' => ''],
+ 'DestinationType' => ['description' => 'Destination type of the network diagnosis. Valid values: '."\n"
+ ."\n"
+ .'- **IP**: indicates that the destination type is an IP address. '."\n"
+ ."\n"
+ .'- **Domain**: indicates that the destination type is a domain name. ', 'type' => 'string', 'example' => 'Domain', 'title' => ''],
+ 'BeginTime' => ['description' => 'UNIX timestamp indicating the start time of the network diagnosis. Unit: seconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1646100223024', 'title' => ''],
+ 'EndTime' => ['description' => 'The UNIX timestamp when the network diagnosis ended. Unit: seconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1646100223264', 'title' => ''],
+ 'Status' => ['description' => 'The status of the network diagnostic task. Valid values: '."\n"
+ ."\n"
+ .'- **success**: Indicates that the diagnosis Succeeded. '."\n"
+ .'- **failed**: Indicates that the diagnosis failed. '."\n"
+ .'- **diagnosing**: Indicates that the diagnosis is in progress. '."\n", 'type' => 'string', 'example' => 'failed', 'title' => ''],
+ 'ErrorResult' => [
+ 'description' => 'List of diagnosis results. ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Diagnosis result. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorLevel' => ['description' => 'Severity level of the diagnosed issue. Valid values: '."\n"
+ ."\n"
+ .'- **Error**: indicates a fault. '."\n"
+ ."\n"
+ .'- **Warning**: indicates a warning. ', 'type' => 'string', 'example' => 'Warning', 'title' => ''],
+ 'ErrorPart' => ['description' => 'Component associated with the diagnosed issue. Valid values: '."\n"
+ ."\n"
+ .'- **CCIOT**: indicates an issue with the cloud connector. '."\n"
+ ."\n"
+ .'- **Card**: indicates an issue with the IoT SIM card. '."\n"
+ ."\n"
+ .'- **Terminal**: indicates an issue with the terminal. '."\n"
+ ."\n"
+ .'- **Server**: indicates an issue with the server. '."\n"
+ ."\n"
+ .'- **Apn**: indicates an issue with the APN. ', 'type' => 'string', 'example' => 'Terminal', 'title' => ''],
+ 'ErrorItem' => ['description' => 'Metric item corresponding to the diagnosed component. For more information, see **Supplementary Description of Response Parameters**. ', 'type' => 'string', 'example' => 'CardStatus', 'title' => ''],
+ 'ErrorDesc' => ['description' => 'Description of the diagnosed issue. ', 'type' => 'string', 'example' => 'Terminal abnormal', 'title' => ''],
+ 'ErrorSuggestion' => ['description' => 'Suggested resolution for the diagnosed issue. ', 'type' => 'string', 'example' => 'Please check whether the terminal and card are compatible or whether the terminal can send messages', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'AlarmThreshold' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
+ 'DiagnoseItem' => [
+ 'description' => 'List of diagnosis items. ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Diagnosis item information. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'Part' => ['description' => 'The name of the diagnosed component. Valid values:'."\n"
+ ."\n"
+ .'- **CCIOT**: cloud connector.'."\n"
+ .'- **Card**: IoT card.'."\n"
+ .'- **Terminal**: terminal.'."\n"
+ .'- **Server**: server.'."\n"
+ .'- **Apn**: APN.', 'type' => 'string', 'example' => 'Terminal', 'title' => ''],
+ 'Status' => ['description' => 'The status of the diagnostic component. Valid values:'."\n"
+ ."\n"
+ .'- **Normal**: indicates that the diagnostic status is normal.'."\n"
+ .'- **Wrong**: indicates that the diagnostic status is faulty.'."\n"
+ .'- **Unknown**: indicates that the diagnostic status is unknown.', 'type' => 'string', 'example' => 'Wrong', 'title' => ''],
+ 'SubItems' => [
+ 'description' => 'The list of diagnostic metrics for the diagnostic component.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A diagnostic metric of the diagnostic component.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SubItem' => ['description' => 'The diagnostic metric item corresponding to the diagnostic component. For more information, see **Supplemental Description of Response Parameters**.', 'type' => 'string', 'example' => 'CardStatus', 'title' => ''],
+ 'SubItemStatus' => ['description' => 'The status of the diagnostic metric. Valid values:'."\n"
+ ."\n"
+ .'- **Normal**: indicates that the diagnostic status is normal.'."\n"
+ .'- **Warnning**: indicates a warning-level fault in the diagnostic status.'."\n"
+ .'- **Minor**: indicates a minor-level fault in the diagnostic status.'."\n"
+ .'- **Major**: indicates a critical-level fault in the diagnostic status.'."\n"
+ .'- **Unknown**: indicates that the diagnostic status is unknown.', 'type' => 'string', 'example' => 'Normal', 'title' => ''],
+ 'SubItemInfo' => ['description' => 'Additional information about the diagnostic metric.', 'type' => 'string', 'example' => 'Card status is real-time', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'enumValueTitles' => [],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'GetCardLockReason' => [
- 'summary' => '查询卡锁定停机的原因',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'Query Single-card Diagnosis Result',
+ 'responseParamsDescription' => 'The diagnostic metric items for each diagnostic component. Valid values: '."\n"
+ ."\n"
+ .'**Part**: Card '."\n"
+ .'- **CardStatus**: Card status '."\n"
+ .'- **CardOnlineStatus**: Card session status '."\n"
+ ."\n"
+ .'**Part**: Apn '."\n"
+ .'- **GreTunnelStatus**: Carrier tunnel status '."\n"
+ ."\n"
+ .'**Part**: CCIOT '."\n"
+ .'- **CciotInstanceStatus**: Cloud connector instance status '."\n"
+ .'- **CciotConnectionPoolConfiged**: Cloud connector connection pool configuration status '."\n"
+ .'- **CciotAuthorizationRulesConfiged**: Cloud connector authorization rule configuration status '."\n"
+ .'- **CardInCciotConnectionPool**: Card is in the cloud connector instance connection pool '."\n"
+ .'- **DestinationInCciotAuthorizationRules**: Destination address is in the cloud connector instance authorization rules '."\n"
+ .'- **DefaultDnsInCciotDnsServiceRules**: Default DNS service endpoint is in the authorization rules '."\n"
+ .'- **DestinationConflictWithIpMapping**: Destination address conflicts with IP mapping '."\n"
+ .'- **CciotAssociateWithVswitch**: Cloud connector instance associates VPC '."\n"
+ .'- **BackhaulRoutePublishedInVpc**: Cloud connector instance backhaul route publish status '."\n"
+ .'- **BackhaulRouteExsited**: Cloud connector instance backhaul route existence status '."\n"
+ .'- **DnsParseStatus**: Cloud connector instance DNS Resolution status '."\n"
+ .'- **AccessLogFromCardToDestination**: Access record from the card to the destination address '."\n"
+ .'- **AccessLogFromDestinationToCard**: Access record from the destination address to the card '."\n"
+ .'- **AccessLogOfCard**: Access record of the card '."\n"
+ .'- **AccessLogOfDesination**: Access record of the destination address '."\n"
+ .'- **DropLogOfCard**: Packet loss record of the card '."\n"
+ .'- **DropLogOfDestination**: Packet loss record of the destination address '."\n"
+ .'- **CciotCardOnlineStatus**: Card online status '."\n",
+ 'changeSet' => [
+ ['createdAt' => '2024-03-07T09:19:39.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-01-05T02:02:59.000Z', 'description' => 'Response parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDiagnoseResultForSingleCard'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'iotcc:GetDiagnoseResultForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetWirelessCloudConnector' => [
+ 'summary' => 'Query the details of a 5G Cloud Connector instance. ',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3611,133 +2276,214 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Iccid',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '*********11111',
- ],
+ 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'WirelessCloudConnectorId',
+ 'in' => 'query',
+ 'schema' => ['description' => '5G high-speed cloud instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => ' ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => 'Request ID. ', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'NetLinks' => [
+ 'title' => '',
+ 'description' => 'List of connections to the user\'s VPC.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => ' ',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'NetLinkId' => ['title' => '', 'description' => 'Network connectivity ID.', 'type' => 'string', 'example' => 'cciot-xxxx'],
+ 'Name' => ['title' => '', 'description' => 'Name.', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => '连接test', 'title' => ''],
+ 'Status' => ['description' => 'Status. Valid values:'."\n"
+ ."\n"
+ .'- **Pending**: Configuring '."\n"
+ .'- **Attached**: Attached '."\n"
+ .'- **Detached**: Detached', 'type' => 'string', 'example' => 'Attached', 'title' => ''],
+ 'Type' => ['description' => 'Type. Valid values:'."\n"
+ ."\n"
+ .'- **Standard**: Standard Edition '."\n"
+ .'- **Basic**: Basic Edition', 'type' => 'string', 'example' => 'Standard', 'title' => ''],
+ 'APN' => ['description' => 'ID of the carrier APN.', 'type' => 'string', 'example' => 'bjaliyun01s.5gbj.bjiot', 'title' => ''],
+ 'ISP' => ['description' => 'Carrier of the card: '."\n"
+ .'- **Telecom**: China Telecom '."\n"
+ .'- **Mobile**: China Mobile '."\n"
+ .'- **Unicom**: China Unicom', 'type' => 'string', 'example' => 'Telecom', 'title' => ''],
+ 'VpcId' => ['description' => 'Virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-xxxx', 'title' => ''],
+ 'VSwitchs' => [
+ 'description' => 'List of attached vSwitches.',
+ 'type' => 'array',
+ 'items' => ['description' => 'vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxxx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreateTime' => ['description' => 'Creation Time of the connection.', 'type' => 'string', 'example' => '2022-03-15 22:20:00', 'title' => ''],
+ 'GrantAliUid' => ['description' => 'UID of the Alibaba Cloud authorizer.', 'type' => 'string', 'example' => '11111111111', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'example' => 'ForceTwoWayStop',
+ 'example' => '',
+ ],
+ 'WirelessCloudConnectorId' => ['description' => '5G Cloud Connector instance ID. ', 'type' => 'string', 'example' => 'cc5g-xxxx', 'title' => ''],
+ 'Status' => ['description' => 'Instance status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creating'."\n"
+ .'- **Available**: Valid and stable'."\n"
+ .'- **Pending**: Configuring'."\n"
+ .'- **Deleting**: Deleting ', 'type' => 'string', 'example' => 'Available', 'title' => ''],
+ 'Name' => ['description' => 'Name. ', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Description' => ['description' => 'Description. ', 'type' => 'string', 'example' => 'cc5g-test', 'title' => ''],
+ 'RegionId' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'UseCase' => ['description' => 'Instance usage scenario. ', 'type' => 'string', 'example' => '智慧工厂', 'title' => ''],
+ 'DataPackageId' => ['description' => 'Data transfer plan ID. ', 'type' => 'string', 'example' => 'dp-xxxx', 'title' => ''],
+ 'DataPackageType' => ['description' => 'Data transfer plan tier. Valid values:'."\n"
+ ."\n"
+ .'- **200**: 200 MB per card per month'."\n"
+ .'- **1000**: 1 GB per card per month'."\n"
+ .'- **3000**: 3 GB per card per month'."\n"
+ .'- **30000**: 30 GB per card per month ', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'CardCount' => ['description' => 'Number of cards. ', 'type' => 'string', 'example' => '20000', 'title' => ''],
+ 'CreateTime' => ['description' => 'Instance creation time. ', 'type' => 'string', 'example' => '2022-3-15 22:20:00', 'title' => ''],
+ 'BusinessType' => ['description' => 'Business type ', 'type' => 'string', 'example' => 'Business', 'title' => ''],
+ 'WirelessCloudConnectorGroupId' => ['description' => 'Group ID ', 'type' => 'string', 'example' => 'cc5gg-****', 'title' => ''],
+ 'Features' => [
+ 'description' => 'List of supported features.',
+ 'type' => 'array',
+ 'items' => ['description' => 'List of supported features.', 'type' => 'string', 'example' => '[\'DirectMode\']', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'ServiceType' => ['description' => 'Service Type. Returned values:'."\n"
+ ."\n"
+ .'- **CC5G**: Standard instance.'."\n"
+ .'- **CC5GCCIoT**: Transferred instance. ', 'type' => 'string', 'example' => 'CC5GCCIoT', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F32C0BBE-5025-5561-8976-7BD096BA21FB\\",\\n \\"LockReason\\": \\"ForceTwoWayStop\\"\\n}","type":"json"}]',
- ],
- 'FailCards' => [
- 'summary' => '卡注销接口',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'Query details of a 5G high-speed cloud instance',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-04T02:45:47.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-10-27T08:34:23.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-09-04T10:43:17.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWirelessCloudConnector'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GrantNetLink' => [
+ 'summary' => 'Authorize a cloud connector to a third-party customer.',
+ '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' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => '8986*******',
- ],
+ 'description' => 'The ID of the 5G high-speed cloud instance.',
+ 'type' => 'string',
'required' => true,
'enumValueTitles' => [],
- 'example' => 'FailCards',
- 'maxItems' => 50,
- 'minItems' => 1,
+ 'example' => 'cc5g-xxxx',
+ 'title' => '',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'NetLinkId',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The ID of the network connectivity.',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
'enumValueTitles' => [],
- 'example' => 'cn-hangzhou',
+ 'example' => 'cciot-xxxx',
+ 'title' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
- 'example' => 'TF-CreateServerlessDBInstance-1639649079-51d933f6-0251-4057-9276',
+ 'example' => 'f0ba469f-de7f-4dde-8390-0966a1a0ef9a',
+ 'title' => '',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without deleting the authorization rule. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the authorization rule is deleted immediately.',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => [],
- 'example' => 'false',
+ 'example' => 'False',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'GrantAliUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UID of the Alibaba Cloud grantor.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => '11111111111',
+ 'title' => '',
],
],
],
@@ -3745,145 +2491,174 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
- 'description' => '',
+ 'description' => 'Request ID',
'type' => 'string',
- 'example' => '186B6E37-D9D1-5E64-ACDE-E89F7E68A37B',
+ 'enumValueTitles' => [],
+ 'example' => 'E6B58AF9-F1BF-5894-B898-6CE2108463C5',
],
],
'enumValueTitles' => [],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"186B6E37-D9D1-5E64-ACDE-E89F7E68A37B\\"\\n}","type":"json"}]',
- ],
- 'RebindCards' => [
- 'summary' => '物联网卡换绑解锁操作',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.GrantUidNotHaveCcIotSlr', 'errorMessage' => 'The operation is not allowed because of GrantUid not have AliyunServiceRoleForCCIoT.', 'description' => ''],
+ ['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' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6B58AF9-F1BF-5894-B898-6CE2108463C5\\"\\n}","type":"json"}]',
+ 'title' => 'Authorize Cloud Connector',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-14T03:05:37.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-09-14T03:05:37.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantNetLink'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GrantNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListAPNs' => [
+ 'summary' => 'Query the list of APNs supported by 5G Express Cloud Connect.',
+ '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' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456789',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
- ],
+ 'schema' => ['description' => 'Region ID of the cloud connector instance. Valid value: cn-hangzhou only. ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'APN',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Carrier access point APN ID. ', 'type' => 'string', 'required' => false, 'example' => 'CMWAP', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'ISP',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Carrier ID ', 'type' => 'string', 'required' => false, 'example' => 'unicom', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Used to mark the position from which to start reading. An empty value indicates starting from the beginning. '."\n"
+ ."\n"
+ .'> You do not need to specify this parameter in the first invocation. The NextToken for the second invocation will be included in the return result. Each subsequent response will contain the NextToken for the next invocation. ', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Page size. Valid values: 1 to 50. Default value: 10. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D2A9864E-BB8D-5A5C-90FC-E2FBD5D0BF9B',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'A175C091-3910-51AF-8D84-D5717B9B8D38'],
+ 'APNs' => [
+ 'title' => '',
+ 'description' => 'List of carrier APNs.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'Carrier APN list item',
+ 'type' => 'object',
+ 'properties' => [
+ 'ISP' => ['title' => '', 'description' => 'Carrier of the 5G Express Cloud Connect instance. Valid values:'."\n"
+ .'- **telecom**: China Telecom.'."\n"
+ .'- **mobile**: China Mobile.'."\n"
+ .'- **unicom**: China Unicom.', 'type' => 'string', 'example' => 'unicom'],
+ 'APN' => ['title' => '', 'description' => 'Carrier access point APN ID.', 'type' => 'string', 'example' => 'zjhzaliyun01s.5gjs.njiot'],
+ 'Name' => ['title' => '', 'description' => 'Name.'."\n"
+ ."\n"
+ .'Currently, the displayed APN supports network disconnection.', 'type' => 'string', 'example' => '10.0.0.0/13'],
+ 'Description' => ['description' => 'Description.'."\n"
+ ."\n"
+ .'The description field for online APNs is currently unused, and this APN description is empty.', 'type' => 'string', 'example' => '空', 'title' => ''],
+ 'Zones' => [
+ 'description' => 'List of zones. ',
+ 'type' => 'array',
+ 'items' => ['description' => 'Zone ID. ', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'Paging token, obtained from the return result.', 'type' => 'string', 'example' => 'vhNxI+jwQfkLCUChCQ+iOoiRkyUbtAilGSvWuwktFBxF+bar2HpV0efI6n1+GkMv', 'title' => ''],
+ 'MaxResults' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of entries.', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query APN List ',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2A9864E-BB8D-5A5C-90FC-E2FBD5D0BF9B\\"\\n}","type":"json"}]',
],
- 'ListCardDayUsages' => [
- 'summary' => '查询5G高速上云服务实例的卡单日流量信息列表',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListAuthorizationRules' => [
+ 'summary' => 'Query the list of authorization rules.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3892,218 +2667,297 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the 5G cloud instance. ', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'Statuses',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
+ 'description' => 'List of authorization rule statuses ',
+ 'type' => 'array',
+ 'items' => ['description' => 'Authorization rule status. Valid values: '."\n"
+ .'- **Creating**: Creation in progress '."\n"
+ .'- **Pending**: Configuration in progress '."\n"
+ .'- **Available**: Valid and stable status '."\n"
+ .'- **Invalid**: Invalid '."\n"
+ .'- **Deleting**: Deletion in progress ', 'type' => 'string', 'required' => false, 'example' => 'Creating', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Iccids',
+ 'name' => 'AuthorizationRuleIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'List of authorization rule IDs. ',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
- 'required' => true,
- 'maxItems' => 50,
- 'minItems' => 1,
+ 'items' => ['description' => 'Authorization rule ID ', 'type' => 'string', 'required' => false, 'example' => 'ar5g-xxxx', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'LatestMonthNum',
+ 'name' => 'Names',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'A list of authorization rule names. ',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name, which can be up to 128 characters in length. ', 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''],
'required' => false,
- 'maximum' => '6',
- 'minimum' => '1',
- 'enumValueTitles' => [],
- 'example' => '1',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'DestinationType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type of destination. Valid values: '."\n"
+ .'- **Cidr**: CIDR block '."\n"
+ .'- **Domain**: Domain name or wildcard domain name '."\n"
+ .'- **IpPort**: IP redirection ', 'type' => 'string', 'required' => false, 'example' => 'Cidr', 'title' => ''],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Protocol Type. Valid values: '."\n"
+ .'- **tcp** '."\n"
+ .'- **udp** '."\n"
+ .'- **icmp** '."\n"
+ .'- **all**: Supports all protocols. ', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''],
+ ],
+ [
+ 'name' => 'DestinationPort',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination port range. Valid values: '."\n"
+ ."\n"
+ .'- For TCP and UDP protocols: 1–65535. Separate the start and end ports with a forward slash (/). Example: 1/200. '."\n"
+ ."\n"
+ .'- For ICMP protocol: -1/-1. '."\n"
+ ."\n"
+ .'- For ALL: -1/-1. ', 'type' => 'string', 'required' => false, 'example' => '-1/-1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Destination',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination address, domain name, or wildcard domain name. Prefix matching is used. ', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Policy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The policy of the authorization rule. Valid values: '."\n"
+ .'- **Permit**: Allow '."\n"
+ .'- **Deny**: Deny '."\n"
+ .'- **Mapping**: Redirection ', 'type' => 'string', 'required' => false, 'example' => 'Permit', 'title' => ''],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The type. Valid values: '."\n"
+ .'- **System**: System '."\n"
+ .'- **Default**: Default '."\n"
+ .'- **Customer**: Custom ', 'type' => 'string', 'required' => false, 'example' => 'System', 'title' => ''],
+ ],
+ [
+ 'name' => 'Dns',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Indicates whether it is DNS. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The value returned from the previous page’s query. Do not pass this parameter when querying the home page. ', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page in a paged query. The maximum value is **50**, and the default value is **10**. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03',
- ],
- 'Cards' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '207F9929-806E-5622-8E4F-8484F7000C22'],
+ 'AuthorizationRules' => [
+ 'title' => '',
+ 'description' => 'List of authorization rules.',
'type' => 'array',
'items' => [
'title' => 'RegionItemType',
- 'description' => '',
+ 'description' => 'RegionItemType',
'type' => 'object',
'properties' => [
- 'Iccid' => [
- 'title' => '资源一级ID',
- 'description' => '代表资源一级ID的资源属性字段',
- 'type' => 'string',
- 'example' => '89091231231219123',
- ],
- 'UsageDataMonths' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'UsageDataMonth' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '40',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'AuthorizationRuleId' => ['title' => '', 'description' => 'Authorization rule ID. ', 'type' => 'string', 'example' => 'ar5g-xxxx'],
+ 'Status' => ['title' => '', 'description' => 'Status of the authorization rule. Valid values:'."\n"
+ .'- **Creating**: Creation in progress'."\n"
+ .'- **Pending**: Configuration in progress'."\n"
+ .'- **Available**: Valid and stable'."\n"
+ .'- **Invalid**: Invalid'."\n"
+ .'- **Deleting**: Deletion in progress', 'type' => 'string', 'example' => 'Pending'],
+ 'Name' => ['title' => '', 'description' => 'Authorization rule name. ', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => 'Description of the authorization rule.', 'type' => 'string', 'example' => 'ar5g-test', 'title' => ''],
+ 'Type' => ['description' => 'Type. Valid values: '."\n"
+ .'- **System**: System '."\n"
+ .'- **Default**: Default '."\n"
+ .'- **Customer**: Custom ', 'type' => 'string', 'example' => 'Default', 'title' => ''],
+ 'SourceCidr' => ['description' => 'Source CIDR block.', 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''],
+ 'DestinationType' => ['description' => 'Target type. Valid values: '."\n"
+ .'- **Cidr**: CIDR segment '."\n"
+ .'- **Domain**: domain name or wildcard domain name '."\n"
+ .'- **IpPort**: IP redirection ', 'type' => 'string', 'example' => 'Cidr', 'title' => ''],
+ 'Protocol' => ['description' => 'Protocol Type. Valid values: '."\n"
+ ."\n"
+ .'- **tcp** '."\n"
+ .'- **udp** '."\n"
+ .'- **icmp** '."\n"
+ .'- **all**: Supports all protocols.', 'type' => 'string', 'example' => 'all', 'title' => ''],
+ 'DestinationPort' => ['description' => 'Destination port range. Valid values: '."\n"
+ ."\n"
+ .'- For TCP and UDP protocols: 1 to 65535. Separate the start port and end port with a forward slash (/). Example: 1/200. '."\n"
+ .'- For ICMP protocol: -1/-1. '."\n"
+ .'- For ALL: -1/-1. ', 'type' => 'string', 'example' => '0-65535', 'title' => ''],
+ 'Destination' => ['description' => 'Destination IP address, domain name, or wildcard domain name, using prefix matching.', 'type' => 'string', 'example' => '10.0.0.0/24', 'title' => ''],
+ 'Policy' => ['description' => 'Authorization rule policy. Valid values:'."\n"
+ .'- **Permit**: Allow'."\n"
+ .'- **Deny**: Deny'."\n"
+ .'- **Mapping**: Redirection', 'type' => 'string', 'example' => 'Permit', 'title' => ''],
+ 'Dns' => ['description' => 'Indicates whether it is DNS. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation Time. ', 'type' => 'string', 'example' => '2022-3-15 22:20:00', 'title' => ''],
],
+ 'example' => '',
],
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The starting token for the next query. ', 'type' => 'string', 'example' => 'iou001238joojjaere', 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries per page in a paged query. The maximum value is **50**, and the default value is **10**. ', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Number of entries in the list.', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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' => 'Query authorization rules ',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-18T13:33:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- '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"}]',
- ],
- '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListBatchOperateCardsTasks' => [
+ 'summary' => 'List batch operation card tasks.',
+ '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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'Statuses',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'The status of the batch operation tasks.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '898606*******',
- ],
- 'required' => true,
- 'maxItems' => 1000,
- 'minItems' => 1,
+ 'items' => ['description' => 'The task status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creating'."\n"
+ ."\n"
+ .'- **Pending**: Pending'."\n"
+ ."\n"
+ .'- **Available**: All successful'."\n"
+ ."\n"
+ .'- **PartialAvailable**: Partially successful'."\n"
+ ."\n"
+ .'- **UnAvailable**: Invalid'."\n"
+ ."\n"
+ .'- **Fail**: All failed', 'type' => 'string', 'required' => false, 'example' => 'Creating', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'BatchOperateCardsTaskIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of batch operation task IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The batch operation task ID.', 'type' => 'string', 'required' => false, 'example' => 'boct-xxxx', 'title' => ''],
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'The token returned from the previous query. Do not pass a value for the first query.', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The number of rows per page for paged queries. The maximum value is **50**, and the default value is **10**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'Province',
+ 'name' => 'Names',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
+ 'description' => 'The name of the batch operation.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'xxxx工厂实例批量限速', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
'example' => '',
],
],
@@ -4112,38 +2966,119 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'BatchOperateCardsTasks' => [
+ 'title' => '',
+ 'description' => 'The list of card batch operation tasks.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'Task item',
+ 'type' => 'object',
+ 'properties' => [
+ 'BatchOperateCardsTaskId' => ['description' => 'The batch operation task ID.', 'type' => 'string', 'title' => '', 'example' => 'boct-xxxx'],
+ 'Status' => ['description' => 'The task status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creating'."\n"
+ ."\n"
+ .'- **Pending**: Pending'."\n"
+ ."\n"
+ .'- **Available**: All successful'."\n"
+ ."\n"
+ .'- **PartialAvailable**: Partially successful'."\n"
+ ."\n"
+ .'- **UnAvailable**: Invalid'."\n"
+ ."\n"
+ .'- **Fail**: All failed', 'type' => 'string', 'example' => 'Available', 'title' => ''],
+ 'OperateType' => ['description' => 'The restriction type. Valid values:'."\n"
+ ."\n"
+ .'- **BreakNetwork**: Break network when data usage reaches threshold'."\n"
+ ."\n"
+ .'- **LimitRate**: Limit rate when data usage reaches threshold'."\n"
+ ."\n"
+ .'- **Alarm**: Alert when data usage reaches threshold', 'type' => 'string', 'title' => '', 'example' => 'BreakNetwork'],
+ 'Threshold' => ['description' => 'The data usage threshold, in MB.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'EffectType' => ['description' => 'The effective type. Valid values:'."\n"
+ ."\n"
+ .'- **CurrentMonth**'."\n"
+ ."\n"
+ .'- **ContinualMonth**', 'type' => 'string', 'example' => 'CurrentMonth', 'title' => ''],
+ 'IccidsOssFilePath' => ['description' => 'The file path where ICCIDs are stored.', 'type' => 'string', 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***', 'title' => ''],
+ 'WirelessCloudConnectors' => [
+ 'description' => 'The list of 5G high-speed cloud instance IDs and statuses.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorId' => ['description' => 'The 5G high-speed cloud instance ID.', 'type' => 'string', 'example' => 'cc5g-xxxx', 'title' => ''],
+ 'Status' => ['description' => 'The status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creating'."\n"
+ ."\n"
+ .'- **Available**: Valid and stable'."\n"
+ ."\n"
+ .'- **Pending**: Configuring'."\n"
+ ."\n"
+ .'- **Deleting**: Deleting'."\n"
+ ."\n"
+ .'- **Deleted**: Deleted', 'type' => 'string', 'example' => 'Deleted', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OperateResultOssFilePath' => ['description' => 'The file path of the batch operation result.', 'type' => 'string', 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***', 'title' => ''],
+ 'Description' => ['description' => 'The description of the batch operation.', 'type' => 'string', 'example' => 'task-test', 'title' => ''],
+ 'Name' => ['description' => 'The name of the batch operation.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-3-15 22:20:00', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The starting token for the next query.', 'type' => 'string', 'example' => 'iou001238joojjaere', 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of rows per page for paged queries. The maximum value is **50**, and the default value is **10**.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The number of items in the list.', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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' => 'List batch operate card jobs ',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-11T07:13:13.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-05-30T07:48:47.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
],
'ListCardAreaLimitSupportArea' => [
- 'summary' => '查询5G高速上云服务物联网卡区域解锁支持区域',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Query the provinces where card area unlocking is supported.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4155,206 +3090,123 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- ],
+ 'schema' => ['description' => 'Language of the response:'."\n"
+ ."\n"
+ .'- zh: Chinese'."\n"
+ ."\n"
+ .'- en: English'."\n"
+ ."\n"
+ .'Default: zh', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- 'default' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'default' => 'cn-hangzhou', 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ProvinceName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Province name. Optional.', 'type' => 'string', 'required' => false, 'example' => '浙江省', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response structure',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
'Provinces' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Array of province names.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'Name of a province where card area unlocking is supported.', 'type' => 'string', 'example' => '江苏省', 'title' => ''],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"Provinces\\": [\\n \\"江苏省\\"\\n ]\\n}","type":"json"}]',
- ],
- 'CreateAuthorizationRule' => [
- 'summary' => '创建5G高速上云服务实例的授权规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Query the provinces supported for card area unlock',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardAreaLimitSupportArea',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListCardDayUsages' => [
+ 'summary' => 'Queries the daily traffic for a single card.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5g-test',
- ],
- ],
- [
- 'name' => 'SourceCidr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0/0',
- ],
- ],
- [
- 'name' => 'DestinationType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Cidr',
- ],
- ],
- [
- 'name' => 'Protocol',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
- ],
- [
- 'name' => 'DestinationPort',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-1/-1',
- ],
- ],
- [
- 'name' => 'Destination',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => 'The ID of the 5G Cloud Connector instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'Policy',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The Integrated Circuit Card Identifiers (ICCIDs) of the Internet of Things (IoT) SIM cards. You can specify up to 50 ICCIDs at a time.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ICCID of the IoT card.', 'type' => 'string', 'required' => false, 'example' => '890912389123', 'title' => ''],
'required' => true,
- 'example' => 'Permit',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'maxItems' => 50,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'DryRun',
+ 'name' => 'LatestMonthNum',
'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'boolean',
+ 'description' => 'The number of recent months for which to query traffic data. The default value is 2, which includes the current month. The value can range from 1 to 6.',
+ 'enumValueTitles' => [],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'maximum' => '6',
+ 'minimum' => '1',
'required' => false,
- 'example' => 'true',
+ 'example' => '1',
+ 'title' => '',
],
],
],
@@ -4362,97 +3214,124 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '61202DF5-668B-5EDA-8177-F2D71F4737C1',
- ],
- 'AuthorizationRuleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ar5g-12fnojjtkkre28t08j',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03'],
+ 'Cards' => [
+ 'title' => '',
+ 'description' => 'The traffic information of the cards.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'The traffic information of the cards.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Iccid' => ['description' => 'The ICCID of the IoT card.', 'type' => 'string', 'title' => '', 'example' => '89091231231219123'],
+ 'UsageDataMonths' => [
+ 'description' => 'The monthly traffic information of the card.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The monthly traffic information of the card.',
+ 'type' => 'object',
+ 'properties' => [
+ 'UsageDataMonth' => ['description' => 'The data usage of the month, in MB.', 'type' => 'string', 'example' => '1030', 'title' => ''],
+ 'Month' => ['description' => 'The month.', 'type' => 'string', 'example' => '202207', 'title' => ''],
+ 'CardDayUsages' => [
+ 'description' => 'The day-level traffic information of the card.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The day-level traffic information of the card.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Day' => ['description' => 'The day.', 'type' => 'string', 'example' => '20220701', 'title' => ''],
+ 'UsageData' => ['description' => 'The data usage of the day, in MB.', 'type' => 'string', 'example' => '40', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- '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' => 'Query daily traffic for a single SIM card',
+ 'description' => 'If the response does not return data for a card or specific days, it indicates that the card did not use any traffic on those days.',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-27T09:15:23.000Z', 'description' => 'Request parameters changed'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61202DF5-668B-5EDA-8177-F2D71F4737C1\\",\\n \\"AuthorizationRuleId\\": \\"ar5g-12fnojjtkkre28t08j\\"\\n}","type":"json"}]',
],
- 'DeleteAuthorizationRule' => [
- 'summary' => '删除5G高速上云服务实例的授权规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListCardUsages' => [
+ 'summary' => 'Query traffic usage information for Internet of Things (IoT) cards.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'AuthorizationRuleId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ar5g-xxxx',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'ID of the 5G high-speed cloud connection instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'boolean',
+ 'description' => 'IoT SIM card numbers. Up to 50 entries at a time.',
+ 'type' => 'array',
+ 'items' => ['description' => 'ICCID of the IoT card.', 'type' => 'string', 'required' => false, 'example' => '890912389123', 'title' => ''],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 50,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -4460,438 +3339,589 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '186B6E37-D9D1-5E64-ACDE-E89F7E68A37B'],
+ 'Cards' => [
+ 'title' => '',
+ 'description' => 'List of cards.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'Card information item.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Iccid' => ['description' => 'ICCID of the IoT card.', 'type' => 'string', 'title' => '', 'example' => '89091231231219123'],
+ 'UsageDataMonth' => ['description' => 'Traffic used this month, in MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'Total count returned.', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'UpdateAuthorizationRule' => [
- 'summary' => '更新5G高速上云服务实例的授权规则',
- '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' => 'Query card traffic usage information ',
+ 'description' => 'Current-month traffic data covers the period from 00:00 on the first day of the month to 23:59:59 on the last day.',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-26T07:35:16.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCardUsages'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardUsages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListCards' => [
+ 'summary' => 'Query the list of card information under a 5G high-speed cloud instance. ',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the 5G high-speed cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'AuthorizationRuleId',
+ 'name' => 'Statuses',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ar5g-xxxx',
+ 'description' => 'A list of card statuses.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The status of the card. Valid values:'."\n"
+ ."\n"
+ .'- **Testable**: Testing'."\n"
+ .'- **Activatable**: Activatable'."\n"
+ .'- **Activated**: Activated'."\n"
+ .'- **Deactivated**: Deactivated'."\n"
+ .'- **Failed**: Out Of Effect'."\n"
+ .'- **Cleared**: Purged'."\n"
+ .'- **Replaced**: Replaced'."\n"
+ .'- **Resuming**: Recovering'."\n"
+ .'- **ShutDown**: Shut down', 'type' => 'string', 'required' => false, 'example' => 'Activated', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Name',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of ICCIDs of the Internet of Things cards.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ICCID of the Internet of Things card.', 'type' => 'string', 'required' => false, 'example' => '89091231231219123', 'title' => ''],
'required' => false,
- 'example' => 'Test',
+ 'enumValueTitles' => [],
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Description',
+ 'name' => 'IpAddress',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5g-test',
- ],
+ 'schema' => ['description' => 'The fixed IP address of the Internet of Things card.', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1', 'title' => ''],
],
[
- 'name' => 'SourceCidr',
+ 'name' => 'Lock',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0/0',
- ],
+ 'schema' => ['description' => 'Whether the card is locked.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'Destination',
+ 'name' => 'Online',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => 'Whether the card is online.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'Protocol',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
+ 'schema' => ['description' => 'The network connectivity ID.', 'type' => 'string', 'required' => false, 'example' => 'cciot-xxxx', 'title' => ''],
],
[
- 'name' => 'DestinationPort',
+ 'name' => 'Apn',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-1/-1',
- ],
+ 'schema' => ['description' => 'The ID of the carrier APN.', 'type' => 'string', 'required' => false, 'example' => 'bjaliyun01s.5gbj.bjiot', 'title' => ''],
],
[
- 'name' => 'Policy',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Permit',
- ],
+ 'schema' => ['description' => 'The value returned from the previous page query. Do not specify this parameter for the first page query.', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'The number of entries per page in a paged query. The maximum value is **50**. The default value is **10**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The prefix of the ICCID of the card. If the suffix contains characters, the characters are removed.', 'type' => 'string', 'required' => false, 'example' => '8909123123121912', 'title' => ''],
+ ],
+ [
+ 'name' => 'Msisdn',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The MSISDN of the Internet of Things SIM card.', 'type' => 'string', 'required' => false, 'example' => '1441204374591', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'],
+ 'Cards' => [
+ 'title' => '',
+ 'description' => 'List of cards. ',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'Iccid' => ['title' => '', 'description' => 'The ICCID of the IoT card. ', 'type' => 'string', 'example' => '89091231231219123'],
+ 'NetType' => ['title' => '', 'description' => 'The network type. Valid values:'."\n"
+ ."\n"
+ .'- **4G**'."\n"
+ .'- **5G**', 'type' => 'string', 'example' => '5G'],
+ 'APN' => ['title' => '', 'description' => 'The ID of the carrier\'s APN.', 'type' => 'string', 'example' => 'bjaliyun01s.5gbj.bjiot'],
+ 'ISP' => ['description' => 'The carrier of the 5G high-speed cloud instance. Valid values: '."\n"
+ .'- **Telecom**: China Telecom '."\n"
+ .'- **Mobile**: China Mobile '."\n"
+ .'- **Unicom**: China Unicom ', 'type' => 'string', 'example' => 'Telecom', 'title' => ''],
+ 'IpAddress' => ['description' => 'The static IP address of the card. ', 'type' => 'string', 'example' => '10.0.0.118', 'title' => ''],
+ 'Imsi' => ['description' => 'The International Mobile Subscriber Identity (IMSI) of the IoT card. ', 'type' => 'string', 'example' => '8912039123', 'title' => ''],
+ 'Imei' => ['description' => 'The International Mobile Equipment Identity (IMEI) of the IoT card. ', 'type' => 'string', 'example' => '7896129300', 'title' => ''],
+ 'Lock' => ['description' => 'Indicates whether the card is locked. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'Spec' => ['description' => 'The card specification. Valid values:'."\n"
+ ."\n"
+ .'- **CONSUMER\\_THREE\\_IN\\_ONE:** Consumer electronics-grade Internet of Things SIM card – tri-cut'."\n"
+ .'- **INDUSTRY\\_PATCH:** Industrial-grade embedded Internet of Things SIM card'."\n"
+ .'- **CONSUMER\\_PATCH:** Consumer electronics-grade embedded Internet of Things SIM card'."\n"
+ .'- **INDUSTRY\\_GENERAL:** Industrial-grade Internet of Things SIM card – standard'."\n"
+ .'- **INDUSTRY\\_MICRO:** Industrial-grade Internet of Things SIM card – Micro'."\n"
+ .'- **CONSUMER\\_GENERAL:** Consumer electronics-grade Internet of Things SIM card – standard'."\n"
+ .'- **CONSUMER\\_TWO\\_IN\\_ONE:** Consumer electronics-grade Internet of Things SIM card – dual-cut'."\n"
+ .'- **INDUSTRY\\_NANO:** Industrial-grade Internet of Things SIM card – Nano'."\n"
+ .'- **CAR\\_PATCH:** Automotive-grade embedded Internet of Things SIM card', 'type' => 'string', 'example' => 'CONSUMER_THREE_IN_ONE', 'title' => ''],
+ 'Status' => ['description' => 'Card status. Valid values:'."\n"
+ ."\n"
+ .'- **Testable**: Testing'."\n"
+ .'- **Activatable**: Activatable'."\n"
+ .'- **Activated**: Activated'."\n"
+ .'- **Deactivated**: Deactivated'."\n"
+ .'- **Failed**: Out Of Effect'."\n"
+ .'- **Cleared**: Purged'."\n"
+ .'- **Replaced**: Replaced'."\n"
+ .'- **Resuming**: Recovering'."\n"
+ .'- **ShutDown**: Shut Down ', 'type' => 'string', 'example' => 'Activated', 'title' => ''],
+ 'Description' => ['description' => 'Description. ', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Name' => ['description' => 'The name. ', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'UsageDataMonth' => ['description' => 'Traffic used this month, in MB. ', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID. ', 'type' => 'string', 'example' => '89099123012', 'title' => ''],
+ 'ActivatedTime' => ['description' => 'The activation time. ', 'type' => 'string', 'example' => '2022-3-15 22:20:00', 'title' => ''],
+ 'BusinessStatus' => ['description' => 'The business status. Valid values: '."\n"
+ .'- **Creating**: Creation in progress '."\n"
+ .'- **Available**: Stable and valid '."\n"
+ .'- **Configuring**: Configuration in progress '."\n"
+ .'- **Deleting**: Deletion in progress ', 'type' => 'string', 'example' => 'Available', 'title' => ''],
+ 'Msisdn' => ['description' => 'The MSISDN of the IoT card. ', 'type' => 'string', 'example' => '1441204374591', 'title' => ''],
+ 'UsageDataTotal' => ['description' => 'Total usage of a single card ', 'type' => 'string', 'example' => '50', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'Value required for querying the next page. ', 'type' => 'string', 'example' => 'iou001238joojjaere', 'title' => ''],
+ 'MaxResults' => ['description' => 'Number of rows per page in a paged query. The maximum value is **50**, and the default value is **10**. ', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Number of entries in the list. ', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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' => 'Query card information under a 5G high-speed cloud instance',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-29T12:41:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-07-18T10:03:51.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-07-11T08:49:31.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-06-13T06:21:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-05-30T07:48:47.000Z', 'description' => 'Response parameters changed'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\"\\n}","type":"json"}]',
],
- 'AddDNSAuthorizationRule' => [
- 'summary' => '添加5G高速上云服务实例的DNS授权规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDataPackages' => [
+ 'summary' => 'Retrieves a list of data transfer plans.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'ID of the 5G high-speed cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'Statuses',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
+ 'description' => 'List of data transfer plan statuses.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Data transfer plan status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creating'."\n"
+ ."\n"
+ .'- **Available**: Active'."\n"
+ ."\n"
+ .'- **Expired**: Expired', 'type' => 'string', 'required' => false, 'example' => 'Available', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Description',
+ 'name' => 'DataPackageIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'IDs of data transfer plans. Maximum: 20.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'dp-xxxx', 'title' => ''],
'required' => false,
- 'example' => 'ar5g-test',
- ],
- ],
- [
- 'name' => 'SourceDNSIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0.0.0.0',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'DestinationIp',
+ 'name' => 'Names',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Names of data transfer plans. Maximum: 20.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cciot-123', 'title' => ''],
'required' => false,
- 'example' => '1.1.1.1',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Value returned by the previous paged query. Do not specify this parameter for the first page.', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Number of entries per page for a paged query. Maximum: **50**. Default: **10**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'AuthorizationRuleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ar5g-xxxx',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE'],
+ 'DataPackages' => [
+ 'title' => '',
+ 'description' => 'List of data transfer plans.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'Region item type.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataPackageId' => ['description' => 'ID of the data transfer plan.', 'type' => 'string', 'example' => 'dp-xxxx', 'title' => ''],
+ 'Status' => ['description' => 'Status of the data transfer plan. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creating'."\n"
+ ."\n"
+ .'- **Available**: Active'."\n"
+ ."\n"
+ .'- **Expired**: Expired', 'type' => 'string', 'title' => '', 'example' => 'Available'],
+ 'Name' => ['description' => 'Name of the data transfer plan.', 'type' => 'string', 'title' => '', 'example' => '测试流量包'],
+ 'ISP' => ['description' => 'Internet Service Provider (ISP) of the SIM card. Valid values:'."\n"
+ ."\n"
+ .'- **Telecom**: China Telecom'."\n"
+ ."\n"
+ .'- **Mobile**: China Mobile'."\n"
+ ."\n"
+ .'- **Unicom**: China Unicom', 'type' => 'string', 'example' => 'Telecom', 'title' => ''],
+ 'Size' => ['description' => 'Quota of the data transfer plan. Valid values:'."\n"
+ ."\n"
+ .'- **200**: 200 MB per SIM card per month'."\n"
+ ."\n"
+ .'- **1000**: 1 GB per SIM card per month'."\n"
+ ."\n"
+ .'- **3000**: 3 GB per SIM card per month'."\n"
+ ."\n"
+ .'- **30000**: 30 GB per SIM card per month', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'CardCount' => ['description' => 'Number of SIM cards.', 'type' => 'string', 'example' => '20000', 'title' => ''],
+ 'CreateTime' => ['description' => 'Activation time.', 'type' => 'string', 'example' => '2022-3-15 22:20:00', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'Expiration time.', 'type' => 'string', 'example' => '2099-3-15 22:20:00', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'Token required to retrieve the next page of results.', 'type' => 'string', 'example' => 'iou001238joojjaere', 'title' => ''],
+ 'MaxResults' => ['description' => 'Number of entries per page for a paged query. Maximum: **50**. Default: **10**.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of entries in the list.', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"AuthorizationRuleId\\": \\"ar5g-xxxx\\"\\n}","type":"json"}]',
- ],
- 'UpdateDNSAuthorizationRule' => [
- 'summary' => '更新5G高速上云服务实例的DNS授权规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'Query data package information ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataPackages'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListDataPackages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListDiagnoseInfoForSingleCard' => [
+ 'summary' => 'Query the historical diagnosis information of 5G cloud instances (excluding diagnosis results).',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'AuthorizationRuleId',
+ 'name' => 'RegionNo',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The region ID of the 5G cloud instance.',
'type' => 'string',
- 'required' => true,
- 'example' => 'ar5g-xxxx',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'cn-hangzhou',
+ 'title' => '',
],
],
[
- 'name' => 'Name',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'The 5G cloud instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'SourceType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5g-test',
- ],
+ 'schema' => ['description' => 'The source type for network diagnosis. Valid values:'."\n"
+ ."\n"
+ .'- **Ip**: Indicates that network diagnosis is performed by using the IP address of the Internet of Things card.'."\n"
+ ."\n"
+ .'- **Iccid**: Indicates that network diagnosis is performed by using the ID of the Internet of Things card.', 'type' => 'string', 'required' => false, 'example' => 'Iccid', 'title' => ''],
],
[
- 'name' => 'SourceDNSIp',
+ 'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0',
- ],
+ 'schema' => ['description' => 'The ID of the source network interface card for network diagnosis.', 'type' => 'string', 'required' => false, 'example' => '89860477102170127555', 'title' => ''],
],
[
- 'name' => 'DestinationIp',
+ 'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => 'The status of the network diagnostic task. Valid values:'."\n"
+ ."\n"
+ .'- **success**: indicates that the diagnosis succeeded.'."\n"
+ ."\n"
+ .'- **failed**: indicates that the diagnosis failed.'."\n"
+ ."\n"
+ .'- **diagnosing**: indicates that the diagnosis is in progress.', 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Indicates whether a token for the next query exists. Valid values:'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, no further query is available.'."\n"
+ ."\n"
+ .'- If **NextToken** has a return value, this value represents the token to start the next query.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
- 'name' => 'DryRun',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The number of entries to display per page when querying results in batches. Valid values: 1 to 100. Default Value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E1E237B1-EED7-55D5-AE5F-671E642DB3B5', 'title' => ''],
+ 'NextToken' => ['description' => 'Indicates whether a token for the next query exists. Valid values:'."\n"
+ ."\n"
+ .'- If **NextToken** is empty, no further query is available.'."\n"
+ ."\n"
+ .'- If **NextToken** has a return value, this value represents the token to start the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'."\n", 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries returned per page when results are queried in batches. Valid values: 1 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'DiagnoseInfo' => [
+ 'description' => 'List of diagnostic tasks.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorId' => ['description' => 'The ID of the 5G high-speed cloud instance.', 'type' => 'string', 'example' => 'cc5g-xxxx', 'title' => ''],
+ 'CardIp' => ['description' => 'The IP address of the source card used for the network diagnosis.', 'type' => 'string', 'example' => '10.176.78.61', 'title' => ''],
+ 'IccId' => ['description' => 'The ID of the source card used for the network diagnosis.', 'type' => 'string', 'example' => '89860477102170127555', 'title' => ''],
+ 'SourceType' => ['description' => 'The source type of the network diagnosis.', 'type' => 'string', 'example' => 'Iccid', 'title' => ''],
+ 'Source' => ['description' => 'The source NIC IP address or NIC ID for the network diagnosis.', 'type' => 'string', 'example' => '89860477102170127555', 'title' => ''],
+ 'DestinationType' => ['description' => 'The destination type of the network diagnosis. Valid values:'."\n"
+ ."\n"
+ .'- **IP**: indicates that the destination type is an IP address.'."\n"
+ ."\n"
+ .'- **Domain**: indicates that the destination type is a domain name.', 'type' => 'string', 'example' => 'Domain', 'title' => ''],
+ 'Destination' => ['description' => 'The destination IP address or domain name for the network diagnosis.', 'type' => 'string', 'example' => 'www.xxx.com', 'title' => ''],
+ 'BeginTime' => ['description' => 'The UNIX timestamp when the network diagnosis started. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1662307200000', 'title' => ''],
+ 'EndTime' => ['description' => 'The UNIX timestamp when the network diagnosis ended. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1662307201200', 'title' => ''],
+ 'Status' => ['description' => 'The status of the network diagnostic task. Valid values:'."\n"
+ ."\n"
+ .'- **success**: The diagnosis succeeded.'."\n"
+ .'- **failed**: The diagnosis failed.'."\n"
+ .'- **diagnosing**: The diagnosis is in progress.', 'type' => 'string', 'example' => 'failed', 'title' => ''],
+ 'DiagnoseTime' => ['description' => 'The UNIX timestamp when the diagnostic task was stored in the database. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1662307202400', 'title' => ''],
+ 'DiagnoseTaskId' => ['description' => 'The network diagnostic task ID.', 'type' => 'string', 'example' => 'diagnoseTask-bp2x7tzkdl655liw3mhbg', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'ListAuthorizationRules' => [
- 'summary' => '查询5G高速上云服务实例的授权规则列表',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => ''],
+ ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'Query historical diagnosis records',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseInfoForSingleCard'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'iotcc:ListDiagnoseInfoForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListGroupAuthorizationRules' => [
+ 'summary' => 'Query the list of authorization rules for a group.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4899,39 +3929,30 @@
],
'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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'Instance ID of the instance group.', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****', 'title' => ''],
],
[
'name' => 'Statuses',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'List of authorization rule statuses.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Creating',
- ],
- 'required' => false,
+ 'items' => ['description' => 'Authorization rule status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creation in progress'."\n"
+ .'- **Available**: Valid and stable status'."\n"
+ .'- **Pending**: Configuration in progress'."\n"
+ .'- **Deleting**: Deletion in progress'."\n"
+ .'- **UnAvailable**: Invalid; this rule is temporarily inactive', 'type' => 'string', 'required' => false, 'example' => 'Creating', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
@@ -4939,15 +3960,12 @@
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'List of authorization rule IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5g-xxxx',
- ],
+ 'items' => ['description' => 'Authorization rule ID', 'type' => 'string', 'required' => false, 'example' => 'ar5gg-xxxx', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
@@ -4955,232 +3973,175 @@
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'List of authorization rule names.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test',
- ],
+ 'items' => ['description' => 'Name, which can contain up to 128 characters.'."\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'DestinationType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cidr',
- ],
+ 'schema' => ['description' => 'Target type. Valid values:'."\n"
+ .'1. Cidr'."\n"
+ .'2. Domain'."\n"
+ .'3. IpPort', 'type' => 'string', 'required' => false, 'example' => 'Cidr', 'title' => ''],
],
[
'name' => 'Protocol',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
+ 'schema' => ['description' => 'Protocol Type. Valid values:'."\n"
+ ."\n"
+ .'- **tcp**'."\n"
+ .'- **udp**'."\n"
+ .'- **icmp**'."\n"
+ .'- **all**: Supports all protocols.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''],
],
[
'name' => 'DestinationPort',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-1/-1',
- ],
+ 'schema' => ['description' => 'Destination port range. Valid values:'."\n"
+ ."\n"
+ .'- For TCP and UDP protocols: 1 to 65535. Separate the start and end ports with a forward slash (/). Example: 1/200.'."\n"
+ ."\n"
+ .'- For ICMP protocol: -1/-1.'."\n"
+ ."\n"
+ .'- For ALL: -1/-1.', 'type' => 'string', 'required' => false, 'example' => '-1/-1', 'title' => ''],
],
[
'name' => 'Destination',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => 'Target address, domain name, or wildcard domain name. Prefix matching is used.', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1', 'title' => ''],
],
[
'name' => 'Policy',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Permit',
- ],
+ 'schema' => ['description' => 'Authorization policy. Valid values:'."\n"
+ .'- **Permit**: Allow'."\n"
+ .'- **Deny**: Deny', 'type' => 'string', 'required' => false, 'example' => 'Permit', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'System',
- ],
+ 'schema' => ['description' => 'Type. Valid values:'."\n"
+ .'- **System**: System'."\n"
+ .'- **Default**: Default'."\n"
+ .'- **Customer**: Custom', 'type' => 'string', 'required' => false, 'example' => 'System', 'title' => ''],
],
[
'name' => 'Dns',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Whether it is DNS.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
+ 'schema' => ['description' => 'The value returned from the previous page query. Do not pass this parameter for the home page query.', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page in a paged query. The maximum value is **50**, and the default value is **10**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '207F9929-806E-5622-8E4F-8484F7000C22',
- ],
- 'AuthorizationRules' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'GroupAuthorizationRules' => [
+ 'title' => '',
+ 'description' => 'List of authorization rules.'."\n"
+ ."\n",
'type' => 'array',
'items' => [
'title' => 'RegionItemType',
- 'description' => 'RegionItemType',
+ 'description' => 'List of authorization rules.',
'type' => 'object',
'properties' => [
- 'AuthorizationRuleId' => [
- 'title' => '资源一级ID',
- 'description' => '代表资源一级ID的资源属性字段',
- 'type' => 'string',
- 'example' => 'ar5g-xxxx',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'Pending',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ar5g-test',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'SourceCidr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.0.0.0/0',
- ],
- 'DestinationType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cidr',
- ],
- 'Protocol' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'all',
- ],
- 'DestinationPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0-65535',
- ],
- 'Destination' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10.0.0.0/24',
- ],
- 'Policy' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Permit',
- ],
- 'Dns' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-3-15 22:20:00',
- ],
+ 'AuthorizationRuleId' => ['title' => '', 'description' => 'The ID of the authorization rule. ', 'type' => 'string', 'example' => 'ar5gg-y5g4rp2w1tl1w7zg59'],
+ 'Status' => ['title' => '', 'description' => 'Status of the authorization rule. Valid values:'."\n"
+ .'- **Creating**: Creating'."\n"
+ .'- **Available**: Valid and stable'."\n"
+ .'- **Pending**: Configuring'."\n"
+ .'- **Deleting**: Deleting'."\n"
+ .'- **UnAvailable**: Invalid', 'type' => 'string', 'example' => 'Creating'],
+ 'Name' => ['title' => '', 'description' => 'The name of the authorization rule. ', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => 'Description of the authorization rule. The description can be up to 256 characters in length.', 'type' => 'string', 'example' => 'ar5gg-test'."\n", 'title' => ''],
+ 'Type' => ['description' => 'The type. Valid values: '."\n"
+ .'- **System**: System '."\n"
+ .'- **Default**: Default '."\n"
+ .'- **Customer**: Custom ', 'type' => 'string', 'example' => 'Default', 'title' => ''],
+ 'SourceCidr' => ['description' => 'Source CIDR block.', 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''],
+ 'DestinationType' => ['description' => 'The destination type. Valid values: '."\n"
+ .'1. Cidr '."\n"
+ .'2. Domain '."\n"
+ .'3. IpPort ', 'type' => 'string', 'example' => 'Cidr', 'title' => ''],
+ 'Protocol' => ['description' => 'The protocol type. Valid values: '."\n"
+ ."\n"
+ .'- **tcp** '."\n"
+ .'- **udp** '."\n"
+ .'- **icmp** '."\n"
+ .'- **all**: Supports all protocols. ', 'type' => 'string', 'example' => 'all', 'title' => ''],
+ 'DestinationPort' => ['description' => 'The destination port range. Valid values: '."\n"
+ ."\n"
+ .'- For TCP and UDP protocols: 1 to 65535. Separate the start and end ports with a forward slash (/). Example: 1/200. '."\n"
+ ."\n"
+ .'- For the ICMP protocol: -1/-1. '."\n"
+ ."\n"
+ .'- For ALL: -1/-1. ', 'type' => 'string', 'example' => '0-65535', 'title' => ''],
+ 'Destination' => ['description' => 'Destination IP address, domain name, or wildcard domain name, using prefix matching.', 'type' => 'string', 'example' => '47.103.184.100/32', 'title' => ''],
+ 'Policy' => ['description' => 'Authorization rule policy. Valid values:'."\n"
+ .'- **Permit**: Allow'."\n"
+ .'- **Deny**: Deny', 'type' => 'string', 'example' => 'Permit', 'title' => ''],
+ 'Dns' => ['description' => 'Indicates whether it is DNS. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation Time.', 'type' => 'string', 'example' => '2022-06-21 15:27:24', 'title' => ''],
],
+ 'example' => '',
],
+ 'example' => '',
],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'NextToken' => ['description' => 'The starting token for the next query.'."\n"
+ ."\n", 'type' => 'string', 'example' => 'iou001238joojjaere'."\n", 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries per page in a paged query. The maximum value is **50**, and the default value is **10**.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The number of entries in the list.', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'CreateBatchOperateCardsTask' => [
- 'summary' => '创建批量操作卡任务',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'Query the list of group authorization rules',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupAuthorizationRules'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListGroupAuthorizationRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListIoTCloudConnectorBackhaulRoute' => [
+ 'summary' => 'Queries the reverse access route list of a specific connection instance in the scenario where the reverse access advanced feature is enabled.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5189,260 +4150,374 @@
'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' => 'The Region ID ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'task- test',
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance. ', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'NetLinkId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the network connectivity. ', 'type' => 'string', 'required' => true, 'example' => 'cciot-xxxx', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response object',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '94032572-8758-575E-B306-86F59D1B826E'],
+ 'NetLinkId' => ['title' => 'Id of the request', 'description' => 'The ID of the network connectivity. ', 'type' => 'string', 'example' => 'cciot-xxxx'],
+ 'Routes' => [
+ 'title' => '',
+ 'description' => 'An array that returns sample folders.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'DestinationCidrBlock' => ['title' => '', 'description' => 'The destination CIDR block of the route entry. ', 'type' => 'string', 'example' => '10.33.190.0/24'],
+ 'NextHopId' => ['title' => '', 'description' => 'The instance ID of the next hop.', 'type' => 'string', 'example' => 'eni-uf677iw3xihqxiz2ssir'],
+ 'NextHopType' => ['title' => '', 'description' => 'The type of the next hop for the custom route entry. Valid values:'."\n"
+ ."\n"
+ .'- **Instance** (Default Value): ECS instance.'."\n"
+ ."\n"
+ .'- **HaVip**: High-availability virtual IP address.'."\n"
+ ."\n"
+ .'- **RouterInterface**: Router interface.'."\n"
+ ."\n"
+ .'- **NetworkInterface**: Elastic Network Interface (ENI).'."\n"
+ ."\n"
+ .'- **VpnGateway**: VPN Gateway.'."\n"
+ ."\n"
+ .'- **IPv6Gateway**: IPv6 gateway.'."\n"
+ ."\n"
+ .'- **NatGateway**: NAT Gateway.'."\n"
+ ."\n"
+ .'- **Attachment**: Transit router.'."\n"
+ ."\n"
+ .'- **VpcPeer**: VPC peering connection.', 'type' => 'string', 'example' => 'NetworkInterface'],
+ 'Description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'example' => 'full cidr block route'],
+ 'Status' => [
+ 'title' => '',
+ 'description' => 'The route status. Valid values:'."\n"
+ ."\n"
+ .'- **init**: Initial state'."\n"
+ .'- **published**: Published',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'published',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ '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' => 'Query reverse access routes of a 5G cloud instance ',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-28T11:47:33.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorBackhaulRoute'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ListOrders' => [
+ 'summary' => 'Query the order list. ',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DryRun',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '5G Wireless Cloud Connector instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'Iccids',
+ 'name' => 'Statuses',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'List of order statuses.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
+ 'items' => ['description' => 'Order status. Valid values:'."\n"
+ ."\n"
+ .'- **Pending**: Pending shipment'."\n"
+ .'- **Posting**: Shipped'."\n"
+ .'- **Finished**: Completed', 'type' => 'string', 'required' => false, 'example' => 'Pending', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'IccidsOssFilePath',
+ 'name' => 'OrderIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'List of order IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Order ID.', 'type' => 'string', 'required' => false, 'example' => '890******', 'title' => ''],
'required' => false,
- 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'OperateType',
+ 'name' => 'OrderAction',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BreakNetwork',
- ],
+ 'schema' => ['description' => 'Order type. Valid values:'."\n"
+ .'- **NewBuy**: New purchase'."\n"
+ .'- **ScaleOut**: Scale-out'."\n"
+ .'- **ScaleIn**: Scale-in'."\n"
+ .'- **BuyCard**: Card purchase'."\n"
+ .'- **Renewal**: Renewal', 'type' => 'string', 'required' => false, 'example' => 'NewBuy', 'title' => ''],
],
[
- 'name' => 'Threshold',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '100',
- ],
+ 'schema' => ['description' => 'Value returned from the previous page query. Do not pass this parameter for the home page query.', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere', 'title' => ''],
],
[
- 'name' => 'EffectType',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CurrentMonth',
- ],
+ 'schema' => ['description' => 'Number of rows per page in a paged query. Maximum value is **50**. Default value is **10**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'BatchOperateCardsTaskId' => [
- 'description' => '',
- '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' => 'Request ID.', 'type' => 'string', 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'."\n"],
+ 'Orders' => [
+ 'title' => '',
+ 'description' => 'Order list. ',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrderId' => ['description' => 'Order ID. ', 'type' => 'string', 'example' => '89************', 'title' => ''],
+ 'Status' => ['title' => '', 'description' => 'Order status. Valid values:'."\n"
+ ."\n"
+ .'- **Pending**: Pending shipment'."\n"
+ .'- **Posting**: Shipped'."\n"
+ .'- **Finished**: Completed ', 'type' => 'string', 'example' => 'Pending'],
+ 'Action' => ['title' => '', 'description' => 'Order type. Valid values:'."\n"
+ .'- **NewBuy**: New purchase'."\n"
+ .'- **ScaleOut**: Scale-out'."\n"
+ .'- **ScaleIn**: Scale-in'."\n"
+ .'- **BuyCard**: Purchase card'."\n"
+ .'- **Renewal**: Renewal ', 'type' => 'string', 'example' => 'NewBuy'],
+ 'Description' => ['description' => 'Order description. ', 'type' => 'string', 'example' => 'order-test', 'title' => ''],
+ 'LogisticsId' => ['description' => 'Logistics tracking number. ', 'type' => 'string', 'example' => 'SF14*********', 'title' => ''],
+ 'LogisticsStatus' => ['description' => 'Logistics status. Valid values: '."\n"
+ .'- **Transporting**: In transit '."\n"
+ .'- **Delivering**: Out for delivery '."\n"
+ .'- **Delivered**: Delivered '."\n"
+ .'- **Signed**: Signed for '."\n", 'type' => 'string', 'example' => 'Signed', 'title' => ''],
+ 'LogisticsType' => ['description' => 'Logistics company. Valid values: '."\n"
+ .'- **SF**: SF Express '."\n"
+ .'- **ZTO**: ZTO Express '."\n", 'type' => 'string', 'example' => 'SF', 'title' => ''],
+ 'LogisticsUpdateTime' => ['description' => 'Latest logistics update time. ', 'type' => 'string', 'example' => '2022-3-15 22:20:00', 'title' => ''],
+ 'CardCount' => ['description' => 'Number of cards. ', 'type' => 'string', 'example' => '20000', 'title' => ''],
+ 'ContactName' => ['description' => 'Mailing contact.', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'ContactPhone' => ['description' => 'Contact phone number for shipping. ', 'type' => 'string', 'example' => '139000*******', 'title' => ''],
+ 'PostAddress' => ['description' => 'Mailing address. ', 'type' => 'string', 'example' => '某公司', 'title' => ''],
+ 'CreateTime' => ['description' => 'Order creation time. ', 'type' => 'string', 'example' => '2022-3-15 21:20:00', 'title' => ''],
+ 'PayTime' => ['description' => 'Order payment time. ', 'type' => 'string', 'example' => '2022-3-15 21:30:00', 'title' => ''],
+ 'RegionId' => ['description' => 'Region ID. ', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'CardType' => ['description' => 'Card specification. Valid values: '."\n"
+ ."\n"
+ .'- **CONSUMER_THREE_IN_ONE**: Consumer-grade Internet of Things SIM card – triple-cut '."\n"
+ .'- **INDUSTRY_PATCH**: Industrial-grade Internet of Things embedded SIM card '."\n"
+ .'- **CONSUMER_PATCH**: Consumer-grade Internet of Things embedded SIM card '."\n"
+ .'- **INDUSTRY_GENERAL**: Industrial-grade Internet of Things SIM card – standard '."\n"
+ .'- **INDUSTRY_MICRO**: Industrial-grade Internet of Things SIM card – Micro '."\n"
+ .'- **CONSUMER_GENERAL**: Consumer-grade Internet of Things SIM card – standard '."\n"
+ .'- **CONSUMER_TWO_IN_ONE**: Consumer-grade Internet of Things SIM card – dual-cut '."\n"
+ .'- **INDUSTRY_NANO**: Industrial-grade Internet of Things SIM card – Nano '."\n"
+ .'- **CAR_PATCH**: Automotive-grade Internet of Things embedded SIM card '."\n", 'type' => 'string', 'example' => 'CONSUMER_THREE_IN_ONE', 'title' => ''],
+ 'CardNetType' => ['description' => 'Network type of the card. Valid values:'."\n"
+ ."\n"
+ .'- **4G**'."\n"
+ .'- **5G** ', 'type' => 'string', 'example' => '5G', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'Value required for querying the next page.', 'type' => 'string', 'example' => 'iou001238joojjaere', 'title' => ''],
+ 'MaxResults' => ['description' => 'Number of rows per page in a paged query. Maximum value is **50**. Default value is **10**.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Number of entries in the list.', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'DeleteBatchOperateCardsTask' => [
- 'summary' => '删除批量操作卡任务',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'Query order list',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrders'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListOrders',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListRegions' => [
+ 'summary' => 'Query the list of Regions supported by Express Cloud Connect.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'boct-xxx',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
- ],
- [
- 'name' => 'DryRun',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Supported language. Valid values:'."\n"
+ ."\n"
+ .'zh-CN: Chinese.'."\n"
+ .'en-US: English.'."\n"
+ .'ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shenzhen',
- ],
+ 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '2DCFA69E-A161-512D-99A7-108022580719'],
+ 'Regions' => [
+ 'title' => '',
+ 'description' => 'Region information.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'Region information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['title' => '', 'description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ 'LocalName' => ['title' => '', 'description' => 'Region name.', 'type' => 'string', 'example' => '华东1(杭州)'],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'UpdateBatchOperateCardsTask' => [
- 'summary' => '修改批量操作卡任务',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1(杭州)\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query the list of active Regions',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-06T08:12:24.000Z', 'description' => 'Response parameters changed'],
],
- '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListWirelessCloudConnectorGroups' => [
+ 'summary' => 'Query cc5g instance groups.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5451,62 +4526,216 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'Region ID. ', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'WirelessCloudConnectorGroupStatus',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
+ 'description' => 'The list of instance group statuses. A maximum of 10 instance group statuses is supported.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The status of an instance group. Valid values:'."\n"
+ ."\n"
+ .'1. Creating: Creation in progress'."\n"
+ .'2. Available: Valid and stable status'."\n"
+ .'3. Pending: Configuration in progress'."\n"
+ .'4. Deleting: Deletion in progress', 'type' => 'string', 'required' => false, 'example' => 'Creating', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Description',
+ 'name' => 'WirelessCloudConnectorGroupIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of instance group IDs. A maximum of 10 instance group IDs is supported.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of an instance group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc5gg-xxxx', 'title' => ''],
'required' => false,
- 'example' => 'task-test',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'RegionId',
+ 'name' => 'WirelessCloudConnectorGroupNames',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'List of instance group names. A maximum of 10 instance group names is supported. '."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'Instance group name. '."\n"
+ .'The name must be 2 to 128 characters in length, and can contain letters, Chinese characters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter or a Chinese character. ', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
'required' => false,
- 'example' => 'cn-hangzhou',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'NextToken',
'in' => 'query',
+ 'schema' => ['description' => 'The value returned from the previous page query. Do not pass this parameter for the home page query. ', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Number of entries per page in a paged query. Maximum value is **50**. Default value is **10**. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response object',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914'],
+ 'WirelessCloudConnectorGroups' => [
+ 'title' => '',
+ 'description' => 'Information about the instance group list.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'Information about an instance group list item.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorGroupId' => ['title' => '', 'description' => 'Instance group ID. '."\n", 'type' => 'string', 'example' => 'cc5gg-xxxx'],
+ 'Status' => ['title' => '', 'description' => 'Status of the instance group. Valid values:'."\n"
+ ."\n"
+ .'1. Creating: Being created '."\n"
+ .'2. Available: Valid and stable '."\n"
+ .'3. Pending: Being configured '."\n"
+ .'4. Deleting: Being deleted'."\n"
+ ."\n", 'type' => 'string', 'example' => 'Creating'],
+ 'Name' => ['title' => '', 'description' => 'Name. ', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'cc5gg-test'."\n", 'title' => ''],
+ 'RegionId' => ['description' => 'Region ID. ', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
+ 'CreateTime' => ['description' => 'Instance creation time.', 'type' => 'string', 'example' => '2022-07-04 19:19:14', 'title' => ''],
+ 'WirelessCloudConnectors' => [
+ 'description' => 'List of 5G high-speed cloud instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorId' => ['description' => 'ID of the 5G high-speed cloud instance.', 'type' => 'string', 'example' => 'cc5g-62eb02o7lz1w5aurl3', 'title' => ''],
+ 'Status' => ['description' => 'Instance status. Valid values:'."\n"
+ ."\n"
+ .'Creating: Creation in progress '."\n"
+ .'Available: Valid and stable '."\n"
+ .'Pending: Configuration in progress '."\n"
+ .'Deleting: Deletion in progress', 'type' => 'string', 'example' => 'Available', 'title' => ''],
+ 'Name' => ['description' => 'Name. ', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'cc5g-test', 'title' => ''],
+ 'RegionId' => ['description' => 'Region ID. ', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
+ 'UseCase' => ['description' => 'Instance usage scenario. ', 'type' => 'string', 'example' => '智慧工厂'."\n", 'title' => ''],
+ 'DataPackageId' => ['description' => 'Data transfer plan ID. ', 'type' => 'string', 'example' => 'dp-xxxx'."\n", 'title' => ''],
+ 'DataPackageType' => ['description' => 'Data pack tier. Valid values:'."\n"
+ ."\n"
+ .'- **200**: 200 MB per card per month '."\n"
+ .'- **1000**: 1 GB per card per month '."\n"
+ .'- **3000**: 3 GB per card per month '."\n"
+ .'- **30000**: 30 GB per card per month', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'CardCount' => ['description' => 'Number of cards.', 'type' => 'string', 'example' => '115', 'title' => ''],
+ 'CreateTime' => ['description' => 'Instance creation time. ', 'type' => 'string', 'example' => '2022-04-28 17:40:53', 'title' => ''],
+ 'BusinessType' => ['description' => 'Business type ', 'type' => 'string', 'example' => 'Business', 'title' => ''],
+ 'ServiceType' => ['description' => 'Service Type. The following values are returned: '."\n"
+ ."\n"
+ .'- **CC5G**: Standard instance. '."\n"
+ .'- **CC5GCCIoT**: Transferred instance. ', 'type' => 'string', 'example' => 'CC5G', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'NextToken' => ['description' => 'Value returned by the previous page query. Do not pass this value for the home page query.', 'type' => 'string', 'example' => 'iou001238joojjaere', 'title' => ''],
+ 'MaxResults' => ['description' => 'Number of rows per page in a paged query. The maximum value is **50**, and the default value is **10**.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Number of entries in the list.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ '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' => 'Query group information ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWirelessCloudConnectorGroups'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListWirelessCloudConnectorGroups',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ListWirelessCloudConnectors' => [
+ 'summary' => 'Query the list of 5G high-speed cloud instances. ',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DryRun',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'Statuses',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'description' => 'A list of instance statuses.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Instance status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creation in progress'."\n"
+ .'- **Available**: Valid and stable'."\n"
+ .'- **Pending**: Configuration in progress'."\n"
+ .'- **Deleting**: Deletion in progress', 'type' => 'string', 'required' => false, 'example' => 'Available', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
@@ -5514,115 +4743,141 @@
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'A list of instance IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
+ 'items' => ['description' => 'A list of instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Iccids',
+ 'name' => 'Names',
'in' => 'query',
'style' => 'flat',
'schema' => [
- 'description' => '',
+ 'description' => 'A list of instance names.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '890912389123',
- ],
+ 'items' => ['description' => 'A list of names.', 'type' => 'string', 'required' => false, 'example' => '智慧工厂', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'IccidsOssFilePath',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cciot-cn-hangzhou/127859184306****/***.csv',
- ],
+ 'schema' => ['description' => 'The value returned from the previous page query. Do not specify this parameter for the home page query.', 'type' => 'string', 'required' => false, 'example' => 'iou001238joojjaere', 'title' => ''],
],
[
- 'name' => 'OperateType',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'BreakNetwork',
- ],
+ 'schema' => ['description' => 'The number of entries per page for paged queries. The maximum value is **50**, and the default value is **10**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'Threshold',
+ 'name' => 'BusinessType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => 'Business type', 'type' => 'string', 'required' => false, 'example' => 'Business', 'title' => ''],
],
[
- 'name' => 'EffectType',
+ 'name' => 'IsInGroup',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'CurrentMonth',
- ],
+ 'schema' => ['description' => 'Specifies whether to query instances that belong to an instance group. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Query instances in an instance group.'."\n"
+ ."\n"
+ .'- **false**: Do not query instances in an instance group.'."\n"
+ ."\n"
+ .'- **null**: Query all instances regardless of whether they belong to an instance group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'BatchOperateCardsTaskId',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'boct-xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the instance in the group.', 'type' => 'string', 'required' => false, 'example' => 'cc5gg-****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
+ 'WirelessCloudConnectors' => [
+ 'title' => '',
+ 'description' => 'The list of 5G high-speed cloud instances. ',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'RegionItemType',
+ 'type' => 'object',
+ 'properties' => [
+ 'WirelessCloudConnectorId' => ['title' => '', 'description' => 'ID of the 5G high-speed cloud instance. ', 'type' => 'string', 'example' => 'cc5g-xxxx'],
+ 'Status' => ['title' => '', 'description' => 'The instance status. Valid values:'."\n"
+ ."\n"
+ .'- **Creating**: Creating'."\n"
+ .'- **Available**: Valid and stable'."\n"
+ .'- **Pending**: Configuring'."\n"
+ .'- **Deleting**: Deleting ', 'type' => 'string', 'example' => 'Available'],
+ 'Name' => ['title' => '', 'description' => 'Name. ', 'type' => 'string', 'example' => 'test'],
+ 'Description' => ['description' => 'Description. ', 'type' => 'string', 'example' => 'cc5g-test', 'title' => ''],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'UseCase' => ['description' => 'Instance use scenario. ', 'type' => 'string', 'example' => '智慧工厂', 'title' => ''],
+ 'DataPackageId' => ['description' => 'Data transfer plan ID. ', 'type' => 'string', 'example' => 'dp-xxxx', 'title' => ''],
+ 'DataPackageType' => ['description' => 'The data transfer plan tier. Valid values:'."\n"
+ ."\n"
+ .'- **200**: 200 MB per card per month'."\n"
+ .'- **1000**: 1 GB per card per month'."\n"
+ .'- **3000**: 3 GB per card per month'."\n"
+ .'- **30000**: 30 GB per card per month ', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'CardCount' => ['description' => 'Number of cards. ', 'type' => 'string', 'example' => '20000', 'title' => ''],
+ 'CreateTime' => ['description' => 'The instance creation time.', 'type' => 'string', 'example' => '2022-3-15 22:20:00', 'title' => ''],
+ 'BusinessType' => ['description' => 'Business Type ', 'type' => 'string', 'example' => 'Business', 'title' => ''],
+ 'ServiceType' => ['description' => 'Service Type. The following values are returned: '."\n"
+ ."\n"
+ .'- **CC5G**: Standard instance. '."\n"
+ .'- **CC5GCCIoT**: Transferred instance. ', 'type' => 'string', 'example' => 'CC5G', 'title' => ''],
+ 'WirelessCloudConnectorGroupId' => ['description' => 'ID of the associated instance group. ', 'type' => 'string', 'example' => 'cc5gg-****', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The value required for querying the next page. ', 'type' => 'string', 'example' => 'iou001238joojjaere', 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries per page for paged queries. The maximum value is **50**, and the default value is **10**.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The number of entries in the list. ', 'type' => 'string', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'ListBatchOperateCardsTasks' => [
- 'summary' => '查询批量操作卡任务列表',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'Query the list of 5G high-speed cloud instances',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWirelessCloudConnectors'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListWirelessCloudConnectors',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListZones' => [
+ 'summary' => 'Query the list of zones supported by 5G Express Cloud Connect.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5634,560 +4889,414 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
+ 'schema' => ['description' => 'The Region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response object',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C2C1DE7C-E14C-53DE-920D-D63ACD7421A4'],
+ 'Zones' => [
+ 'title' => '',
+ 'description' => 'The list of zones supported in the current Region.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'RegionItemType',
+ 'description' => 'Zone information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h'],
+ 'LocalName' => ['title' => '', 'description' => 'The zone name.', 'type' => 'string', 'example' => '杭州可用区h'],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'Statuses',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Creating',
+ ],
+ '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' => 'Query the List of Zones',
+ 'description' => 'This API is an O&M API, primarily used for network planning and special control. It is currently available only in Beijing, Hangzhou, Shanghai, and Shenzhen. If you have special Region requirements, contact customer service.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListZones'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListZones',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ ],
+ 'LockCards' => [
+ 'summary' => 'Locks cards in a batch.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'BatchOperateCardsTaskIds',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Iccids',
'in' => 'query',
- 'style' => 'flat',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The Integrated Circuit Card Identifiers (ICCIDs) of the Internet of Things (IoT) SIM cards. You can specify up to 500 ICCIDs at a time.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'boct-xxxx',
- ],
- 'required' => false,
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '890912389123', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 1000,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'NextToken',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. Make sure that the token is unique for each request. The token can contain only ASCII characters and must be no more than 64 characters long.'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'Names',
+ 'name' => 'DryRun',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Sends a check request without locking the cards. The system checks for required parameters, the request format, and service limits. If the check fails, an error is returned. If the check passes, the system returns the `DryRunOperation` error code.'."\n"
+ ."\n"
+ .'- **false** (default): Sends a normal request. After the check passes, the system locks the cards.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'OperateType' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'BreakNetwork',
- ],
- 'Threshold' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'EffectType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CurrentMonth',
- ],
- 'IccidsOssFilePath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/***',
- ],
- 'WirelessCloudConnectors' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'Status' => [
- 'description' => '',
- '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',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE'],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'SubmitDiagnoseTaskForSingleCard' => [
- 'summary' => '开启cciot单卡一键诊断',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
+ 'title' => 'Batch lock SIM cards.',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-20T02:37:47.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyWirelessCloudConnectorFeature' => [
+ 'summary' => 'Modify advanced properties of a 5G high-speed cloud instance, such as enabling reverse access.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
+ 'schema' => ['description' => 'The ID of the 5G high-speed cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'Source',
+ 'name' => 'FeatureName',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The feature name.'."\n"
+ .'- **DirectMode**: Direct mode',
'type' => 'string',
- 'required' => true,
- 'example' => '89860477102170127555',
+ 'required' => false,
+ 'enumValueTitles' => ['DirectMode' => 'DirectMode'],
+ 'example' => 'DirectMode',
+ 'title' => '',
],
],
[
- 'name' => 'Destination',
+ 'name' => 'FeatureValue',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '106.14.175.4',
- ],
+ 'schema' => ['description' => 'The feature value.', 'type' => 'string', 'required' => false, 'example' => 'On', 'title' => ''],
],
[
- 'name' => 'BeginTime',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1662307201200',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken identity. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'EndTime',
+ 'name' => 'DryRun',
'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform only a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without updating the instance information. The system checks whether required parameters are provided, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the instance information is updated immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1662307201200',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response object',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '999E0F64-9A10-567B-BB84-B7C46023BA3B'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"999E0F64-9A10-567B-BB84-B7C46023BA3B\\"\\n}","type":"json"}]',
+ 'title' => 'Modify Advanced Properties of a 5G High-Speed Cloud Instance',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-28T11:47:33.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyWirelessCloudConnectorFeature'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'RegionNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ModifyWirelessCloudConnectorFeature',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'WirelessCloudConnector', 'arn' => 'acs:fivegcc:*:{#accountId}:wirelesscloudconnector/{#WirelessCloudConnectorId}'],
+ ],
],
],
+ ],
+ ],
+ 'OpenCc5gService' => [
+ 'summary' => 'Activate Express Cloud Connect over 5G.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ResourceUid',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '253460731706911258',
- ],
+ 'schema' => ['description' => 'Area ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'DiagnoseTaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'diagnoseTask-bp2n6rgaj49qcs34jyzo8',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '2DCFA69E-A161-512D-99A7-108022580719'],
],
+ 'example' => '',
],
],
],
- '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\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\"\\n}","type":"json"}]',
+ 'title' => 'Activate service',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenCc5gService'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:OpenCc5gService',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2n6rgaj49qcs34jyzo8\\"\\n}","type":"json"}]',
],
- 'GetDiagnoseResultForSingleCard' => [
- 'summary' => '查询单卡诊断结果',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RebindCards' => [
+ 'summary' => 'Unlocks an IoT card after rebinding.',
+ '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' => 'Iccids',
'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The ICCID numbers of IoT SIM cards. You can specify up to 500 cards per request.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ICCID of an IoT card.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''],
'required' => true,
- 'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****',
+ 'maxItems' => 1000,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'RegionNo',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Ensures idempotence. Generate a unique value on your client for each request. The value must contain only ASCII characters and be no longer than 64 characters.'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. Each API request has a different RequestId.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
+ ],
+ [
+ 'name' => 'DryRun',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Performs a check. Does not delete the batch task. Checks include required parameters, request format, and business limits. If the check fails, the system returns the corresponding error code. If the check passes, the system returns the error code `DryRunOperation`.'."\n"
+ ."\n"
+ .'- **false** (default): Performs the operation normally. Deletes the batch task after passing the check.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '94032572-8758-575E-B306-86F59D1B826E',
- ],
- 'WirelessCloudConnectorId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'CardIp' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10.176.78.61',
- ],
- 'IccId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89860477102170127555',
- ],
- 'Destination' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106.14.175.4',
- ],
- 'DestinationType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Domain',
- ],
- 'BeginTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1646100223024',
- ],
- 'EndTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1646100223264',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'failed',
- ],
- 'ErrorResult' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ErrorLevel' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Warning',
- ],
- 'ErrorPart' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'Terminal',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Wrong',
- ],
- 'SubItems' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SubItem' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CardStatus',
- ],
- 'SubItemStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'SubItemInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Card status is real-time',
- ],
- ],
- ],
- ],
- ],
- ],
- 'enumValueTitles' => [],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D2A9864E-BB8D-5A5C-90FC-E2FBD5D0BF9B'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Forbidden.RAM',
- 'errorMessage' => 'Ram user does not have permission to perform this operation.',
+ ['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\\": \\"D2A9864E-BB8D-5A5C-90FC-E2FBD5D0BF9B\\"\\n}","type":"json"}]',
+ 'title' => 'Unlock a single SIM card for device re-binding',
+ 'description' => 'When you rebind an IoT card to a new device, the carrier locks the card. You must unlock the card to use it again. Note: Some carriers allow only two rebinding unlocks per card each month.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebindCards'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RebindCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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"}]',
],
- 'ListDiagnoseInfoForSingleCard' => [
- 'summary' => '查询单卡诊断信息列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RemoveWirelessCloudConnectorFromGroup' => [
+ 'summary' => 'Remove a CC5G instance from a CC5G instance group.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6196,417 +5305,289 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'RegionNo',
+ 'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The instance group ID.', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorId',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'A list of IDs of 5G cloud instances. A maximum of 20 IDs can be specified.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of a 5G cloud instance.', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx', 'title' => ''],
'required' => true,
- 'example' => 'cc5g-xxxx',
- ],
- ],
- [
- 'name' => 'SourceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Iccid',
- ],
- ],
- [
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '89860477102170127555',
+ 'maxItems' => 20,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Status',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'success',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken identity. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without updating the instance information. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. After passing the checks, the instance information is updated directly.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E1E237B1-EED7-55D5-AE5F-671E642DB3B5',
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'."\n",
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'DiagnoseInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-xxxx',
- ],
- 'CardIp' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10.176.78.61',
- ],
- 'IccId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89860477102170127555',
- ],
- 'SourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Iccid',
- ],
- 'Source' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '89860477102170127555',
- ],
- 'DestinationType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Domain',
- ],
- 'Destination' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'www.xxx.com',
- ],
- 'BeginTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1662307200000',
- ],
- 'EndTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1662307201200',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'failed',
- ],
- 'DiagnoseTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1662307202400',
- ],
- 'DiagnoseTaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'diagnoseTask-bp2x7tzkdl655liw3mhbg',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2DCFA69E-A161-512D-99A7-108022580719'],
],
+ 'example' => '',
],
],
],
- '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.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\"\\n}","type":"json"}]',
+ 'title' => 'Remove a CC5G instance from a group',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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"}]',
],
- 'GrantNetLink' => [
- 'summary' => '分享授权网络连接',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ResetAreaLimitCards' => [
+ 'summary' => 'Unlocks the area restriction for Internet of Things (IoT) cards.',
+ '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' => '',
- 'type' => 'string',
+ 'description' => 'The Integrated Circuit Card Identifiers (ICCIDs) of the IoT SIM cards. You can specify up to 50 ICCIDs at a time.',
+ 'type' => 'array',
+ 'items' => ['description' => 'An ICCID of an IoT SIM card.', 'type' => 'string', 'required' => false, 'example' => '898606*******', 'title' => ''],
'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'cc5g-xxxx',
+ 'maxItems' => 1000,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'cciot-xxxx',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'f0ba469f-de7f-4dde-8390-0966a1a0ef9a',
- ],
+ 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request.'."\n"
+ .'Make sure that the token is unique for each request. The ClientToken can contain only ASCII characters.'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the system uses the **RequestId** of the API request as the **ClientToken**. The **RequestId** may be different for each request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'False',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run for the request. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Performs a dry run. The system checks the request for potential issues, including missing required parameters, incorrect formatting, and business limits. The system does not create a batch operation task. If the check fails, an error is returned. If the check passes, the `DryRunOperation` error code is returned.'."\n"
+ ."\n"
+ .'- **false** (default): Sends a normal request. A batch operation task is created after the request passes the check.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'GrantAliUid',
+ 'name' => 'Province',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => '11111111111',
- ],
+ 'schema' => ['description' => 'The province.', 'type' => 'string', 'required' => true, 'example' => '湖南省', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'E6B58AF9-F1BF-5894-B898-6CE2108463C5',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
- 'enumValueTitles' => [],
+ 'example' => '',
],
],
],
'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' => 'Unlock Regional Restrictions ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ResetAreaLimitCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6B58AF9-F1BF-5894-B898-6CE2108463C5\\"\\n}","type":"json"}]',
],
- 'RevokeNetLink' => [
- 'summary' => '撤销分享授权网络连接',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ResumeCards' => [
+ 'summary' => 'Resumes one or more SIM cards with the carrier. Batch operations are supported.',
+ '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' => '',
- 'type' => 'string',
+ 'description' => 'IoT SIM card ICCID. Maximum 500 ICCIDs per request.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '890912389123', 'title' => ''],
'required' => true,
- 'example' => 'cc5g-xxxx',
+ 'maxItems' => 1000,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'NetLinkId',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'iotcc-ua6xy4vpmi24y114ws',
- ],
+ 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8278082c-0b8c-412c-b0ad-876a3cf0d0f8',
- ],
+ 'schema' => ['description' => 'Ensures idempotence. Generate a unique value on your client for each request. Only ASCII characters are supported, and the value must not exceed 64 characters.'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. Each API request may have a different RequestId.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Indicates whether to perform only a dry run. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Performs a check without activating or resuming the SIM card. Checks include required parameters, request format, and business limits. If the check fails, the corresponding error code returns. If the check passes, the error code `DryRunOperation` returns.'."\n"
+ ."\n"
+ .'- **false** (default): Performs the actual operation. Activates or resumes the SIM card after passing the check.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1E781588-69D4-56C3-93BA-DEFECF2596B8',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E781588-69D4-56C3-93BA-DEFECF2596B8\\"\\n}","type":"json"}]',
- ],
- 'CreateWirelessCloudConnectorGroup' => [
- 'summary' => '创建5G高速上云服务实例组',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CardsSimStatusNotResume', 'errorMessage' => 'The operation is not allowed because of card status not support to resume.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => 'Activate/Recover SIM Card Status',
+ 'description' => 'You can resume a SIM card if it is locked because of a device change or frequent dial-up attempts.',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-10T17:21:04.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-05-20T02:37:47.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RevokeNetLink' => [
+ 'summary' => 'Actively revoke a previously authorized action. ',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6615,99 +5596,78 @@
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'Description',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5gg-test',
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance. ', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'NetLinkId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the network connectivity. ', 'type' => 'string', 'required' => true, 'example' => 'iotcc-ua6xy4vpmi24y114ws', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter across different requests. The value must contain only ASCII characters and cannot exceed 64 characters. '."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request. '."\n", 'type' => 'string', 'required' => false, 'example' => '8278082c-0b8c-412c-b0ad-876a3cf0d0f8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values: '."\n"
+ .'- **true**: Sends a dry run request without revoking the association. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned. '."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the association between the user\'s VPC and vSwitch is directly revoked. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '88C2F32F-B641-5980-B7A5-6907050ABCD1'."\n",
- ],
- 'WirelessCloudConnectorGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5gg-****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID ', 'type' => 'string', 'example' => '1E781588-69D4-56C3-93BA-DEFECF2596B8'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88C2F32F-B641-5980-B7A5-6907050ABCD1\\\\n\\",\\n \\"WirelessCloudConnectorGroupId\\": \\"cc5gg-****\\"\\n}","type":"json"}]',
- ],
- 'UpdateWirelessCloudConnectorGroup' => [
- 'summary' => '修改5G高速上云服务实例分组',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E781588-69D4-56C3-93BA-DEFECF2596B8\\"\\n}","type":"json"}]',
+ 'title' => 'Revoke Authorization ',
+ 'description' => 'If the authorized customer has already accepted the authorization, it cannot be revoked. Revocation is only allowed before the authorization is accepted. ',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-04T10:43:43.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeNetLink'],
+ ],
],
+ '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' => 'Stops a single IoT SIM card or multiple cards in a batch operation.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6719,351 +5679,190 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'IoT SIM card ICCIDs. Maximum 500 per request.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '890912389123', 'title' => ''],
'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'cc5gg-****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'test',
+ 'maxItems' => 1000,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Description',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'description',
- ],
+ 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures idempotence. Generate a unique value on your client for each request. Supports only ASCII characters. Maximum 64 characters.'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. Each API request has a different RequestId.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Indicates whether to perform a dry run. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Performs a check only. Does not stop cards. Checks include required parameters, request format, and business limits. Returns an error if the check fails. If the check passes, returns the error code `DryRunOperation`.'."\n"
+ ."\n"
+ .'- **false** (default): Performs the normal operation. Stops cards after passing the check.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE'],
],
- 'enumValueTitles' => [],
+ 'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
- ],
- 'ListWirelessCloudConnectorGroups' => [
- 'summary' => '查询5G高速上云服务实例分组列表',
- 'methods' => [
- 'get',
+ 'title' => 'SIM Card Shutdown Operation',
+ 'description' => 'Stops an IoT SIM card with the carrier. This operation is useful when a card is compromised or for proactive operations and maintenance (O\\&M) tasks.',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-20T02:37:47.000Z', 'description' => 'OpenAPI offline'],
],
- '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SubmitDiagnoseTaskForSingleCard' => [
+ 'summary' => 'Initiate a network diagnosis for a single Internet of Things SIM card.',
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The ID of the 5G high-speed cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorGroupStatus',
+ 'name' => 'Source',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Creating',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the source Internet of Things SIM card for the network diagnosis.', 'type' => 'string', 'required' => true, 'example' => '89860477102170127555', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorGroupIds',
+ 'name' => 'Destination',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5gg-xxxx',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The destination IP address or domain name for the network diagnosis.', 'type' => 'string', 'required' => false, 'example' => '106.14.175.4', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorGroupNames',
+ 'name' => 'BeginTime',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The UNIX timestamp indicating the start time of the network diagnosis. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1662307201200', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere'."\n",
- ],
+ 'schema' => ['description' => 'The UNIX timestamp indicating the end time of the network diagnosis. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1662307201200', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'RegionNo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The region ID of the 5G high-speed cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceUid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Alibaba Cloud account ID of the user of the cloud connector instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '253460731706911258', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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的资源属性字段',
- 'type' => 'string',
- 'example' => 'cc5gg-xxxx',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'Creating',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5gg-test'."\n",
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-07-04 19:19:14',
- ],
- 'WirelessCloudConnectors' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => 'RegionItemType',
- 'type' => 'object',
- 'properties' => [
- 'WirelessCloudConnectorId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-62eb02o7lz1w5aurl3',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cc5g-test',
- ],
- 'RegionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
- 'UseCase' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DataPackageId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dp-xxxx'."\n",
- ],
- 'DataPackageType' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'CC5G',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere',
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6', 'title' => ''],
+ 'DiagnoseTaskId' => ['description' => 'The network diagnostic task ID.', 'type' => 'string', 'example' => 'diagnoseTask-bp2n6rgaj49qcs34jyzo8', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'DeleteWirelessCloudConnectorGroup' => [
- 'summary' => '删除5G高速上云服务实例分组',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => ''],
+ ['errorCode' => 'cardIdNotExist', 'errorMessage' => 'diagnose task iccid not exist', 'description' => ''],
+ ['errorCode' => 'CardIPNotBind', 'errorMessage' => 'card ip not bind', 'description' => ''],
+ ['errorCode' => 'CardIPAndIccIdNotMatch', 'errorMessage' => 'card ip and iccid not match', 'description' => ''],
+ ['errorCode' => 'CardIPNotExist', 'errorMessage' => 'card ip not exist', 'description' => ''],
+ ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\",\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2n6rgaj49qcs34jyzo8\\"\\n}","type":"json"}]',
+ 'title' => 'Initiate Single-SIM Network Diagnosis',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-28T07:22:13.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDiagnoseTaskForSingleCard'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'iotcc:SubmitDiagnoseTaskForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SwitchWirelessCloudConnectorToBusiness' => [
+ 'summary' => 'Switches a 5G Cloud service test instance to a commercial instance. ',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7072,447 +5871,454 @@
'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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => 'ID of the 5G Cloud instance. ', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter across different requests. Only ASCII characters are supported, and the length cannot exceed 64 characters. '."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request. ', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values: '."\n"
+ .'- **true**: Sends a dry run request without deleting the instance. Checks include whether required parameters are provided, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned. '."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, an HTTP 2xx status code is returned and the instance is deleted. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- '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'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E759287-F208-589B-82D8-6D7A30F417E3\\"\\n}","type":"json"}]',
- ],
- 'AddWirelessCloudConnectorToGroup' => [
- 'summary' => '添加5G高速上云服务实例到组',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74ADDCF3-E3FE-5200-9290-1320125D71DC\\"\\n}","type":"json"}]',
+ 'title' => 'Switch 5G Cloud Service Instance to Commercial Mode ',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-20T06:47:52.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchWirelessCloudConnectorToBusiness'],
+ ],
+ ],
+ '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' => 'Unlocks cards in a batch.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
- ],
- [
- 'name' => 'WirelessCloudConnectorIds',
+ 'name' => 'Iccids',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '',
+ 'description' => 'The Integrated Circuit Card Identifiers (ICCIDs) of the Internet of Things (IoT) SIM cards. You can specify up to 500 ICCIDs in each request.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '890912389123', 'title' => ''],
'required' => true,
- 'maxItems' => 20,
+ 'maxItems' => 1000,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'A client token used to ensure the idempotence of the request. Generate a unique value for this parameter from the client. The token can contain only ASCII characters and must be no more than 64 characters in length.'."\n"
+ ."\n"
+ .'> If this parameter is not specified, the system uses the RequestId of the request as the ClientToken. The RequestId may be different for each request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Sends a check request without unlocking the cards. The system checks for required parameters, the request format, and business limits. If the check fails, a corresponding error is returned. If the check passes, the `DryRunOperation` error code is returned.'."\n"
+ ."\n"
+ .'- **false** (default): Sends a normal request. After the check passes, the batch unlock operation is performed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '81CB64DF-E328-50A3-B386-03CAD604C114'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
- ],
- 'RemoveWirelessCloudConnectorFromGroup' => [
- 'summary' => '从组里移除5G高速上云服务实例',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CardsSimStatusNotUnlock', 'errorMessage' => 'The operation is not allowed because of card status not support to unlock.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81CB64DF-E328-50A3-B386-03CAD604C114\\"\\n}","type":"json"}]',
+ 'title' => 'Unlock multiple SIM cards in batch',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-13T02:36:20.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2022-05-20T02:37:47.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockCards'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UnlockCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateAuthorizationRule' => [
+ 'summary' => 'Update an authorization rule.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'WirelessCloudConnectorIds',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cc5g-xxxx',
- ],
- 'required' => true,
- 'maxItems' => 20,
- ],
+ 'schema' => ['description' => 'The ID of the authorization rule.', 'type' => 'string', 'required' => true, 'example' => 'ar5g-xxxx', 'title' => ''],
],
[
- 'name' => 'RegionId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'Name, with a maximum length of 128 characters. ', 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description. The description can be up to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ar5g-test', 'title' => ''],
+ ],
+ [
+ 'name' => 'SourceCidr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source CIDR block.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0', 'title' => ''],
+ ],
+ [
+ 'name' => 'Destination',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination IP address or domain name.', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The protocol type. Valid values:'."\n"
+ .'- **tcp**'."\n"
+ .'- **udp**'."\n"
+ .'- **icmp**'."\n"
+ .'- **all**: All protocols are supported.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''],
+ ],
+ [
+ 'name' => 'DestinationPort',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination port range. Valid values:'."\n"
+ .'- For TCP and UDP protocols: 1 to 65535. Separate the start and end ports with a forward slash (/). Example: 1/200.'."\n"
+ .'- For ICMP protocol: -1/-1.'."\n"
+ .'- For ALL: -1/-1.', 'type' => 'string', 'required' => false, 'example' => '-1/-1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Policy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The policy of the authorization rule. Valid values:'."\n"
+ .'- **Permit**: Allow'."\n"
+ .'- **Deny**: Deny', 'type' => 'string', 'required' => false, 'example' => 'Permit', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. Generate a unique value from your client for this parameter across different requests. The value must contain only ASCII characters and cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without updating the authorization rule. The system checks required parameters, request format, and service limits. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (Default Value): Sends a normal request. If the check passes, the authorization rule is updated.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2DCFA69E-A161-512D-99A7-108022580719',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DCFA69E-A161-512D-99A7-108022580719\\"\\n}","type":"json"}]',
- ],
- 'CreateGroupAuthorizationRule' => [
- 'summary' => '创建5G高速上云服务实例组的授权规则',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\"\\n}","type":"json"}]',
+ 'title' => 'Update an authorization rule',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-18T13:33:38.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-06-23T08:23:56.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateBatchOperateCardsTask' => [
+ 'summary' => 'Update a batch operations card job.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => 'Task Name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'Job description.', 'type' => 'string', 'required' => false, 'example' => 'task-test', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5gg-test',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
- 'name' => 'SourceCidr',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.0.0.0/0',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'DestinationType',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Cidr',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform only a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without updating the batch operations card job. The system checks whether required parameters are provided, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. After passing the checks, the batch operations card job is updated.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'Protocol',
+ 'name' => 'WirelessCloudConnectorIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'A list of IDs of 5G high-speed cloud instances. A maximum of 10 IDs can be specified.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of a 5G high-speed cloud instance.', 'type' => 'string', 'required' => false, 'example' => 'cc5g-xxxx', 'title' => ''],
'required' => false,
- 'example' => 'all',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'DestinationPort',
+ 'name' => 'Iccids',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'A list of ICCIDs of cards. A maximum of 200 ICCIDs can be specified.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ICCID of a card.', 'type' => 'string', 'required' => false, 'example' => '890912389123', 'title' => ''],
'required' => false,
- 'example' => '-1/-1',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Destination',
+ 'name' => 'IccidsOssFilePath',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '106.14.175.4',
- ],
+ 'schema' => ['description' => 'The OSS file path where the ICCID file is stored.', 'type' => 'string', 'required' => false, 'example' => 'cciot-cn-hangzhou/127859184306****/***.csv', 'title' => ''],
],
[
- 'name' => 'Policy',
+ 'name' => 'OperateType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The throttling type. Valid values: '."\n"
+ ."\n"
+ .'- **BreakNetwork**: Disconnect the network when the threshold is exceeded.'."\n"
+ .'- **LimitRate**: Apply throttling when the threshold is exceeded.'."\n"
+ .'- **Alarm**: Trigger an alert when the threshold is exceeded.',
'type' => 'string',
- 'required' => true,
- 'example' => 'Permit',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'BreakNetwork',
+ 'title' => '',
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Threshold',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The threshold in MB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
+ ],
+ [
+ 'name' => 'EffectType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The effect type. Valid values:'."\n"
+ .'- **CurrentMonth**'."\n"
+ .'- **ContinualMonth**',
'type' => 'string',
'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'enumValueTitles' => [],
+ 'example' => 'CurrentMonth',
+ 'title' => '',
],
],
[
- 'name' => 'DryRun',
+ 'name' => 'BatchOperateCardsTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The ID of the Batch Operations job.', 'type' => 'string', 'required' => true, 'example' => 'boct-xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AA93A076-3D94-51AB-AC70-4C94AF003B03',
- ],
- 'AuthorizationRuleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ar5gg-xxxx',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- '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' => 'Update a batch operations card job',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-08T10:39:02.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA93A076-3D94-51AB-AC70-4C94AF003B03\\",\\n \\"AuthorizationRuleId\\": \\"ar5gg-xxxx\\"\\n}","type":"json"}]',
],
- 'UpdateGroupAuthorizationRule' => [
- 'summary' => '更新5G高速上云服务实例组的授权规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateCard' => [
+ 'summary' => 'Update the name and description of a card instance. ',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7524,444 +6330,310 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
- 'name' => 'WirelessCloudConnectorGroupId',
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance. ', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'AuthorizationRuleId',
+ 'name' => 'Iccid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ar5gg-xxxx',
- ],
+ 'schema' => ['description' => 'The ICCID of the Internet of Things (IoT) card. ', 'type' => 'string', 'required' => false, 'example' => '890912389123', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'Name. ', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'Description. ', 'type' => 'string', 'required' => false, 'example' => 'card-test', 'title' => ''],
],
[
- 'name' => 'SourceCidr',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.0.1',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters. '."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request. ', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'Destination',
+ 'name' => 'DryRun',
'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values: '."\n"
+ .'- **true**: Sends a dry run request without updating the card information. The system checks whether required parameters are provided, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned. '."\n"
+ .'- **false** (default): Sends a normal request. After passing the checks, the card information is updated. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.XX.XX',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response object ',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE'],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
+ 'title' => 'Update Card Information ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCard'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateDNSAuthorizationRule' => [
+ 'summary' => 'Update the DNS authorization rule.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Protocol',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WirelessCloudConnectorId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
+ 'schema' => ['description' => 'The ID of the 5G cloud instance.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
- 'name' => 'DestinationPort',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '80/80'."\n",
- ],
+ 'schema' => ['description' => 'The ID of the DNS authorization rule.', 'type' => 'string', 'required' => true, 'example' => 'ar5g-xxxx', 'title' => ''],
],
[
- 'name' => 'Policy',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Permit',
- ],
+ 'schema' => ['description' => 'Name, with a maximum length of 128 characters.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Description, with a maximum length of 256 characters.', 'type' => 'string', 'required' => false, 'example' => 'ar5g-test', 'title' => ''],
+ ],
+ [
+ 'name' => 'SourceDNSIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DNS server address.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0', 'title' => ''],
+ ],
+ [
+ 'name' => 'DestinationIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The DNS server address to which traffic is redirected.', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without updating the DNS authorization rule. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are met. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. After passing the checks, the DNS authorization rule is updated.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '79B01B1A-7089-552F-9798-DEDFFBAAED5F',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- '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' => 'Update DNS Authorization Rule',
+ 'changeSet' => [
+ ['createdAt' => '2022-11-02T09:57:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79B01B1A-7089-552F-9798-DEDFFBAAED5F\\"\\n}","type":"json"}]',
],
- 'ListGroupAuthorizationRules' => [
- 'summary' => '查询5G高速上云服务实例组的授权规则列表',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateGroupAuthorizationRule' => [
+ 'summary' => 'Modify the authorization rule of a CC5G instance group.',
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
- ],
- [
- 'name' => 'Statuses',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Creating',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'AuthorizationRuleIds',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5gg-xxxx',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Instance group ID.', 'type' => 'string', 'required' => true, 'example' => 'cc5gg-****', 'title' => ''],
],
[
- 'name' => 'Names',
+ 'name' => 'AuthorizationRuleId',
'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'ar5gg-xxxx', 'title' => ''],
],
[
- 'name' => 'DestinationType',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Cidr',
- ],
+ 'schema' => ['description' => 'The Name of the authorization rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'Protocol',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
+ 'schema' => ['description' => 'Description of the authorization rule. The description can be up to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
- 'name' => 'DestinationPort',
+ 'name' => 'SourceCidr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '-1/-1',
- ],
+ 'schema' => ['description' => 'Source CIDR block.', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1', 'title' => ''],
],
[
'name' => 'Destination',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.1',
- ],
+ 'schema' => ['description' => 'Access target.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', 'title' => ''],
],
[
- 'name' => 'Policy',
+ 'name' => 'Protocol',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Permit',
- ],
+ 'schema' => ['description' => 'Protocol type. Valid values:'."\n"
+ .'- **tcp**'."\n"
+ .'- **udp**'."\n"
+ .'- **icmp**'."\n"
+ .'- **all**: Supports all protocols.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''],
],
[
- 'name' => 'Type',
+ 'name' => 'DestinationPort',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'System',
- ],
+ 'schema' => ['description' => 'The destination port range. Valid values:'."\n"
+ ."\n"
+ .'- For TCP and UDP protocols: 1 to 65535. Separate the start port and stop port with a forward slash (/). Example: 1/200.'."\n"
+ ."\n"
+ .'- For ICMP protocol: -1/-1.'."\n"
+ ."\n"
+ .'- For ALL: -1/-1.', 'type' => 'string', 'required' => false, 'example' => '80/80'."\n", 'title' => ''],
],
[
- 'name' => 'Dns',
+ 'name' => 'Policy',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Authorization policy. Valid values:'."\n"
+ .'- **Permit**: Allow'."\n"
+ .'- **Deny**: Deny', 'type' => 'string', 'required' => false, 'example' => 'Permit', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'iou001238joojjaere',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without deleting the instance. The system checks whether required parameters are specified, whether the request format is valid, and whether the request complies with business limits. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the system returns an HTTP 2xx status code and deletes the instance.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6',
- ],
- 'GroupAuthorizationRules' => [
- 'title' => '数组,返回示例目录。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'RegionItemType',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AuthorizationRuleId' => [
- 'title' => '资源一级ID',
- 'description' => '代表资源一级ID的资源属性字段',
- 'type' => 'string',
- 'example' => 'ar5gg-y5g4rp2w1tl1w7zg59',
- ],
- 'Status' => [
- 'title' => '资源名称',
- 'description' => '代表资源名称的资源属性字段',
- 'type' => 'string',
- 'example' => 'Creating',
- ],
- 'Name' => [
- 'title' => '创建时间',
- 'description' => '代表创建时间的资源属性字段',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ar5gg-test'."\n",
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'SourceCidr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.0.0.0/0',
- ],
- 'DestinationType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Cidr',
- ],
- 'Protocol' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'all',
- ],
- 'DestinationPort' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0-65535',
- ],
- 'Destination' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '47.103.184.100/32',
- ],
- 'Policy' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Permit',
- ],
- 'Dns' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-06-21 15:27:24',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'iou001238joojjaere'."\n",
- ],
- 'MaxResults' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '79B01B1A-7089-552F-9798-DEDFFBAAED5F'],
],
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'DeleteGroupAuthorizationRule' => [
- 'summary' => '删除5G高速上云服务实例组的授权规则',
- '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' => 'Update Group Authorization Rule',
+ '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' => 'Modify the DNS authorization rule of an instance group.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7970,83 +6642,116 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The ID of the instance group.',
'type' => 'string',
'required' => true,
+ 'enumValueTitles' => [],
'example' => 'cc5gg-****',
+ 'title' => '',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The ID of the DNS authorization rule.'."\n",
'type' => 'string',
'required' => true,
- 'example' => 'ar5gg-12fnojjtkkre28t08j',
+ 'enumValueTitles' => [],
+ 'example' => 'ar5gg-xxxx',
+ 'title' => '',
],
],
[
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the DNS authorization rule.'."\n"
+ ."\n"
+ .'The name must be 2 to 128 characters in length and can contain English letters, Chinese characters, digits, periods (.), underscores (_), and hyphens (-). It must start with an uppercase or lowercase English letter or a Chinese character.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the DNS authorization rule.'."\n"
+ ."\n"
+ .'The description must be 2 to 256 characters in length. It must start with an uppercase or lowercase English letter or a Chinese character, and it cannot start with http:// or https://.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''],
+ ],
+ [
+ 'name' => 'SourceDNSIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The source IP address of the DNS authorization rule. Valid values include but are not limited to:'."\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", 'type' => 'string', 'required' => false, 'example' => '100.100.2.136'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'DestinationIp',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The destination IP address of the DNS authorization rule.', 'type' => 'string', 'required' => false, 'example' => '192.168.0.2'."\n", 'title' => ''],
+ ],
+ [
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. Generate a unique value from your client for this parameter across different requests. The value can contain only ASCII characters and must not exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform only a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without creating the authorization rule. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are exceeded. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the authorization rule is created immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A175C091-3910-51AF-8D84-D5717B9B8D38',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '207F9929-806E-5622-8E4F-8484F7000C22'],
],
+ 'enumValueTitles' => [],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A175C091-3910-51AF-8D84-D5717B9B8D38\\"\\n}","type":"json"}]',
- ],
- 'AddGroupDnsAuthorizationRule' => [
- 'summary' => '添加5G高速上云服务实例组的DNS授权规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"207F9929-806E-5622-8E4F-8484F7000C22\\"\\n}","type":"json"}]',
+ 'title' => 'Update Group DNS Authorization Rule',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupDnsAuthorizationRule'],
+ ],
+ ],
+ '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' => 'Update the 5G high-speed cloud instance information.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8055,118 +6760,80 @@
'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' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc5gg-****',
- ],
+ 'schema' => ['description' => '5G high-speed cloud instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cc5g-xxxx', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'Name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ar5gg-test'."\n",
- ],
- ],
- [
- 'name' => 'SourceDNSIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '114.114.114.114',
- ],
- ],
- [
- 'name' => 'DestinationIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.1.1.1',
- ],
+ 'schema' => ['description' => 'Description.', 'type' => 'string', 'required' => false, 'example' => 'cc5g-test', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
- ],
+ 'schema' => ['description' => 'Ensures idempotence of the request. Generate a unique value from your client for this parameter across different requests. Only ASCII characters are supported, and the length cannot exceed 64 characters.'."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.', 'type' => 'string', 'required' => false, 'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to perform a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without updating the instance information. The system checks required parameters, request format, and business restrictions. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. After passing the checks, the instance information is updated directly.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D3BAFE75-C670-52DB-9739-03133E5FC914',
- ],
- 'AuthorizationRuleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ar5gg-12fnojjtkkre28t08j',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6'],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D3BAFE75-C670-52DB-9739-03133E5FC914\\",\\n \\"AuthorizationRuleId\\": \\"ar5gg-12fnojjtkkre28t08j\\"\\n}","type":"json"}]',
- ],
- 'UpdateGroupDnsAuthorizationRule' => [
- 'summary' => '更新5G高速上云服务实例组的DNS授权规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6\\"\\n}","type":"json"}]',
+ 'title' => 'Update 5G High-Speed Cloud Instance',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWirelessCloudConnector'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateWirelessCloudConnectorGroup' => [
+ 'summary' => 'Modify the information of a CC5G instance group.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8178,91 +6845,75 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREuisCRZVRV',
- ],
+ 'abilityTreeNodes' => ['FEATUREuisCRZVRV'],
],
'parameters' => [
[
'name' => 'WirelessCloudConnectorGroupId',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The ID of the instance group.',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'cc5gg-****',
- ],
- ],
- [
- 'name' => 'AuthorizationRuleId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'ar5gg-xxxx',
+ 'title' => '',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The name of the instance group to be modified.'."\n"
+ ."\n"
+ .'The name must be 2 to 128 English or Chinese characters in length. It must start with an uppercase or lowercase English letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-).',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'test',
+ 'title' => '',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'The description of the instance group to be modified.'."\n"
+ ."\n"
+ .'The description must be 2 to 256 characters in length. It must start with an uppercase or lowercase English letter or a Chinese character, and it cannot start with `http://` or `https://`.',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'description',
- ],
- ],
- [
- 'name' => 'SourceDNSIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '100.100.2.136'."\n",
- ],
- ],
- [
- 'name' => 'DestinationIp',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.0.2'."\n",
+ 'title' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Ensures the idempotence of the request. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. Only ASCII characters are supported, and the value cannot exceed 64 characters.'."\n"
+ ."\n"
+ .'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'TF-******-1633255280-43c94bf7-2dd3-4c14-8',
+ 'title' => '',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'description' => 'Specifies whether to perform only a dry run of the request. Valid values:'."\n"
+ .'- **true**: Sends a dry run request without updating the instance information. The system checks whether required parameters are specified, whether the request format is valid, and whether the request complies with service limits. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned.'."\n"
+ .'- **false** (default): Sends a normal request. If the check passes, the instance information is updated immediately.',
'type' => 'boolean',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'true',
+ 'title' => '',
],
],
],
@@ -8270,59 +6921,1220 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response object',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
- 'description' => '',
+ 'description' => 'The ID of the request.',
'type' => 'string',
- 'example' => '207F9929-806E-5622-8E4F-8484F7000C22',
+ 'enumValueTitles' => [],
+ 'example' => '8734B5B2-FC84-54C4-8038-D40228CF01FE',
],
],
'enumValueTitles' => [],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8734B5B2-FC84-54C4-8038-D40228CF01FE\\"\\n}","type":"json"}]',
+ 'title' => 'Update group information',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"207F9929-806E-5622-8E4F-8484F7000C22\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => 'cc5g-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cc5g.aliyuncs.com', 'endpoint' => 'cc5g.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'cardIdNotExist', 'message' => 'diagnose task iccid not exist', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CardIPAndIccIdNotMatch', 'message' => 'card ip and iccid not match', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CardIPNotBind', 'message' => 'card ip not bind', 'http_code' => 400, 'description' => ''],
+ ['code' => 'CardIPNotExist', 'message' => 'card ip not exist', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Forbidden.RAM', 'message' => 'Ram user does not have permission to perform this operation.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OperationDenied.AttachedVpc', 'message' => 'The operation is not allowed because of exist vpc.', 'http_code' => 400, 'description' => 'The operation is denied because a bound VPC exists.'],
+ ['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' => ''],
+ ['code' => 'OperationDenied.ExistCustomerAuthorizationRules', 'message' => 'The operation is not allowed because of exist customer authorization rules.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'OperationDenied.ExistCustomerAuthorizationRules', 'message' => 'The operation is not allowed because of exist customer authorizationRule.', 'http_code' => 400, 'description' => 'The operation is denied because a custom authorization rule exists in the current instance.'],
+ ['code' => 'OperationDenied.GrantUidNotHaveCcIotSlr', 'message' => 'The operation is not allowed because of GrantUid not have AliyunServiceRoleForCCIoT.', 'http_code' => 400, 'description' => ''],
+ ['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' => ''],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetCreateCustomerInfomation'],
+ ],
+ 'createdAt' => '2024-07-16T07:39:05.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetDiagnoseResultForSingleCard'],
+ ],
+ 'createdAt' => '2024-03-07T09:19:48.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'DeleteWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2023-05-30T09:09:43.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2023-05-04T02:45:56.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListCardDayUsages'],
+ ],
+ 'createdAt' => '2023-04-27T09:15:32.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2023-04-23T07:55:25.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'GetDiagnoseResultForSingleCard'],
+ ],
+ 'createdAt' => '2023-01-06T07:30:55.000Z',
+ 'description' => '5G高速上云获取单卡诊断结果的API GetDiagnoseResultForSingleCard返回结果中新增诊断子项信息,用于更加详细的展示诊断结果。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListCardUsages'],
+ ],
+ 'createdAt' => '2022-12-26T07:36:49.000Z',
+ 'description' => '增加iccid入参数量1~50',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListRegions'],
+ ],
+ 'createdAt' => '2022-12-06T08:13:01.000Z',
+ 'description' => '下线显示endpoint',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'DeleteWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2022-11-29T08:55:05.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'UpdateDNSAuthorizationRule'],
+ ],
+ 'createdAt' => '2022-11-02T09:58:39.000Z',
+ 'description' => 'dns更新接口实例id必填',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateWirelessCloudConnector'],
+ ['description' => 'Response parameters changed', 'api' => 'GetWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2022-10-27T08:43:25.000Z',
+ 'description' => 'cc5g分组相关api发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateBatchOperateCardsTask'],
+ ],
+ 'createdAt' => '2022-10-17T02:12:04.000Z',
+ 'description' => 'inner api publish',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateAuthorizationRule'],
+ ['description' => 'Error codes changed', 'api' => 'UpdateAuthorizationRule'],
+ ],
+ 'createdAt' => '2022-10-17T02:12:03.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'UnlockCards'],
+ ],
+ 'createdAt' => '2022-10-13T02:36:53.000Z',
+ 'description' => '错误码发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ResumeCards'],
+ ],
+ 'createdAt' => '2022-10-10T17:21:21.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-09-29T12:42:11.000Z',
+ 'description' => 'ListCards接口增加按MSISDN搜索参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'SubmitDiagnoseTaskForSingleCard'],
+ ],
+ 'createdAt' => '2022-09-28T07:23:41.000Z',
+ 'description' => '新增CC5G单卡诊断功能相关接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateWirelessCloudConnector'],
+ ],
+ 'createdAt' => '2022-09-20T09:17:20.000Z',
+ 'description' => '创建5G高速上云服务接口RegionID参数改成必填',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GrantNetLink'],
+ ['description' => 'Error codes changed', 'api' => 'GrantNetLink'],
+ ],
+ 'createdAt' => '2022-09-14T03:05:47.000Z',
+ 'description' => '增加错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'FailCards'],
+ ],
+ 'createdAt' => '2022-09-04T13:01:36.000Z',
+ 'description' => '发布卡失效接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetWirelessCloudConnector'],
+ ['description' => 'OpenAPI offline', 'api' => 'RevokeNetLink'],
+ ],
+ 'createdAt' => '2022-09-04T10:44:00.000Z',
+ 'description' => 'cc5g过户',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateAuthorizationRule'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAuthorizationRules'],
+ ['description' => 'Request parameters changed', 'api' => 'UpdateAuthorizationRule'],
+ ],
+ 'createdAt' => '2022-08-19T02:34:01.000Z',
+ 'description' => '支持端口级别白名单规则',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetCard'],
+ ],
+ 'createdAt' => '2022-08-09T11:31:03.000Z',
+ 'description' => '发布GetCard接口',
+ ],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'GetCreateCustomerInformation'],
+ ],
+ 'createdAt' => '2022-08-02T06:21:50.000Z',
+ 'description' => '客户资料录入可以传入cc5gid来判断这个cc5gid下面是否需要录入资料',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'],
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteIoTCloudConnectorBackhaulRoute'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListIoTCloudConnectorBackhaulRoute'],
+ ['description' => 'OpenAPI offline', 'api' => 'ModifyWirelessCloudConnectorFeature'],
+ ],
+ 'createdAt' => '2022-07-28T11:48:11.000Z',
+ 'description' => '新增CC5G支持反向访问能力相关API',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetCardLockReason'],
+ ['description' => 'OpenAPI offline', 'api' => 'SwitchWirelessCloudConnectorToBusiness'],
+ ],
+ 'createdAt' => '2022-07-20T06:48:12.000Z',
+ 'description' => '测试卡功能发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-07-18T10:04:22.000Z',
+ 'description' => '添加MSISDN字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetCreateCustomerInformation'],
+ ],
+ 'createdAt' => '2022-07-11T12:29:07.000Z',
+ 'description' => '改下接口名',
],
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-07-11T08:50:18.000Z',
+ 'description' => '更新',
],
[
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListBatchOperateCardsTasks'],
+ ],
+ 'createdAt' => '2022-07-11T07:13:26.000Z',
+ 'description' => '字段类型调整',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'InnerLimitRateCards'],
+ ['description' => 'OpenAPI offline', 'api' => 'InnerStopCards'],
+ ],
+ 'createdAt' => '2022-06-20T09:00:07.000Z',
+ 'description' => '添加INNER接口',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-06-13T06:32:55.000Z',
+ 'description' => '新增相应的iccid字段',
],
[
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'GetCreateCustomerInfomation'],
+ ],
+ 'createdAt' => '2022-06-09T07:41:06.000Z',
+ 'description' => '发布接口',
],
[
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'UpdateBatchOperateCardsTask'],
+ ],
+ 'createdAt' => '2022-06-08T10:40:05.000Z',
+ 'description' => 'ram调整',
],
[
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CreateBatchOperateCardsTask'],
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteBatchOperateCardsTask'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListBatchOperateCardsTasks'],
+ ['description' => 'Response parameters changed', 'api' => 'ListCards'],
+ ],
+ 'createdAt' => '2022-05-30T07:50:03.000Z',
+ 'description' => '新增批量操作和RAM相关API',
],
[
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'cc5g.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'LockCards'],
+ ['description' => 'OpenAPI offline', 'api' => 'ResumeCards'],
+ ['description' => 'OpenAPI offline', 'api' => 'StopCards'],
+ ['description' => 'OpenAPI offline', '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' => 'cloud connector',
+ 'ramCodes' => ['fivegcc', 'iotcc'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'UnlockCards',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UnlockCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopCards',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:StopCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResetAreaLimitCards',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ResetAreaLimitCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListBatchOperateCardsTasks',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListBatchOperateCardsTasks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetWirelessCloudConnector',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DetachVpcFromNetLink',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DetachVpcFromNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteBatchOperateCardsTask',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddGroupDnsAuthorizationRule',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddGroupDnsAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCard',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWirelessCloudConnectorGroup',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWirelessCloudConnectorGroup',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCardDayUsages',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardDayUsages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GrantNetLink',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GrantNetLink',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAuthorizationRules',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListAuthorizationRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListZones',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListZones',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCardUsages',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCardUsages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWirelessCloudConnectorGroups',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListWirelessCloudConnectorGroups',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataPackages',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListDataPackages',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWirelessCloudConnector',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIoTCloudConnectorBackhaulRoute',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListIoTCloudConnectorBackhaulRoute',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'OpenCc5gService',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:OpenCc5gService',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateBatchOperateCardsTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FailCards',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:FailCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddWirelessCloudConnectorToGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddWirelessCloudConnectorToGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SwitchWirelessCloudConnectorToBusiness',
+ 'description' => '',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCards',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListOrders',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListOrders',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateCard',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWirelessCloudConnector',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'additionalActions' => [
+ ['action' => 'ram:CreateServiceLinkedRole', 'validationType' => 'always'],
+ ],
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRegions',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListRegions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteGroupAuthorizationRule',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteGroupAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddDNSAuthorizationRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:AddDNSAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCreateCustomerInformation',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCreateCustomerInformation',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateBatchOperateCardsTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateBatchOperateCardsTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCardLockReason',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:GetCardLockReason',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AttachVpcToNetLink',
+ 'description' => '',
+ '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' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteWirelessCloudConnector',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWirelessCloudConnectors',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListWirelessCloudConnectors',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyWirelessCloudConnectorFeature',
+ 'description' => '',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResumeCards',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ResumeCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAuthorizationRule',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'fivegcc:CreateAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', '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' => '',
+ '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' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWirelessCloudConnectorGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateWirelessCloudConnectorGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteIoTCloudConnectorBackhaulRoute',
+ 'description' => '',
+ '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' => '',
+ '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' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'fivegcc:ListAPNs',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDNSAuthorizationRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:UpdateDNSAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAuthorizationRule',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'fivegcc:DeleteAuthorizationRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RebindCards',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RebindCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveWirelessCloudConnectorFromGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:RemoveWirelessCloudConnectorFromGroup',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LockCards',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'fivegcc:LockCards',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitDiagnoseTaskForSingleCard',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'iotcc:SubmitDiagnoseTaskForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDiagnoseInfoForSingleCard',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'iotcc:ListDiagnoseInfoForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDiagnoseResultForSingleCard',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'iotcc:GetDiagnoseResultForSingleCard',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'All Resource', '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}'],
],
],
];