'1.0',
'info' => [
'style' => 'RPC',
'product' => 'IoTCC',
'version' => '2021-05-13',
],
'directories' => [
[
'id' => 171122,
'title' => null,
'type' => 'directory',
'children' => [
'OpenIoTCloudConnectorService',
],
],
[
'id' => 181681,
'title' => null,
'type' => 'directory',
'children' => [
'ListRegions',
],
],
[
'id' => 171128,
'title' => null,
'type' => 'directory',
'children' => [
'ListAPNs',
],
],
[
'id' => 172548,
'title' => null,
'type' => 'directory',
'children' => [
'CreateIoTCloudConnector',
'UpdateIoTCloudConnectorAttribute',
'ListIoTCloudConnectors',
'ListIoTCloudConnectorAvailableZones',
'AssociateVSwitchWithIoTCloudConnector',
'DissociateVSwitchFromIoTCloudConnector',
'ListIoTCloudConnectorEIPs',
'DeleteIoTCloudConnector',
],
],
[
'id' => 171130,
'title' => null,
'type' => 'directory',
'children' => [
'CreateConnectionPool',
'AddCidrToConnectionPool',
'UpdateConnectionPoolAttribute',
'ListConnectionPools',
'ListConnectionPoolIps',
'GetStsInfoAndOssPath',
'AssociateIpWithConnectionPool',
'DissociateIpFromConnectionPool',
'GetConnectionPoolIpOperationResult',
'ListConnectionPoolAllIps',
'DeleteConnectionPool',
],
],
[
'id' => 171124,
'title' => null,
'type' => 'directory',
'children' => [
'CreateAuthorizationRule',
'CreateAuthorizationRules',
'UpdateAuthorizationRuleAttribute',
'ListAuthorizationRules',
'DeleteAuthorizationRule',
],
],
[
'id' => 172549,
'title' => null,
'type' => 'directory',
'children' => [
'CreateIoTCloudConnectorGroup',
'AddIoTCloudConnectorToGroup',
'UpdateIoTCloudConnectorGroupAttribute',
'ListIoTCloudConnectorGroups',
'RemoveIoTCloudConnectorFromGroup',
'DeleteIoTCloudConnectorGroup',
],
],
[
'id' => 181641,
'title' => null,
'type' => 'directory',
'children' => [
'CreateGroupAuthorizationRule',
'UpdateGroupAuthorizationRuleAttribute',
'ListGroupAuthorizationRules',
'DeleteGroupAuthorizationRule',
],
],
[
'id' => 181682,
'title' => null,
'type' => 'directory',
'children' => [
'GrantVirtualBorderRouter',
],
],
[
'id' => 181683,
'title' => null,
'type' => 'directory',
'children' => [
'CreateDNSServiceRule',
'UpdateDNSServiceRuleAttribute',
'ListDNSServiceRules',
'DeleteDNSServiceRule',
'MoveAuthorizationRuleToDNSService',
],
],
[
'id' => 181684,
'title' => null,
'type' => 'directory',
'children' => [
'CreateGroupDNSServiceRule',
'UpdateGroupDNSServiceRuleAttribute',
'ListGroupDNSServiceRules',
'MoveGroupAuthorizationRuleToDNSService',
'DeleteGroupDNSServiceRule',
],
],
[
'id' => 181685,
'title' => null,
'type' => 'directory',
'children' => [
'EnableIoTCloudConnectorAccessLog',
'DisableIoTCloudConnectorAccessLog',
'GetIoTCloudConnectorAccessLog',
],
],
[
'id' => 171117,
'title' => null,
'type' => 'directory',
'children' => [
'CreateService',
'UpdateServiceAttribute',
'ListService',
'DeleteService',
],
],
[
'id' => 181686,
'title' => null,
'type' => 'directory',
'children' => [
'CreateServiceEntry',
'UpdateServiceEntryAttribute',
'ListServiceEntries',
'DeleteServiceEntry',
],
],
[
'id' => 181642,
'title' => null,
'type' => 'directory',
'children' => [
'SubmitDiagnoseTaskForSingleCard',
'GetDiagnoseResultForSingleCard',
'ListDiagnoseInfoForSingleCard',
],
],
[
'id' => 181687,
'title' => null,
'type' => 'directory',
'children' => [
'CreateIoTCloudConnectorBackhaulRoute',
'ListIoTCoudConnectorBackhaulRoute',
'DeleteIoTCloudConnetorBackhaulRoute',
],
],
[
'id' => 181688,
'title' => null,
'type' => 'directory',
'children' => [
'CreateIpMappingRule',
'UpdateIpMappingRule',
'ListIpMappingRules',
'DeleteIpMappingRule',
],
],
[
'id' => 181689,
'title' => null,
'type' => 'directory',
'children' => [
'CreateGroupIpMappingRule',
'UpdateGroupIpMappingRule',
'ListGroupIpMappingRules',
'DeleteGroupIpMappingRule',
],
],
[
'id' => 181690,
'title' => null,
'type' => 'directory',
'children' => [
'ConfirmIoTCloudConnector',
'RevertIoTCloudConnector',
],
],
[
'id' => 171254,
'title' => null,
'type' => 'directory',
'children' => [
'DeleteAuthorizationRules',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'OpenIoTCloudConnectorService' => [
'summary' => 'iotcc开通服务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.IoTCloudConnectorServiceOpened',
'errorMessage' => 'The operation is not allowed because of iotcc service have opened.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
],
'ListRegions' => [
'summary' => '查询CCIoT支持Region',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'Regions' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'LocalName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'RegionEndpoint' => [
'description' => '',
'type' => 'string',
'example' => 'cciot.cn-hangzhou.aliyuncs.com',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1(杭州)\\",\\n \\"RegionEndpoint\\": \\"cciot.cn-hangzhou.aliyuncs.com\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 79FAFC4C-6251-5C2D-818A-FD26FFFF10A5\\n \\n cn-hangzhou\\n cciot.cn-hangzhou.aliyuncs.com\\n 华东1(杭州)\\n \\n \\n cn-shanghai\\n cciot.cn-shanghai.aliyuncs.com\\n 华东2(上海)\\n \\n \\n cn-qingdao\\n cciot.cn-qingdao.aliyuncs.com\\n 华北1(青岛)\\n \\n \\n cn-beijing\\n cciot.cn-beijing.aliyuncs.com\\n 华北2(北京)\\n \\n \\n cn-huhehaote\\n cciot.cn-huhehaote.aliyuncs.com\\n 华北5(呼和浩特)\\n \\n \\n cn-wulanchabu\\n cciot.cn-wulanchabu.aliyuncs.com\\n 华北6(乌兰察布)\\n \\n \\n cn-shenzhen\\n cciot.cn-shenzhen.aliyuncs.com\\n 华南1(深圳)\\n \\n \\n cn-guangzhou\\n cciot.cn-guangzhou.aliyuncs.com\\n 华南3(广州)\\n \\n \\n cn-chengdu\\n cciot.cn-chengdu.aliyuncs.com\\n 西南1(成都)\\n \\n \\n eu-central-1\\n cciot.eu-central-1.aliyuncs.com\\n 德国(法兰克福)\\n \\n","errorExample":""}]',
'title' => 'ListRegions',
],
'ListAPNs' => [
'summary' => '查询APN信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'APN',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CMWAP',
],
],
[
'name' => 'ISP',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'mobile',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'APNs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ISP' => [
'description' => '',
'type' => 'string',
'example' => 'mobile',
],
'APN' => [
'description' => '',
'type' => 'string',
'example' => 'CMWAP',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'ZoneList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '["eu-central-1a", "eu-central-1b"]',
],
],
'FeatureList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'trafficMirror',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"TotalCount\\": 1,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 10,\\n \\"APNs\\": [\\n {\\n \\"ISP\\": \\"mobile\\",\\n \\"APN\\": \\"CMWAP\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"ZoneList\\": [\\n \\"[\\\\\\"eu-central-1a\\\\\\", \\\\\\"eu-central-1b\\\\\\"]\\"\\n ],\\n \\"FeatureList\\": [\\n \\"trafficMirror\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n 1\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 10\\n \\n mobile\\n CMWAP\\n test\\n test\\n [\\"eu-central-1a\\", \\"eu-central-1b\\"]\\n trafficMirror\\n \\n","errorExample":""}]',
'title' => 'ListAPNs',
],
'CreateIoTCloudConnector' => [
'summary' => '创建IoTCloudConnector',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ISP',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'mobile',
],
],
[
'name' => 'APN',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'CMWAP',
],
],
[
'name' => 'IoTCloudConnectorName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'IoTCloudConnectorDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'WildcardDomainEnabled',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'deprecated' => true,
'required' => false,
'example' => 'true',
'default' => 'true',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceUid',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '132193271328****',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.ApnDisabledWildcardDomain',
'errorMessage' => 'The operation is not allowed because of apn disabled wildcardDomain.',
],
[
'errorCode' => 'OperationDenied.NotOpenIoTCloudConnectorService',
'errorMessage' => 'The operation is not allowed because of not open iotcc service.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'QuotaExceeded.iotccInstanceLimit',
'errorMessage' => 'The quota of IoTCCPerUser is exceeded',
],
[
'errorCode' => 'ResourceNotEnough.APN',
'errorMessage' => 'The specified resource of APN is not enough.',
],
[
'errorCode' => 'IncorrectStatus.APNNotReady',
'errorMessage' => 'The status of APN is incorrect.',
],
[
'errorCode' => 'OperationDenied.ApnNotSupportBasicType',
'errorMessage' => 'The operation is not allowed because of apn do not support basic type cciot instance.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n iotcc-bp1odcab8tmno0hdq****\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
],
'UpdateIoTCloudConnectorAttribute' => [
'summary' => '修改IoTCloudConnector',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'IoTCloudConnectorName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'IoTCloudConnectorDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'WildcardDomainEnabled',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Mode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'PassThrough',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
[
'errorCode' => 'OperationDenied.NotAssociateVpc',
'errorMessage' => 'The operation is not allowed because of not associate vpc.',
],
[
'errorCode' => 'OperationDenied.BasicInstanceNotSupportPassThrough',
'errorMessage' => 'The operation is not allowed because of basic instance not support.',
],
[
'errorCode' => 'IllegalParam.Mode',
'errorMessage' => 'The param of Mode is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n iotcc-bp1odcab8tmno0hdq****\\n","errorExample":""}]',
],
'ListIoTCloudConnectors' => [
'summary' => '显示IoTCloudConnector',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IoTCloudConnectorIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IoTCloudConnectorName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ISP',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'mobile',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'VpcId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vpc-bp1aevy8sofi8mh1q****',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'APN',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CMWAP',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IsInGroup',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'IoTCloudConnectors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'IoTCloudConnectorStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'ISP' => [
'description' => '',
'type' => 'string',
'example' => 'mobile',
],
'IoTCloudConnectorBusinessStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Normal',
],
'APN' => [
'description' => '',
'type' => 'string',
'example' => 'CMWAP',
],
'RateLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'VpcId' => [
'description' => '',
'type' => 'string',
'example' => 'vpc-bp1aevy8sofi8mh1q****',
],
'VSwitchList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'vsw-m5e3r57pxkgijcdvfcdvf****',
],
],
'IoTCloudConnectorName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'IoTCloudConnectorDescription' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'WildcardDomainEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'CreateTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2021-10-01T00:00:00Z',
],
'ModifyTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2021-10-01T10:00:00Z',
],
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'Mode' => [
'description' => '',
'type' => 'string',
'example' => 'PassThrough',
],
'IpFeature' => [
'description' => '',
'type' => 'string',
'example' => '192.168.0.1',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'Standard',
],
'ServiceType' => [
'description' => '',
'type' => 'string',
'example' => 'Normal',
],
'GrantAliUid' => [
'description' => '',
'type' => 'string',
'example' => '253460731706911258',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'SystemBusy',
'errorMessage' => 'System is busy, please try again later.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 20,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"IoTCloudConnectors\\": [\\n {\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"IoTCloudConnectorStatus\\": \\"Created\\",\\n \\"ISP\\": \\"mobile\\",\\n \\"IoTCloudConnectorBusinessStatus\\": \\"Normal\\",\\n \\"APN\\": \\"CMWAP\\",\\n \\"RateLimit\\": 2,\\n \\"VpcId\\": \\"vpc-bp1aevy8sofi8mh1q****\\",\\n \\"VSwitchList\\": [\\n \\"vsw-m5e3r57pxkgijcdvfcdvf****\\"\\n ],\\n \\"IoTCloudConnectorName\\": \\"test\\",\\n \\"IoTCloudConnectorDescription\\": \\"test\\",\\n \\"WildcardDomainEnabled\\": false,\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"Mode\\": \\"PassThrough\\",\\n \\"IpFeature\\": \\"192.168.0.1\\",\\n \\"Type\\": \\"Standard\\",\\n \\"ServiceType\\": \\"Normal\\",\\n \\"GrantAliUid\\": \\"253460731706911258\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 20\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 10\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n iotcc-bp1odcab8tmno0hdq****\\n Created\\n mobile\\n Normal\\n CMWAP\\n 2\\n vpc-bp1aevy8sofi8mh1q****\\n vsw-m5e3r57pxkgijcdvfcdvf****\\n test\\n test\\n false\\n iotccg-g00epppbi9di9y****\\n PassThrough\\n 192.168.0.1\\n Standard\\n Normal\\n 253460731706911258\\n \\n","errorExample":""}]',
'title' => 'ListIoTCloudConnectors',
],
'ListIoTCloudConnectorAvailableZones' => [
'summary' => '查询IoTCloudConnector可以绑定vsw的可用区',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'AvailableZoneList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou-h',
],
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"AvailableZoneList\\": [\\n \\"cn-hangzhou-h\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n iotcc-bp1odcab8tmno0hdq****\\n cn-hangzhou-h\\n","errorExample":""}]',
'title' => ' ListIoTCloudConnectorAvailableZones',
],
'AssociateVSwitchWithIoTCloudConnector' => [
'summary' => 'IoTCloudConnector关联用户Vpc和Vswitch',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'vpc-bp1aevy8sofi8mh1q****',
],
],
[
'name' => 'VSwitchList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vsw-m5e3r57pxkgijcdvfcdvf****',
],
'required' => true,
'maxItems' => 20,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ResourceNotEnough.CIDRNotHaveEnoughIp',
'errorMessage' => 'The specified resource of IP in CIDR is not enough.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParam.VSwitchZone',
'errorMessage' => 'The param of VSwitch zone is illegal.',
],
[
'errorCode' => 'IllegalParamSize.VSwitchList',
'errorMessage' => 'The param size of VSwitch is illegal',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'ResourceAlreadyAssociated.VpcId',
'errorMessage' => 'The specified resource of VpcId already associated',
],
[
'errorCode' => 'IllegalParam.VSwitch',
'errorMessage' => 'The param of VSwitch is illegal.',
],
[
'errorCode' => 'IllegalParam.VpcId',
'errorMessage' => 'The param of Vpc is illegal.',
],
[
'errorCode' => 'OperationDenied.VpcStatusNotSupport',
'errorMessage' => 'The operation is not allowed because of vpc status not support.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
[
'errorCode' => 'IllegalParam.VSwitchSize',
'errorMessage' => 'The param of VSwitch size is illegal.',
],
[
'errorCode' => 'OperationDenied.OneVpcOnlySupportOneSpecIoTCC',
'errorMessage' => 'The operation is not allowed because of one vpc create different spec IoTCC not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'AssociateVSwitchWithIoTCloudConnector',
],
'DissociateVSwitchFromIoTCloudConnector' => [
'summary' => 'IoTCloudConnector取消关联用户Vpc和Vswitch',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceNotAssociated.VpcId',
'errorMessage' => 'The specified resource of VpcId is not associated.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'DissociateVSwitchFromIoTCloudConnector',
],
'ListIoTCloudConnectorEIPs' => [
'summary' => '显示IoTCloudConnector绑定的EIP信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'NextToken',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'EIPs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '["42.1.XX.XX", "42.2.XX.XX", … "42.3.XX.XX"]',
],
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 20,\\n \\"EIPs\\": [\\n \\"[\\\\\\"42.1.XX.XX\\\\\\", \\\\\\"42.2.XX.XX\\\\\\", … \\\\\\"42.3.XX.XX\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 20\\n [\\"42.1.XX.XX\\", \\"42.2.XX.XX\\", … \\"42.3.XX.XX\\"]\\n","errorExample":""}]',
'title' => 'ListIoTCloudConnectorEIPs',
],
'DeleteIoTCloudConnector' => [
'summary' => '删除IoTCloudConnector',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'OperationDenied.IotCloudConnectorInGroup',
'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceInUse.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCC is in use.',
],
[
'errorCode' => 'IncorrectStatus.CloudConnector',
'errorMessage' => 'The status of CloudConnector is incorrect.',
],
[
'errorCode' => 'ResourceInCreating.IoTCloudConnector',
'errorMessage' => 'ResourceInCreating.IoTCloudConnector',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'DeleteIoTCloudConnector',
],
'CreateConnectionPool' => [
'summary' => '创建ConnectionPool',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'Count',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'ConnectionPoolName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
],
[
'name' => 'ConnectionPoolDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
],
[
'name' => 'Cidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidrs.1=192.168.XX.XX/24&Cidrs.2=10.0.XX.XX/24',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'ConnectionPoolId' => [
'description' => '',
'type' => 'string',
'example' => 'cp-bp11234abctmno0hdq****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'QuotaExceeded.CIDRLimit',
'errorMessage' => 'The quota of cidr_limit is exceeded.',
],
[
'errorCode' => 'Forbidden.IPUsedInCIDR',
'errorMessage' => 'IP has been used in CIDR.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceInUse.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCC is in use.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'ResourceInCreating.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is creating, please try again later.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'QuotaExceeded.ConnectionPoolPerIoTCC',
'errorMessage' => 'The quota of ConnectionPoolPerIoTCC is exceeded',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'IllegalParam.Cidrs',
'errorMessage' => 'The param of Cidrs is illegal.',
],
[
'errorCode' => 'IllegalParamSize.Cidr',
'errorMessage' => 'The param size of Cidr is illegal, only support one.',
],
[
'errorCode' => 'OperationDenied.GrantedInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of granted instance not support.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ConnectionPoolId\\": \\"cp-bp11234abctmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n cp-bp11234abctmno0hdq****\\n","errorExample":""}]',
'title' => 'CreateConnectionPool',
],
'AddCidrToConnectionPool' => [
'summary' => 'ConnectionPool新增地址池',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Cidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidrs.1=192.168.1.32/24&Cidrs.2=10.0.10.3/24',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IllegalParam.Cidrs',
'errorMessage' => 'The param of Cidrs is too many, only most 2 can be supported at a time.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'ResourceNotFound.ConnectionPool',
'errorMessage' => 'The param of ConnectionPoolId is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'IllegalParam.ConnectionPoolId',
'errorMessage' => 'The param of ConnectionPoolId is illegal.',
],
[
'errorCode' => 'IllegalParamSize.Cidr',
'errorMessage' => 'The param size of Cidr is illegal, only support one.',
],
[
'errorCode' => 'IncorrectStatus.IP',
'errorMessage' => 'The status of IP is incorrect.',
],
[
'errorCode' => 'OperationDenied.GrantedInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of granted instance not support.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'AddCidrToConnectionPool',
],
'UpdateConnectionPoolAttribute' => [
'summary' => '创建ConnectionPool',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Count',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'ConnectionPoolName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
],
[
'name' => 'ConnectionPoolDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
],
[
'name' => 'Cidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidrs.1=192.168.XX.XX/24&Cidrs.2=10.0.XX.XX/24',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'ResourceNotFound.ConnectionPool',
'errorMessage' => 'The param of ConnectionPoolId is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'IllegalParam.Cidrs',
'errorMessage' => 'The param of Cidrs is illegal.',
],
[
'errorCode' => 'IllegalParam.ConnectionPoolId',
'errorMessage' => 'The param of ConnectionPoolId is illegal.',
],
[
'errorCode' => 'OperationDenied.GrantedInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of granted instance not support.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'UpdateConnectionPoolAttribute',
],
'ListConnectionPools' => [
'summary' => '显示ConnectionPool',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cp-bp11234abctmno0hdq****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ConnectionPoolName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ConnectionPoolStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Running',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ConnectionPools' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ConnectionPoolId' => [
'description' => '',
'type' => 'string',
'example' => 'cp-bp11234abctmno0hdq****',
],
'ConnectionPoolStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Running',
],
'ConnectionPoolName' => [
'description' => '',
'type' => 'string',
'example' => 'pool01',
],
'ConnectionPoolDescription' => [
'description' => '',
'type' => 'string',
'example' => 'pool01',
],
'Cidrs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '192.168.XX.XX/32',
],
],
'OperateResultRequestID' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA651',
],
],
],
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"TotalCount\\": 2,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 10,\\n \\"ConnectionPools\\": [\\n {\\n \\"ConnectionPoolId\\": \\"cp-bp11234abctmno0hdq****\\",\\n \\"ConnectionPoolStatus\\": \\"Running\\",\\n \\"ConnectionPoolName\\": \\"pool01\\",\\n \\"ConnectionPoolDescription\\": \\"pool01\\",\\n \\"Cidrs\\": [\\n \\"192.168.XX.XX/32\\"\\n ],\\n \\"OperateResultRequestID\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA651\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n 2\\n caeba0bbb2be03f84eb48b699f0a****\\n 50\\n \\n cp-bp11234abctmno0hdq****\\n Running\\n pool01\\n pool01\\n 192.168.XX.XX/32\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA651\\n \\n","errorExample":""}]',
'title' => 'ListConnectionPools',
],
'ListConnectionPoolIps' => [
'summary' => '查询地址池IP信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2000',
'minimum' => '1',
'example' => '10',
'default' => '50',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ConnectionPoolIps' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ConnectionPoolId' => [
'description' => '',
'type' => 'string',
'example' => 'cp-bp11234abctmno0hdq****',
],
'Ip' => [
'description' => '',
'type' => 'string',
'example' => '192.168.XX.XX',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'activated',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"TotalCount\\": 2,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 10,\\n \\"ConnectionPoolIps\\": [\\n {\\n \\"ConnectionPoolId\\": \\"cp-bp11234abctmno0hdq****\\",\\n \\"Ip\\": \\"192.168.XX.XX\\",\\n \\"Status\\": \\"activated\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n 2\\n caeba0bbb2be03f84eb48b699f0a****\\n 10\\n \\n cp-bp11234abctmno0hdq****\\n 192.168.XX.XX\\n activated\\n \\n","errorExample":""}]',
'title' => 'ListConnectionPoolIps',
],
'GetStsInfoAndOssPath' => [
'summary' => '获取服务账号sts信息和提交Ip绑定关系文件提交地址',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test.csv',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'Expiration' => [
'title' => 'Sts info expiration time',
'description' => '',
'type' => 'string',
'example' => '1633060876',
],
'AccessKeyId' => [
'title' => 'Sts info of accessKeyId',
'description' => '',
'type' => 'string',
'example' => '',
],
'AccessKeySecret' => [
'title' => 'Sts info of accessKeySecret',
'description' => '',
'type' => 'string',
'example' => '',
],
'SecurityToken' => [
'title' => 'Sts info of securityToken',
'description' => '',
'type' => 'string',
'example' => '',
],
'OssPath' => [
'title' => 'OssPath',
'description' => '',
'type' => 'string',
'example' => 'cciot-cn-hangzhou/127859184306****/test.csv',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"Expiration\\": \\"1633060876\\",\\n \\"AccessKeyId\\": \\"\\",\\n \\"AccessKeySecret\\": \\"\\",\\n \\"SecurityToken\\": \\"\\",\\n \\"OssPath\\": \\"cciot-cn-hangzhou/127859184306****/test.csv\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n 1633060876\\n <yourAccessKeyId>\\n <yourAccessKeySecret>\\n <yourSecurityToken>\\n cciot-cn-hangzhou/127859184306****/test.csv\\n","errorExample":""}]',
'title' => 'GetStsInfoAndOssPath',
],
'AssociateIpWithConnectionPool' => [
'summary' => '绑定ip到cciot关联ConnectionPool上面',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Ips',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.1.10,10.0.10.0,172.16.8.190',
],
'required' => false,
'maxItems' => 1000,
],
],
[
'name' => 'IpsFilePath',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cciot-cn-hangzhou/127859184306****/test.csv',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceNotFound.UploadFile',
'errorMessage' => 'The specified resource of uploaded ip file is not found.',
],
[
'errorCode' => 'MissingParam.IpParam',
'errorMessage' => 'The param of ip or ip path is missing.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'OperationDenied.GrantedInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of granted instance not support.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
[
'errorCode' => 'ResourceInConfiguring.APN',
'errorMessage' => 'The specified resource of apn is being configured, please try again later.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
],
'DissociateIpFromConnectionPool' => [
'summary' => '解除ip到cciot关联ConnectionPool上面的关联关系',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Ips',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX,10.0.XX.XX,172.16.XX.XX',
],
'required' => false,
'maxItems' => 1000,
],
],
[
'name' => 'IpsFilePath',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cciot-cn-hangzhou/127859184306****/test.csv',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ResourceInConfiguring.ConnectionPool',
'errorMessage' => 'The specified resource of ConnectionPool is being configured, please try again later.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'MissingParam.IpParam',
'errorMessage' => 'The param of ip or ip path is missing.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'OperationDenied.GrantedInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of granted instance not support.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'DissociateIpFromConnectionPool',
],
'GetConnectionPoolIpOperationResult' => [
'summary' => '获取地址池Ip操作结果',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cp-0gd9qnmv8431rh****',
],
],
[
'name' => 'QueryRequestId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'CFA63CEB-15B6-4AE8-B203-F855FF7BA962',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA651',
],
'ResultFilePaths' => [
'title' => 'OssPath',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'https://examplebucket.oss-eu-central-1.aliyuncs.com/ipma/cp-0gd9qnmv8431rh****-IOTCCGW67cbd****-error.xlsx?Expires=163239****&OSSAccessKeyId=TMP.3Kiw6QS****&Signature=isbvgluXxHv****&versionId=CAEQOhiBgMC****&response-content-type=application%2Foctet-stream',
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA651\\",\\n \\"ResultFilePaths\\": [\\n \\"https://examplebucket.oss-eu-central-1.aliyuncs.com/ipma/cp-0gd9qnmv8431rh****-IOTCCGW67cbd****-error.xlsx?Expires=163239****&OSSAccessKeyId=TMP.3Kiw6QS****&Signature=isbvgluXxHv****&versionId=CAEQOhiBgMC****&response-content-type=application%2Foctet-stream\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA651\\n https://examplebucket.oss-eu-central-1.aliyuncs.com/ipma/cp-0gd9qnmv8431rh****-IOTCCGW67cbd****-error.xlsx?Expires=163239****&OSSAccessKeyId=TMP.3Kiw6QS****&Signature=isbvgluXxHv****&versionId=CAEQOhiBgMC****&response-content-type=application%2Foctet-stream\\n","errorExample":""}]',
'title' => 'GetConnectionPoolIpOperationResult',
],
'ListConnectionPoolAllIps' => [
'summary' => '查询地址池IP(CIDR)信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2000',
'minimum' => '1',
'example' => '10',
'default' => '50',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'TotalIpsCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ConnectionPoolIps' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ConnectionPoolId' => [
'description' => '',
'type' => 'string',
'example' => 'cp-bp11234abctmno0hdq****',
],
'Ip' => [
'description' => '',
'type' => 'string',
'example' => '192.168.0.1',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'activated',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'Cidr',
],
'IpNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '254',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceNotFound.ConnectionPool',
'errorMessage' => 'The specified resource of connection pool is not found.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"TotalIpsCount\\": 1,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 10,\\n \\"ConnectionPoolIps\\": [\\n {\\n \\"ConnectionPoolId\\": \\"cp-bp11234abctmno0hdq****\\",\\n \\"Ip\\": \\"192.168.0.1\\",\\n \\"Status\\": \\"activated\\",\\n \\"Type\\": \\"Cidr\\",\\n \\"IpNum\\": 254\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n 1\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 10\\n \\n cp-bp11234abctmno0hdq****\\n 192.168.0.1\\n activated\\n Cidr\\n 254\\n \\n","errorExample":""}]',
'title' => 'ListConnectionPoolAllIps',
],
'DeleteConnectionPool' => [
'summary' => '删除ConnectionPool',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1234abc',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceExist.AuthorizationRule',
'errorMessage' => 'The specified resource of AuthorizationRule exists.',
],
[
'errorCode' => 'ResourceNotFound.ConnectionPool',
'errorMessage' => 'The param of ConnectionPoolId is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'IllegalParam.ConnectionPoolId',
'errorMessage' => 'The param of ConnectionPoolId is illegal.',
],
[
'errorCode' => 'OperationDenied.GrantedInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of granted instance not support.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'DeleteConnectionPool',
],
'CreateAuthorizationRule' => [
'summary' => '创建AuthorizationRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Cidr',
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'tcp',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'Policy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Permit',
],
],
[
'name' => 'SourceCidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
'required' => true,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
],
[
'name' => 'AuthorizationRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'AuthorizationRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'ar-1234abcb8tmno0hdq****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.DomainFeatureDisabled',
'errorMessage' => 'The operation is not allowed because of domain feature disabled.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
[
'errorCode' => 'ResourceAlreadyExist.AuthorizationRule',
'errorMessage' => 'The specified resource of AuthorizationRule already exists.',
],
[
'errorCode' => 'Conflict.Param',
'errorMessage' => 'The param is conflict.',
],
[
'errorCode' => 'Conflict.Cidr',
'errorMessage' => 'The cidr is conflict.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'QuotaExceeded.sourceCidrLimit',
'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded',
],
[
'errorCode' => 'IllegalParam',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit',
'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'OperationDenied.DomainInHumanNetwork',
'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
[
'errorCode' => 'IllegalParam.AuthorizationRule.DestinationType',
'errorMessage' => 'The param of DestinationType is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AuthorizationRuleId\\": \\"ar-1234abcb8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n ar-1234abcb8tmno0hdq****\\n","errorExample":""}]',
],
'CreateAuthorizationRules' => [
'summary' => '批量创建AuthorizationRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'AuthorizationRules',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
'Description' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
'SourceCidr' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '192.168.0.1/24',
],
'DestinationType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Cidr',
],
'DestinationPort' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
'Protocol' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TCP',
],
'Destination' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '47.0.XX.XX',
],
'Policy' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Permit',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'AuthorizationRuleIds' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'ar-1234abcb8tmno0hdq****',
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.DomainFeatureDisabled',
'errorMessage' => 'The operation is not allowed because of domain feature disabled.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
[
'errorCode' => 'ResourceAlreadyExist.AuthorizationRule',
'errorMessage' => 'The specified resource of AuthorizationRule already exists.',
],
[
'errorCode' => 'Conflict.Param',
'errorMessage' => 'The param is conflict.',
],
[
'errorCode' => 'Conflict.Cidr',
'errorMessage' => 'The cidr is conflict.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'QuotaExceeded.sourceCidrLimit',
'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded',
],
[
'errorCode' => 'IllegalParam',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit',
'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'OperationDenied.DomainInHumanNetwork',
'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
[
'errorCode' => 'IllegalParam.AuthorizationRule.DestinationType',
'errorMessage' => 'The param of DestinationType is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AuthorizationRuleIds\\": [\\n \\"ar-1234abcb8tmno0hdq****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n ar-1234abcb8tmno0hdq****\\n","errorExample":""}]',
'title' => 'CreateAuthorizationRules',
],
'UpdateAuthorizationRuleAttribute' => [
'summary' => '更新AuthorizationRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ar-1234abcb8tmno0hdq****',
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'tcp',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
],
[
'name' => 'Policy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Permit',
],
],
[
'name' => 'SourceCidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
],
[
'name' => 'AuthorizationRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.NoParamModify',
'errorMessage' => 'The operation is not allowed because of no param modified.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'QuotaExceeded.sourceCidrLimit',
'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded',
],
[
'errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit',
'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'IllegalParam',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.AuthorizationRule',
'errorMessage' => 'The param of AuthorizationRuleId is illegal.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
[
'errorCode' => 'OperationDenied.NotSupportModify',
'errorMessage' => 'The operation is not allowed because of this type not support modify.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'UpdateAuthorizationRuleAttribute',
],
'ListAuthorizationRules' => [
'summary' => '显示AuthorizationRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AuthorizationRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ar-1234abcb8tmno0hdq****',
],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Protocol',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'tcp',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Destination',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Policy',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Permit',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'AuthorizationRuleType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'System',
],
],
[
'name' => 'FuzzyDestination',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'FuzzyAuthorizationRuleName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'AuthorizationRules' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'Policy' => [
'description' => '',
'type' => 'string',
'example' => 'Permit',
],
'AuthorizationRuleStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'SourceCidrs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '192.168.XX.XX',
],
],
'DestinationType' => [
'description' => '',
'type' => 'string',
'example' => 'Cidr',
],
'Protocol' => [
'description' => '',
'type' => 'string',
'example' => 'tcp',
],
'DestinationPort' => [
'description' => '',
'type' => 'string',
'example' => '80/80',
],
'Destination' => [
'description' => '',
'type' => 'string',
'example' => '192.168.XX.XX',
],
'AuthorizationRuleName' => [
'description' => '',
'type' => 'string',
'example' => 'rule01',
],
'AuthorizationRuleDescription' => [
'description' => '',
'type' => 'string',
'example' => 'rule01',
],
'AuthorizationRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'ar-1234abcb8tmno0hdq****',
],
'AuthorizationRuleType' => [
'description' => '',
'type' => 'string',
'example' => 'System',
],
],
],
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 10,\\n \\"AuthorizationRules\\": [\\n {\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"AuthorizationRuleStatus\\": \\"Created\\",\\n \\"SourceCidrs\\": [\\n \\"192.168.XX.XX\\"\\n ],\\n \\"DestinationType\\": \\"Cidr\\",\\n \\"Protocol\\": \\"tcp\\",\\n \\"DestinationPort\\": \\"80/80\\",\\n \\"Destination\\": \\"192.168.XX.XX\\",\\n \\"AuthorizationRuleName\\": \\"rule01\\",\\n \\"AuthorizationRuleDescription\\": \\"rule01\\",\\n \\"AuthorizationRuleId\\": \\"ar-1234abcb8tmno0hdq****\\",\\n \\"AuthorizationRuleType\\": \\"System\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n 10\\n caeba0bbb2be03f84eb48b699f0a****\\n 10\\n \\n iotcc-bp1odcab8tmno0hdq****\\n Permit\\n Created\\n 192.168.XX.XX\\n Cidr\\n tcp\\n 80/80\\n 192.168.XX.XX\\n rule01\\n rule01\\n ar-1234abcb8tmno0hdq****\\n System\\n \\n","errorExample":""}]',
'title' => 'ListAuthorizationRules',
],
'DeleteAuthorizationRule' => [
'summary' => '删除AuthorizationRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ar-1234abcb8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'OperationDenied.IotCloudConnectorInGroup',
'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.AuthorizationRule',
'errorMessage' => 'The param of AuthorizationRuleId is illegal.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'IllegalParam.AuthoriztionRuleId',
'errorMessage' => 'The param of AuthoriztionRuleId is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'DeleteAuthorizationRule',
],
'CreateIoTCloudConnectorGroup' => [
'summary' => '创建IoTCC Group',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cctest',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n iotccg-g00epppbi9di9y****\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
'title' => 'CreateIoTCloudConnectorGroup',
],
'AddIoTCloudConnectorToGroup' => [
'summary' => '增加IoTCC到Group',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'required' => true,
'maxItems' => 20,
],
],
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ResourceAlreadyAssociated.CloudConnector',
'errorMessage' => 'The specified resource of CloudConnector is already associated.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"\\n cn-hangzhou\\n","errorExample":""}]',
'title' => 'AddIoTCloudConnectorToGroup',
],
'UpdateIoTCloudConnectorGroupAttribute' => [
'summary' => '修改IoTCC Group属性',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnectorGroup',
'errorMessage' => 'The specified resource of IoTCloudConnectorGroup is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup',
'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n","errorExample":""}]',
'title' => ' UpdateIoTCloudConnectorGroupAttribute',
],
'ListIoTCloudConnectorGroups' => [
'summary' => '查询IoTCC Group分组列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IoTCloudConnectorGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iotccg-g00epppbi9di9y****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IoTCloudConnectorGroupName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cctest',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'IoTCloudConnectorGroups' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'IoTCloudConnectorGroupStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'IoTCloudConnectors' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'IoTCloudConnectorStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'IoTCloudConnectorName' => [
'description' => '',
'type' => 'string',
'example' => 'cc01',
],
'IoTCloudConnectorDescription' => [
'description' => '',
'type' => 'string',
'example' => 'cc01',
],
'CreateTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2021-10-01 00:00:00',
],
'ISP' => [
'description' => '',
'type' => 'string',
'example' => 'mobile',
],
'APN' => [
'description' => '',
'type' => 'string',
'example' => 'CMWAP',
],
'ServiceType' => [
'description' => '',
'type' => 'string',
'example' => 'Normal',
],
],
],
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'cctest',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'CreateTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2021-10-01 00:00:00',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'Standard',
],
'ServiceType' => [
'description' => '',
'type' => 'string',
'example' => 'Normal',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 10,\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"IoTCloudConnectorGroups\\": [\\n {\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"IoTCloudConnectorGroupStatus\\": \\"Created\\",\\n \\"IoTCloudConnectors\\": [\\n {\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"IoTCloudConnectorStatus\\": \\"Created\\",\\n \\"IoTCloudConnectorName\\": \\"cc01\\",\\n \\"IoTCloudConnectorDescription\\": \\"cc01\\",\\n \\"CreateTime\\": 0,\\n \\"ISP\\": \\"mobile\\",\\n \\"APN\\": \\"CMWAP\\",\\n \\"ServiceType\\": \\"Normal\\"\\n }\\n ],\\n \\"Name\\": \\"cctest\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 0,\\n \\"Type\\": \\"Standard\\",\\n \\"ServiceType\\": \\"Normal\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 10\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n \\n iotccg-g00epppbi9di9y****\\n Created\\n \\n iotcc-bp1odcab8tmno0hdq****\\n Created\\n cc01\\n cc01\\n mobile\\n CMWAP\\n Normal\\n \\n cctest\\n test\\n Standard\\n Normal\\n \\n","errorExample":""}]',
'title' => 'ListIoTCloudConnectorGroups',
],
'RemoveIoTCloudConnectorFromGroup' => [
'summary' => '移除IoTCC Group中的IoTCC',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'required' => true,
],
],
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
'title' => 'RemoveIoTCloudConnectorFromGroup',
],
'DeleteIoTCloudConnectorGroup' => [
'summary' => '删除CloudConnector分组',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceInCreating.IoTCloudConnectorGroup',
'errorMessage' => 'ResourceInCreating.IoTCloudConnectorGroup',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnectorGroup',
'errorMessage' => 'The specified resource of IoTCloudConnector Group is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup',
'errorMessage' => 'The param of IoTCloudConnectorId Group is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
'title' => 'DeleteIoTCloudConnectorGroup',
],
'CreateGroupAuthorizationRule' => [
'summary' => '创建CloudConnector分组白名单',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule',
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ruletest',
],
],
[
'name' => 'SourceCidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1/24',
],
'required' => true,
'maxItems' => 200,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Cidr',
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'tcp',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Policy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Permit',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'System',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'AuthorizationRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'gar-ez91t41jvi6tr8****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'ResourceAlreadyExist.AuthorizationRule',
'errorMessage' => 'The specified resource of AuthorizationRule already exists.',
],
[
'errorCode' => 'OperationDenied.DomainInHumanNetwork',
'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AuthorizationRuleId\\": \\"gar-ez91t41jvi6tr8****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n iotccg-g00epppbi9di9y****\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n gar-ez91t41jvi6tr8****\\n","errorExample":""}]',
'title' => 'CreateGroupAuthorizationRule',
],
'UpdateGroupAuthorizationRuleAttribute' => [
'summary' => '修改CloudConnector分组白名单属性',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rule',
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ruletest',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'gar-ez91t41jvi6tr8****',
],
],
[
'name' => 'SourceCidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1',
],
'required' => false,
'maxItems' => 200,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'tcp',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'Policy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Permit',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'AuthorizationRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'gar-ez91t41jvi6tr8****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'OperationDenied.NoFieldModify',
'errorMessage' => 'The operation is not allowed because of no field modify.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AuthorizationRuleId\\": \\"gar-ez91t41jvi6tr8****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n iotccg-g00epppbi9di9y****\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n gar-ez91t41jvi6tr8****\\n","errorExample":""}]',
'title' => 'UpdateGroupAuthorizationRuleAttribute',
],
'ListGroupAuthorizationRules' => [
'summary' => '显示分组AuthorizationRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'gar-ez91t41jvi6tr8****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Destination',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Protocol',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'tcp',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ruletest',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Policy',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Permit',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'System',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'GroupAuthorizationRules' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'Policy' => [
'description' => '',
'type' => 'string',
'example' => 'Permit',
],
'AuthorizationRuleStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'SourceCidrs' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '192.168.0.0/32',
],
],
'DestinationType' => [
'description' => '',
'type' => 'string',
'example' => 'Cidr',
],
'DestinationPort' => [
'description' => '',
'type' => 'string',
'example' => '80/80',
],
'Protocol' => [
'description' => '',
'type' => 'string',
'example' => 'tcp',
],
'Destination' => [
'description' => '',
'type' => 'string',
'example' => '47.0.XX.XX',
],
'AuthorizationRuleName' => [
'description' => '',
'type' => 'string',
'example' => 'ruletest',
],
'AuthorizationRuleDescription' => [
'description' => '',
'type' => 'string',
'example' => 'rule',
],
'AuthorizationRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'gar-ez91t41jvi6tr8****',
],
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'System',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup',
'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 10,\\n \\"GroupAuthorizationRules\\": [\\n {\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"AuthorizationRuleStatus\\": \\"Created\\",\\n \\"SourceCidrs\\": [\\n \\"192.168.0.0/32\\"\\n ],\\n \\"DestinationType\\": \\"Cidr\\",\\n \\"DestinationPort\\": \\"80/80\\",\\n \\"Protocol\\": \\"tcp\\",\\n \\"Destination\\": \\"47.0.XX.XX\\",\\n \\"AuthorizationRuleName\\": \\"ruletest\\",\\n \\"AuthorizationRuleDescription\\": \\"rule\\",\\n \\"AuthorizationRuleId\\": \\"gar-ez91t41jvi6tr8****\\",\\n \\"Type\\": \\"System\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 10\\n \\n iotccg-g00epppbi9di9y****\\n Permit\\n Created\\n 192.168.0.0/32\\n Cidr\\n 80/80\\n tcp\\n 47.0.XX.XX\\n ruletest\\n rule\\n gar-ez91t41jvi6tr8****\\n System\\n \\n","errorExample":""}]',
'title' => 'ListGroupAuthorizationRules',
],
'DeleteGroupAuthorizationRule' => [
'summary' => '删除CloudConnector分组白名单',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'gar-ez91t41jvi6tr8****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
'title' => 'DeleteGroupAuthorizationRule',
],
'GrantVirtualBorderRouter' => [
'summary' => '授权VirtualBorderRouter给后端创建云上APN',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'VirtualBorderRouterId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'vbr-bp1svadp4lq38janc****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
'title' => 'GrantVirtualBorderRouter',
],
'CreateDNSServiceRule' => [
'summary' => '创建DNSServiceRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '100.100.2.138',
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'DNSServiceRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01',
],
'DNSServiceRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'ar-r56ijpurlu50gi****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.DomainFeatureDisabled',
'errorMessage' => 'The operation is not allowed because of domain feature disabled.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
[
'errorCode' => 'ResourceAlreadyExist.AuthorizationRule',
'errorMessage' => 'The specified resource of AuthorizationRule already exists.',
],
[
'errorCode' => 'Conflict.Param',
'errorMessage' => 'The param is conflict.',
],
[
'errorCode' => 'Conflict.Cidr',
'errorMessage' => 'The cidr is conflict.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'QuotaExceeded.sourceCidrLimit',
'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded',
],
[
'errorCode' => 'IllegalParam',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit',
'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\",\\n \\"DNSServiceRuleId\\": \\"ar-r56ijpurlu50gi****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\n ar-r56ijpurlu50gi****\\n","errorExample":""}]',
],
'UpdateDNSServiceRuleAttribute' => [
'summary' => '更新DNSServiceRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'DNSServiceRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ar-r56ijpurlu50gi****',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '100.100.2.138',
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'DNSServiceRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.NoParamModify',
'errorMessage' => 'The operation is not allowed because of no param modified.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'QuotaExceeded.sourceCidrLimit',
'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded',
],
[
'errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit',
'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'IllegalParam',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.AuthorizationRule',
'errorMessage' => 'The param of AuthorizationRuleId is illegal.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\"\\n}","errorExample":""},{"type":"xml","example":"\\n BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\n","errorExample":""}]',
'title' => 'UpdateDNSServiceRuleAttribute',
],
'ListDNSServiceRules' => [
'summary' => '显示DNSServiceRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'DNSServiceRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ar-c1dk4jb73j5791****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DNSServiceRuleStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Source',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '100.100.2.138',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '4A63118E-B375-5718-8F03-30F6804E1DCD',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'DNSServiceRules' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
'ServiceType' => [
'description' => '',
'type' => 'string',
'example' => 'Normal',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => '100.100.2.138',
],
'Destination' => [
'description' => '',
'type' => 'string',
'example' => '192.168.0.2',
],
'DNSServiceRuleStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'DNSServiceRuleName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'DNSServiceRuleDescription' => [
'description' => '',
'type' => 'string',
'example' => 'description',
],
'DNSServiceRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'ar-c1dk4jb73j5791****',
],
],
],
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A63118E-B375-5718-8F03-30F6804E1DCD\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 10,\\n \\"DNSServiceRules\\": [\\n {\\n \\"IoTCloudConnectorId\\": \\"iotcc-1y6h8z7imd2yu4****\\",\\n \\"ServiceType\\": \\"Normal\\",\\n \\"Source\\": \\"100.100.2.138\\",\\n \\"Destination\\": \\"192.168.0.2\\",\\n \\"DNSServiceRuleStatus\\": \\"Created\\",\\n \\"DNSServiceRuleName\\": \\"test\\",\\n \\"DNSServiceRuleDescription\\": \\"description\\",\\n \\"DNSServiceRuleId\\": \\"ar-c1dk4jb73j5791****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4A63118E-B375-5718-8F03-30F6804E1DCD\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 10\\n \\n iotcc-1y6h8z7imd2yu4****\\n Normal\\n 100.100.2.138\\n 192.168.0.2\\n Created\\n test\\n description\\n ar-c1dk4jb73j5791****\\n \\n","errorExample":""}]',
'title' => 'ListDNSServiceRules',
],
'DeleteDNSServiceRule' => [
'summary' => '删除DNSServiceRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'DNSServiceRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ar-r56ijpurlu50gi****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'OperationDenied.IotCloudConnectorInGroup',
'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.AuthorizationRule',
'errorMessage' => 'The param of AuthorizationRuleId is illegal.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'IllegalParam.AuthoriztionRuleId',
'errorMessage' => 'The param of AuthoriztionRuleId is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\"\\n}","errorExample":""},{"type":"xml","example":"\\n BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\n","errorExample":""}]',
'title' => 'DeleteDNSServiceRule',
],
'MoveAuthorizationRuleToDNSService' => [
'summary' => '移动普通白名单规则里面的DNS条目到DNS服务中',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ar-la6sn6gng90e1x****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '862D2D7E-E6A9-5645-9CA0-64B520256A7B',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"862D2D7E-E6A9-5645-9CA0-64B520256A7B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 862D2D7E-E6A9-5645-9CA0-64B520256A7B\\n","errorExample":""}]',
'title' => 'MoveAuthorizationRuleToDNSService',
],
'CreateGroupDNSServiceRule' => [
'summary' => '创建CloudConnector分组DNS服务规则',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'DNSServiceRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '100.100.2.136',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8',
],
'DNSServiceRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'gar-ffnn1ewe2nmf3y****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'ResourceAlreadyExist.AuthorizationRule',
'errorMessage' => 'The specified resource of AuthorizationRule already exists.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\",\\n \\"DNSServiceRuleId\\": \\"gar-ffnn1ewe2nmf3y****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n iotccg-g00epppbi9di9y****\\n 77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\n gar-ffnn1ewe2nmf3y****\\n","errorExample":""}]',
'title' => 'CreateGroupDNSServiceRule',
],
'UpdateGroupDNSServiceRuleAttribute' => [
'summary' => '修改CloudConnector分组DNS服务规则属性',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'DNSServiceRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'DNSServiceRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'gar-ffnn1ewe2nmf3y****',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '100.100.2.136',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\n","errorExample":""}]',
'title' => 'UpdateGroupDNSServiceRuleAttribute',
],
'ListGroupDNSServiceRules' => [
'summary' => '显示分组DNSServiceRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'DNSServiceRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'gar-ffnn1ewe2nmf3y****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Source',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '100.100.2.136',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DNSServiceRuleStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'DNSServiceRules' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'DNSServiceRuleStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => '100.100.2.136',
],
'ServiceType' => [
'description' => '',
'type' => 'string',
'example' => 'Normal',
],
'Destination' => [
'description' => '',
'type' => 'string',
'example' => '192.168.0.2',
],
'DNSServiceRuleName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'DNSServiceRuleDescription' => [
'description' => '',
'type' => 'string',
'example' => 'description',
],
'DNSServiceRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'gar-ffnn1ewe2nmf3y****',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup',
'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 10,\\n \\"DNSServiceRules\\": [\\n {\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"DNSServiceRuleStatus\\": \\"Created\\",\\n \\"Source\\": \\"100.100.2.136\\",\\n \\"ServiceType\\": \\"Normal\\",\\n \\"Destination\\": \\"192.168.0.2\\",\\n \\"DNSServiceRuleName\\": \\"test\\",\\n \\"DNSServiceRuleDescription\\": \\"description\\",\\n \\"DNSServiceRuleId\\": \\"gar-ffnn1ewe2nmf3y****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 10\\n \\n iotccg-g00epppbi9di9y****\\n Created\\n 100.100.2.136\\n Normal\\n 192.168.0.2\\n test\\n description\\n gar-ffnn1ewe2nmf3y****\\n \\n","errorExample":""}]',
'title' => 'ListGroupDNSServiceRules',
],
'MoveGroupAuthorizationRuleToDNSService' => [
'summary' => '移动普通分组白名单规则里面的DNS条目到分组DNS服务中',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'gar-ez91t41jvi6tr8****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
'title' => 'MoveGroupAuthorizationRuleToDNSService',
],
'DeleteGroupDNSServiceRule' => [
'summary' => '删除CloudConnector分组DNS服务规则',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'DNSServiceRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'gar-ffnn1ewe2nmf3y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\n","errorExample":""}]',
'title' => 'DeleteGroupDNSServiceRule',
],
'EnableIoTCloudConnectorAccessLog' => [
'summary' => 'EnableIoTCloudConnectorAccessLog',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AccessLogSlsProject',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'sls-setter',
],
],
[
'name' => 'AccessLogSlsLogStore',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'test',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'EnableIoTCloudConnectorAccessLog',
],
'DisableIoTCloudConnectorAccessLog' => [
'summary' => 'DisableIoTCloudConnectorAccessLog',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'DisableIoTCloudConnectorAccessLog',
],
'GetIoTCloudConnectorAccessLog' => [
'summary' => 'GetIoTCloudConnectorAccessLog',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'AccessLogSlsProject' => [
'description' => '',
'type' => 'string',
'example' => 'sls-setter',
],
'AccessLogSlsLogStore' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'AccessLogStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Opened',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AccessLogSlsProject\\": \\"sls-setter\\",\\n \\"AccessLogSlsLogStore\\": \\"test\\",\\n \\"AccessLogStatus\\": \\"Opened\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n sls-setter\\n test\\n Opened\\n","errorExample":""}]',
'title' => 'GetIoTCloudConnectorAccessLog',
],
'CreateService' => [
'summary' => '创建Service',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'service_name',
],
],
[
'name' => 'ServiceDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'service_description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'ServiceId' => [
'description' => '',
'type' => 'string',
'example' => 'c910061f-****-44e6-b659-***c',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ServiceId\\": \\"c910061f-****-44e6-b659-***c\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n c910061f-****-44e6-b659-***c\\n","errorExample":""}]',
'title' => 'CreateService',
],
'UpdateServiceAttribute' => [
'summary' => '修改Service',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'service_name',
],
],
[
'name' => 'ServiceDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'service_description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n","errorExample":""}]',
'title' => 'UpdateServiceAttribute',
],
'ListService' => [
'summary' => '显示Service',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'c910061f-****-44e6-b659-***c',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceNames',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'service_name',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ResourceStatuses',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'NextToken FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'Services' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'ServiceId' => [
'description' => '',
'type' => 'string',
'example' => 'c910061f-****-44e6-b659-***c',
],
'ServiceStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'ServiceName' => [
'description' => '',
'type' => 'string',
'example' => 'service_name',
],
'ServiceDescription' => [
'description' => '',
'type' => 'string',
'example' => 'service_description',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"NextToken\\\\tFFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 20,\\n \\"Services\\": [\\n {\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"ServiceId\\": \\"c910061f-****-44e6-b659-***c\\",\\n \\"ServiceStatus\\": \\"Created\\",\\n \\"ServiceName\\": \\"service_name\\",\\n \\"ServiceDescription\\": \\"service_description\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n 10\\n NextToken\\tFFmyTO70tTpLG6I3FmYAXGKPd****\\n 20\\n \\n iotcc-bp1odcab8tmno0hdq****\\n c910061f-****-44e6-b659-***c\\n Created\\n service_name\\n service_description\\n \\n","errorExample":""}]',
'title' => 'ListService',
],
'DeleteService' => [
'summary' => '删除Service',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n","errorExample":""}]',
'title' => 'DeleteService',
],
'CreateServiceEntry' => [
'summary' => '创建ServiceEntry',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '192.168.1.32/27',
],
],
[
'name' => 'TargetType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Cidr',
],
],
[
'name' => 'ServiceEntryName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'entry_name',
],
],
[
'name' => 'ServiceEntryDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'entry_description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'ServiceEntryId' => [
'description' => '',
'type' => 'string',
'example' => 'fwd-119smw5tkasdf****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"ServiceEntryId\\": \\"fwd-119smw5tkasdf****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n fwd-119smw5tkasdf****\\n","errorExample":""}]',
'title' => 'CreateServiceEntry',
],
'UpdateServiceEntryAttribute' => [
'summary' => '更新ServiceEntry',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceEntryId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fwd-119smw5tkasdf****',
],
],
[
'name' => 'ServiceEntryName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'entry_name',
],
],
[
'name' => 'ServiceEntryDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'entry_description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
'title' => 'UpdateServiceEntryAttribute',
],
'ListServiceEntries' => [
'summary' => '显示ServiceEntry',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'Target',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.1.32/27',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'TargetType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceEntryStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceEntryName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'entry_name',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ServiceEntryIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'fwd-119smw5tkasdf****',
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'ServiceEntries' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ServiceId' => [
'description' => '',
'type' => 'string',
'example' => 'c910061f-****-44e6-b659-***c',
],
'ServiceEntryStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'Target' => [
'description' => '',
'type' => 'string',
'example' => '192.168.1.32/27',
],
'TargetType' => [
'description' => '',
'type' => 'string',
'example' => 'Cidr',
],
'ServiceEntryName' => [
'description' => '',
'type' => 'string',
'example' => 'entry_name',
],
'ServiceEntryDescription' => [
'description' => '',
'type' => 'string',
'example' => 'entry_description',
],
'ServiceEntryId' => [
'description' => '',
'type' => 'string',
'example' => 'fwd-119smw5tkasdf****',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 20,\\n \\"ServiceEntries\\": [\\n {\\n \\"ServiceId\\": \\"c910061f-****-44e6-b659-***c\\",\\n \\"ServiceEntryStatus\\": \\"Created\\",\\n \\"Target\\": \\"192.168.1.32/27\\",\\n \\"TargetType\\": \\"Cidr\\",\\n \\"ServiceEntryName\\": \\"entry_name\\",\\n \\"ServiceEntryDescription\\": \\"entry_description\\",\\n \\"ServiceEntryId\\": \\"fwd-119smw5tkasdf****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 20\\n \\n c910061f-****-44e6-b659-***c\\n Created\\n 192.168.1.32/27\\n Cidr\\n entry_name\\n entry_description\\n fwd-119smw5tkasdf****\\n \\n","errorExample":""}]',
'title' => 'ListServiceEntries',
],
'DeleteServiceEntry' => [
'summary' => '删除ServiceEntry',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceEntryId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fwd-119smw5tkasdf****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n","errorExample":""}]',
'title' => 'DeleteServiceEntry',
],
'SubmitDiagnoseTaskForSingleCard' => [
'summary' => '开启cciot单卡一键诊断',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-smy9a5ockzp08n****',
],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '169.254.XX.XX',
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'IP',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '114.114.XX.XX',
],
],
[
'name' => 'BeginTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1643077466',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1643077666',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceUid',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '253460731706911258',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'DiagnoseTaskId' => [
'description' => '',
'type' => 'string',
'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****',
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2qhwdp2n9x6zkvq****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n diagnoseTask-bp2qhwdp2n9x6zkvq****\\n","errorExample":""}]',
'title' => 'SubmitDiagnoseTaskForSingleCard',
],
'GetDiagnoseResultForSingleCard' => [
'summary' => '查询单卡诊断结果',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'DiagnoseTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-smy9a5ockzp08n****',
],
'CardIp' => [
'description' => '',
'type' => 'string',
'example' => '169.254.XX.XX',
],
'IccId' => [
'description' => '',
'type' => 'string',
'example' => '89860477*******27546',
],
'Destination' => [
'description' => '',
'type' => 'string',
'example' => '114.114.XX.XX',
],
'BeginTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1643077466',
],
'EndTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1643077666',
],
'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',
],
'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' => 'Normal',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"IoTCloudConnectorId\\": \\"iotcc-smy9a5ockzp08n****\\",\\n \\"CardIp\\": \\"169.254.XX.XX\\",\\n \\"IccId\\": \\"89860477*******27546\\",\\n \\"Destination\\": \\"114.114.XX.XX\\",\\n \\"BeginTime\\": 1643077466,\\n \\"EndTime\\": 1643077666,\\n \\"Status\\": \\"failed\\",\\n \\"ErrorResult\\": [\\n {\\n \\"ErrorLevel\\": \\"Warning\\",\\n \\"ErrorPart\\": \\"Terminal\\",\\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\\": \\"Normal\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n iotcc-smy9a5ockzp08n****\\n 169.254.XX.XX\\n 89860477*******27546\\n 114.114.XX.XX\\n 1643077466\\n 1643077666\\n failed\\n \\n Warning\\n Terminal\\n Terminal abnormal\\n Please check whether the terminal and card are compatible or whether the terminal can send messages\\n \\n \\n Terminal\\n Normal\\n \\n","errorExample":""}]',
'title' => 'GetDiagnoseResultForSingleCard',
],
'ListDiagnoseInfoForSingleCard' => [
'summary' => '查询单卡诊断信息列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-smy9a5ockzp08n****',
],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '169.254.XX.XX',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'DiagnoseInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-smy9a5ockzp08n****',
],
'CardIp' => [
'description' => '',
'type' => 'string',
'example' => '169.254.XX.XX',
],
'IccId' => [
'description' => '',
'type' => 'string',
'example' => '89860477*******27546',
],
'SourceType' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => '169.254.XX.XX',
],
'DestinationType' => [
'description' => '',
'type' => 'string',
'example' => 'IP',
],
'Destination' => [
'description' => '',
'type' => 'string',
'example' => '114.114.XX.XX',
],
'BeginTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1643077466',
],
'EndTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1643077666',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'completed',
],
'DiagnoseTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1649669904',
],
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****',
],
],
],
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 20,\\n \\"DiagnoseInfo\\": [\\n {\\n \\"IoTCloudConnectorId\\": \\"iotcc-smy9a5ockzp08n****\\",\\n \\"CardIp\\": \\"169.254.XX.XX\\",\\n \\"IccId\\": \\"89860477*******27546\\",\\n \\"SourceType\\": \\"卡IP\\",\\n \\"Source\\": \\"169.254.XX.XX\\",\\n \\"DestinationType\\": \\"IP\\",\\n \\"Destination\\": \\"114.114.XX.XX\\",\\n \\"BeginTime\\": 1643077466,\\n \\"EndTime\\": 1643077666,\\n \\"Status\\": \\"completed\\",\\n \\"DiagnoseTime\\": 1649669904,\\n \\"TaskId\\": \\"diagnoseTask-bp2qhwdp2n9x6zkvq****\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 20\\n \\n iotcc-smy9a5ockzp08n****\\n 169.254.XX.XX\\n 89860477*******27546\\n 卡IP\\n 169.254.XX.XX\\n IP\\n 114.114.XX.XX\\n 1643077466\\n 1643077666\\n completed\\n 1649669904\\n diagnoseTask-bp2qhwdp2n9x6zkvq****\\n \\n 10\\n","errorExample":""}]',
'title' => 'ListDiagnoseInfoForSingleCard',
],
'CreateIoTCloudConnectorBackhaulRoute' => [
'summary' => '创建IoTCloudConnector回程路由',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'OperationDenied.UserVpcRouteAlreadyPublished',
'errorMessage' => 'The operation is not allowed because of user vpc route already published.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\n iotcc-bp1odcab8tmno0hdq****\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n","errorExample":""}]',
'title' => ' CreateIoTCloudConnectorBackhaulRoute',
],
'ListIoTCoudConnectorBackhaulRoute' => [
'summary' => '显示IoTCloudConnector回程路由',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136568',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'Routes' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DestinationCidrBlock' => [
'description' => '',
'type' => 'string',
'example' => '192.168.2.0/24',
],
'NextHopId' => [
'description' => '',
'type' => 'string',
'example' => 'eni-bp1d66qjxb3qoin3****',
],
'NextHopType' => [
'description' => '',
'type' => 'string',
'example' => 'NetworkInterface',
],
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Published',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 20,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Routes\\": [\\n {\\n \\"DestinationCidrBlock\\": \\"192.168.2.0/24\\",\\n \\"NextHopId\\": \\"eni-bp1d66qjxb3qoin3****\\",\\n \\"NextHopType\\": \\"NetworkInterface\\",\\n \\"Status\\": \\"Published\\",\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 20\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 192.168.2.0/24\\n eni-bp1d66qjxb3qoin3****\\n NetworkInterface\\n Published\\n test\\n \\n","errorExample":""}]',
'title' => ' ListIoTCoudConnectorBackhaulRoute',
],
'DeleteIoTCloudConnetorBackhaulRoute' => [
'summary' => '删除IoTCloudConnector回程路由',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'OperationDenied.IotCloudConnectorInGroup',
'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceInUse.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCC is in use.',
],
[
'errorCode' => 'IncorrectStatus.CloudConnector',
'errorMessage' => 'The status of CloudConnector is incorrect.',
],
[
'errorCode' => 'ResourceInCreating.IoTCloudConnector',
'errorMessage' => 'ResourceInCreating.IoTCloudConnector',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n","errorExample":""}]',
'title' => 'DeleteIoTCloudConnetorBackhaulRoute',
],
'CreateIpMappingRule' => [
'summary' => '创建IpMappingRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'DestinationIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '192.168.10.8',
],
],
[
'name' => 'MappingIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'IpMappingRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'name',
],
],
[
'name' => 'IpMappingRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'IpMappingRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'im-irrp3bzuu5nrbx****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.DomainFeatureDisabled',
'errorMessage' => 'The operation is not allowed because of domain feature disabled.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
[
'errorCode' => 'ResourceAlreadyExist.AuthorizationRule',
'errorMessage' => 'The specified resource of AuthorizationRule already exists.',
],
[
'errorCode' => 'Conflict.Param',
'errorMessage' => 'The param is conflict.',
],
[
'errorCode' => 'Conflict.Cidr',
'errorMessage' => 'The cidr is conflict.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'QuotaExceeded.sourceCidrLimit',
'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded',
],
[
'errorCode' => 'IllegalParam',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit',
'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'OperationDenied.DomainInHumanNetwork',
'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"IpMappingRuleId\\": \\"im-irrp3bzuu5nrbx****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n im-irrp3bzuu5nrbx****\\n","errorExample":""}]',
'title' => 'CreateIpMappingRule',
],
'UpdateIpMappingRule' => [
'summary' => '更新IpMappingRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'IpMappingRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'im-irrp3bzuu5nrbx****',
],
],
[
'name' => 'DestinationIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.10.8',
],
],
[
'name' => 'MappingIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'IpMappingRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'name',
],
],
[
'name' => 'IpMappingRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.NoParamModify',
'errorMessage' => 'The operation is not allowed because of no param modified.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'QuotaExceeded.sourceCidrLimit',
'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded',
],
[
'errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit',
'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'IllegalParam',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IpMapping',
'errorMessage' => 'The param of IpMapping is illegal.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
[
'errorCode' => 'OperationDenied.NotSupportModify',
'errorMessage' => 'The operation is not allowed because of this type not support modify.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'UpdateIpMappingRule',
],
'ListIpMappingRules' => [
'summary' => '显示IpMapping',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'IpMappingRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'im-irrp3bzuu5nrbx****',
],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'MappingIps',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IpMappingRuleStatuses',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IpMappingRuleNames',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'name',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationIps',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.10.8',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'IpMappingRules' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'IpMappingRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'im-irrp3bzuu5nrbx****',
],
'IpMappingRuleStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'MappingIp' => [
'description' => '',
'type' => 'string',
'example' => '47.0.XX.XX',
],
'DestinationIp' => [
'description' => '',
'type' => 'string',
'example' => '192.168.10.8',
],
'IpMappingRuleName' => [
'description' => '',
'type' => 'string',
'example' => 'name',
],
'IpMappingRuleDescription' => [
'description' => '',
'type' => 'string',
'example' => 'description',
],
],
],
],
],
],
],
],
'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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 20,\\n \\"IpMappingRules\\": [\\n {\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"IpMappingRuleId\\": \\"im-irrp3bzuu5nrbx****\\",\\n \\"IpMappingRuleStatus\\": \\"Created\\",\\n \\"MappingIp\\": \\"47.0.XX.XX\\",\\n \\"DestinationIp\\": \\"192.168.10.8\\",\\n \\"IpMappingRuleName\\": \\"name\\",\\n \\"IpMappingRuleDescription\\": \\"description\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 20\\n \\n iotcc-bp1odcab8tmno0hdq****\\n im-irrp3bzuu5nrbx****\\n Created\\n 47.0.XX.XX\\n 192.168.10.8\\n name\\n description\\n \\n","errorExample":""}]',
'title' => 'ListIpMappingRules',
],
'DeleteIpMappingRule' => [
'summary' => '删除IpMapping',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'IpMappingRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'im-irrp3bzuu5nrbx****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'OperationDenied.IotCloudConnectorInGroup',
'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.AuthorizationRule',
'errorMessage' => 'The param of AuthorizationRuleId is illegal.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'IllegalParam.AuthoriztionRuleId',
'errorMessage' => 'The param of AuthoriztionRuleId is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n","errorExample":""}]',
'title' => 'DeleteIpMappingRule',
],
'CreateGroupIpMappingRule' => [
'summary' => '创建CloudConnector分组IpMapping',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'IpMappingRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'IpMappingRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'name',
],
],
[
'name' => 'DestinationIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '192.168.10.8',
],
],
[
'name' => 'MappingIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'GroupIpMappingRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'im-irrp3bzuu5nrbx****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
[
'errorCode' => 'ResourceAlreadyExist.AuthorizationRule',
'errorMessage' => 'The specified resource of AuthorizationRule already exists.',
],
[
'errorCode' => 'OperationDenied.DomainInHumanNetwork',
'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
[
'errorCode' => 'IllegalParam.Destination',
'errorMessage' => 'The param of Destination is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"GroupIpMappingRuleId\\": \\"im-irrp3bzuu5nrbx****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n im-irrp3bzuu5nrbx****\\n","errorExample":""}]',
'title' => 'CreateGroupIpMappingRule',
],
'UpdateGroupIpMappingRule' => [
'summary' => '修改CloudConnector分组IpMapping属性',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'IpMappingRuleDescription',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'IpMappingRuleName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'name',
],
],
[
'name' => 'GroupIpMappingRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'im-irrp3bzuu5nrbx****',
],
],
[
'name' => 'MappingIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'DestinationIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.10.8',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'AuthorizationRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'ar-1234abcb8tmno0hdq****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'OperationDenied.NoFieldModify',
'errorMessage' => 'The operation is not allowed because of no field modify.',
],
[
'errorCode' => 'OperationDenied.CIDRMaskTooLarge',
'errorMessage' => 'The operation is not allowed because of CIDR too large.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AuthorizationRuleId\\": \\"ar-1234abcb8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n iotccg-g00epppbi9di9y****\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n ar-1234abcb8tmno0hdq****\\n","errorExample":""}]',
'title' => 'UpdateGroupIpMappingRule',
],
'ListGroupIpMappingRules' => [
'summary' => '显示分组IpMappingRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'IpMappingRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'im-irrp3bzuu5nrbx****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationIps',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '192.168.10.8',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IpMappingRuleStatuses',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IpMappingRuleNames',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Name',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'MappingIps',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'IpMappingRules' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'IpMappingRuleStatus' => [
'description' => '',
'type' => 'string',
'example' => 'Created',
],
'MappingIp' => [
'description' => '',
'type' => 'string',
'example' => '47.0.XX.XX',
],
'DestinationIp' => [
'description' => '',
'type' => 'string',
'example' => '192.168.10.8',
],
'IpMappingRuleName' => [
'description' => '',
'type' => 'string',
'example' => 'name',
],
'IpMappingRuleDescription' => [
'description' => '',
'type' => 'string',
'example' => 'description',
],
'IpMappingRuleId' => [
'description' => '',
'type' => 'string',
'example' => 'im-irrp3bzuu5nrbx****',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup',
'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 20,\\n \\"IpMappingRules\\": [\\n {\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"IpMappingRuleStatus\\": \\"Created\\",\\n \\"MappingIp\\": \\"47.0.XX.XX\\",\\n \\"DestinationIp\\": \\"192.168.10.8\\",\\n \\"IpMappingRuleName\\": \\"name\\",\\n \\"IpMappingRuleDescription\\": \\"description\\",\\n \\"IpMappingRuleId\\": \\"im-irrp3bzuu5nrbx****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n 10\\n FFmyTO70tTpLG6I3FmYAXGKPd****\\n 20\\n \\n iotccg-g00epppbi9di9y****\\n Created\\n 47.0.XX.XX\\n 192.168.10.8\\n name\\n description\\n im-irrp3bzuu5nrbx****\\n \\n","errorExample":""}]',
'title' => 'ListGroupIpMappingRules',
],
'DeleteGroupIpMappingRule' => [
'summary' => '删除CloudConnector分组IpMapping',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'GroupIpMappingRuleId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'im-irrp3bzuu5nrbx****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit',
'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n","errorExample":""}]',
'title' => 'DeleteGroupIpMappingRule',
],
'ConfirmIoTCloudConnector' => [
'summary' => '被授权方进行授权IoTCloudConnector确认或者拒绝',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ConfirmStatus',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Confirm',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 54B48E3D-DF70-471B-AA93-08E683A1B45\\n iotcc-bp1odcab8tmno0hdq****\\n","errorExample":""}]',
'title' => 'ConfirmIoTCloudConnector',
],
'RevertIoTCloudConnector' => [
'summary' => '归还IoTCloudConnector',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'IllegalParamFormat',
'errorMessage' => 'The param is illegal.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\n iotcc-bp1odcab8tmno0hdq****\\n","errorExample":""}]',
'title' => 'RevertIoTCloudConnector',
],
'DeleteAuthorizationRules' => [
'summary' => '批量删除AuthorizationRule',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREuisYFDH9T',
],
],
'parameters' => [
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AuthorizationRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ar-1234abcb8tmno0hdq****',
],
'required' => true,
'maxItems' => 200,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'OperationDenied.IotCloudConnectorInGroup',
'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.',
],
[
'errorCode' => 'Forbidden.RAM',
'errorMessage' => 'Ram user does not have permission to perform this operation.',
],
[
'errorCode' => 'ResourceInConfiguring.IoTCloudConnector',
'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.',
],
[
'errorCode' => 'ResourceNotFound.AuthorizationRule',
'errorMessage' => 'The param of AuthorizationRuleId is illegal.',
],
[
'errorCode' => 'ResourceNotFound.IoTCloudConnector',
'errorMessage' => 'The param of IoTCloudConnectorId is illegal.',
],
[
'errorCode' => 'IllegalParam.AuthoriztionRuleId',
'errorMessage' => 'The param of AuthoriztionRuleId is illegal.',
],
[
'errorCode' => 'OperationDenied.CC5GInstanceNotSupport',
'errorMessage' => 'The operation is not allowed because of CC5G instance not support.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
[
'regionId' => 'cn-chengdu',
'endpoint' => 'iotcc.cn-chengdu.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao',
'endpoint' => 'iotcc.cn-qingdao.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'iotcc.cn-beijing.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'iotcc.cn-huhehaote.aliyuncs.com',
],
[
'regionId' => 'cn-wulanchabu',
'endpoint' => 'iotcc.cn-wulanchabu.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'iotcc.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'iotcc.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'iotcc.cn-shenzhen.aliyuncs.com',
],
[
'regionId' => 'cn-guangzhou',
'endpoint' => 'iotcc.cn-guangzhou.aliyuncs.com',
],
],
];