'1.0',
'info' => [
'style' => 'RPC',
'product' => 'IoTCC',
'version' => '2021-05-13',
],
'directories' => [
[
'id' => 171122,
'title' => '服务开通',
'type' => 'directory',
'children' => [
'OpenIoTCloudConnectorService',
],
],
[
'id' => 181681,
'title' => '地域',
'type' => 'directory',
'children' => [
'ListRegions',
],
],
[
'id' => 171128,
'title' => 'APN',
'type' => 'directory',
'children' => [
'ListAPNs',
],
],
[
'id' => 172548,
'title' => '云连接器',
'type' => 'directory',
'children' => [
'CreateIoTCloudConnector',
'UpdateIoTCloudConnectorAttribute',
'ListIoTCloudConnectors',
'ListIoTCloudConnectorAvailableZones',
'AssociateVSwitchWithIoTCloudConnector',
'DissociateVSwitchFromIoTCloudConnector',
'ListIoTCloudConnectorEIPs',
'DeleteIoTCloudConnector',
],
],
[
'id' => 171130,
'title' => '连接池',
'type' => 'directory',
'children' => [
'CreateConnectionPool',
'AddCidrToConnectionPool',
'UpdateConnectionPoolAttribute',
'ListConnectionPools',
'ListConnectionPoolIps',
'GetStsInfoAndOssPath',
'AssociateIpWithConnectionPool',
'DissociateIpFromConnectionPool',
'GetConnectionPoolIpOperationResult',
'ListConnectionPoolAllIps',
'DeleteConnectionPool',
],
],
[
'id' => 171124,
'title' => '授权规则',
'type' => 'directory',
'children' => [
'CreateAuthorizationRule',
'CreateAuthorizationRules',
'UpdateAuthorizationRuleAttribute',
'ListAuthorizationRules',
'DeleteAuthorizationRule',
],
],
[
'id' => 172549,
'title' => '实例组',
'type' => 'directory',
'children' => [
'CreateIoTCloudConnectorGroup',
'AddIoTCloudConnectorToGroup',
'UpdateIoTCloudConnectorGroupAttribute',
'ListIoTCloudConnectorGroups',
'RemoveIoTCloudConnectorFromGroup',
'DeleteIoTCloudConnectorGroup',
],
],
[
'id' => 181641,
'title' => '实例组授权规则',
'type' => 'directory',
'children' => [
'CreateGroupAuthorizationRule',
'UpdateGroupAuthorizationRuleAttribute',
'ListGroupAuthorizationRules',
'DeleteGroupAuthorizationRule',
],
],
[
'id' => 181682,
'title' => '授权VBR',
'type' => 'directory',
'children' => [
'GrantVirtualBorderRouter',
],
],
[
'id' => 181683,
'title' => 'DNS授权规则',
'type' => 'directory',
'children' => [
'CreateDNSServiceRule',
'UpdateDNSServiceRuleAttribute',
'ListDNSServiceRules',
'DeleteDNSServiceRule',
'MoveAuthorizationRuleToDNSService',
],
],
[
'id' => 181684,
'title' => '实例组DNS授权规则',
'type' => 'directory',
'children' => [
'CreateGroupDNSServiceRule',
'UpdateGroupDNSServiceRuleAttribute',
'ListGroupDNSServiceRules',
'MoveGroupAuthorizationRuleToDNSService',
'DeleteGroupDNSServiceRule',
],
],
[
'id' => 181685,
'title' => '访问日志',
'type' => 'directory',
'children' => [
'EnableIoTCloudConnectorAccessLog',
'DisableIoTCloudConnectorAccessLog',
'GetIoTCloudConnectorAccessLog',
],
],
[
'id' => 171117,
'title' => '分应用统计服务',
'type' => 'directory',
'children' => [
'CreateService',
'UpdateServiceAttribute',
'ListService',
'DeleteService',
],
],
[
'id' => 181686,
'title' => '应用条目',
'type' => 'directory',
'children' => [
'CreateServiceEntry',
'UpdateServiceEntryAttribute',
'ListServiceEntries',
'DeleteServiceEntry',
],
],
[
'id' => 181642,
'title' => '网络诊断',
'type' => 'directory',
'children' => [
'SubmitDiagnoseTaskForSingleCard',
'GetDiagnoseResultForSingleCard',
'ListDiagnoseInfoForSingleCard',
],
],
[
'id' => 181687,
'title' => '回程路由',
'type' => 'directory',
'children' => [
'CreateIoTCloudConnectorBackhaulRoute',
'ListIoTCoudConnectorBackhaulRoute',
'DeleteIoTCloudConnetorBackhaulRoute',
],
],
[
'id' => 181688,
'title' => '授权规则IP重定向',
'type' => 'directory',
'children' => [
'CreateIpMappingRule',
'UpdateIpMappingRule',
'ListIpMappingRules',
'DeleteIpMappingRule',
],
],
[
'id' => 181689,
'title' => '实例组授权规则IP重定向',
'type' => 'directory',
'children' => [
'CreateGroupIpMappingRule',
'UpdateGroupIpMappingRule',
'ListGroupIpMappingRules',
'DeleteGroupIpMappingRule',
],
],
[
'id' => 181690,
'title' => '实例过户',
'type' => 'directory',
'children' => [
'ConfirmIoTCloudConnector',
'RevertIoTCloudConnector',
],
],
[
'id' => 171254,
'title' => '其他',
'type' => 'directory',
'children' => [
'DeleteAuthorizationRules',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'OpenIoTCloudConnectorService' => [
'summary' => '开通云连接器服务。',
'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' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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":""}]',
'title' => '开通云连接器服务',
],
'ListRegions' => [
'summary' => '查询云连接器支持的地域列表。',
'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' => '支持的语言。取值:'."\n"
.'- **zh-CN**:中文。'."\n"
.'- **en-US**:英文。'."\n"
.'- **ja**:日文。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'Regions' => [
'description' => '地域列表。',
'type' => 'array',
'items' => [
'description' => '地域列表。',
'type' => 'object',
'properties' => [
'RegionId' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'LocalName' => [
'description' => '地域名称。',
'type' => 'string',
'example' => '华东1(杭州)',
],
'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' => '查询云连接器支持的地域列表',
],
'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' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值:**1**~**50**。默认值:**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'APN',
'in' => 'query',
'schema' => [
'description' => '运营商APN ID。',
'type' => 'string',
'required' => false,
'example' => 'CMWAP',
],
],
[
'name' => 'ISP',
'in' => 'query',
'schema' => [
'description' => 'APN对应的运营商。取值:'."\n"
."\n"
.'- **telecom**:中国电信。'."\n"
."\n"
.'- **mobile**:中国移动。'."\n"
."\n"
.'- **unicom**:中国联通。',
'type' => 'string',
'required' => false,
'example' => 'mobile',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:'."\n"
."\n"
.'- **Basic**:基础版。'."\n"
."\n"
.'- **Standard**:标准版。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请'."\n",
'type' => 'string',
'required' => false,
'example' => 'Standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '总列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'APNs' => [
'description' => 'APN列表。',
'type' => 'array',
'items' => [
'description' => 'APN列表。',
'type' => 'object',
'properties' => [
'ISP' => [
'description' => 'APN对应的运营商。取值:'."\n"
.'- **telecom**:中国电信。'."\n"
.'- **mobile**:中国移动。'."\n"
.'- **unicom**:中国联通。',
'type' => 'string',
'example' => 'mobile',
],
'APN' => [
'description' => '运营商APN ID。',
'type' => 'string',
'example' => 'CMWAP',
],
'Name' => [
'description' => 'APN名称。'."\n",
'type' => 'string',
'example' => 'test',
],
'Description' => [
'description' => 'APN的描述信息。',
'type' => 'string',
'example' => 'test',
],
'ZoneList' => [
'description' => 'APN所属可用区列表。'."\n"
.'根据可用区列表,可以过滤出可使用的交换机列表。',
'type' => 'array',
'items' => [
'description' => 'APN所属可用区列表。'."\n"
.'根据可用区列表,可以过滤出可使用的交换机列表。',
'type' => 'string',
'example' => '["eu-central-1a", "eu-central-1b"]',
],
],
'FeatureList' => [
'description' => '当前APN属性,取值:'."\n"
.'- **trafficMirror**:流量镜像。'."\n"
.'- **wildcardDomain**:泛域名。'."\n",
'type' => 'array',
'items' => [
'description' => '当前APN属性,取值:'."\n"
.'- **trafficMirror**:流量镜像。'."\n"
.'- **wildcardDomain**:泛域名。'."\n",
'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' => '查询APN',
],
'CreateIoTCloudConnector' => [
'summary' => '创建云连接器实例。',
'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' => '指定云连接器实例的运营商。取值:'."\n"
.'- **telecom**:中国电信。'."\n"
.'- **mobile**:中国移动。'."\n"
.'- **unicom**:中国联通。',
'type' => 'string',
'required' => true,
'example' => 'mobile',
],
],
[
'name' => 'APN',
'in' => 'query',
'schema' => [
'description' => '运营商APN ID。',
'type' => 'string',
'required' => true,
'example' => 'CMWAP',
],
],
[
'name' => 'IoTCloudConnectorName',
'in' => 'query',
'schema' => [
'description' => '云连接器实例的名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'IoTCloudConnectorDescription',
'in' => 'query',
'schema' => [
'description' => '云连接器实例描述信息。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但开头不能为`http://` 或`https://`。'."\n",
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'WildcardDomainEnabled',
'in' => 'query',
'schema' => [
'description' => '是否开启泛域名功能。'."\n"
.'- **true**(默认值):开启。'."\n"
.'- **false**:关闭。'."\n"
."\n"
.'> 泛域名默认开启,本字段传值无效。',
'type' => 'boolean',
'deprecated' => true,
'required' => false,
'example' => 'true',
'default' => 'true',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接创建实例。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceUid',
'in' => 'query',
'schema' => [
'description' => '云连接器实例使用者ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '132193271328****',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:'."\n"
."\n"
.'- **Basic**:基础版。'."\n"
."\n"
.'- **Standard**:标准版。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请'."\n",
'type' => 'string',
'required' => false,
'example' => 'Standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'RequestId' => [
'description' => '请求ID。',
'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":""}]',
'title' => '创建云连接器实例',
],
'UpdateIoTCloudConnectorAttribute' => [
'summary' => '更新云连接器实例信息。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'IoTCloudConnectorName',
'in' => 'query',
'schema' => [
'description' => '云连接器实例的名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)或短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'IoTCloudConnectorDescription',
'in' => 'query',
'schema' => [
'description' => '云连接器实例描述信息。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http://` 或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'WildcardDomainEnabled',
'in' => 'query',
'schema' => [
'description' => '是否开启泛域名功能。取值:'."\n"
.'- **true**(默认值):开启。'."\n"
.'- **false**:关闭。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会更新实例信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接更新实例信息。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Mode',
'in' => 'query',
'schema' => [
'description' => '实例模式。取值:'."\n"
."\n"
.'- **PassThrough**:直通模式。'."\n"
.'- **VpcNat**:私网NAT模式。',
'type' => 'string',
'required' => false,
'example' => 'PassThrough',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'ResourceId' => [
'description' => '云连接器实例ID。',
'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":""}]',
'title' => '更新云连接器实例信息',
],
'ListIoTCloudConnectors' => [
'summary' => '查询云连接器实例信息。',
'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' => '云连接器实例的状态。最多支持输入20个实例状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:创建完成。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Updating**:修改中。',
'type' => 'array',
'items' => [
'description' => '云连接器实例的状态。最多支持输入20个实例状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:创建完成。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Updating**:修改中。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IoTCloudConnectorIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云连接器实例ID列表。',
'type' => 'array',
'items' => [
'description' => '云连接器实例ID列表。最多支持输入20个实例ID。',
'type' => 'string',
'required' => false,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IoTCloudConnectorName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云连接器实例的名称。最多支持输入20个实例名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'array',
'items' => [
'description' => '云连接器实例的名称。最多支持输入20个实例名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ISP',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云连接器实例的运营商。最多支持输入20个实例的运营商。取值:'."\n"
.'- **telecom**:中国电信。'."\n"
.'- **mobile**:中国移动。'."\n"
.'- **unicom**:中国联通。',
'type' => 'array',
'items' => [
'description' => '云连接器实例的运营商。最多支持输入20个实例的运营商。取值:'."\n"
.'- **telecom**:中国电信。'."\n"
.'- **mobile**:中国移动。'."\n"
.'- **unicom**:中国联通。',
'type' => 'string',
'required' => false,
'example' => 'mobile',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'VpcId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云连接器实例连接的VPC的ID。',
'type' => 'array',
'items' => [
'description' => '云连接器实例连接的VPC的ID。最多支持输入20个VPC的ID。',
'type' => 'string',
'required' => false,
'example' => 'vpc-bp1aevy8sofi8mh1q****',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'APN',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '运营商APN的ID。',
'type' => 'array',
'items' => [
'description' => '运营商APN的ID。最多支持输入20个APN的ID。',
'type' => 'string',
'required' => false,
'example' => 'CMWAP',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1**~**50**,默认值:**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IsInGroup',
'in' => 'query',
'schema' => [
'description' => '是否查询实例组中的实例。取值:'."\n"
."\n"
.'- **true**:查询实例组中的实例。'."\n"
."\n"
.'- **false**(默认值):不查询实例组中的实例。'."\n"
."\n"
.'- **null**:全量查询实例,不区分实例是否在实例组中。'."\n",
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例组ID。',
'type' => 'string',
'required' => false,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '总列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'IoTCloudConnectors' => [
'description' => '云连接器实例列表。',
'type' => 'array',
'items' => [
'description' => '云连接器实例列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'IoTCloudConnectorStatus' => [
'description' => '云连接器实例的状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:创建完成。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Updating**:修改中。',
'type' => 'string',
'example' => 'Created',
],
'ISP' => [
'description' => '云连接器实例的运营商。取值:'."\n"
.'- **telecom**:中国电信。'."\n"
.'- **mobile**:中国移动。'."\n"
.'- **unicom**:中国联通。',
'type' => 'string',
'example' => 'mobile',
],
'IoTCloudConnectorBusinessStatus' => [
'description' => '云连接器实例的运行状态。取值:'."\n"
.'- **Normal**:正常。'."\n"
.'- **Abnormal**:不正常。'."\n",
'type' => 'string',
'example' => 'Normal',
],
'APN' => [
'description' => '运营商APN的ID。',
'type' => 'string',
'example' => 'CMWAP',
],
'RateLimit' => [
'description' => '云连接器实例的带宽峰值。单位:**Gbps**,取值范围:**1**~**10**。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'VpcId' => [
'description' => '云连接器实例连接的VPC的ID。',
'type' => 'string',
'example' => 'vpc-bp1aevy8sofi8mh1q****',
],
'VSwitchList' => [
'description' => '交换机ID。',
'type' => 'array',
'items' => [
'description' => '交换机ID。',
'type' => 'string',
'example' => 'vsw-m5e3r57pxkgijcdvfcdvf****',
],
],
'IoTCloudConnectorName' => [
'description' => '云连接器实例的名称。',
'type' => 'string',
'example' => 'test',
],
'IoTCloudConnectorDescription' => [
'description' => '云连接器实例描述信息。',
'type' => 'string',
'example' => 'test',
],
'WildcardDomainEnabled' => [
'description' => '是否开启泛域名功能。取值:'."\n"
.'- **true**:开启。'."\n"
.'- **false**:关闭。',
'type' => 'boolean',
'example' => 'false',
],
'CreateTime' => [
'description' => '云连接器实例创建时间。'."\n"
."\n"
.'按照ISO8601标准表示,并需要使用UTC时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。',
'type' => 'integer',
'format' => 'int64',
'example' => '2021-10-01T00:00:00Z',
],
'ModifyTime' => [
'description' => '云连接器实例信息修改时间。'."\n"
."\n"
.'按照ISO8601标准表示,并需要使用UTC时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。',
'type' => 'integer',
'format' => 'int64',
'example' => '2021-10-01T10:00:00Z',
],
'IoTCloudConnectorGroupId' => [
'description' => '云连接器实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'Mode' => [
'description' => '云连接器的属性值。表示当前属于**passTrough**模式时显示回程路由。',
'type' => 'string',
'example' => 'PassThrough',
],
'IpFeature' => [
'description' => '动态或静态IP。',
'type' => 'string',
'example' => '192.168.0.1',
],
'Type' => [
'description' => '云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:'."\n"
."\n"
.'- **Basic**:基础版。'."\n"
."\n"
.'- **Standard**:标准版。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请'."\n",
'type' => 'string',
'example' => 'Standard',
],
'ServiceType' => [
'description' => '服务类型。取值:'."\n"
."\n"
.'- **Normal**:普通型。'."\n"
.'- **CC5G**:云连接器5G实例托管类型。'."\n"
.'- **CC5GCCIoT**:云连接器5G过户类型。',
'type' => 'string',
'example' => 'Normal',
],
'GrantAliUid' => [
'description' => '阿里云授权者UID。',
'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' => '查询云连接器实例信息',
],
'ListIoTCloudConnectorAvailableZones' => [
'summary' => '查询支持云连接器实例绑定交换机的可用区。',
'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' => '云连接器实例所在的地域ID,仅取值:**cn-hangzhou**。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'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' => 'IoTCC实例绑定交换机可用区',
],
'AssociateVSwitchWithIoTCloudConnector' => [
'summary' => '将交换机与云连接器实例进行关联。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例需关联的VPC的ID。'."\n"
."\n"
.'如果填写此参数则必须填**VSwitchList**;如果不填,则**VSwitchList**也不填。',
'type' => 'string',
'required' => true,
'example' => 'vpc-bp1aevy8sofi8mh1q****',
],
],
[
'name' => 'VSwitchList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '客户端VPC下的交换机列表,并且交换机的可用区必须和云连接器实例的可用区一致。'."\n"
."\n"
.'**N**取值为**2**,表示必须为2个交换机。'."\n",
'type' => 'array',
'items' => [
'description' => '客户端VPC下的交换机列表,并且交换机的可用区必须和云连接器实例的可用区一致。'."\n"
.'**N**取值为**2**,表示必须为2个交换机。',
'type' => 'string',
'required' => false,
'example' => 'vsw-m5e3r57pxkgijcdvfcdvf****',
],
'required' => true,
'maxItems' => 20,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会将交换机与云连接器实例进行关联。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接将交换机与云连接器实例进行关联。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '交换机与云连接器实例进行关联',
],
'DissociateVSwitchFromIoTCloudConnector' => [
'summary' => '将交换机与云连接器实例解关联。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会将交换机与云连接器实例解关联。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接将交换机与云连接器实例解关联。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '解绑vsw/vpc',
],
'ListIoTCloudConnectorEIPs' => [
'summary' => '调用ListIoTCloudConnectorEIPs接口查询云连接器实例关联的弹性公网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' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'NextToken',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1**~**100**,默认值为**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1**~**100**,默认值为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'EIPs' => [
'description' => '关联的弹性公网IP。',
'type' => 'array',
'items' => [
'description' => '关联的弹性公网IP列表。'."\n"
."\n"
.'取值可以由多个IP组成一个JSON数组,IP之间用半角逗号(,)隔开。'."\n"
."\n"
.'> 只有基础版的云连接器实例支持返回关联的弹性公网IP列表。',
'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' => '查询云连接器实例关联的弹性公网IP列表',
],
'DeleteIoTCloudConnector' => [
'summary' => '删除云连接器实例。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会删除实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接删除实例。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID,仅取值:**cn-hangzhou**。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除云连接器实例',
],
'CreateConnectionPool' => [
'summary' => '创建连接地址池。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'Count',
'in' => 'query',
'schema' => [
'description' => '连接地址池的IP数量。取值范围:**1**~**500**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'ConnectionPoolName',
'in' => 'query',
'schema' => [
'description' => '连接地址池的名称。'."\n"
."\n"
.'长度为2~128个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。但不能以`http:// `或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
],
[
'name' => 'ConnectionPoolDescription',
'in' => 'query',
'schema' => [
'description' => '连接地址池的描述信息。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http:// `或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
],
[
'name' => 'Cidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '连接地址池所属的CIDR地址块。**N**的取值范围:**1**~**20**。'."\n"
."\n"
.'多个CIDR地址块使用and(&)分隔,格式为`Cidrs.1=CIDR地址块1&Cidrs.2=CIDR地址块2`。',
'type' => 'array',
'items' => [
'description' => '连接地址池所属的CIDR地址块。**N**的取值范围:**1**~**20**。'."\n"
."\n"
.'多个CIDR地址块使用and(&)分隔,格式为`Cidrs.1=CIDR地址块1&Cidrs.2=CIDR地址块2`。',
'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' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会创建连接地址池。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接创建连接地址池。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'ConnectionPoolId' => [
'description' => '连接地址池的ID。',
'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' => '创建连接地址池',
],
'AddCidrToConnectionPool' => [
'summary' => '连接池增加连接IP段,主要用于动态IP增加IP方式,区别于单个卡IP添加方式。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '连接地址池的ID。',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Cidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '连接地址池所属的CIDR地址块。',
'type' => 'array',
'items' => [
'description' => '需要添加到连接地址池所属的CIDR地址块。最多支持20个CIDR地址块。'."\n"
."\n"
.'多个CIDR地址块使用and(&)分隔,格式为`Cidrs.1=CIDR地址块1&Cidrs.2=CIDR地址块2`。',
'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' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会添加CIDR地址块。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接添加CIDR地址块。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '连接池增加连接IP段',
],
'UpdateConnectionPoolAttribute' => [
'summary' => '更新连接地址池。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '连接地址池的ID。',
'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' => '连接地址池的名称。'."\n"
."\n"
.'长度为2~128个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。但不能以`http:// `或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
],
[
'name' => 'ConnectionPoolDescription',
'in' => 'query',
'schema' => [
'description' => '连接地址池的描述信息。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http:// `或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
],
[
'name' => 'Cidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '连接地址池所属的CIDR地址块。**N**的取值范围:**1**~**20**。'."\n"
."\n"
.'多个CIDR地址块使用and(&)分隔,格式为`Cidrs.1=CIDR地址块1&Cidrs.2=CIDR地址块2`。',
'type' => 'array',
'items' => [
'description' => '连接地址池所属的CIDR地址块。**N**的取值范围:**1**~**20**。'."\n"
."\n"
.'多个CIDR地址块使用and(&)分隔,格式为`Cidrs.1=CIDR地址块1&Cidrs.2=CIDR地址块2`。',
'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' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会更新连接地址池。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接更新连接地址池。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '更新连接地址池',
],
'ListConnectionPools' => [
'summary' => '查询云连接地址池。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '连接地址池的ID列表。最多支持传入20个连接地址池ID。',
'type' => 'array',
'items' => [
'description' => '连接地址池的ID列表。最多支持传入20个连接地址池ID。',
'type' => 'string',
'required' => false,
'example' => 'cp-bp11234abctmno0hdq****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ConnectionPoolName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '连接地址池的名称。最多支持传入20个连接地址池名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'array',
'items' => [
'description' => '连接地址池的名称。最多支持传入20个连接地址池名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'pool01',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ConnectionPoolStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '连接地址池的状态。最多支持传入20个连接地址池状态。'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Running**:运行中。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Deleted**:已删除。'."\n"
.'- **Associating**:IP绑定中。'."\n"
.'- **Dissociating**:IP解绑中。',
'type' => 'array',
'items' => [
'description' => '连接地址池的状态。最多支持传入20个连接地址池状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Running**:运行中。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Deleted**:已删除。'."\n"
.'- **Associating**:IP绑定中。'."\n"
.'- **Dissociating**:IP解绑中。',
'type' => 'string',
'required' => false,
'example' => 'Running',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '用来标记当前开始读取的位置,置空表示从头开始。'."\n"
."\n"
.'> 第一次调用不用填写,会在返回结果中包含第二次调用时用的NextToken,之后每次调用返回结果中都有下一次调用时的NextToken。',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '本次读取的最大数据记录数量,取值:**1**~**50**。传入为空时,默认值为**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID,仅取值:**cn-hangzhou**。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '连接地址池总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NextToken' => [
'description' => '下一个查询开始的Token,为空表示没有下一个。',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
'MaxResults' => [
'description' => '本次请求所返回的最大记录条数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ConnectionPools' => [
'description' => '连接地址池信息。',
'type' => 'array',
'items' => [
'description' => '连接地址池信息。',
'type' => 'object',
'properties' => [
'ConnectionPoolId' => [
'description' => '连接地址池ID。',
'type' => 'string',
'example' => 'cp-bp11234abctmno0hdq****',
],
'ConnectionPoolStatus' => [
'description' => '连接地址池的状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Running**:运行中。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Deleted**:已删除。'."\n"
.'- **Associating**:IP绑定中。'."\n"
.'- **Dissociating**:IP解绑中。',
'type' => 'string',
'example' => 'Running',
],
'ConnectionPoolName' => [
'description' => '连接地址池的名称。',
'type' => 'string',
'example' => 'pool01',
],
'ConnectionPoolDescription' => [
'description' => '连接地址池的描述信息。',
'type' => 'string',
'example' => 'pool01',
],
'Cidrs' => [
'description' => '连接地址池所属的CIDR地址块。',
'type' => 'array',
'items' => [
'description' => '连接地址池所属的CIDR地址块。',
'type' => 'string',
'example' => '192.168.XX.XX/32',
],
],
'OperateResultRequestID' => [
'description' => '上一次绑定解绑调用返回的**RequestId**。可以根据此ID调用**GetConnectionPoolIpOperationResult**返回绑定解绑的失败原因。',
'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' => '查询云连接地址池',
],
'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' => '用来标记当前开始读取的位置,置空表示从头开始。'."\n"
."\n"
.'> 第一次调用不用填写,会在返回结果中包含第二次调用时用的NextToken,之后每次调用返回结果中都有下一次调用时的NextToken。',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分页大小,取值:**1**~**2000**。传入为空时,默认值为**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2000',
'minimum' => '1',
'example' => '10',
'default' => '50',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID,仅取值:**cn-hangzhou**。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => false,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '连接地址池的ID。',
'type' => 'string',
'required' => false,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'description' => '连接地址池中的IP地址。',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回请求列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '连接地址池IP总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NextToken' => [
'description' => '下一个查询开始的Token,为空表示没有下一个。',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
'MaxResults' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ConnectionPoolIps' => [
'description' => '连接地址池IP列表。',
'type' => 'array',
'items' => [
'description' => '连接地址池IP列表。',
'type' => 'object',
'properties' => [
'ConnectionPoolId' => [
'description' => '连接地址池ID。',
'type' => 'string',
'example' => 'cp-bp11234abctmno0hdq****',
],
'Ip' => [
'description' => '连接地址池中的IP地址。',
'type' => 'string',
'example' => '192.168.XX.XX',
],
'Status' => [
'description' => 'IP地址状态,仅取值**activated**,表示已激活,IP地址和云连接器绑定完成。',
'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' => '查询连接地址池中的IP地址状态',
],
'GetStsInfoAndOssPath' => [
'summary' => '获取服务账号STS信息和模板文件临时提交地址。',
'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' => '保证请求幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会获取信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接获取信息。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID,仅取值:**cn-hangzhou**。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '连接地址池的ID。',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '模板文件名称。'."\n"
."\n"
.'模板文件仅支持CSV格式。',
'type' => 'string',
'required' => false,
'example' => 'test.csv',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回列表信息。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'Expiration' => [
'title' => 'Sts info expiration time',
'description' => 'STS超期时间的时间戳。',
'type' => 'string',
'example' => '1633060876',
],
'AccessKeyId' => [
'title' => 'Sts info of accessKeyId',
'description' => 'STS临时AccessKey ID。',
'type' => 'string',
'example' => '',
],
'AccessKeySecret' => [
'title' => 'Sts info of accessKeySecret',
'description' => 'STS临时AccessKey Secret。',
'type' => 'string',
'example' => '',
],
'SecurityToken' => [
'title' => 'Sts info of securityToken',
'description' => 'STS安全令牌。',
'type' => 'string',
'example' => '',
],
'OssPath' => [
'title' => 'OssPath',
'description' => '模板文件提交临时地址。'."\n"
."\n"
.'格式为`//`。'."\n"
."\n"
.'根据上传的文件名及用户信息,系统会返回临时STS信息和IP绑定关系CSV文件提交地址,该地址需要调用[PutObject](~~31978~~)接口上传文件。',
'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' => '获取服务账号信息和提交地址',
],
'AssociateIpWithConnectionPool' => [
'summary' => '绑定某个已存在的IP访问控制。',
'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' => '保证请求幂等性。'."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会将IP地址与云连接器关联的连接地址池绑定。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接将IP地址与云连接器关联的连接地址池绑定。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n"
."\n\n"
."\n\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '连接地址池ID。',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Ips',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要绑定的IP地址列表。'."\n"
.'最多支持传入500个IP地址。多个IP地址使用半角逗号(,)分隔。',
'type' => 'array',
'items' => [
'description' => '要绑定的IP地址列表。'."\n"
.'最多支持传入500个IP地址。多个IP地址使用半角逗号(,)分隔。'."\n"
."\n"
.'**Ips**和**IpsFilePath**不能同时填写,如果IP数量较少,可直接选择**Ips**方式,如果IP数量较多,建议选择**IpsFilePath**方式,将需要绑定的IP地址记录在模板文件中,整体绑定。',
'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' => '模板文件OSS地址,即[GetStsInfoAndOssPath](~~313331~~)接口的返回参数**OssPath**。'."\n"
."\n"
.'格式为`//`。'."\n"
."\n"
.'**Ips**和**IpsFilePath**不能同时填写,如果IP数量较少,可直接选择**Ips**方式,如果IP数量较多,建议选择**IpsFilePath**方式,将需要绑定的IP地址记录在模板文件中,整体绑定。',
'type' => 'string',
'required' => false,
'example' => 'cciot-cn-hangzhou/127859184306****/test.csv',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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":""}]',
'title' => '绑定IP地址与云连接器关联的连接地址池',
],
'DissociateIpFromConnectionPool' => [
'summary' => '解除IP地址与云连接器关联的连接地址池的绑定关系。',
'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' => '保证请求幂等性。'."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会解除IP地址与云连接器关联的连接地址池的绑定关系。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接解除IP地址与云连接器关联的连接地址池的绑定关系。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID,仅取值:**cn-hangzhou**。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '连接地址池ID。',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Ips',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要解除绑定的IP地址列表。'."\n"
.'最多支持传入500个IP地址。多个IP地址使用半角逗号(,)分隔。',
'type' => 'array',
'items' => [
'description' => '要解除绑定的IP地址列表。'."\n"
.'最多支持传入500个IP地址。多个IP地址使用半角逗号(,)分隔。'."\n"
."\n"
.'**Ips**和**IpsFilePath**不能同时填写,如果IP数量较少,可直接选择**Ips**方式,如果IP数量较多,建议选择**IpsFilePath**方式,将需要解绑的IP地址记录在模板文件中,整体解绑。',
'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' => '模板文件OSS地址,即[GetStsInfoAndOssPath](~~313331~~)接口的返回参数**OssPath**。'."\n"
."\n"
.'格式为`//`。'."\n"
."\n"
.'**Ips**和**IpsFilePath**不能同时填写,如果IP数量较少,可直接选择**Ips**方式,如果IP数量较多,建议选择**IpsFilePath**方式,将需要解绑的IP地址记录在模板文件中,整体解绑。',
'type' => 'string',
'required' => false,
'example' => 'cciot-cn-hangzhou/127859184306****/test.csv',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '解绑卡IP',
],
'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' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '连接地址池ID。',
'type' => 'string',
'required' => true,
'example' => 'cp-0gd9qnmv8431rh****',
],
],
[
'name' => 'QueryRequestId',
'in' => 'query',
'schema' => [
'description' => '查询请求ID,即调用[AssociateIpWithConnectionPool](~~313334~~)或[DissociateIpFromConnectionPool](~~313335~~)接口,操作成功后返回的**RequestId**。',
'type' => 'string',
'required' => true,
'example' => 'CFA63CEB-15B6-4AE8-B203-F855FF7BA962',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回请求列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA651',
],
'ResultFilePaths' => [
'title' => 'OssPath',
'description' => '绑定与解绑的执行结果文件地址,即调用[AssociateIpWithConnectionPool](~~313334~~)或[DissociateIpFromConnectionPool](~~313335~~)接口执行结果文件下载地址。格式为`https:///ipma/<执行结果文件>?<超期信息>&<临时AK/SK信息>&<签名信息>`。'."\n"
."\n"
.'文件内容为绑定和解绑的错误IP地址或错误原因列表,如果该字段为空,代表没有失败记录。',
'type' => 'array',
'items' => [
'description' => '绑定与解绑的执行结果文件地址,即调用[AssociateIpWithConnectionPool](~~313334~~)或[DissociateIpFromConnectionPool](~~313335~~)接口执行结果文件下载地址。格式为`https:///ipma/<执行结果文件>?<超期信息>&<临时AK/SK信息>&<签名信息>`。'."\n"
."\n"
.'文件内容为绑定和解绑的错误IP地址或错误原因列表,如果该字段为空,代表没有失败记录。',
'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' => '获取IP地址绑定与解绑结果',
],
'ListConnectionPoolAllIps' => [
'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' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的NextToken值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值:**1**~**50**。默认值:**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2000',
'minimum' => '1',
'example' => '10',
'default' => '50',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '要查询的连接地址池ID。',
'type' => 'string',
'required' => true,
'example' => 'cp-bp11234abctmno0hdq****',
],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'description' => '连接地址池中的IP地址。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '连接地址池中IP地址类型。取值:'."\n"
."\n"
.'- **Cidr**:连接地址池所属的CIDR地址块。'."\n"
."\n"
.'- **Host**:物联网卡的IP地址。',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'TotalIpsCount' => [
'description' => '总列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ConnectionPoolIps' => [
'description' => '连接地址池IP列表。',
'type' => 'array',
'items' => [
'description' => '连接地址池IP列表。',
'type' => 'object',
'properties' => [
'ConnectionPoolId' => [
'description' => '连接地址池ID。',
'type' => 'string',
'example' => 'cp-bp11234abctmno0hdq****',
],
'Ip' => [
'description' => '连接地址池中的IP地址。',
'type' => 'string',
'example' => '192.168.0.1',
],
'Status' => [
'description' => 'IP地址状态,仅返回**activated**,表示已激活,IP地址和云连接器绑定完成。',
'type' => 'string',
'example' => 'activated',
],
'Type' => [
'description' => '连接地址池中IP地址类型。取值:'."\n"
."\n"
.'- **Cidr**:连接地址池所属的CIDR地址块。'."\n"
."\n"
.'- **Host**:物联网卡的IP地址。',
'type' => 'string',
'example' => 'Cidr',
],
'IpNum' => [
'description' => '可用IP数量。'."\n"
.'- **Type**取值为**Host**时,可用IP数量为**1**。'."\n"
."\n"
.'- **Type**取值为**Cidr**时,可用IP数量为CIDR地址块的IP总数。'."\n",
'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' => '查询连接地址池所有IP地址',
],
'DeleteConnectionPool' => [
'summary' => '删除连接地址池。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ConnectionPoolId',
'in' => 'query',
'schema' => [
'description' => '连接地址池的ID。',
'type' => 'string',
'required' => true,
'example' => '1234abc',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会删除连接地址池。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接删除连接地址池。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID,仅取值:**cn-hangzhou**。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除连接地址池',
],
'CreateAuthorizationRule' => [
'summary' => '创建授权规则。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '访问目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => true,
'example' => 'Cidr',
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'schema' => [
'description' => '目标端口范围。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
."\n"
.'- ICMP协议:-1/-1。'."\n"
."\n"
.'- ALL:-1/-1。',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'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' => '访问策略。取值:'."\n"
.'- **Permit**:允许。'."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'required' => true,
'example' => 'Permit',
],
],
[
'name' => 'SourceCidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '源CIDR地址块。最多支持20个源CIDR地址块。',
'type' => 'array',
'items' => [
'description' => '源CIDR地址块。最多支持20个源CIDR地址块。',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
'required' => true,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)或短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
],
[
'name' => 'AuthorizationRuleDescription',
'in' => 'query',
'schema' => [
'description' => '授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接创建授权规则。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'AuthorizationRuleId' => [
'description' => '授权规则ID。',
'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":""}]',
'title' => '创建授权规则',
],
'CreateAuthorizationRules' => [
'summary' => '调用CreateAuthorizationRules接口创建多条授权规则。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会创建多条授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'AuthorizationRules',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则列表。',
'type' => 'array',
'items' => [
'description' => '授权规则列表。',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '授权规则名称。最多支持20个授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)或短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
'Description' => [
'description' => '授权规则描述。最多支持20个授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
'SourceCidr' => [
'description' => '源CIDR地址块。最多支持20个CIDR地址块。',
'type' => 'string',
'required' => true,
'example' => '192.168.0.1/24',
],
'DestinationType' => [
'description' => '访问目标类型。最多支持20个访问目标类型。取值:'."\n"
."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => true,
'example' => 'Cidr',
],
'DestinationPort' => [
'description' => '目标端口范围。最多支持20个访问目标端口。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:**1~65535**。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
."\n"
.'- ICMP协议:-1/-1。'."\n"
."\n"
.'- ALL:-1/-1。'."\n",
'type' => 'string',
'required' => false,
'example' => '80/80',
],
'Protocol' => [
'description' => '协议类型。最多支持20个协议类型。取值:'."\n"
."\n"
.'- **TCP**。'."\n"
."\n"
.'- **UDP**。'."\n"
."\n"
.'- **ICMP**。'."\n"
."\n"
.'- **ALL**:支持所有协议。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => 'TCP',
],
'Destination' => [
'description' => '访问目标地址。最多支持20个访问目标地址。',
'type' => 'string',
'required' => true,
'example' => '47.0.XX.XX',
],
'Policy' => [
'description' => '访问策略。最多支持20个访问策略。取值:'."\n"
."\n"
.'- **Permit**:允许。'."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'required' => true,
'example' => 'Permit',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'AuthorizationRuleIds' => [
'description' => '授权规则ID。',
'type' => 'array',
'items' => [
'description' => '授权规则ID。',
'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' => '创建多条授权规则',
],
'UpdateAuthorizationRuleAttribute' => [
'summary' => '更新授权规则信息。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'ar-1234abcb8tmno0hdq****',
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '访问目标类型。'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'schema' => [
'description' => '目标端口范围。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'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' => '访问策略。'."\n"
.'- **Permit**:允许。'."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'required' => false,
'example' => 'Permit',
],
],
[
'name' => 'SourceCidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '源CIDR地址块。最多支持传入20个源CIDR地址块。',
'type' => 'array',
'items' => [
'description' => '源CIDR地址块。最多支持传入20个源CIDR地址块。',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
],
[
'name' => 'AuthorizationRuleDescription',
'in' => 'query',
'schema' => [
'description' => '授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会更新授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接更新授权规则。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '更新授权规则信息',
],
'ListAuthorizationRules' => [
'summary' => '查询授权规则信息。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AuthorizationRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则ID列表。最多支持传入20个授权规则ID。',
'type' => 'array',
'items' => [
'description' => '授权规则ID列表。最多支持传入20个授权规则ID。',
'type' => 'string',
'required' => false,
'example' => 'ar-1234abcb8tmno0hdq****',
],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '访问目标类型。最多支持传入20个访问目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'array',
'items' => [
'description' => '访问目标类型。最多支持传入20个访问目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Protocol',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '协议类型。最多支持输入20个协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'type' => 'array',
'items' => [
'description' => '协议类型。最多支持输入20个协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'type' => 'string',
'required' => false,
'example' => 'tcp',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '目标端口范围。最多支持20个端口取值范围。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'type' => 'array',
'items' => [
'description' => '目标端口范围。最多支持20个端口取值范围。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'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' => '访问目标。最多支持20个访问目标。',
'type' => 'string',
'required' => false,
'example' => '192.168.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则状态。最多支持传入20个授权规则状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:创建完成。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Updating**:更新中。'."\n",
'type' => 'array',
'items' => [
'description' => '授权规则状态。最多支持传入20个授权规则状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:创建完成。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则名称。最多支持传入20个授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'array',
'items' => [
'description' => '授权规则名称。最多支持传入20个授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'rule01',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Policy',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '访问策略。最多支持传入20个访问策略。'."\n"
.'- **Permit**:允许。'."\n"
.'- **Deny**:拒绝。',
'type' => 'array',
'items' => [
'description' => '访问策略。最多支持传入20个访问策略。取值:'."\n"
.'- **Permit**:允许。'."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'required' => false,
'example' => 'Permit',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的NextToken值。',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分页大小,取值:**1**~**50**。传入为空时,默认值:**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'AuthorizationRuleType',
'in' => 'query',
'schema' => [
'description' => '授权规则的类型。取值:'."\n"
."\n"
.'- **System**,表示授权规则的类型为系统类型。'."\n"
."\n"
.'- **Customer**:表示授权规则的类型为自定义类型。'."\n"
."\n"
.'- **Default**:表示授权规则的类型为默认类型。',
'type' => 'string',
'required' => false,
'example' => 'System',
],
],
[
'name' => 'FuzzyDestination',
'in' => 'query',
'schema' => [
'description' => '模糊的访问目标',
'type' => 'string',
'required' => false,
'example' => 'aliyuncs',
],
],
[
'name' => 'FuzzyAuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '模糊的授权规则名称',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '授权规则总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
'MaxResults' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'AuthorizationRules' => [
'description' => '授权规则列表。',
'type' => 'array',
'items' => [
'description' => '授权规则列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'Policy' => [
'description' => '访问策略。取值:'."\n"
.'- **Permit**:允许。'."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'example' => 'Permit',
],
'AuthorizationRuleStatus' => [
'description' => '授权规则状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:创建完成。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'example' => 'Created',
],
'SourceCidrs' => [
'description' => '源CIDR地址块。',
'type' => 'array',
'items' => [
'description' => '源CIDR地址块。',
'type' => 'string',
'example' => '192.168.XX.XX',
],
],
'DestinationType' => [
'description' => '访问目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'example' => 'Cidr',
],
'Protocol' => [
'description' => '协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'type' => 'string',
'example' => 'tcp',
],
'DestinationPort' => [
'description' => '目标端口范围。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'type' => 'string',
'example' => '80/80',
],
'Destination' => [
'description' => '访问目标。',
'type' => 'string',
'example' => '192.168.XX.XX',
],
'AuthorizationRuleName' => [
'description' => '授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。',
'type' => 'string',
'example' => 'rule01',
],
'AuthorizationRuleDescription' => [
'description' => '授权规则描述。',
'type' => 'string',
'example' => 'rule01',
],
'AuthorizationRuleId' => [
'description' => '授权规则ID。',
'type' => 'string',
'example' => 'ar-1234abcb8tmno0hdq****',
],
'AuthorizationRuleType' => [
'description' => '授权规则的类型。取值:'."\n"
."\n"
.'- **System**,表示授权规则的类型为系统类型。'."\n"
."\n"
.'- **Customer**:表示授权规则的类型为自定义类型。'."\n"
."\n"
.'- **Default**:表示授权规则的类型为默认类型。',
'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' => '查询授权规则',
],
'DeleteAuthorizationRule' => [
'summary' => '删除授权规则。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'ar-1234abcb8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会删除授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接删除授权规则。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除授权规则',
],
'CreateIoTCloudConnectorGroup' => [
'summary' => '创建实例组。',
'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' => '实例组的名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'cctest',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '实例组的描述信息。'."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http://` 或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会创建实例组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:'."\n"
."\n"
.'- **Basic**:基础版。'."\n"
."\n"
.'- **Standard**:标准版。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请'."\n",
'type' => 'string',
'required' => false,
'example' => 'Standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '请求ID。',
'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' => '创建实例组',
],
'AddIoTCloudConnectorToGroup' => [
'summary' => '为实例组添加云连接器实例。',
'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' => '云连接器实例ID。**N**的取值范围:**1**~**20**。',
'type' => 'array',
'items' => [
'description' => '云连接器实例ID。**N**的取值范围:**1**~**20**。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'required' => true,
'maxItems' => 20,
],
],
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会为实例组添加云连接器实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '添加云连接器到分组中',
],
'UpdateIoTCloudConnectorGroupAttribute' => [
'summary' => '修改云连接器分组属性。',
'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' => '实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '要修改的实例组的实例名称。'."\n"
."\n"
.'长度为2-128个英文或中文字符,必须以大小字母或中文开头,可包含数字,半角句号(.),下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '要修改的实例组的描述信息。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会修改实例组的属性。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行修改。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '修改云连接器分组属性',
],
'ListIoTCloudConnectorGroups' => [
'summary' => '查询实例组列表信息。',
'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' => '实例组的状态。最多支持20个实例组的状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。'."\n",
'type' => 'array',
'items' => [
'description' => '实例组的状态。最多支持20个实例组的状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。'."\n",
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IoTCloudConnectorGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例组的ID列表。最多支持20个实例组的ID列表。',
'type' => 'array',
'items' => [
'description' => '实例组的ID列表。最多支持20个实例组的ID列表。',
'type' => 'string',
'required' => false,
'example' => 'iotccg-g00epppbi9di9y****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IoTCloudConnectorGroupName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例组的名称。最多支持20个实例组的名称。',
'type' => 'array',
'items' => [
'description' => '实例组的名称。最多支持20个实例组的名称。'."\n"
."\n"
.'名称长度为2~128个英文或中文字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'cctest',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值:**1**~**50**。默认值:**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:'."\n"
."\n"
.'- **Basic**:基础版。'."\n"
."\n"
.'- **Standard**:标准版。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请'."\n",
'type' => 'string',
'required' => false,
'example' => 'Standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'IoTCloudConnectorGroups' => [
'description' => '实例组列表信息。',
'type' => 'array',
'items' => [
'description' => '实例组列表信息。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'IoTCloudConnectorGroupStatus' => [
'description' => '实例组的状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。'."\n",
'type' => 'string',
'example' => 'Created',
],
'IoTCloudConnectors' => [
'description' => '云连接器实例列表。',
'type' => 'array',
'items' => [
'description' => '云连接器实例列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'IoTCloudConnectorStatus' => [
'description' => '云连接器实例的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:修改中。',
'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' => '云连接器实例的运营商。取值:'."\n"
."\n"
.'- **telecom**:中国电信。'."\n"
."\n"
.'- **mobile**:中国移动。'."\n"
."\n"
.'- **unicom**:中国联通。',
'type' => 'string',
'example' => 'mobile',
],
'APN' => [
'description' => '运营商APN ID。',
'type' => 'string',
'example' => 'CMWAP',
],
'ServiceType' => [
'description' => '服务类型。取值:'."\n"
."\n"
.'- **Normal**:普通型。'."\n"
.'- **CC5G**:云连接器5G实例托管类型。'."\n"
.'- **CC5GCCIoT**:云连接器5G过户类型。',
'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' => '云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:'."\n"
."\n"
.'- **Basic**:基础版。'."\n"
."\n"
.'- **Standard**:标准版。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。'."\n"
."\n"
.'云连接器实例默认创建标准版,如果需要创建基础版实例,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请'."\n",
'type' => 'string',
'example' => 'Standard',
],
'ServiceType' => [
'description' => '服务类型。取值:'."\n"
."\n"
.'- **Normal**:普通型。'."\n"
.'- **CC5G**:云连接器5G实例托管类型。'."\n"
.'- **CC5GCCIoT**:云连接器5G过户类型。',
'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' => '查询实例组列表信息',
],
'RemoveIoTCloudConnectorFromGroup' => [
'summary' => '将云连接器实例从实例组中移除。',
'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' => '云连接器实例ID。**N**的取值范围:**1**~**20**。',
'type' => 'array',
'items' => [
'description' => '云连接器实例ID。**N**的取值范围:**1**~**20**。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'required' => true,
],
],
[
'name' => 'IoTCloudConnectorGroupId',
'in' => 'query',
'schema' => [
'description' => '实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会将云连接器实例从实例组中移除。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '将云连接器实例从实例组中移除',
],
'DeleteIoTCloudConnectorGroup' => [
'summary' => '删除实例组。',
'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' => '要删除的实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会删除实例组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除实例组',
],
'CreateGroupAuthorizationRule' => [
'summary' => '实例组创建授权规则。',
'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' => '实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleDescription',
'in' => 'query',
'schema' => [
'description' => '授权规则的描述信息。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http://` 或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'rule',
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '授权规则的名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'ruletest',
],
],
[
'name' => 'SourceCidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '源CIDR地址块。最多支持20个CIDR地址块。',
'type' => 'array',
'items' => [
'description' => '源CIDR地址块。最多支持20个CIDR地址块。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1/24',
],
'required' => true,
'maxItems' => 200,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '访问目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => true,
'example' => 'Cidr',
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'schema' => [
'description' => '目标端口范围。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'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' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会为实例组创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Policy',
'in' => 'query',
'schema' => [
'description' => '访问策略。取值:'."\n"
."\n"
.'- **Permit**:允许。'."\n"
."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'required' => true,
'example' => 'Permit',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '授权规则的类型。取值:'."\n"
."\n"
.'- **System**,表示授权规则的类型为系统类型。'."\n"
."\n"
.'- **Customer**:表示授权规则的类型为自定义类型。'."\n"
."\n"
.'- **Default**:表示授权规则的类型为默认类型。',
'type' => 'string',
'required' => false,
'example' => 'System',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'AuthorizationRuleId' => [
'description' => '授权规则ID。',
'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' => '实例组创建授权规则',
],
'UpdateGroupAuthorizationRuleAttribute' => [
'summary' => '修改实例组的授权规则。',
'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' => '实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleDescription',
'in' => 'query',
'schema' => [
'description' => '授权规则的描述信息。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http://` 或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'rule',
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => [
'description' => '授权规则的名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'ruletest',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '要修改的授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'gar-ez91t41jvi6tr8****',
],
],
[
'name' => 'SourceCidrs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '源CIDR地址块。N的取值范围:**1**~**20**。',
'type' => 'array',
'items' => [
'description' => '源CIDR地址块。N的取值范围:**1**~**20**。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1',
],
'required' => false,
'maxItems' => 200,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '访问目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'schema' => [
'description' => '目标端口范围。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'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' => '访问策略。取值:'."\n"
."\n"
.'- **Permit**:允许。'."\n"
."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'required' => false,
'example' => 'Permit',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会修改实例组的授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'AuthorizationRuleId' => [
'description' => '授权规则ID。',
'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' => '修改实例组的授权规则',
],
'ListGroupAuthorizationRules' => [
'summary' => '查询实例组的授权规则信息。',
'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' => '实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则ID。最多支持20个授权规则ID。',
'type' => 'array',
'items' => [
'description' => '授权规则ID。最多支持20个授权规则ID。',
'type' => 'string',
'required' => false,
'example' => 'gar-ez91t41jvi6tr8****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '访问目标类型。最多支持20个目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '访问目标类型。最多支持20个目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Destination',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '访问目标地址。最多支持20个目标地址。',
'type' => 'array',
'items' => [
'description' => '访问目标地址。最多支持20个目标地址。',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Protocol',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'type' => 'array',
'items' => [
'description' => '协议类型。最多支持20个协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'type' => 'string',
'required' => false,
'example' => 'tcp',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationPort',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '目标端口范围。最多支持20个访问目标端口。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'type' => 'array',
'items' => [
'description' => '目标端口范围。最多支持20个访问目标端口。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'type' => 'string',
'required' => false,
'example' => '80/80',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则状态。最多支持20个授权规则状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。',
'type' => 'array',
'items' => [
'description' => '授权规则状态。最多支持20个授权规则状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则的名称。最多支持20个授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'array',
'items' => [
'description' => '授权规则的名称。最多支持20个授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'ruletest',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Policy',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '访问策略。最多支持20个访问策略。取值:'."\n"
."\n"
.'- **Permit**:允许。'."\n"
."\n"
.'- **Deny**:拒绝。',
'type' => 'array',
'items' => [
'description' => '访问策略。最多支持20个访问策略。取值:'."\n"
."\n"
.'- **Permit**:允许。'."\n"
."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'required' => false,
'example' => 'Permit',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值:**1**~**50**。默认值:**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '授权规则的类型。取值:'."\n"
."\n"
.'- **System**,表示授权规则的类型为系统类型。'."\n"
.'- **Customer**:表示授权规则的类型为自定义类型。'."\n"
.'- **Default**:表示授权规则的类型为默认类型。',
'type' => 'string',
'required' => false,
'example' => 'System',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'TotalCount' => [
'description' => '总列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'GroupAuthorizationRules' => [
'description' => '授权规则列表。',
'type' => 'array',
'items' => [
'description' => '授权规则列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'Policy' => [
'description' => '访问策略。取值:'."\n"
."\n"
.'- **Permit**:允许。'."\n"
."\n"
.'- **Deny**:拒绝。',
'type' => 'string',
'example' => 'Permit',
],
'AuthorizationRuleStatus' => [
'description' => '授权规则状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'example' => 'Created',
],
'SourceCidrs' => [
'description' => '源CIDR地址块。',
'type' => 'array',
'items' => [
'description' => '源CIDR地址块。',
'type' => 'string',
'example' => '192.168.0.0/32',
],
],
'DestinationType' => [
'description' => '访问目标类型。取值:'."\n"
.'- **Cidr**:CIDR地址块。'."\n"
.'- **Domain**:域名。',
'type' => 'string',
'example' => 'Cidr',
],
'DestinationPort' => [
'description' => '目标端口范围。取值范围:'."\n"
."\n"
.'- TCP、UDP协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:-1/-1。'."\n"
.'- ALL:-1/-1。',
'type' => 'string',
'example' => '80/80',
],
'Protocol' => [
'description' => '协议类型。取值:'."\n"
."\n"
.'- **tcp**。'."\n"
.'- **udp**。'."\n"
.'- **icmp**。'."\n"
.'- **all**:支持所有协议。',
'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' => '授权规则ID。',
'type' => 'string',
'example' => 'gar-ez91t41jvi6tr8****',
],
'Type' => [
'description' => '授权规则的类型。取值:'."\n"
."\n"
.'- **System**,表示授权规则的类型为系统类型。'."\n"
.'- **Customer**:表示授权规则的类型为自定义类型。'."\n"
.'- **Default**:表示授权规则的类型为默认类型。',
'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' => '查询实例组的授权规则',
],
'DeleteGroupAuthorizationRule' => [
'summary' => '删除实例组的授权规则。',
'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' => '实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'gar-ez91t41jvi6tr8****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会删除实例组的授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除实例组的授权规则',
],
'GrantVirtualBorderRouter' => [
'summary' => '获取边界路由器VBR的服务关联角色SLR权限。',
'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' => '边界路由器VBR实例ID。',
'type' => 'string',
'required' => false,
'example' => 'vbr-bp1svadp4lq38janc****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '边界路由器VBR实例所在的地域ID。 '."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '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' => '授权绑定VBR',
],
'CreateDNSServiceRule' => [
'summary' => '创建DNS授权规则。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则的目标类型。取值:'."\n"
."\n"
.'- **Normal**:普通类型。'."\n"
."\n"
.'- **DNSRedirect**:重定向类型,重定向类型指将当前DNS服务地址重定向至另一个地址。',
'type' => 'string',
'required' => true,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '重定向后的DNS服务地址。'."\n"
."\n"
.'> 当**ServiceType**参数取值为**DNSRedirect**时,该参数必选。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '源DNS IP地址。取值:'."\n"
."\n"
.'**100.100.2.136**,**100.100.2.137**,**100.100.2.138**,**114.114.114.114**,**8.8.8.8**,**8.8.4.4**,**223.5.5.5**,**223.6.6.6**,**221.5.88.88**,**116.116.116.116**,**221.228.15.26**,**61.139.2.69**,**218.6.200.139**,**119.29.29.29**,**218.2.2.2**,**208.67.220.220**,**208.67.222.222**,**218.4.4.4**。'."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today),并在工单中附上需要申请的DNS授权规则的IP。'."\n"
.''."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex),并在工单中附上需要申请的DNS授权规则的IP。',
'type' => 'string',
'required' => true,
'example' => '100.100.2.138',
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'DNSServiceRuleDescription',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会创建DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行创建。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01',
],
'DNSServiceRuleId' => [
'description' => 'DNS授权规则ID。',
'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":""}]',
'title' => '创建DNS授权规则',
],
'UpdateDNSServiceRuleAttribute' => [
'summary' => '修改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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'DNSServiceRuleId',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'ar-r56ijpurlu50gi****',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则的目标类型。取值:'."\n"
."\n"
.'- **Normal**:普通类型。'."\n"
."\n"
.'- **DNSRedirect**:重定向类型,重定向类型指将当前DNS服务地址重定向至另一个地址。',
'type' => 'string',
'required' => false,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '重定向后的DNS服务地址。'."\n"
."\n"
.'> 当**ServiceType**参数取值为**DNSRedirect**时,该参数必选。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '源DNS IP地址。包括但不限于以下取值:'."\n"
."\n"
.'**100.100.2.136**,**100.100.2.137**,**100.100.2.138**,**114.114.114.114**,**8.8.8.8**,**8.8.4.4**,**223.5.5.5**,**223.6.6.6**,**221.5.88.88**,**116.116.116.116**,**221.228.15.26**,**61.139.2.69**,**218.6.200.139**,**119.29.29.29**,**218.2.2.2**,**208.67.220.220**,**208.67.222.222**,**218.4.4.4**。'."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today),并在工单中附上需要申请的DNS授权规则的IP。'."\n"
.''."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex),并在工单中附上需要申请的DNS授权规则的IP。',
'type' => 'string',
'required' => false,
'example' => '100.100.2.138',
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'DNSServiceRuleDescription',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会修改DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行修改。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '修改DNS授权规则',
],
'ListDNSServiceRules' => [
'summary' => '查询DNS授权规则。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'DNSServiceRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'DNS授权规则ID。',
'type' => 'array',
'items' => [
'description' => 'DNS授权规则ID。最多支持输入20个规则ID。',
'type' => 'string',
'required' => false,
'example' => 'ar-c1dk4jb73j5791****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则的目标类型。取值:'."\n"
."\n"
.'- **Normal**:普通类型。'."\n"
."\n"
.'- **DNSRedirect**:重定向类型,重定向类型指将当前DNS服务地址重定向至另一个地址。',
'type' => 'string',
'required' => false,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '目标DNS授权规则IP地址。',
'type' => 'array',
'items' => [
'description' => '重定向后的DNS服务地址。最多支持输入20个目标IP地址。'."\n"
."\n"
.'> 当**ServiceType**参数取值为**DNSRedirect**时,该参数必选。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DNSServiceRuleStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'DNS授权规则的状态。',
'type' => 'array',
'items' => [
'description' => 'DNS授权规则的状态。最多支持输入20个DNS授权规则状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'DNS授权规则名称。最多支持输入20个规则名称。',
'type' => 'array',
'items' => [
'description' => 'DNS授权规则名称。最多支持输入20个规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Source',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '源DNS授权规则IP地址。',
'type' => 'array',
'items' => [
'description' => '源DNS IP地址。最多支持输入20个源IP地址。包括但不限于以下取值:'."\n"
."\n"
.'**100.100.2.136**,**100.100.2.137**,**100.100.2.138**,**114.114.114.114**,**8.8.8.8**,**8.8.4.4**,**223.5.5.5**,**223.6.6.6**,**221.5.88.88**,**116.116.116.116**,**221.228.15.26**,**61.139.2.69**,**218.6.200.139**,**119.29.29.29**,**218.2.2.2**,**208.67.220.220**,**208.67.222.222**,**218.4.4.4**。'."\n"
."\n\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today),并在工单中附上需要申请的DNS授权规则的IP。'."\n"
.''."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex),并在工单中附上需要申请的DNS授权规则的IP。'."\n",
'type' => 'string',
'required' => false,
'example' => '100.100.2.138',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的NextToken值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值:**1~50**。默认值:**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[DescribeRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4A63118E-B375-5718-8F03-30F6804E1DCD',
],
'TotalCount' => [
'description' => '总列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'DNSServiceRules' => [
'description' => 'DNS授权规则列表。',
'type' => 'array',
'items' => [
'description' => 'DNS授权规则列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
'ServiceType' => [
'description' => 'DNS授权规则的目标类型。取值:'."\n"
."\n"
.'- **Normal**:普通类型。'."\n"
."\n"
.'- **DNSRedirect**:重定向类型,重定向类型指将当前DNS服务地址重定向至另一个地址。',
'type' => 'string',
'example' => 'Normal',
],
'Source' => [
'description' => '源DNS IP地址。包括但不限于以下取值:'."\n"
."\n"
.'**100.100.2.136**,**100.100.2.137**,**100.100.2.138**,**114.114.114.114**,**8.8.8.8**,**8.8.4.4**,**223.5.5.5**,**223.6.6.6**,**221.5.88.88**,**116.116.116.116**,**221.228.15.26**,**61.139.2.69**,**218.6.200.139**,**119.29.29.29**,**218.2.2.2**,**208.67.220.220**,**208.67.222.222**,**218.4.4.4**。'."\n"
."\n\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today),并在工单中附上需要申请的DNS授权规则的IP。'."\n"
.''."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex),并在工单中附上需要申请的DNS授权规则的IP。'."\n",
'type' => 'string',
'example' => '100.100.2.138',
],
'Destination' => [
'description' => '重定向后的DNS服务地址。'."\n"
."\n"
.'> 当**ServiceType**参数取值为**DNSRedirect**时,该参数必选。',
'type' => 'string',
'example' => '192.168.0.2',
],
'DNSServiceRuleStatus' => [
'description' => 'DNS授权规则的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。'."\n",
'type' => 'string',
'example' => 'Created',
],
'DNSServiceRuleName' => [
'description' => 'DNS授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'example' => 'test',
],
'DNSServiceRuleDescription' => [
'description' => 'DNS授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'example' => 'description',
],
'DNSServiceRuleId' => [
'description' => 'DNS授权规则ID。',
'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' => '查询DNS授权规则',
],
'DeleteDNSServiceRule' => [
'summary' => '删除DNS授权规则。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'DNSServiceRuleId',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'ar-r56ijpurlu50gi****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会删除DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接删除DNS授权规则。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则所在的地域ID。'."\n"
."\n"
.'> 目前,支持开通云连接器的地域:华东1(杭州)、华东2(上海)、华北1(青岛)、华北2(北京)、华北5(呼和浩特)、华北6(乌兰察布)、华南1(深圳)、华南3(广州)、西南1(成都)、德国(法兰克福)。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除DNS授权规则',
],
'MoveAuthorizationRuleToDNSService' => [
'summary' => '将授权规则转移到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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-1y6h8z7imd2yu4****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'ar-la6sn6gng90e1x****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会转移授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行转移。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'> 目前,支持开通云连接器的地域:华东1(杭州)、华东2(上海)、华北1(青岛)、华北2(北京)、华北5(呼和浩特)、华北6(乌兰察布)、华南1(深圳)、华南3(广州)、西南1(成都)、德国(法兰克福)。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '授权规则转移到DNS授权规则',
'description' => '> 只允许将授权规则中访问目标类型为**Cidr**且目的地址为DNS IP的规则转移到DNS授权规则中,您可以通过调用[ListAuthorizationRules](~~298298~~)接口查看实例组授权规则的访问目标类型和目的地址。',
],
'CreateGroupDNSServiceRule' => [
'summary' => '实例组创建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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'DNSServiceRuleDescription',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '源DNS授权规则IP地址。包括但不限于以下取值:'."\n"
."\n"
.'**100.100.2.136**,**100.100.2.137**,**100.100.2.138**,**114.114.114.114**,**8.8.8.8**,**8.8.4.4**,**223.5.5.5**,**223.6.6.6**,**221.5.88.88**,**116.116.116.116**,**221.228.15.26**,**61.139.2.69**,**218.6.200.139**,**119.29.29.29**,**218.2.2.2**,**208.67.220.220**,**208.67.222.222**,**218.4.4.4**。'."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today),并在工单中附上需要申请的DNS授权规则的IP。'."\n"
.''."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex),并在工单中附上需要申请的DNS授权规则的IP。'."\n",
'type' => 'string',
'required' => true,
'example' => '100.100.2.136',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则的目标类型。取值:'."\n"
."\n"
.'- **Normal**:表示目标类型为DNS普通类型。'."\n"
."\n"
.'- **DNSRedirect**:表示目标类型为DNS重定向类型。',
'type' => 'string',
'required' => true,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '目标DNS授权规则IP地址。'."\n"
."\n"
.'> 当**ServiceType**参数取值为**DNSRedirect**时,该参数必选。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会创建DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行创建。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '云连接器实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8',
],
'DNSServiceRuleId' => [
'description' => 'DNS授权规则ID。',
'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' => '实例组创建DNS授权规则',
],
'UpdateGroupDNSServiceRuleAttribute' => [
'summary' => '修改实例组的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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'DNSServiceRuleDescription',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'DNSServiceRuleId',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'gar-ffnn1ewe2nmf3y****',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '源DNS授权规则IP地址。包括但不限于以下取值:'."\n"
."\n"
.'**100.100.2.136**,**100.100.2.137**,**100.100.2.138**,**114.114.114.114**,**8.8.8.8**,**8.8.4.4**,**223.5.5.5**,**223.6.6.6**,**221.5.88.88**,**116.116.116.116**,**221.228.15.26**,**61.139.2.69**,**218.6.200.139**,**119.29.29.29**,**218.2.2.2**,**208.67.220.220**,**208.67.222.222**,**218.4.4.4**。'."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today),并在工单中附上需要申请的DNS授权规则的IP。'."\n"
.''."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex),并在工单中附上需要申请的DNS授权规则的IP。'."\n",
'type' => 'string',
'required' => false,
'example' => '100.100.2.136',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则的目标类型。取值:'."\n"
."\n"
.'- **Normal**:表示目标类型为DNS普通类型。'."\n"
."\n"
.'- **DNSRedirect**:表示目标类型为DNS重定向类型。',
'type' => 'string',
'required' => false,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '目标DNS授权规则IP地址。'."\n"
."\n"
.'> 当**ServiceType**参数取值为**DNSRedirect**时,该参数必选。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会修改DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行修改。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '改实例组的DNS授权规则',
],
'ListGroupDNSServiceRules' => [
'summary' => '查询实例组的DNS授权规则。',
'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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'DNSServiceRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'DNS授权规则ID。',
'type' => 'array',
'items' => [
'description' => 'DNS授权规则ID。最多支持输入20个规则ID。',
'type' => 'string',
'required' => false,
'example' => 'gar-ffnn1ewe2nmf3y****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则的目标类型。取值:'."\n"
."\n"
.'- **Normal**:表示目标类型为DNS普通类型。'."\n"
."\n"
.'- **DNSRedirect**:表示目标类型为DNS重定向类型。',
'type' => 'string',
'required' => false,
'example' => 'Normal',
],
],
[
'name' => 'Destination',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '目标DNS授权规则IP地址。',
'type' => 'array',
'items' => [
'description' => '目标DNS授权规则IP地址。最多支持输入20个目标IP地址。'."\n"
."\n"
.'> 当**ServiceType**参数取值为**DNSRedirect**时,该参数必选。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.2',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'Source',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '源DNS授权规则IP地址。',
'type' => 'array',
'items' => [
'description' => '源DNS授权规则IP地址。最多支持输入20个源IP地址。包括但不限于以下取值:'."\n"
."\n"
.'**100.100.2.136**,**100.100.2.137**,**100.100.2.138**,**114.114.114.114**,**8.8.8.8**,**8.8.4.4**,**223.5.5.5**,**223.6.6.6**,**221.5.88.88**,**116.116.116.116**,**221.228.15.26**,**61.139.2.69**,**218.6.200.139**,**119.29.29.29**,**218.2.2.2**,**208.67.220.220**,**208.67.222.222**,**218.4.4.4**。'."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today),并在工单中附上需要申请的DNS授权规则的IP。'."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex),并在工单中附上需要申请的DNS授权规则的IP。'."\n",
'type' => 'string',
'required' => false,
'example' => '100.100.2.136',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DNSServiceRuleStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'DNS授权规则的状态。',
'type' => 'array',
'items' => [
'description' => 'DNS授权规则的状态。最多支持输入20个DNS授权规则状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DNSServiceRuleName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'DNS授权规则名称。最多支持输入20个规则名称。',
'type' => 'array',
'items' => [
'description' => 'DNS授权规则名称。最多支持输入20个规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的NextToken值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值:**1~50**。默认值:**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8',
],
'TotalCount' => [
'description' => '总列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'DNSServiceRules' => [
'description' => 'DNS授权规则列表。',
'type' => 'array',
'items' => [
'description' => 'DNS授权规则列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '云连接器实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'DNSServiceRuleStatus' => [
'description' => 'DNS授权规则的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'example' => 'Created',
],
'Source' => [
'description' => '源DNS授权规则IP地址。包括但不限于以下取值:'."\n"
."\n"
.'**100.100.2.136**,**100.100.2.137**,**100.100.2.138**,**114.114.114.114**,**8.8.8.8**,**8.8.4.4**,**223.5.5.5**,**223.6.6.6**,**221.5.88.88**,**116.116.116.116**,**221.228.15.26**,**61.139.2.69**,**218.6.200.139**,**119.29.29.29**,**218.2.2.2**,**208.67.220.220**,**208.67.222.222**,**218.4.4.4**。'."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today),并在工单中附上需要申请的DNS授权规则的IP。'."\n"
.''."\n"
."\n"
.'除以上默认的DNS授权规则的IP,如有其他DNS授权规则的IP诉求,请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex),并在工单中附上需要申请的DNS授权规则的IP。'."\n",
'type' => 'string',
'example' => '100.100.2.136',
],
'ServiceType' => [
'description' => 'DNS授权规则的目标类型。取值:'."\n"
."\n"
.'- **Normal**:表示目标类型为DNS普通类型。'."\n"
."\n"
.'- **DNSRedirect**:表示目标类型为DNS重定向类型。',
'type' => 'string',
'example' => 'Normal',
],
'Destination' => [
'description' => '目标DNS授权规则IP地址。'."\n"
."\n"
.'> 当**ServiceType**参数取值为**DNSRedirect**时,该参数必选。',
'type' => 'string',
'example' => '192.168.0.2',
],
'DNSServiceRuleName' => [
'description' => 'DNS授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'example' => 'test',
],
'DNSServiceRuleDescription' => [
'description' => 'DNS授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'example' => 'description',
],
'DNSServiceRuleId' => [
'description' => 'DNS授权规则ID。',
'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' => '查询实例组的DNS授权规则',
],
'MoveGroupAuthorizationRuleToDNSService' => [
'summary' => '将实例组的授权规则转移到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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => [
'description' => '授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'gar-ez91t41jvi6tr8****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会转移授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行转移。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例组所在的地域ID。'."\n"
."\n"
.'> 目前,支持开通云连接器的地域:华东1(杭州)、华东2(上海)、华北1(青岛)、华北2(北京)、华北5(呼和浩特)、华北6(乌兰察布)、华南1(深圳)、华南3(广州)、西南1(成都)、德国(法兰克福)。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '实例组规则转移到DNS授权规则',
'description' => '> 只允许将授权规则中访问目标类型为**Cidr**且目的地址为DNS IP的规则转移到DNS授权规则中,您可以通过调用[ListGroupAuthorizationRules](~~402441~~)接口查看实例组授权规则的访问目标类型和目的地址。',
],
'DeleteGroupDNSServiceRule' => [
'summary' => '删除实例组的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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'DNSServiceRuleId',
'in' => 'query',
'schema' => [
'description' => 'DNS授权规则ID。',
'type' => 'string',
'required' => true,
'example' => 'gar-ffnn1ewe2nmf3y****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会删除DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行删除。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例组所在的地域ID。'."\n"
."\n"
.'> 目前,支持开通云连接器的地域:华东1(杭州)、华东2(上海)、华北1(青岛)、华北2(北京)、华北5(呼和浩特)、华北6(乌兰察布)、华南1(深圳)、华南3(广州)、西南1(成都)、德国(法兰克福)。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除实例组的DNS授权规则',
],
'EnableIoTCloudConnectorAccessLog' => [
'summary' => '指定云连接器开启访问日志功能。',
'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' => '云连接器实例ID。',
'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' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会开启访问日志的功能。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接开启访问日志的功能。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => [
'summary' => '关闭访问日志功能。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会关闭访问日志功能。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接关闭访问日志功能。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '关闭访问日志功能',
],
'GetIoTCloudConnectorAccessLog' => [
'summary' => '获取指定云连接器访问日志状态信息。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会获取访问日志状态信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接获取访问日志状态信息。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'AccessLogSlsProject' => [
'description' => '访问日志投递的日志项目。',
'type' => 'string',
'example' => 'sls-setter',
],
'AccessLogSlsLogStore' => [
'description' => '访问日志投递的日志库。',
'type' => 'string',
'example' => 'test',
],
'AccessLogStatus' => [
'description' => '访问日志的状态,取值:'."\n"
.'- **Opening**:开启中。'."\n"
.'- **Opened**:已开启。'."\n"
.'- **Closed**:已关闭。'."\n"
.'- **Closing**:关闭中。',
'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' => '获取指定云连接器访问日志',
],
'CreateService' => [
'summary' => '创建分应用统计服务。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => '分应用统计服务的名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'service_name',
],
],
[
'name' => 'ServiceDescription',
'in' => 'query',
'schema' => [
'description' => '分应用统计服务的描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'service_description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会创建服务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接创建服务。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '分应用统计服务所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'ServiceId' => [
'description' => '系统为分应用统计服务生成的ID,全网唯一。',
'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' => '创建分应用统计服务',
],
'UpdateServiceAttribute' => [
'summary' => '修改分应用统计服务。',
'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' => '系统为分应用统计服务生成的ID,全网唯一。',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => '分应用统计服务的名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'service_name',
],
],
[
'name' => 'ServiceDescription',
'in' => 'query',
'schema' => [
'description' => '分应用统计服务的描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'service_description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会修改服务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接修改服务。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '分应用统计服务所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '修改分应用统计服务',
],
'ListService' => [
'summary' => '查询分应用统计服务。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '分应用统计服务ID列表。',
'type' => 'array',
'items' => [
'description' => '系统为分应用统计服务生成的ID,全网唯一。最多支持输入20个服务ID。',
'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' => '分应用统计服务名称,最多支持输入20个服务名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'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' => '服务资源的状态,最多支持输入20个服务资源。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:已创建。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1**~**100**。默认值:**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '分应用统计服务所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'TotalCount' => [
'description' => '总列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'NextToken FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'Services' => [
'description' => '服务列表。',
'type' => 'array',
'items' => [
'description' => '服务列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'ServiceId' => [
'description' => '系统为分应用统计服务生成的ID,全网唯一。',
'type' => 'string',
'example' => 'c910061f-****-44e6-b659-***c',
],
'ServiceStatus' => [
'description' => '服务资源的状态。取值:'."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:已创建。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'example' => 'Created',
],
'ServiceName' => [
'description' => '分应用统计服务的名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'example' => 'service_name',
],
'ServiceDescription' => [
'description' => '分应用统计服务的描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'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' => '查询分应用统计服务',
],
'DeleteService' => [
'summary' => '删除分应用统计服务。',
'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' => '系统为分应用统计服务生成的ID,全网唯一。',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会删除服务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接删除服务。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '分应用统计服务所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除分应用统计服务',
],
'CreateServiceEntry' => [
'summary' => '分应用统计服务列表中添加应用条目。',
'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' => '系统为分应用统计服务生成的ID,全网唯一。',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'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' => '应用条目的目的地址类型。取值:'."\n"
."\n"
.'- **Cidr**:CIDR地址块。'."\n"
."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => true,
'example' => 'Cidr',
],
],
[
'name' => 'ServiceEntryName',
'in' => 'query',
'schema' => [
'description' => '应用条目的名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'entry_name',
],
],
[
'name' => 'ServiceEntryDescription',
'in' => 'query',
'schema' => [
'description' => '应用条目的描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'entry_description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会添加应用条目。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接添加应用条目。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '应用条目所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'ServiceEntryId' => [
'description' => '应用条目的ID。',
'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' => '分应用功能列表中添加应用条目',
],
'UpdateServiceEntryAttribute' => [
'summary' => '修改分应用统计服务列表中的应用条目。',
'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' => '系统为分应用统计服务生成的ID,全网唯一。',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceEntryId',
'in' => 'query',
'schema' => [
'description' => '应用条目的ID。',
'type' => 'string',
'required' => true,
'example' => 'fwd-119smw5tkasdf****',
],
],
[
'name' => 'ServiceEntryName',
'in' => 'query',
'schema' => [
'description' => '应用条目的名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'entry_name',
],
],
[
'name' => 'ServiceEntryDescription',
'in' => 'query',
'schema' => [
'description' => '应用条目的描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'required' => false,
'example' => 'entry_description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会修改应用条目。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接修改应用条目。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '应用条目所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '修改分应用统计列表的应用条目',
],
'ListServiceEntries' => [
'summary' => '查询分应用统计条目。',
'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' => '系统为分应用统计服务生成的ID,全网唯一。',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'Target',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '应用条目的目的地址。',
'type' => 'array',
'items' => [
'description' => '应用条目的目的地址。最多支持输入20个目的地址。',
'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' => '应用条目的目的地址类型,最多支持输入20个目的地址类型。取值:'."\n"
."\n"
.'- **Cidr**:CIDR地址块。'."\n"
."\n"
.'- **Domain**:域名。',
'type' => 'string',
'required' => false,
'example' => 'Cidr',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceEntryStatus',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '应用条目的状态。',
'type' => 'array',
'items' => [
'description' => '应用条目的状态。最多支持输入20个应用条目状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:已创建。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'ServiceEntryName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '应用条目的名称。',
'type' => 'array',
'items' => [
'description' => '应用条目的名称。最多支持输入20个应用条目名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'entry_name',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1~100**。默认值:**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '应用条目所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ServiceEntryIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '应用条目的ID。',
'type' => 'array',
'items' => [
'description' => '应用条目的ID。最多支持输入20个应用条目ID。',
'type' => 'string',
'required' => false,
'example' => 'fwd-119smw5tkasdf****',
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'TotalCount' => [
'description' => '总列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'ServiceEntries' => [
'description' => '应用条目列表。',
'type' => 'array',
'items' => [
'description' => '应用条目列表。',
'type' => 'object',
'properties' => [
'ServiceId' => [
'description' => '系统为分应用统计服务生成的ID,全网唯一。',
'type' => 'string',
'example' => 'c910061f-****-44e6-b659-***c',
],
'ServiceEntryStatus' => [
'description' => '应用条目的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:已创建。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Updating**:更新中。',
'type' => 'string',
'example' => 'Created',
],
'Target' => [
'description' => '应用条目的目的地址。',
'type' => 'string',
'example' => '192.168.1.32/27',
],
'TargetType' => [
'description' => '应用条目的目的地址类型。取值:'."\n"
."\n"
.'- **Cidr**:CIDR地址块。'."\n"
."\n"
.'- **Domain**:域名。',
'type' => 'string',
'example' => 'Cidr',
],
'ServiceEntryName' => [
'description' => '应用条目的名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'example' => 'entry_name',
],
'ServiceEntryDescription' => [
'description' => '应用条目的描述。'."\n"
."\n"
.'长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为`http://`或`https://`。',
'type' => 'string',
'example' => 'entry_description',
],
'ServiceEntryId' => [
'description' => '应用条目的ID。',
'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' => '查询分应用统计条目',
],
'DeleteServiceEntry' => [
'summary' => '删除分应用统计条目。',
'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' => '系统为分应用统计服务生成的ID,全网唯一。',
'type' => 'string',
'required' => true,
'example' => 'c910061f-****-44e6-b659-***c',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ServiceEntryId',
'in' => 'query',
'schema' => [
'description' => '应用条目的ID。',
'type' => 'string',
'required' => true,
'example' => 'fwd-119smw5tkasdf****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会删除应用条目。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接删除应用条目。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '应用条目所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除分应用统计条目',
],
'SubmitDiagnoseTaskForSingleCard' => [
'summary' => '提交单卡诊断任务。',
'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' => '发起单张物联网卡网络诊断的实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-smy9a5ockzp08n****',
],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => '网络诊断的源类型。取值:'."\n"
."\n"
.'- **卡IP**:表示通过物联网卡的卡IP进行网络诊断。'."\n"
."\n"
.'- **卡ID**:表示通过物联网卡的卡ID进行网络诊断。',
'type' => 'string',
'required' => true,
'example' => '卡IP',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '网络诊断的源端卡IP或者卡ID。',
'type' => 'string',
'required' => true,
'example' => '169.254.XX.XX',
],
],
[
'name' => 'DestinationType',
'in' => 'query',
'schema' => [
'description' => '网路诊断的目的类型。取值:'."\n"
."\n"
.'- **IP**:表示诊断的目的类型是IP类型。'."\n"
."\n"
.'- **域名**:表示诊断的目的类型是域名类型。'."\n",
'type' => 'string',
'required' => false,
'example' => 'IP',
],
],
[
'name' => 'Destination',
'in' => 'query',
'schema' => [
'description' => '网络诊断的目的IP或者域名。',
'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' => '网络诊断所在的地域ID。'."\n"
."\n\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceUid',
'in' => 'query',
'schema' => [
'description' => '云连接器实例使用者的阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '253460731706911258',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'DiagnoseTaskId' => [
'description' => '网络诊断任务ID。',
'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' => '提交单卡诊断任务',
],
'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' => '网络诊断任务ID。',
'type' => 'string',
'required' => true,
'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '网络诊断的云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'IoTCloudConnectorId' => [
'description' => '网络诊断的云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-smy9a5ockzp08n****',
],
'CardIp' => [
'description' => '网络诊断的源端卡的IP地址。',
'type' => 'string',
'example' => '169.254.XX.XX',
],
'IccId' => [
'description' => '网络诊断的源端卡的ID。',
'type' => 'string',
'example' => '89860477*******27546',
],
'Destination' => [
'description' => '网络诊断的目的IP或者域名。',
'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' => '网络诊断任务的状态。取值:'."\n"
."\n"
.'- **success**:表示诊断成功。'."\n"
."\n"
.'- **failed**:表示诊断失败。'."\n"
."\n"
.'- **diagnosing**:表示诊断中。',
'type' => 'string',
'example' => 'failed',
],
'ErrorResult' => [
'description' => '诊断结果列表。',
'type' => 'array',
'items' => [
'description' => '诊断结果列表。',
'type' => 'object',
'properties' => [
'ErrorLevel' => [
'description' => '诊断问题的级别。取值:'."\n"
."\n"
.'- **Error**:表示错误。'."\n"
."\n"
.'- **Warning**:表示警告。',
'type' => 'string',
'example' => 'Warning',
],
'ErrorPart' => [
'description' => '诊断问题的组件。取值:'."\n"
."\n"
.'- **CCIOT**:表示诊断的问题为云连接器的问题。'."\n"
."\n"
.'- **Card**:表示诊断的问题为物联网卡的问题。'."\n"
."\n"
.'- **Terminal**:表示诊断的问题为终端的问题。'."\n"
."\n"
.'- **Server**:表示诊断的问题为服务器的问题。'."\n"
."\n"
.'- **Apn**:表示诊断的问题为APN的问题。',
'type' => 'string',
'example' => 'Terminal',
],
'ErrorDesc' => [
'description' => '诊断问题的原因。',
'type' => 'string',
'example' => 'Terminal abnormal',
],
'ErrorSuggestion' => [
'description' => '诊断问题的解决建议。',
'type' => 'string',
'example' => 'Please check whether the terminal and card are compatible or whether the terminal can send messages',
],
],
],
],
'DiagnoseItem' => [
'description' => '诊断项信息列表。',
'type' => 'array',
'items' => [
'description' => '诊断项信息列表。',
'type' => 'object',
'properties' => [
'Part' => [
'description' => '诊断的部件名称。取值:'."\n"
.'- **CCIOT**:云连接器。'."\n"
."\n"
.'- **Card**:物联网卡。'."\n"
."\n"
.'- **Terminal**:终端。'."\n"
."\n"
.'- **Server**:服务器。'."\n"
."\n"
.'- **Apn**:APN。',
'type' => 'string',
'example' => 'Terminal',
],
'Status' => [
'description' => '诊断部件的状态。取值:'."\n"
."\n"
.'- **Normal**:表示诊断状态正常。'."\n"
."\n"
.'- **Wrong**:表示诊断状态错误。'."\n"
."\n"
.'- **Unknown**:表示诊断状态未知。',
'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' => '获取单卡诊断结果',
],
'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' => '网络诊断的云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => false,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'IoTCloudConnectorId',
'in' => 'query',
'schema' => [
'description' => '网络诊断的云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-smy9a5ockzp08n****',
],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => '网络诊断的源类型。取值:'."\n"
."\n"
.'- **卡IP**:表示通过物联网卡的卡IP进行网络诊断。'."\n"
."\n"
.'- **卡ID**:表示通过物联网卡的卡ID进行网络诊断。',
'type' => 'string',
'required' => false,
'example' => '卡IP',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '网络诊断的源端卡IP或者卡ID。'."\n",
'type' => 'string',
'required' => false,
'example' => '169.254.XX.XX',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1~100**。默认值:**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'DiagnoseInfo' => [
'description' => '诊断结果列表。',
'type' => 'array',
'items' => [
'description' => '诊断结果列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '网络诊断的云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-smy9a5ockzp08n****',
],
'CardIp' => [
'description' => '网络诊断的源端卡的IP地址。',
'type' => 'string',
'example' => '169.254.XX.XX',
],
'IccId' => [
'description' => '网络诊断的源端卡的ID。',
'type' => 'string',
'example' => '89860477*******27546',
],
'SourceType' => [
'description' => '网络诊断的源类型。取值:'."\n"
."\n"
.'- **卡IP**:表示通过物联网卡的卡IP进行网络诊断。'."\n"
."\n"
.'- **卡ID**:表示通过物联网卡的卡ID进行网络诊断。',
'type' => 'string',
'example' => '卡IP',
],
'Source' => [
'description' => '网络诊断的源端卡IP或者卡ID。',
'type' => 'string',
'example' => '169.254.XX.XX',
],
'DestinationType' => [
'description' => '网路诊断的目的类型。取值:'."\n"
."\n"
.'- **IP**:表示诊断的目的类型是IP类型。'."\n"
."\n"
.'- **域名**:表示诊断的目的类型是域名类型。',
'type' => 'string',
'example' => 'IP',
],
'Destination' => [
'description' => '网络诊断的目的IP或者域名。',
'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' => '诊断任务的状态。取值:'."\n"
."\n"
.'- **completed**:已完成。'."\n"
."\n"
.'- **diagnosing**:诊断中。',
'type' => 'string',
'example' => 'completed',
],
'DiagnoseTime' => [
'description' => '诊断任务入库的时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1649669904',
],
'TaskId' => [
'description' => '网络诊断任务ID。',
'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' => '查询单卡诊断的诊断结果信息',
],
'CreateIoTCloudConnectorBackhaulRoute' => [
'summary' => '调用CreateIoTCloudConnectorBackhaulRoute接口创建当前云连接器实例绑定VPC后的回程路由。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会创建当前云连接器实例绑定VPC后的回程路由。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并创建云连接器实例绑定VPC后的回程路由。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '云连接器实例ID。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'RequestId' => [
'description' => '请求ID。',
'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' => '创建当前云连接器实例绑定VPC后的回程路由',
],
'ListIoTCoudConnectorBackhaulRoute' => [
'summary' => '调用ListIoTCoudConnectorBackhaulRoute接口查询当前云连接器实例绑定VPC后的回程路由。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1**~**100**,默认值:**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '列表条目数。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '请求ID。',
'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' => '下一跳的实例ID。',
'type' => 'string',
'example' => 'eni-bp1d66qjxb3qoin3****',
],
'NextHopType' => [
'description' => '下一跳类型。取值: **NetworkInterface**,表示下一跳类型为弹性网卡。'."\n"
."\n\n"
."\n",
'type' => 'string',
'example' => 'NetworkInterface',
],
'Status' => [
'description' => '路由条目在云连接器中的发布状态。取值:'."\n"
."\n"
.'- **Published**:已发布。'."\n"
."\n"
.'- **Publishing**:发布中。'."\n"
."\n"
.'- **Unpublished**:已解除发布。'."\n"
."\n"
.'- **Unpublishing**:解除发布中。'."\n"
."\n"
.'- **Init**:未发布。'."\n"
."\n"
.'- **Deleting**:删除中。',
'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' => '查询当前云连接器实例绑定VPC后的回程路由',
],
'DeleteIoTCloudConnetorBackhaulRoute' => [
'summary' => '调用DeleteIoTCloudConnetorBackhaulRoute接口删除当前云连接器实例绑定VPC后的回程路由。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会删除当前云连接器实例绑定VPC后的回程路由。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接删除云连接器实例绑定VPC后的回程路由。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除当前云连接器实例绑定VPC后的回程路由',
],
'CreateIpMappingRule' => [
'summary' => '调用CreateIpMappingRule接口创建授权规则IP的重定向功能。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'DestinationIp',
'in' => 'query',
'schema' => [
'description' => '重定向的目标IP地址。',
'type' => 'string',
'required' => true,
'example' => '192.168.10.8',
],
],
[
'name' => 'MappingIp',
'in' => 'query',
'schema' => [
'description' => '需要进行重定向的IP地址。',
'type' => 'string',
'required' => true,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'IpMappingRuleName',
'in' => 'query',
'schema' => [
'description' => '需要进行IP重定向的授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'name',
],
],
[
'name' => 'IpMappingRuleDescription',
'in' => 'query',
'schema' => [
'description' => '需要进行IP重定向的授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http:// `或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会创建授权规则IP重定向功能。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'IpMappingRuleId' => [
'description' => '需要进行IP重定向的授权规则的ID。',
'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' => '创建授权规则IP的重定向功能',
],
'UpdateIpMappingRule' => [
'summary' => '调用UpdateIpMappingRule接口修改授权规则IP重定向的相关信息。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'IpMappingRuleId',
'in' => 'query',
'schema' => [
'description' => '需要进行重定向的授权规则的ID。',
'type' => 'string',
'required' => true,
'example' => 'im-irrp3bzuu5nrbx****',
],
],
[
'name' => 'DestinationIp',
'in' => 'query',
'schema' => [
'description' => '重定向的目标IP地址。',
'type' => 'string',
'required' => false,
'example' => '192.168.10.8',
],
],
[
'name' => 'MappingIp',
'in' => 'query',
'schema' => [
'description' => '需要进行重定向的IP地址。',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'IpMappingRuleName',
'in' => 'query',
'schema' => [
'description' => '需要进行IP重定向的授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'name',
],
],
[
'name' => 'IpMappingRuleDescription',
'in' => 'query',
'schema' => [
'description' => '需要进行IP重定向的授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http://` 或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会修改授权规则IP重定向的相关信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '修改授权规则IP重定向的相关信息',
],
'ListIpMappingRules' => [
'summary' => '调用ListIpMappingRules接口查询授权规则IP重定向信息。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'IpMappingRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要进行IP重定向的授权规则的ID。',
'type' => 'array',
'items' => [
'description' => '需要进行IP重定向的授权规则的ID。最多支持20个授权规则ID。',
'type' => 'string',
'required' => false,
'example' => 'im-irrp3bzuu5nrbx****',
],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'MappingIps',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要进行重定向的IP地址。',
'type' => 'array',
'items' => [
'description' => '需要进行重定向的IP地址。最多支持20个重定向的IP地址。',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IpMappingRuleStatuses',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则IP重定向的状态。最多支持20个授权规则IP重定向的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Updating**:更新中。'."\n"
."\n"
.'- **Associating**:IP绑定中。'."\n"
."\n"
.'- **Dissociating**:IP解绑中。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'array',
'items' => [
'description' => '授权规则IP重定向的状态。最多支持20个授权规则IP重定向的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Updating**:更新中。'."\n"
."\n"
.'- **Associating**:IP绑定中。'."\n"
."\n"
.'- **Dissociating**:IP解绑中。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IpMappingRuleNames',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要进行IP重定向的授权规则名称。',
'type' => 'array',
'items' => [
'description' => '需要进行IP重定向的授权规则名称。最多支持20个授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'name',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationIps',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '重定向的目标IP地址。',
'type' => 'array',
'items' => [
'description' => '重定向的目标IP地址。最多支持20个目标IP地址。',
'type' => 'string',
'required' => false,
'example' => '192.168.10.8',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
.'- 如果有下一次查询,取值为上一次API调用返回的**NextToken**值。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1**~**100**,默认值为**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'IpMappingRules' => [
'description' => '授权规则IP重定向列表。',
'type' => 'array',
'items' => [
'description' => '授权规则IP重定向列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorId' => [
'description' => '云连接器实例ID。',
'type' => 'string',
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
'IpMappingRuleId' => [
'description' => '需要进行IP重定向的授权规则的ID。',
'type' => 'string',
'example' => 'im-irrp3bzuu5nrbx****',
],
'IpMappingRuleStatus' => [
'description' => '授权规则IP重定向的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
."\n"
.'- **Created**:创建完成。'."\n"
."\n"
.'- **Updating**:更新中。'."\n"
."\n"
.'- **Associating**:IP绑定中。'."\n"
."\n"
.'- **Dissociating**:IP解绑中。'."\n"
."\n"
.'- **Deleting**:删除中。'."\n"
."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Created',
],
'MappingIp' => [
'description' => '需要进行重定向的IP地址。',
'type' => 'string',
'example' => '47.0.XX.XX',
],
'DestinationIp' => [
'description' => '重定向的目标IP地址。',
'type' => 'string',
'example' => '192.168.10.8',
],
'IpMappingRuleName' => [
'description' => '需要进行IP重定向的授权规则名称。',
'type' => 'string',
'example' => 'name',
],
'IpMappingRuleDescription' => [
'description' => '需要进行IP重定向的授权规则描述。',
'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' => '查询授权规则IP重定向信息',
],
'DeleteIpMappingRule' => [
'summary' => '调用DeleteIpMappingRule接口删除授权规则IP重定向信息。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'IpMappingRuleId',
'in' => 'query',
'schema' => [
'description' => '待删除的IP重定向的授权规则的ID。',
'type' => 'string',
'required' => true,
'example' => 'im-irrp3bzuu5nrbx****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会删除授权规则IP重定向信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除授权规则IP重定向信息',
],
'CreateGroupIpMappingRule' => [
'summary' => '调用CreateGroupIpMappingRule接口创建实例组授权规则IP的重定向规则。',
'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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'IpMappingRuleDescription',
'in' => 'query',
'schema' => [
'description' => '需要进行实例组IP重定向的授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http:// `或`https://`开头。'."\n",
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'IpMappingRuleName',
'in' => 'query',
'schema' => [
'description' => '需要进行实例组IP重定向的授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'name',
],
],
[
'name' => 'DestinationIp',
'in' => 'query',
'schema' => [
'description' => '重定向的目标IP地址。',
'type' => 'string',
'required' => true,
'example' => '192.168.10.8',
],
],
[
'name' => 'MappingIp',
'in' => 'query',
'schema' => [
'description' => '需要进行重定向的IP地址。',
'type' => 'string',
'required' => true,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会创建实例组授权规则IP的重定向功能。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'GroupIpMappingRuleId' => [
'description' => '需要进行IP重定向的授权规则的ID。',
'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' => '创建实例组授权规则IP的重定向规则',
],
'UpdateGroupIpMappingRule' => [
'summary' => '调用UpdateGroupIpMappingRule接口修改实例组授权规则IP重定向的相关信息。',
'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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'IpMappingRuleDescription',
'in' => 'query',
'schema' => [
'description' => '需要进行实例组IP重定向的授权规则描述。'."\n"
."\n"
.'长度为2~256个字符,必须以字母或中文开头,但不能以`http:// `或`https://`开头。',
'type' => 'string',
'required' => false,
'example' => 'description',
],
],
[
'name' => 'IpMappingRuleName',
'in' => 'query',
'schema' => [
'description' => '需要进行实例组IP重定向的授权规则名称。'."\n"
."\n"
.'名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'name',
],
],
[
'name' => 'GroupIpMappingRuleId',
'in' => 'query',
'schema' => [
'description' => '需要进行重定向的授权规则的ID。',
'type' => 'string',
'required' => true,
'example' => 'im-irrp3bzuu5nrbx****',
],
],
[
'name' => 'MappingIp',
'in' => 'query',
'schema' => [
'description' => '需要进行重定向的IP地址。',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
],
[
'name' => 'DestinationIp',
'in' => 'query',
'schema' => [
'description' => '访问目标IP地址。',
'type' => 'string',
'required' => false,
'example' => '192.168.10.8',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会修改实例组授权规则IP重定向的相关信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '云连接器实例组ID。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '云连接器实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'AuthorizationRuleId' => [
'description' => '授权规则ID。',
'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' => '修改实例组授权规则IP重定向的相关信',
],
'ListGroupIpMappingRules' => [
'summary' => '调用ListGroupIpMappingRules接口查询实例组授权规则IP重定向信息。',
'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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'IpMappingRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要进行IP重定向的授权规则的ID。最多支持20个授权规则ID。',
'type' => 'array',
'items' => [
'description' => '需要进行IP重定向的授权规则的ID。最多支持20个授权规则ID。',
'type' => 'string',
'required' => false,
'example' => 'im-irrp3bzuu5nrbx****',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DestinationIps',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '重定向的目标IP地址。最多支持20个目标IP地址。',
'type' => 'array',
'items' => [
'description' => '重定向的目标IP地址。最多支持20个目标IP地址。',
'type' => 'string',
'required' => false,
'example' => '192.168.10.8',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IpMappingRuleStatuses',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则IP重定向的状态。最多支持20个授权规则IP重定向的状态。',
'type' => 'array',
'items' => [
'description' => '授权规则IP重定向的状态。最多支持20个授权规则IP重定向的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:创建完成。'."\n"
.'- **Updating**:更新中。'."\n"
.'- **Associating**:IP绑定中。'."\n"
.'- **Dissociating**:IP解绑中。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'required' => false,
'example' => 'Created',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'IpMappingRuleNames',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要进行IP重定向的授权规则名称。最多支持20个授权规则名称。',
'type' => 'array',
'items' => [
'description' => '需要进行IP重定向的授权规则名称。最多支持20个授权规则名称。'."\n"
."\n"
.'长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'Name',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'required' => false,
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1**~**100**,默认值为**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'MappingIps',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要进行重定向的IP地址。最多支持20个重定向的IP地址。',
'type' => 'array',
'items' => [
'description' => '需要进行重定向的IP地址。最多支持20个重定向的IP地址。',
'type' => 'string',
'required' => false,
'example' => '47.0.XX.XX',
],
'required' => false,
'maxItems' => 20,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'TotalCount' => [
'description' => '列表条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '是否拥有下一次查询的令牌(Token)。取值:'."\n"
.'- 如果**NextToken**为空表示没有下一次查询。'."\n"
.'- 如果**NextToken**有返回值,该取值表示下一次查询开始的令牌。',
'type' => 'string',
'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****',
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'IpMappingRules' => [
'description' => '需要进行重定向的IP地址列表。',
'type' => 'array',
'items' => [
'description' => '需要进行重定向的IP地址列表。',
'type' => 'object',
'properties' => [
'IoTCloudConnectorGroupId' => [
'description' => '云连接器实例组ID。',
'type' => 'string',
'example' => 'iotccg-g00epppbi9di9y****',
],
'IpMappingRuleStatus' => [
'description' => '授权规则IP重定向的状态。取值:'."\n"
."\n"
.'- **Creating**:创建中。'."\n"
.'- **Created**:创建完成。'."\n"
.'- **Updating**:更新中。'."\n"
.'- **Associating**:IP绑定中。'."\n"
.'- **Dissociating**:IP解绑中。'."\n"
.'- **Deleting**:删除中。'."\n"
.'- **Deleted**:已删除。',
'type' => 'string',
'example' => 'Created',
],
'MappingIp' => [
'description' => '需要进行重定向的IP地址。',
'type' => 'string',
'example' => '47.0.XX.XX',
],
'DestinationIp' => [
'description' => '重定向的目标IP地址。',
'type' => 'string',
'example' => '192.168.10.8',
],
'IpMappingRuleName' => [
'description' => '需要进行IP重定向的授权规则名称。',
'type' => 'string',
'example' => 'name',
],
'IpMappingRuleDescription' => [
'description' => '需要进行IP重定向的授权规则描述。',
'type' => 'string',
'example' => 'description',
],
'IpMappingRuleId' => [
'description' => '需要进行IP重定向的授权规则的ID。',
'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' => '查询实例组授权规则IP重定向信息',
],
'DeleteGroupIpMappingRule' => [
'summary' => '调用DeleteGroupIpMappingRule接口删除实例组授权规则IP重定向信息。',
'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' => '云连接器实例组ID。',
'type' => 'string',
'required' => true,
'example' => 'iotccg-g00epppbi9di9y****',
],
],
[
'name' => 'GroupIpMappingRuleId',
'in' => 'query',
'schema' => [
'description' => '待删除的实例组IP重定向的授权规则的ID。',
'type' => 'string',
'required' => true,
'example' => 'im-irrp3bzuu5nrbx****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会删除实例组授权规则IP重定向信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '实例组所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n",
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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' => '删除实例组授权规则IP重定向信息',
],
'ConfirmIoTCloudConnector' => [
'summary' => '调用ConfirmIoTCloudConnector接口确认或拒绝云连接器实例过户。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会确认或拒绝云连接器实例过户。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ConfirmStatus',
'in' => 'query',
'schema' => [
'description' => '确认状态。取值:'."\n"
."\n"
.'- **Confirm**:确认。'."\n"
.'- **Refuse**:拒绝。',
'type' => 'string',
'required' => true,
'example' => 'Confirm',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45',
],
'ResourceId' => [
'description' => '云连接器实例ID。',
'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' => '确认或拒绝云连接器实例过户',
],
'RevertIoTCloudConnector' => [
'summary' => '调用RevertIoTCloudConnector接口归还已拒绝过户的云连接器实例。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求。取值:'."\n"
.'- **true**:发送检查请求,不会归还已拒绝过户的云连接器实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '云连接器实例所在的地域ID。'."\n"
."\n"
.'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数列表。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
'ResourceId' => [
'description' => '云连接器实例ID。',
'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' => '归还已拒绝过户的云连接器实例',
],
'DeleteAuthorizationRules' => [
'summary' => '批量删除授权规则。',
'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' => '云连接器实例ID。',
'type' => 'string',
'required' => true,
'example' => 'iotcc-bp1odcab8tmno0hdq****',
],
],
[
'name' => 'AuthorizationRuleIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权规则ID列表。最多支持传入200个授权规则ID。',
'type' => 'array',
'items' => [
'description' => '授权规则ID。',
'type' => 'string',
'required' => false,
'example' => 'ar-1234abcb8tmno0hdq****',
],
'required' => true,
'maxItems' => 200,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。'."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => [
'description' => '是否只预检此次请求,取值:'."\n"
.'- **true**:发送检查请求,不会更新授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码`DryRunOperation`。'."\n"
.'- **false**(默认值):发送正常请求,通过检查后直接更新授权规则。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。默认为cn-hangzhou。',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息体',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'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"}]',
'title' => '批量删除授权规则',
],
],
'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',
],
],
];