diff options
Diffstat (limited to 'data/zh_cn/iotcc/2021-05-13/api-docs.php')
| -rw-r--r-- | data/zh_cn/iotcc/2021-05-13/api-docs.php | 17959 |
1 files changed, 7872 insertions, 10087 deletions
diff --git a/data/zh_cn/iotcc/2021-05-13/api-docs.php b/data/zh_cn/iotcc/2021-05-13/api-docs.php index 483622f..d2caa06 100644 --- a/data/zh_cn/iotcc/2021-05-13/api-docs.php +++ b/data/zh_cn/iotcc/2021-05-13/api-docs.php @@ -1,242 +1,136 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'IoTCC', - 'version' => '2021-05-13', - ], + 'info' => ['style' => 'RPC', 'product' => 'IoTCC', 'version' => '2021-05-13'], 'directories' => [ [ - 'id' => 171122, - 'title' => '服务开通', + 'children' => ['OpenIoTCloudConnectorService'], 'type' => 'directory', - 'children' => [ - 'OpenIoTCloudConnectorService', - ], + 'title' => '服务开通', + 'id' => 302614, ], [ - 'id' => 181681, - 'title' => '地域', + 'children' => ['ListRegions'], 'type' => 'directory', - 'children' => [ - 'ListRegions', - ], + 'title' => '地域', + 'id' => 302663, ], [ - 'id' => 171128, - 'title' => 'APN', + 'children' => ['ListAPNs'], 'type' => 'directory', - 'children' => [ - 'ListAPNs', - ], + 'title' => 'APN', + 'id' => 302622, ], [ - 'id' => 172548, - 'title' => '云连接器', + 'children' => ['CreateIoTCloudConnector', 'UpdateIoTCloudConnectorAttribute', 'ListIoTCloudConnectors', 'ListIoTCloudConnectorAvailableZones', 'AssociateVSwitchWithIoTCloudConnector', 'DissociateVSwitchFromIoTCloudConnector', 'ListIoTCloudConnectorEIPs', 'DeleteIoTCloudConnector'], 'type' => 'directory', - 'children' => [ - 'CreateIoTCloudConnector', - 'UpdateIoTCloudConnectorAttribute', - 'ListIoTCloudConnectors', - 'ListIoTCloudConnectorAvailableZones', - 'AssociateVSwitchWithIoTCloudConnector', - 'DissociateVSwitchFromIoTCloudConnector', - 'ListIoTCloudConnectorEIPs', - 'DeleteIoTCloudConnector', - ], + 'title' => '云连接器', + 'id' => 302638, ], [ - 'id' => 171130, - 'title' => '连接池', + 'children' => ['CreateConnectionPool', 'AddCidrToConnectionPool', 'UpdateConnectionPoolAttribute', 'ListConnectionPools', 'ListConnectionPoolIps', 'GetStsInfoAndOssPath', 'AssociateIpWithConnectionPool', 'DissociateIpFromConnectionPool', 'GetConnectionPoolIpOperationResult', 'ListConnectionPoolAllIps', 'DeleteConnectionPool'], 'type' => 'directory', - 'children' => [ - 'CreateConnectionPool', - 'AddCidrToConnectionPool', - 'UpdateConnectionPoolAttribute', - 'ListConnectionPools', - 'ListConnectionPoolIps', - 'GetStsInfoAndOssPath', - 'AssociateIpWithConnectionPool', - 'DissociateIpFromConnectionPool', - 'GetConnectionPoolIpOperationResult', - 'ListConnectionPoolAllIps', - 'DeleteConnectionPool', - ], + 'title' => '连接池', + 'id' => 302624, ], [ - 'id' => 171124, - 'title' => '授权规则', + 'children' => ['CreateAuthorizationRule', 'CreateAuthorizationRules', 'UpdateAuthorizationRuleAttribute', 'ListAuthorizationRules', 'DeleteAuthorizationRule'], 'type' => 'directory', - 'children' => [ - 'CreateAuthorizationRule', - 'CreateAuthorizationRules', - 'UpdateAuthorizationRuleAttribute', - 'ListAuthorizationRules', - 'DeleteAuthorizationRule', - ], + 'title' => '授权规则', + 'id' => 302616, ], [ - 'id' => 172549, - 'title' => '实例组', + 'children' => ['CreateIoTCloudConnectorGroup', 'AddIoTCloudConnectorToGroup', 'UpdateIoTCloudConnectorGroupAttribute', 'ListIoTCloudConnectorGroups', 'RemoveIoTCloudConnectorFromGroup', 'DeleteIoTCloudConnectorGroup'], 'type' => 'directory', - 'children' => [ - 'CreateIoTCloudConnectorGroup', - 'AddIoTCloudConnectorToGroup', - 'UpdateIoTCloudConnectorGroupAttribute', - 'ListIoTCloudConnectorGroups', - 'RemoveIoTCloudConnectorFromGroup', - 'DeleteIoTCloudConnectorGroup', - ], + 'title' => '实例组', + 'id' => 302647, ], [ - 'id' => 181641, - 'title' => '实例组授权规则', + 'children' => ['CreateGroupAuthorizationRule', 'UpdateGroupAuthorizationRuleAttribute', 'ListGroupAuthorizationRules', 'DeleteGroupAuthorizationRule'], 'type' => 'directory', - 'children' => [ - 'CreateGroupAuthorizationRule', - 'UpdateGroupAuthorizationRuleAttribute', - 'ListGroupAuthorizationRules', - 'DeleteGroupAuthorizationRule', - ], + 'title' => '实例组授权规则', + 'id' => 302654, ], [ - 'id' => 181682, - 'title' => '授权VBR', + 'children' => ['GrantVirtualBorderRouter'], 'type' => 'directory', - 'children' => [ - 'GrantVirtualBorderRouter', - ], + 'title' => '授权VBR', + 'id' => 302665, ], [ - 'id' => 181683, - 'title' => 'DNS授权规则', + 'children' => ['CreateDNSServiceRule', 'UpdateDNSServiceRuleAttribute', 'ListDNSServiceRules', 'DeleteDNSServiceRule', 'MoveAuthorizationRuleToDNSService'], 'type' => 'directory', - 'children' => [ - 'CreateDNSServiceRule', - 'UpdateDNSServiceRuleAttribute', - 'ListDNSServiceRules', - 'DeleteDNSServiceRule', - 'MoveAuthorizationRuleToDNSService', - ], + 'title' => 'DNS授权规则', + 'id' => 302667, ], [ - 'id' => 181684, - 'title' => '实例组DNS授权规则', + 'children' => ['CreateGroupDNSServiceRule', 'UpdateGroupDNSServiceRuleAttribute', 'ListGroupDNSServiceRules', 'MoveGroupAuthorizationRuleToDNSService', 'DeleteGroupDNSServiceRule'], 'type' => 'directory', - 'children' => [ - 'CreateGroupDNSServiceRule', - 'UpdateGroupDNSServiceRuleAttribute', - 'ListGroupDNSServiceRules', - 'MoveGroupAuthorizationRuleToDNSService', - 'DeleteGroupDNSServiceRule', - ], + 'title' => '实例组DNS授权规则', + 'id' => 302673, ], [ - 'id' => 181685, - 'title' => '访问日志', + 'children' => ['EnableIoTCloudConnectorAccessLog', 'DisableIoTCloudConnectorAccessLog', 'GetIoTCloudConnectorAccessLog'], 'type' => 'directory', - 'children' => [ - 'EnableIoTCloudConnectorAccessLog', - 'DisableIoTCloudConnectorAccessLog', - 'GetIoTCloudConnectorAccessLog', - ], + 'title' => '访问日志', + 'id' => 302679, ], [ - 'id' => 171117, - 'title' => '分应用统计服务', + 'children' => ['CreateService', 'UpdateServiceAttribute', 'ListService', 'DeleteService'], 'type' => 'directory', - 'children' => [ - 'CreateService', - 'UpdateServiceAttribute', - 'ListService', - 'DeleteService', - ], + 'title' => '分应用统计服务', + 'id' => 302609, ], [ - 'id' => 181686, - 'title' => '应用条目', + 'children' => ['CreateServiceEntry', 'UpdateServiceEntryAttribute', 'ListServiceEntries', 'DeleteServiceEntry'], 'type' => 'directory', - 'children' => [ - 'CreateServiceEntry', - 'UpdateServiceEntryAttribute', - 'ListServiceEntries', - 'DeleteServiceEntry', - ], + 'title' => '应用条目', + 'id' => 302683, ], [ - 'id' => 181642, - 'title' => '网络诊断', + 'children' => ['SubmitDiagnoseTaskForSingleCard', 'GetDiagnoseResultForSingleCard', 'ListDiagnoseInfoForSingleCard'], 'type' => 'directory', - 'children' => [ - 'SubmitDiagnoseTaskForSingleCard', - 'GetDiagnoseResultForSingleCard', - 'ListDiagnoseInfoForSingleCard', - ], + 'title' => '网络诊断', + 'id' => 302659, ], [ - 'id' => 181687, - 'title' => '回程路由', + 'children' => ['CreateIoTCloudConnectorBackhaulRoute', 'ListIoTCoudConnectorBackhaulRoute', 'DeleteIoTCloudConnetorBackhaulRoute'], 'type' => 'directory', - 'children' => [ - 'CreateIoTCloudConnectorBackhaulRoute', - 'ListIoTCoudConnectorBackhaulRoute', - 'DeleteIoTCloudConnetorBackhaulRoute', - ], + 'title' => '回程路由', + 'id' => 302688, ], [ - 'id' => 181688, - 'title' => '授权规则IP重定向', + 'children' => ['CreateIpMappingRule', 'UpdateIpMappingRule', 'ListIpMappingRules', 'DeleteIpMappingRule'], 'type' => 'directory', - 'children' => [ - 'CreateIpMappingRule', - 'UpdateIpMappingRule', - 'ListIpMappingRules', - 'DeleteIpMappingRule', - ], + 'title' => '授权规则IP重定向', + 'id' => 302692, ], [ - 'id' => 181689, - 'title' => '实例组授权规则IP重定向', + 'children' => ['CreateGroupIpMappingRule', 'UpdateGroupIpMappingRule', 'ListGroupIpMappingRules', 'DeleteGroupIpMappingRule'], 'type' => 'directory', - 'children' => [ - 'CreateGroupIpMappingRule', - 'UpdateGroupIpMappingRule', - 'ListGroupIpMappingRules', - 'DeleteGroupIpMappingRule', - ], + 'title' => '实例组授权规则IP重定向', + 'id' => 302697, ], [ - 'id' => 181690, - 'title' => '实例过户', + 'children' => ['ConfirmIoTCloudConnector', 'RevertIoTCloudConnector'], 'type' => 'directory', - 'children' => [ - 'ConfirmIoTCloudConnector', - 'RevertIoTCloudConnector', - ], + 'title' => '实例过户', + 'id' => 302702, ], [ - 'id' => 171254, - 'title' => '其他', + 'children' => ['DeleteAuthorizationRules'], 'type' => 'directory', - 'children' => [ - 'DeleteAuthorizationRules', - ], + 'title' => '其他', + 'id' => 302636, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'OpenIoTCloudConnectorService' => [ - 'summary' => '开通云连接器服务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddCidrToConnectionPool' => [ + 'summary' => '连接池增加连接IP段，主要用于动态IP增加IP方式，区别于单个卡IP添加方式。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -248,23 +142,56 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'RegionId', + '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' => '云连接器实例所在的地域ID。'."\n" + 'description' => '连接地址池所属的CIDR地址块。', + 'type' => 'array', + 'items' => ['description' => '需要添加到连接地址池所属的CIDR地址块。最多支持20个CIDR地址块。'."\n" ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + .'多个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 => [ @@ -272,40 +199,53 @@ 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', - ], + '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.IoTCloudConnectorServiceOpened', - 'errorMessage' => 'The operation is not allowed because of iotcc service have opened.', - ], + ['errorCode' => 'IllegalParam.Cidrs', 'errorMessage' => 'The param of Cidrs is too many, only most 2 can be supported at a time.', 'description' => 'Cidrs的参数太多，一次最多只能支持2个。'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'ResourceNotFound.ConnectionPool', 'errorMessage' => 'The param of ConnectionPoolId is illegal.', 'description' => 'ConnectionPoolId参数非法'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'IllegalParam.ConnectionPoolId', 'errorMessage' => 'The param of ConnectionPoolId is illegal.', 'description' => 'ConnectionPoolId不存在'], + ['errorCode' => 'IllegalParamSize.Cidr', 'errorMessage' => 'The param size of Cidr is illegal, only support one.', 'description' => 'Cidr参数大小现在只能支持1。'], + ['errorCode' => 'IncorrectStatus.IP', 'errorMessage' => 'The status of IP is incorrect.', 'description' => 'IP状态不对，可能IP未申请或者已经绑定到别的云连接器实例。'], + ['errorCode' => 'OperationDenied.GrantedInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of granted instance not support.', 'description' => '授权实例不允许IP管理相关操作。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenIoTCloudConnectorServiceResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</OpenIoTCloudConnectorServiceResponse>","errorExample":""}]', - 'title' => '开通云连接器服务', - ], - 'ListRegions' => [ - 'summary' => '查询云连接器支持的地域列表。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<AddCidrToConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</AddCidrToConnectionPoolResponse>","errorExample":""}]', + 'title' => '连接池增加连接IP段', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCidrToConnectionPool'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:AddCidrToConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'AddIoTCloudConnectorToGroup' => [ + 'summary' => '为实例组添加云连接器实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -314,36 +254,51 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'AcceptLanguage', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '支持的语言。取值：'."\n" - .'- **zh-CN**：中文。'."\n" - .'- **en-US**：英文。'."\n" - .'- **ja**：日文。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', + '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。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例组所在的地域ID。 '."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -352,61 +307,46 @@ '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', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'ResourceAlreadyAssociated.CloudConnector', 'errorMessage' => 'The specified resource of CloudConnector is already associated.', 'description' => '云连接器已经绑定了分组。'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - '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":"<ListRegionsResponse>\\n <RequestId>79FAFC4C-6251-5C2D-818A-FD26FFFF10A5</RequestId>\\n <Regions>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>cciot.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东1（杭州）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-shanghai</RegionId>\\n <RegionEndpoint>cciot.cn-shanghai.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2（上海）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-qingdao</RegionId>\\n <RegionEndpoint>cciot.cn-qingdao.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北1（青岛）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-beijing</RegionId>\\n <RegionEndpoint>cciot.cn-beijing.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2（北京）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-huhehaote</RegionId>\\n <RegionEndpoint>cciot.cn-huhehaote.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北5（呼和浩特）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-wulanchabu</RegionId>\\n <RegionEndpoint>cciot.cn-wulanchabu.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北6（乌兰察布）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>cciot.cn-shenzhen.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1（深圳）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-guangzhou</RegionId>\\n <RegionEndpoint>cciot.cn-guangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南3（广州）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-chengdu</RegionId>\\n <RegionEndpoint>cciot.cn-chengdu.aliyuncs.com</RegionEndpoint>\\n <LocalName>西南1（成都）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>eu-central-1</RegionId>\\n <RegionEndpoint>cciot.eu-central-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>德国（法兰克福）</LocalName>\\n </Regions>\\n</ListRegionsResponse>","errorExample":""}]', - 'title' => '查询云连接器支持的地域列表', - ], - 'ListAPNs' => [ - 'summary' => '查询云连接器实例支持的APN列表。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"<AddIoTCloudConnectorToGroupResponse>\\n <RequestId>cn-hangzhou</RequestId>\\n</AddIoTCloudConnectorToGroupResponse>","errorExample":""}]', + 'title' => '添加云连接器到分组中', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddIoTCloudConnectorToGroup'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:AddIoTCloudConnectorToGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'AssociateIpWithConnectionPool' => [ + 'summary' => '绑定某个已存在的IP访问控制。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -415,211 +355,129 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - ."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - ."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + 'schema' => ['description' => '保证请求幂等性。'."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], [ - 'name' => 'MaxResults', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '分批次查询时每次显示的条目数。取值：**1**~**50**。默认值：**10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会将IP地址与云连接器关联的连接地址池绑定。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后直接将IP地址与云连接器关联的连接地址池绑定。', '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n" + ."\n\n" + ."\n\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'APN', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '运营商APN ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'CMWAP', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'ISP', + 'name' => 'ConnectionPoolId', 'in' => 'query', - 'schema' => [ - 'description' => 'APN对应的运营商。取值：'."\n" - ."\n" - .'- **telecom**：中国电信。'."\n" - ."\n" - .'- **mobile**：中国移动。'."\n" - ."\n" - .'- **unicom**：中国联通。', - 'type' => 'string', - 'required' => false, - 'example' => 'mobile', - ], + 'schema' => ['description' => '连接地址池ID。', 'type' => 'string', 'required' => true, 'example' => 'cp-bp11234abctmno0hdq****'], ], [ - 'name' => 'Type', + 'name' => 'Ips', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '云连接器实例的版本，不同版本有不同功能限制和计费策略。取值：'."\n" - ."\n" - .'- **Basic**：基础版。'."\n" - ."\n" - .'- **Standard**：标准版。'."\n" - ."\n" - .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" + 'description' => '要绑定的IP地址列表。'."\n" + .'最多支持传入500个IP地址。多个IP地址使用半角逗号（,）分隔。', + 'type' => 'array', + 'items' => ['description' => '要绑定的IP地址列表。'."\n" + .'最多支持传入500个IP地址。多个IP地址使用半角逗号（,）分隔。'."\n" ."\n" - .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", - 'type' => 'string', + .'**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, - 'example' => 'Standard', + 'maxItems' => 1000, ], ], + [ + 'name' => 'IpsFilePath', + 'in' => 'query', + 'schema' => ['description' => '模板文件OSS地址，即[GetStsInfoAndOssPath](~~313331~~)接口的返回参数**OssPath**。'."\n" + ."\n" + .'格式为`<BucketName>/<uid>/<FileName>`。'."\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', - ], - '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', - ], - ], - ], - ], - ], + '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.UploadFile', 'errorMessage' => 'The specified resource of uploaded ip file is not found.', 'description' => '输入的IP文件未找到。'], + ['errorCode' => 'MissingParam.IpParam', 'errorMessage' => 'The param of ip or ip path is missing.', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'OperationDenied.GrantedInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of granted instance not support.', 'description' => '授权实例不允许IP管理相关操作。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ['errorCode' => 'ResourceInConfiguring.APN', 'errorMessage' => 'The specified resource of apn is being configured, please try again later.', 'description' => 'APN当前处于变配中状态，请稍后再试。'], ], ], - '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":"<ListAPNsResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <APNs>\\n <ISP>mobile</ISP>\\n <APN>CMWAP</APN>\\n <Name>test</Name>\\n <Description>test</Description>\\n <ZoneList>[\\"eu-central-1a\\", \\"eu-central-1b\\"]</ZoneList>\\n <FeatureList>trafficMirror</FeatureList>\\n </APNs>\\n</ListAPNsResponse>","errorExample":""}]', - 'title' => '查询APN', - ], - 'CreateIoTCloudConnector' => [ - 'summary' => '创建云连接器实例。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<AssociateIpWithConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</AssociateIpWithConnectionPoolResponse>","errorExample":""}]', + 'title' => '绑定IP地址与云连接器关联的连接地址池', + 'changeSet' => [ + ['createdAt' => '2023-01-05T09:14:01.000Z', 'description' => '错误码发生变更、响应参数发生变更'], + ['createdAt' => '2022-08-26T16:03:39.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-08-27T02:33:48.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2021-08-27T02:33:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-27T02:33:48.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateIpWithConnectionPool'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:AssociateIpWithConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], ], + ], + 'AssociateVSwitchWithIoTCloudConnector' => [ + 'summary' => '将交换机与云连接器实例进行关联。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -628,143 +486,61 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例的名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'IoTCloudConnectorDescription', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例描述信息。'."\n" - ."\n" - .'长度为2~256个字符，必须以字母或中文开头，但开头不能为`http://` 或`https://`。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '云连接器实例需关联的VPC的ID。'."\n" + ."\n" + .'如果填写此参数则必须填**VSwitchList**；如果不填，则**VSwitchList**也不填。', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1aevy8sofi8mh1q****'], ], [ - 'name' => 'WildcardDomainEnabled', + 'name' => 'VSwitchList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '是否开启泛域名功能。'."\n" - .'- **true**（默认值）：开启。'."\n" - .'- **false**：关闭。'."\n" + 'description' => '客户端VPC下的交换机列表，并且交换机的可用区必须和云连接器实例的可用区一致。'."\n" ."\n" - .'> 泛域名默认开启，本字段传值无效。', - 'type' => 'boolean', - 'deprecated' => true, - 'required' => false, - 'example' => 'true', - 'default' => 'true', + .'**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" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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', - ], + '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" - .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" - ."\n" - .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Standard', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -773,69 +549,57 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'IoTCloudConnectorId' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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.', - ], + ['errorCode' => 'ResourceNotEnough.CIDRNotHaveEnoughIp', 'errorMessage' => 'The specified resource of IP in CIDR is not enough.', 'description' => 'APN CIDR中的IP已经不足。'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParam.VSwitchZone', 'errorMessage' => 'The param of VSwitch zone is illegal.', 'description' => ''], + ['errorCode' => 'IllegalParamSize.VSwitchList', 'errorMessage' => 'The param size of VSwitch is illegal', 'description' => 'vSwitch参数长度非法'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'ResourceAlreadyAssociated.VpcId', 'errorMessage' => 'The specified resource of VpcId already associated', 'description' => '已绑定vpc'], + ['errorCode' => 'IllegalParam.VSwitch', 'errorMessage' => 'The param of VSwitch is illegal.', 'description' => 'vswitchId参数错误'], + ['errorCode' => 'IllegalParam.VpcId', 'errorMessage' => 'The param of Vpc is illegal.', 'description' => 'VpcId参数错误'], + ['errorCode' => 'OperationDenied.VpcStatusNotSupport', 'errorMessage' => 'The operation is not allowed because of vpc status not support.', 'description' => 'VPC状态不支持此操作。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ['errorCode' => 'IllegalParam.VSwitchSize', 'errorMessage' => 'The param of VSwitch size is illegal.', 'description' => '虚拟机交换机参数数量不对。'], + ['errorCode' => 'OperationDenied.OneVpcOnlySupportOneSpecIoTCC', 'errorMessage' => 'The operation is not allowed because of one vpc create different spec IoTCC not support.', 'description' => '单VPC不支持不同类型的云连接器。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIoTCloudConnectorResponse>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</CreateIoTCloudConnectorResponse>","errorExample":""}]', - 'title' => '创建云连接器实例', - ], - 'UpdateIoTCloudConnectorAttribute' => [ - 'summary' => '更新云连接器实例信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<AssociateVSwitchWithIoTCloudConnectorResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</AssociateVSwitchWithIoTCloudConnectorResponse>","errorExample":""}]', + 'title' => '交换机与云连接器实例进行关联', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateVSwitchWithIoTCloudConnector'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:AssociateVSwitchWithIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'VSwitch', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}'], + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'VPC', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}'], + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'ConfirmIoTCloudConnector' => [ + 'summary' => '调用ConfirmIoTCloudConnector接口确认或拒绝云连接器实例过户。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -847,178 +611,95 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Mode', + 'name' => 'ConfirmStatus', 'in' => 'query', - 'schema' => [ - 'description' => '实例模式。取值：'."\n" - ."\n" - .'- **PassThrough**：直通模式。'."\n" - .'- **VpcNat**：私网NAT模式。', - 'type' => 'string', - 'required' => false, - 'example' => 'PassThrough', - ], + 'schema' => ['description' => '确认状态。取值：'."\n" + ."\n" + .'- **Confirm**：确认。'."\n" + .'- **Refuse**：拒绝。', 'type' => 'string', 'required' => true, 'example' => 'Confirm'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], - 'ResourceId' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + '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.', - ], - [ - '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIoTCloudConnectorAttributeResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <ResourceId>iotcc-bp1odcab8tmno0hdq****</ResourceId>\\n</UpdateIoTCloudConnectorAttributeResponse>","errorExample":""}]', - 'title' => '更新云连接器实例信息', - ], - 'ListIoTCloudConnectors' => [ - 'summary' => '查询云连接器实例信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<ConfirmIoTCloudConnectorResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <ResourceId>iotcc-bp1odcab8tmno0hdq****</ResourceId>\\n</ConfirmIoTCloudConnectorResponse>","errorExample":""}]', + 'title' => '确认或拒绝云连接器实例过户', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:58.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmIoTCloudConnector'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:ConfirmIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'CreateAuthorizationRule' => [ + 'summary' => '创建授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1027,202 +708,106 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorStatus', + 'name' => 'IoTCloudConnectorId', '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, - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'IoTCloudConnectorIds', + 'name' => 'DestinationType', '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, - ], + 'schema' => ['description' => '访问目标类型。取值：'."\n" + .'- **Cidr**：CIDR地址块。'."\n" + .'- **Domain**：域名。', 'type' => 'string', 'required' => true, 'example' => 'Cidr'], ], [ - 'name' => 'IoTCloudConnectorName', + 'name' => 'DestinationPort', '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, - ], + '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' => 'ISP', + 'name' => 'Protocol', '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, - ], + 'schema' => ['description' => '协议类型。取值：'."\n" + ."\n" + .'- **tcp**。'."\n" + .'- **udp**。'."\n" + .'- **icmp**。'."\n" + .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'tcp'], ], [ - 'name' => 'VpcId', + 'name' => 'Destination', '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, - ], + 'schema' => ['description' => '访问目标。', 'type' => 'string', 'required' => true, 'example' => '47.0.XX.XX'], ], [ - 'name' => 'APN', + 'name' => 'Policy', + 'in' => 'query', + 'schema' => ['description' => '访问策略。取值：'."\n" + .'- **Permit**：允许。'."\n" + .'- **Deny**：拒绝。', 'type' => 'string', 'required' => true, 'example' => 'Permit'], + ], + [ + 'name' => 'SourceCidrs', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '运营商APN的ID。', + 'description' => '源CIDR地址块。最多支持20个源CIDR地址块。', 'type' => 'array', - 'items' => [ - 'description' => '运营商APN的ID。最多支持输入20个APN的ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'CMWAP', - ], - 'required' => false, + 'items' => ['description' => '源CIDR地址块。最多支持20个源CIDR地址块。', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'], + 'required' => true, 'maxItems' => 20, 'minItems' => 1, ], ], [ - 'name' => 'NextToken', + 'name' => 'AuthorizationRuleName', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], + 'schema' => ['description' => '授权规则名称。'."\n" + ."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）或短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'rule01'], ], [ - 'name' => 'MaxResults', + 'name' => 'AuthorizationRuleDescription', 'in' => 'query', - 'schema' => [ - 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**50**，默认值：**10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '授权规则描述。'."\n" + ."\n" + .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'rule01'], ], [ - 'name' => 'RegionId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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' => 'IsInGroup', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询实例组中的实例。取值：'."\n" - ."\n" - .'- **true**：查询实例组中的实例。'."\n" - ."\n" - .'- **false**（默认值）：不查询实例组中的实例。'."\n" - ."\n" - .'- **null**：全量查询实例，不区分实例是否在实例组中。'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后直接创建授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'IoTCloudConnectorGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -1231,198 +816,65 @@ '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" - .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" - ."\n" - .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\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', - ], - ], - ], - ], + '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' => 'SystemBusy', - 'errorMessage' => 'System is busy, please try again later.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.DomainFeatureDisabled', 'errorMessage' => 'The operation is not allowed because of domain feature disabled.', 'description' => ''], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], + ['errorCode' => 'ResourceAlreadyExist.AuthorizationRule', 'errorMessage' => 'The specified resource of AuthorizationRule already exists.', 'description' => '规则已经存在'], + ['errorCode' => 'Conflict.Param', 'errorMessage' => 'The param is conflict.', 'description' => ''], + ['errorCode' => 'Conflict.Cidr', 'errorMessage' => 'The cidr is conflict.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'QuotaExceeded.sourceCidrLimit', 'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded', 'description' => 'SourceCidrsPerAuthorizationRule quota超出'], + ['errorCode' => 'IllegalParam', 'errorMessage' => 'The param is illegal.', 'description' => '参数非法'], + ['errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit', 'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded.', 'description' => '单个云连接器的授权规则配额超限。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'OperationDenied.DomainInHumanNetwork', 'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.', 'description' => '配置的域名或者网段在人联网里面，不被允许。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ['errorCode' => 'IllegalParam.AuthorizationRule.DestinationType', 'errorMessage' => 'The param of DestinationType is illegal.', 'description' => ''], ], ], - '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":"<ListIoTCloudConnectorsResponse>\\n <TotalCount>20</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <IoTCloudConnectors>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <IoTCloudConnectorStatus>Created</IoTCloudConnectorStatus>\\n <ISP>mobile</ISP>\\n <IoTCloudConnectorBusinessStatus>Normal</IoTCloudConnectorBusinessStatus>\\n <APN>CMWAP</APN>\\n <RateLimit>2</RateLimit>\\n <VpcId>vpc-bp1aevy8sofi8mh1q****</VpcId>\\n <VSwitchList>vsw-m5e3r57pxkgijcdvfcdvf****</VSwitchList>\\n <IoTCloudConnectorName>test</IoTCloudConnectorName>\\n <IoTCloudConnectorDescription>test</IoTCloudConnectorDescription>\\n <WildcardDomainEnabled>false</WildcardDomainEnabled>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <Mode>PassThrough</Mode>\\n <IpFeature>192.168.0.1</IpFeature>\\n <Type>Standard</Type>\\n <ServiceType>Normal</ServiceType>\\n <GrantAliUid>253460731706911258</GrantAliUid>\\n </IoTCloudConnectors>\\n</ListIoTCloudConnectorsResponse>","errorExample":""}]', - 'title' => '查询云连接器实例信息', - ], - 'ListIoTCloudConnectorAvailableZones' => [ - 'summary' => '查询支持云连接器实例绑定交换机的可用区。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AuthorizationRuleId\\": \\"ar-1234abcb8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAuthorizationRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AuthorizationRuleId>ar-1234abcb8tmno0hdq****</AuthorizationRuleId>\\n</CreateAuthorizationRuleResponse>","errorExample":""}]', + 'title' => '创建授权规则', + 'changeSet' => [ + ['createdAt' => '2023-03-23T08:47:39.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-26T16:03:38.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-23T05:13:55.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-07T09:57:44.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAuthorizationRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateAuthorizationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + ], + ], + 'CreateAuthorizationRules' => [ + 'summary' => '调用CreateAuthorizationRules接口创建多条授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1431,59 +883,104 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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，仅取值：**cn-hangzhou**。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'AuthorizationRules', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', + '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, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', + 'maxItems' => 100, + 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'IoTCloudConnectorId' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], - 'AvailableZoneList' => [ - 'description' => '支持的可用区列表。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984'], + 'AuthorizationRuleIds' => [ + 'description' => '授权规则ID。', 'type' => 'array', - 'items' => [ - 'description' => '支持的可用区列表。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], + 'items' => ['description' => '授权规则ID。', 'type' => 'string', 'example' => 'ar-1234abcb8tmno0hdq****'], ], ], ], @@ -1491,29 +988,55 @@ ], '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.DomainFeatureDisabled', 'errorMessage' => 'The operation is not allowed because of domain feature disabled.', 'description' => ''], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], + ['errorCode' => 'ResourceAlreadyExist.AuthorizationRule', 'errorMessage' => 'The specified resource of AuthorizationRule already exists.', 'description' => '规则已经存在'], + ['errorCode' => 'Conflict.Param', 'errorMessage' => 'The param is conflict.', 'description' => ''], + ['errorCode' => 'Conflict.Cidr', 'errorMessage' => 'The cidr is conflict.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'QuotaExceeded.sourceCidrLimit', 'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded', 'description' => 'SourceCidrsPerAuthorizationRule quota超出'], + ['errorCode' => 'IllegalParam', 'errorMessage' => 'The param is illegal.', 'description' => '参数非法'], + ['errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit', 'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'OperationDenied.DomainInHumanNetwork', 'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.', 'description' => '配置的域名或者网段在人联网里面，不被允许。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ['errorCode' => 'IllegalParam.AuthorizationRule.DestinationType', 'errorMessage' => 'The param of DestinationType is illegal.', 'description' => ''], ], ], - '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":"<ListIoTCloudConnectorAvailableZonesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <AvailableZoneList>cn-hangzhou-h</AvailableZoneList>\\n</ListIoTCloudConnectorAvailableZonesResponse>","errorExample":""}]', - 'title' => 'IoTCC实例绑定交换机可用区', - ], - 'AssociateVSwitchWithIoTCloudConnector' => [ - 'summary' => '将交换机与云连接器实例进行关联。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AuthorizationRuleIds\\": [\\n \\"ar-1234abcb8tmno0hdq****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateAuthorizationRulesResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AuthorizationRuleIds>ar-1234abcb8tmno0hdq****</AuthorizationRuleIds>\\n</CreateAuthorizationRulesResponse>","errorExample":""}]', + 'title' => '创建多条授权规则', + 'changeSet' => [ + ['createdAt' => '2023-03-23T08:47:39.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-26T16:03:38.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-02T07:48:37.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAuthorizationRules'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateAuthorizationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'CreateConnectionPool' => [ + 'summary' => '创建连接地址池。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1522,93 +1045,74 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'VpcId', + 'name' => 'Count', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例需关联的VPC的ID。'."\n" - ."\n" - .'如果填写此参数则必须填**VSwitchList**；如果不填，则**VSwitchList**也不填。', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp1aevy8sofi8mh1q****', - ], + 'schema' => ['description' => '连接地址池的IP数量。取值范围：**1**~**500**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ - 'name' => 'VSwitchList', + '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' => '客户端VPC下的交换机列表，并且交换机的可用区必须和云连接器实例的可用区一致。'."\n" + 'description' => '连接地址池所属的CIDR地址块。**N**的取值范围：**1**~**20**。'."\n" ."\n" - .'**N**取值为**2**，表示必须为2个交换机。'."\n", + .'多个CIDR地址块使用and（&）分隔，格式为`Cidrs.1=CIDR地址块1&Cidrs.2=CIDR地址块2`。', 'type' => 'array', - 'items' => [ - 'description' => '客户端VPC下的交换机列表，并且交换机的可用区必须和云连接器实例的可用区一致。'."\n" - .'**N**取值为**2**，表示必须为2个交换机。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-m5e3r57pxkgijcdvfcdvf****', - ], - 'required' => true, + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。 '."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -1617,84 +1121,62 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984'], + 'ConnectionPoolId' => ['description' => '连接地址池的ID。', 'type' => 'string', 'example' => 'cp-bp11234abctmno0hdq****'], ], ], ], ], '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.', - ], + ['errorCode' => 'QuotaExceeded.CIDRLimit', 'errorMessage' => 'The quota of cidr_limit is exceeded.', 'description' => '连接池CIDR列表长度超配额。'], + ['errorCode' => 'Forbidden.IPUsedInCIDR', 'errorMessage' => 'IP has been used in CIDR.', 'description' => 'CIDR中有IP已经被使用。'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceInUse.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCC is in use.', 'description' => 'iotcc下有connection_pool未删除'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'ResourceInCreating.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is creating, please try again later.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'QuotaExceeded.ConnectionPoolPerIoTCC', 'errorMessage' => 'The quota of ConnectionPoolPerIoTCC is exceeded', 'description' => 'ConnectionPoolPerIoTCC quota超出'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'IllegalParam.Cidrs', 'errorMessage' => 'The param of Cidrs is illegal.', 'description' => 'cidrs参数错误'], + ['errorCode' => 'IllegalParamSize.Cidr', 'errorMessage' => 'The param size of Cidr is illegal, only support one.', 'description' => 'Cidr参数大小现在只能支持1。'], + ['errorCode' => 'OperationDenied.GrantedInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of granted instance not support.', 'description' => '授权实例不允许IP管理相关操作。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<AssociateVSwitchWithIoTCloudConnectorResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</AssociateVSwitchWithIoTCloudConnectorResponse>","errorExample":""}]', - 'title' => '交换机与云连接器实例进行关联', - ], - 'DissociateVSwitchFromIoTCloudConnector' => [ - 'summary' => '将交换机与云连接器实例解关联。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ConnectionPoolId\\": \\"cp-bp11234abctmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>\\n</CreateConnectionPoolResponse>","errorExample":""}]', + 'title' => '创建连接地址池', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:39.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-01-20T04:23:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-01-12T08:49:25.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-21T07:37:32.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnectionPool'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + ], + ], + 'CreateDNSServiceRule' => [ + 'summary' => '创建DNS授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1703,307 +1185,262 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + '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" + .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>', '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' => '保证请求幂等性。'."\n" - ."\n" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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', - ], + '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。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'DNS授权规则所在的地域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', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01'], + 'DNSServiceRuleId' => ['description' => 'DNS授权规则ID。', 'type' => 'string', 'example' => 'ar-r56ijpurlu50gi****'], ], + 'description' => '', ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.DomainFeatureDisabled', 'errorMessage' => 'The operation is not allowed because of domain feature disabled.', 'description' => ''], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], + ['errorCode' => 'ResourceAlreadyExist.AuthorizationRule', 'errorMessage' => 'The specified resource of AuthorizationRule already exists.', 'description' => '规则已经存在'], + ['errorCode' => 'Conflict.Param', 'errorMessage' => 'The param is conflict.', 'description' => ''], + ['errorCode' => 'Conflict.Cidr', 'errorMessage' => 'The cidr is conflict.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'QuotaExceeded.sourceCidrLimit', 'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded', 'description' => 'SourceCidrsPerAuthorizationRule quota超出'], + ['errorCode' => 'IllegalParam', 'errorMessage' => 'The param is illegal.', 'description' => '参数非法'], + ['errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit', 'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DissociateVSwitchFromIoTCloudConnectorResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DissociateVSwitchFromIoTCloudConnectorResponse>","errorExample":""}]', - 'title' => '解绑vsw/vpc', - ], - 'ListIoTCloudConnectorEIPs' => [ - 'summary' => '调用ListIoTCloudConnectorEIPs接口查询云连接器实例关联的弹性公网IP列表。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\",\\n \\"DNSServiceRuleId\\": \\"ar-r56ijpurlu50gi****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDNSServiceRuleResponse>\\n <RequestId>BC6D1C1D-6DBD-568C-B867-BC9CA699ED01</RequestId>\\n <DNSServiceRuleId>ar-r56ijpurlu50gi****</DNSServiceRuleId>\\n</CreateDNSServiceRuleResponse>","errorExample":""}]', + 'title' => '创建DNS授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:38.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-17T07:06:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-02-17T05:32:11.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDNSServiceRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateDNSServiceRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'CreateGroupAuthorizationRule' => [ + 'summary' => '实例组创建授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'NextToken', - ], + 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'MaxResults', + 'name' => 'AuthorizationRuleDescription', 'in' => 'query', - 'schema' => [ - 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**100**，默认值为**20**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => '授权规则的描述信息。'."\n" + ."\n" + .'长度为2~256个字符，必须以字母或中文开头，但不能以`http://` 或`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'rule'], ], [ - 'name' => 'RegionId', + 'name' => 'AuthorizationRuleName', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '授权规则的名称。'."\n" + ."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'ruletest'], ], [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'SourceCidrs', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', + 'description' => '源CIDR地址块。最多支持20个CIDR地址块。', + 'type' => 'array', + 'items' => ['description' => '源CIDR地址块。最多支持20个CIDR地址块。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1/24'], '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"]', - ], - ], - ], + 'maxItems' => 200, ], ], - ], - '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.', - ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => ['description' => '访问目标类型。取值：'."\n" + .'- **Cidr**：CIDR地址块。'."\n" + .'- **Domain**：域名。', 'type' => 'string', 'required' => true, 'example' => 'Cidr'], ], - ], - '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":"<ListIoTCloudConnectorEIPsResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <EIPs>[\\"42.1.XX.XX\\", \\"42.2.XX.XX\\", … \\"42.3.XX.XX\\"]</EIPs>\\n</ListIoTCloudConnectorEIPsResponse>","errorExample":""}]', - 'title' => '查询云连接器实例关联的弹性公网IP列表', - ], - 'DeleteIoTCloudConnector' => [ - 'summary' => '删除云连接器实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + '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'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => '协议类型。取值：'."\n" + ."\n" + .'- **tcp**。'."\n" + .'- **udp**。'."\n" + .'- **icmp**。'."\n" + .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'tcp'], ], - ], - 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'Destination', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '访问目标地址。', 'type' => 'string', 'required' => true, 'example' => '47.0.XX.XX'], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '保证请求幂等性。'."\n" - ."\n" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会为实例组创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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' => [ @@ -2012,64 +1449,61 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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' => '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'ResourceAlreadyExist.AuthorizationRule', 'errorMessage' => 'The specified resource of AuthorizationRule already exists.', 'description' => '规则已经存在'], + ['errorCode' => 'OperationDenied.DomainInHumanNetwork', 'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.', 'description' => '配置的域名或者网段在人联网里面，不被允许。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIoTCloudConnectorResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DeleteIoTCloudConnectorResponse>","errorExample":""}]', - 'title' => '删除云连接器实例', - ], - 'CreateConnectionPool' => [ - 'summary' => '创建连接地址池。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AuthorizationRuleId\\": \\"gar-ez91t41jvi6tr8****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupAuthorizationRuleResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <AuthorizationRuleId>gar-ez91t41jvi6tr8****</AuthorizationRuleId>\\n</CreateGroupAuthorizationRuleResponse>","errorExample":""}]', + 'title' => '实例组创建授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:38.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-05T08:40:14.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-23T06:27:36.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-13T11:44:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-07T09:57:44.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-01-04T12:38:26.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-14T12:33:41.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-14T12:19:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-14T09:32:05.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupAuthorizationRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateGroupAuthorizationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'CreateGroupDNSServiceRule' => [ + 'summary' => '实例组创建DNS授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2081,205 +1515,132 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'Count', + 'name' => 'DNSServiceRuleDescription', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的IP数量。取值范围：**1**~**500**。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'DNS授权规则描述。'."\n" + ."\n" + .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ - 'name' => 'ConnectionPoolName', + 'name' => 'DNSServiceRuleName', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的名称。'."\n" - ."\n" - .'长度为2~128个字符，必须以字母或中文开头，可包含数字、下划线（_）和短划线（-）。但不能以`http:// `或`https://`开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'pool01', - ], + 'schema' => ['description' => 'DNS授权规则名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'ConnectionPoolDescription', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的描述信息。'."\n" - ."\n" - .'长度为2~256个字符，必须以字母或中文开头，但不能以`http:// `或`https://`开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'pool01', - ], + '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" + .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\n", 'type' => 'string', 'required' => true, 'example' => '100.100.2.136'], ], [ - 'name' => 'Cidrs', + 'name' => 'ServiceType', '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, - ], + '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" - .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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**：发送检查请求，不会创建连接地址池。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后直接创建连接地址池。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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" - .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + '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', - ], - 'ConnectionPoolId' => [ - 'description' => '连接地址池的ID。', - 'type' => 'string', - 'example' => 'cp-bp11234abctmno0hdq****', - ], + '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****'], ], + 'description' => '', ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'ResourceAlreadyExist.AuthorizationRule', 'errorMessage' => 'The specified resource of AuthorizationRule already exists.', 'description' => '规则已经存在'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ConnectionPoolId\\": \\"cp-bp11234abctmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>\\n</CreateConnectionPoolResponse>","errorExample":""}]', - 'title' => '创建连接地址池', - ], - 'AddCidrToConnectionPool' => [ - 'summary' => '连接池增加连接IP段，主要用于动态IP增加IP方式，区别于单个卡IP添加方式。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\",\\n \\"DNSServiceRuleId\\": \\"gar-ffnn1ewe2nmf3y****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupDNSServiceRuleResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>77111A6A-56BA-59B2-8CAA-7CBF21648FB8</RequestId>\\n <DNSServiceRuleId>gar-ffnn1ewe2nmf3y****</DNSServiceRuleId>\\n</CreateGroupDNSServiceRuleResponse>","errorExample":""}]', + 'title' => '实例组创建DNS授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:38.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-22T06:47:54.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupDNSServiceRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateGroupDNSServiceRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'CreateGroupIpMappingRule' => [ + 'summary' => '调用CreateGroupIpMappingRule接口创建实例组授权规则IP的重定向规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2291,87 +1652,60 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'ConnectionPoolId', + 'name' => 'IpMappingRuleDescription', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cp-bp11234abctmno0hdq****', - ], + 'schema' => ['description' => '需要进行实例组IP重定向的授权规则描述。'."\n" + ."\n" + .'长度为2~256个字符，必须以字母或中文开头，但不能以`http:// `或`https://`开头。'."\n", 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ - 'name' => 'Cidrs', + 'name' => 'IpMappingRuleName', '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, - ], + '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" - .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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**：发送检查请求，不会添加CIDR地址块。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后直接添加CIDR地址块。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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', - ], + 'schema' => ['description' => '实例组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -2380,76 +1714,51 @@ 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984'], + 'GroupIpMappingRuleId' => ['description' => '需要进行IP重定向的授权规则的ID。', 'type' => 'string', 'example' => 'im-irrp3bzuu5nrbx****'], ], ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'ResourceAlreadyExist.AuthorizationRule', 'errorMessage' => 'The specified resource of AuthorizationRule already exists.', 'description' => '规则已经存在'], + ['errorCode' => 'OperationDenied.DomainInHumanNetwork', 'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.', 'description' => '配置的域名或者网段在人联网里面，不被允许。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<AddCidrToConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</AddCidrToConnectionPoolResponse>","errorExample":""}]', - 'title' => '连接池增加连接IP段', - ], - 'UpdateConnectionPoolAttribute' => [ - 'summary' => '更新连接地址池。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"GroupIpMappingRuleId\\": \\"im-irrp3bzuu5nrbx****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupIpMappingRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <GroupIpMappingRuleId>im-irrp3bzuu5nrbx****</GroupIpMappingRuleId>\\n</CreateGroupIpMappingRuleResponse>","errorExample":""}]', + 'title' => '创建实例组授权规则IP的重定向规则', + 'changeSet' => [ + ['createdAt' => '2022-08-23T06:53:44.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupIpMappingRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateGroupIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'CreateIoTCloudConnector' => [ + 'summary' => '创建云连接器实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2458,127 +1767,88 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'ISP', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '指定云连接器实例的运营商。取值：'."\n" + .'- **telecom**：中国电信。'."\n" + .'- **mobile**：中国移动。'."\n" + .'- **unicom**：中国联通。', 'type' => 'string', 'required' => true, 'example' => 'mobile'], ], [ - 'name' => 'ConnectionPoolId', + 'name' => 'APN', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cp-bp11234abctmno0hdq****', - ], + 'schema' => ['description' => '运营商APN ID。', 'type' => 'string', 'required' => true, 'example' => 'CMWAP'], ], [ - 'name' => 'Count', + 'name' => 'IoTCloudConnectorName', 'in' => 'query', - 'schema' => [ - 'description' => '物联网卡的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '云连接器实例的名称。'."\n" + ."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'ConnectionPoolName', + 'name' => 'IoTCloudConnectorDescription', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的名称。'."\n" - ."\n" - .'长度为2~128个字符，必须以字母或中文开头，可包含数字、下划线（_）和短划线（-）。但不能以`http:// `或`https://`开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'pool01', - ], + 'schema' => ['description' => '云连接器实例描述信息。'."\n" + ."\n" + .'长度为2~256个字符，必须以字母或中文开头，但开头不能为`http://` 或`https://`。'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'ConnectionPoolDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的描述信息。'."\n" - ."\n" - .'长度为2~256个字符，必须以字母或中文开头，但不能以`http:// `或`https://`开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'pool01', - ], - ], - [ - 'name' => 'Cidrs', + 'name' => 'WildcardDomainEnabled', '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, - ], + '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" - .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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', - ], + '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', - ], + '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" + .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" + ."\n" + .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard'], ], ], 'responses' => [ @@ -2587,68 +1857,57 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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' => '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.ApnDisabledWildcardDomain', 'errorMessage' => 'The operation is not allowed because of apn disabled wildcardDomain.', 'description' => ''], + ['errorCode' => 'OperationDenied.NotOpenIoTCloudConnectorService', 'errorMessage' => 'The operation is not allowed because of not open iotcc service.', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'QuotaExceeded.iotccInstanceLimit', 'errorMessage' => 'The quota of IoTCCPerUser is exceeded', 'description' => ''], + ['errorCode' => 'ResourceNotEnough.APN', 'errorMessage' => 'The specified resource of APN is not enough.', 'description' => 'APN资源不足'], + ['errorCode' => 'IncorrectStatus.APNNotReady', 'errorMessage' => 'The status of APN is incorrect.', 'description' => 'APN当前没有准备好，请稍等。'], + ['errorCode' => 'OperationDenied.ApnNotSupportBasicType', 'errorMessage' => 'The operation is not allowed because of apn do not support basic type cciot instance.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateConnectionPoolAttributeResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</UpdateConnectionPoolAttributeResponse>","errorExample":""}]', - 'title' => '更新连接地址池', - ], - 'ListConnectionPools' => [ - 'summary' => '查询云连接地址池。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIoTCloudConnectorResponse>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</CreateIoTCloudConnectorResponse>","errorExample":""}]', + 'title' => '创建云连接器实例', + 'changeSet' => [ + ['createdAt' => '2023-04-23T12:16:22.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-03-10T06:55:59.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-11-16T08:41:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-02-25T07:54:45.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIoTCloudConnector'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/*'], + ], + ], + ], ], + ], + 'CreateIoTCloudConnectorBackhaulRoute' => [ + 'summary' => '调用CreateIoTCloudConnectorBackhaulRoute接口创建当前云连接器实例绑定VPC后的回程路由。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2657,399 +1916,207 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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, - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'NextToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" - ."\n" - .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], + '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' => 'MaxResults', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据记录数量，取值：**1**~**50**。传入为空时，默认值为**10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会创建当前云连接器实例绑定VPC后的回程路由。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并创建云连接器实例绑定VPC后的回程路由。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + 'description' => '云连接器实例ID。', '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', - ], - ], - ], - ], + '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' => 'ResourceNotFound.IoTCloudConnector', - 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'OperationDenied.UserVpcRouteAlreadyPublished', 'errorMessage' => 'The operation is not allowed because of user vpc route already published.', 'description' => '本操作不允许，原因是VPC路由已经存在。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - '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":"<ListConnectionPoolsResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>2</TotalCount>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <MaxResults>50</MaxResults>\\n <ConnectionPools>\\n <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>\\n <ConnectionPoolStatus>Running</ConnectionPoolStatus>\\n <ConnectionPoolName>pool01</ConnectionPoolName>\\n <ConnectionPoolDescription>pool01</ConnectionPoolDescription>\\n <Cidrs>192.168.XX.XX/32</Cidrs>\\n <OperateResultRequestID>CEF72CEB-54B6-4AE8-B225-F876FF7BA651</OperateResultRequestID>\\n </ConnectionPools>\\n</ListConnectionPoolsResponse>","errorExample":""}]', - 'title' => '查询云连接地址池', - ], - 'ListConnectionPoolIps' => [ - 'summary' => '查询连接地址池中的IP地址状态信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIoTCloudConnectorBackhaulRouteResponse>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</CreateIoTCloudConnectorBackhaulRouteResponse>","errorExample":""}]', + 'title' => '创建当前云连接器实例绑定VPC后的回程路由', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-05-06T12:57:35.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2022-05-06T12:57:35.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-05-06T12:57:35.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateIoTCloudConnectorBackhaulRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'CreateIoTCloudConnectorGroup' => [ + 'summary' => '创建实例组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" - ."\n" - .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], + 'schema' => ['description' => '实例组的名称。'."\n" + ."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'cctest'], ], [ - 'name' => 'MaxResults', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，取值：**1**~**2000**。传入为空时，默认值为**10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2000', - 'minimum' => '1', - 'example' => '10', - 'default' => '50', - ], + 'schema' => ['description' => '实例组的描述信息。'."\n" + .'长度为2~256个字符，必须以字母或中文开头，但不能以`http://` 或`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'RegionId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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' => 'IoTCloudConnectorId', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会创建实例组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'ConnectionPoolId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cp-bp11234abctmno0hdq****', - ], + 'schema' => ['description' => '实例组所在的地域ID。 '."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Ip', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池中的IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], + 'schema' => ['description' => '云连接器实例的版本，不同版本有不同功能限制和计费策略。取值：'."\n" + ."\n" + .'- **Basic**：基础版。'."\n" + ."\n" + .'- **Standard**：标准版。'."\n" + ."\n" + .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" + ."\n" + .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回请求列表。', + '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', - ], - ], - ], - ], + '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], ], ], - '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":"<ListConnectionPoolIpsResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>2</TotalCount>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <MaxResults>10</MaxResults>\\n <ConnectionPoolIps>\\n <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>\\n <Ip>192.168.XX.XX</Ip>\\n <Status>activated</Status>\\n </ConnectionPoolIps>\\n</ListConnectionPoolIpsResponse>","errorExample":""}]', - 'title' => '查询连接地址池中的IP地址状态', - ], - 'GetStsInfoAndOssPath' => [ - 'summary' => '获取服务账号STS信息和模板文件临时提交地址。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIoTCloudConnectorGroupResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</CreateIoTCloudConnectorGroupResponse>","errorExample":""}]', + 'title' => '创建实例组', + 'changeSet' => [ + ['createdAt' => '2022-06-13T11:44:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-14T09:32:05.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIoTCloudConnectorGroup'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateIoTCloudConnectorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateIpMappingRule' => [ + 'summary' => '调用CreateIpMappingRule接口创建授权规则IP的重定向功能。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3058,156 +2125,125 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '保证请求幂等性。'."\n" - ."\n" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'DryRun', + 'name' => 'DestinationIp', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求，取值：'."\n" - .'- **true**：发送检查请求，不会获取信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后直接获取信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '重定向的目标IP地址。', 'type' => 'string', 'required' => true, 'example' => '192.168.10.8'], ], [ - 'name' => 'RegionId', + 'name' => 'MappingIp', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '需要进行重定向的IP地址。', 'type' => 'string', 'required' => true, 'example' => '47.0.XX.XX'], ], [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'IpMappingRuleName', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '需要进行IP重定向的授权规则名称。'."\n" + ."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'name'], ], [ - 'name' => 'ConnectionPoolId', + 'name' => 'IpMappingRuleDescription', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cp-bp11234abctmno0hdq****', - ], + 'schema' => ['description' => '需要进行IP重定向的授权规则描述。'."\n" + ."\n" + .'长度为2~256个字符，必须以字母或中文开头，但不能以`http:// `或`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ - 'name' => 'FileName', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '模板文件名称。'."\n" - ."\n" - .'模板文件仅支持CSV格式。', - 'type' => 'string', - 'required' => false, - 'example' => 'test.csv', - ], + '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' => '返回列表信息。', + 'description' => '请求ID。', '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' => '<yourAccessKeyId>', - ], - 'AccessKeySecret' => [ - 'title' => 'Sts info of accessKeySecret', - 'description' => 'STS临时AccessKey Secret。', - 'type' => 'string', - 'example' => '<yourAccessKeySecret>', - ], - 'SecurityToken' => [ - 'title' => 'Sts info of securityToken', - 'description' => 'STS安全令牌。', - 'type' => 'string', - 'example' => '<yourSecurityToken>', - ], - 'OssPath' => [ - 'title' => 'OssPath', - 'description' => '模板文件提交临时地址。'."\n" - ."\n" - .'格式为`<BucketName>/<uid>/<FileName>`。'."\n" - ."\n" - .'根据上传的文件名及用户信息，系统会返回临时STS信息和IP绑定关系CSV文件提交地址，该地址需要调用[PutObject](~~31978~~)接口上传文件。', - 'type' => 'string', - 'example' => 'cciot-cn-hangzhou/127859184306****/test.csv', - ], + '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' => 'IllegalParamFormat', - 'errorMessage' => 'The param is illegal.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.DomainFeatureDisabled', 'errorMessage' => 'The operation is not allowed because of domain feature disabled.', 'description' => ''], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], + ['errorCode' => 'ResourceAlreadyExist.AuthorizationRule', 'errorMessage' => 'The specified resource of AuthorizationRule already exists.', 'description' => '规则已经存在'], + ['errorCode' => 'Conflict.Param', 'errorMessage' => 'The param is conflict.', 'description' => ''], + ['errorCode' => 'Conflict.Cidr', 'errorMessage' => 'The cidr is conflict.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'QuotaExceeded.sourceCidrLimit', 'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded', 'description' => 'SourceCidrsPerAuthorizationRule quota超出'], + ['errorCode' => 'IllegalParam', 'errorMessage' => 'The param is illegal.', 'description' => '参数非法'], + ['errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit', 'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'OperationDenied.DomainInHumanNetwork', 'errorMessage' => 'The operation is not allowed because of domain or CIDR in human network.', 'description' => '配置的域名或者网段在人联网里面，不被允许。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"Expiration\\": \\"1633060876\\",\\n \\"AccessKeyId\\": \\"<yourAccessKeyId>\\",\\n \\"AccessKeySecret\\": \\"<yourAccessKeySecret>\\",\\n \\"SecurityToken\\": \\"<yourSecurityToken>\\",\\n \\"OssPath\\": \\"cciot-cn-hangzhou/127859184306****/test.csv\\"\\n}","errorExample":""},{"type":"xml","example":"<GetStsInfoAndOssPathResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <Expiration>1633060876</Expiration>\\n <AccessKeyId><yourAccessKeyId></AccessKeyId>\\n <AccessKeySecret><yourAccessKeySecret></AccessKeySecret>\\n <SecurityToken><yourSecurityToken></SecurityToken>\\n <OssPath>cciot-cn-hangzhou/127859184306****/test.csv</OssPath>\\n</GetStsInfoAndOssPathResponse>","errorExample":""}]', - 'title' => '获取服务账号信息和提交地址', - ], - 'AssociateIpWithConnectionPool' => [ - 'summary' => '绑定某个已存在的IP访问控制。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"IpMappingRuleId\\": \\"im-irrp3bzuu5nrbx****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIpMappingRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <IpMappingRuleId>im-irrp3bzuu5nrbx****</IpMappingRuleId>\\n</CreateIpMappingRuleResponse>","errorExample":""}]', + 'title' => '创建授权规则IP的重定向功能', + 'changeSet' => [ + ['createdAt' => '2022-08-29T07:23:20.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-19T03:29:20.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIpMappingRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'CreateService' => [ + 'summary' => '创建分应用统计服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3216,170 +2252,101 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求，取值：'."\n" - .'- **true**：发送检查请求，不会将IP地址与云连接器关联的连接地址池绑定。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后直接将IP地址与云连接器关联的连接地址池绑定。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'RegionId', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n" - ."\n\n" - ."\n\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '分应用统计服务的名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'service_name'], ], [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'ServiceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '分应用统计服务的描述。'."\n" + ."\n" + .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'service_description'], ], [ - 'name' => 'ConnectionPoolId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cp-bp11234abctmno0hdq****', - ], + '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' => 'Ips', + 'name' => 'DryRun', '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, - ], + 'schema' => ['description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会创建服务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建服务。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'IpsFilePath', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '模板文件OSS地址，即[GetStsInfoAndOssPath](~~313331~~)接口的返回参数**OssPath**。'."\n" - ."\n" - .'格式为`<BucketName>/<uid>/<FileName>`。'."\n" - ."\n" - .'**Ips**和**IpsFilePath**不能同时填写，如果IP数量较少，可直接选择**Ips**方式，如果IP数量较多，建议选择**IpsFilePath**方式，将需要绑定的IP地址记录在模板文件中，整体绑定。', - 'type' => 'string', - 'required' => false, - 'example' => 'cciot-cn-hangzhou/127859184306****/test.csv', - ], + 'schema' => ['description' => '分应用统计服务所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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.', - ], - [ - '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<AssociateIpWithConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</AssociateIpWithConnectionPoolResponse>","errorExample":""}]', - 'title' => '绑定IP地址与云连接器关联的连接地址池', - ], - 'DissociateIpFromConnectionPool' => [ - 'summary' => '解除IP地址与云连接器关联的连接地址池的绑定关系。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ServiceId\\": \\"c910061f-****-44e6-b659-***c\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <ServiceId>c910061f-****-44e6-b659-***c</ServiceId>\\n</CreateServiceResponse>","errorExample":""}]', + 'title' => '创建分应用统计服务', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateService'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateServiceEntry' => [ + 'summary' => '分应用统计服务列表中添加应用条目。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3388,474 +2355,322 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '保证请求幂等性。'."\n" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + 'schema' => ['description' => '系统为分应用统计服务生成的ID，全网唯一。', 'type' => 'string', 'required' => true, 'example' => 'c910061f-****-44e6-b659-***c'], ], [ - 'name' => 'DryRun', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求，取值：'."\n" - .'- **true**：发送检查请求，不会解除IP地址与云连接器关联的连接地址池的绑定关系。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后直接解除IP地址与云连接器关联的连接地址池的绑定关系。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'RegionId', + 'name' => 'Target', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '应用条目的目的地址。', 'type' => 'string', 'required' => true, 'example' => '192.168.1.32/27'], ], [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'TargetType', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '应用条目的目的地址类型。取值：'."\n" + ."\n" + .'- **Cidr**：CIDR地址块。'."\n" + ."\n" + .'- **Domain**：域名。', 'type' => 'string', 'required' => true, 'example' => 'Cidr'], ], [ - 'name' => 'ConnectionPoolId', + 'name' => 'ServiceEntryName', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cp-bp11234abctmno0hdq****', - ], + 'schema' => ['description' => '应用条目的名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'entry_name'], ], [ - 'name' => 'Ips', + 'name' => 'ServiceEntryDescription', '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, - ], + 'schema' => ['description' => '应用条目的描述。'."\n" + ."\n" + .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'entry_description'], ], [ - 'name' => 'IpsFilePath', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '模板文件OSS地址，即[GetStsInfoAndOssPath](~~313331~~)接口的返回参数**OssPath**。'."\n" - ."\n" - .'格式为`<BucketName>/<uid>/<FileName>`。'."\n" - ."\n" - .'**Ips**和**IpsFilePath**不能同时填写，如果IP数量较少，可直接选择**Ips**方式，如果IP数量较多，建议选择**IpsFilePath**方式，将需要解绑的IP地址记录在模板文件中，整体解绑。', - 'type' => 'string', - 'required' => false, - 'example' => 'cciot-cn-hangzhou/127859184306****/test.csv', - ], + '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' => '返回信息列表。', + 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45'], + 'ServiceEntryId' => ['description' => '应用条目的ID。', 'type' => 'string', 'example' => 'fwd-119smw5tkasdf****'], ], ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DissociateIpFromConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DissociateIpFromConnectionPoolResponse>","errorExample":""}]', - 'title' => '解绑卡IP', - ], - 'GetConnectionPoolIpOperationResult' => [ - 'summary' => '获取IP地址与连接地址池绑定与解绑的操作结果。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"ServiceEntryId\\": \\"fwd-119smw5tkasdf****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceEntryResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <ServiceEntryId>fwd-119smw5tkasdf****</ServiceEntryId>\\n</CreateServiceEntryResponse>","errorExample":""}]', + 'title' => '分应用功能列表中添加应用条目', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceEntry'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateServiceEntry', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + ], + ], + 'DeleteAuthorizationRule' => [ + 'summary' => '删除授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'AuthorizationRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'ar-1234abcb8tmno0hdq****'], ], [ - 'name' => 'ConnectionPoolId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cp-0gd9qnmv8431rh****', - ], + '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' => 'QueryRequestId', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '查询请求ID，即调用[AssociateIpWithConnectionPool](~~313334~~)或[DissociateIpFromConnectionPool](~~313335~~)接口，操作成功后返回的**RequestId**。', - 'type' => 'string', - 'required' => true, - 'example' => 'CFA63CEB-15B6-4AE8-B203-F855FF7BA962', - ], + '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' => '返回请求列表。', + '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://<BucketName.oss域名>/ipma/<执行结果文件>?<超期信息>&<临时AK/SK信息>&<签名信息>`。'."\n" - ."\n" - .'文件内容为绑定和解绑的错误IP地址或错误原因列表，如果该字段为空，代表没有失败记录。', - 'type' => 'array', - 'items' => [ - 'description' => '绑定与解绑的执行结果文件地址，即调用[AssociateIpWithConnectionPool](~~313334~~)或[DissociateIpFromConnectionPool](~~313335~~)接口执行结果文件下载地址。格式为`https://<BucketName.oss域名>/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', - ], - ], + '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' => 'IllegalParamFormat', - 'errorMessage' => 'The param is illegal.', - ], + ['errorCode' => 'OperationDenied.IotCloudConnectorInGroup', 'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.', 'description' => '本次操作不被允许的原因是IotCloudConnector在Group分组中.'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.AuthorizationRule', 'errorMessage' => 'The param of AuthorizationRuleId is illegal.', 'description' => 'AuthorizationRuleId非法'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'IllegalParam.AuthoriztionRuleId', 'errorMessage' => 'The param of AuthoriztionRuleId is illegal.', 'description' => 'AuthoriztionRuleId不存在'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - '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":"<GetConnectionPoolIpOperationResultResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA651</RequestId>\\n <ResultFilePaths>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</ResultFilePaths>\\n</GetConnectionPoolIpOperationResultResponse>","errorExample":""}]', - 'title' => '获取IP地址绑定与解绑结果', - ], - 'ListConnectionPoolAllIps' => [ - 'summary' => '查询连接地址池所有IP地址信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAuthorizationRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DeleteAuthorizationRuleResponse>","errorExample":""}]', + 'title' => '删除授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-20T08:55:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAuthorizationRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteAuthorizationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DeleteAuthorizationRules' => [ + 'summary' => '批量删除授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'AuthorizationRuleIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', + 'description' => '授权规则ID列表。最多支持传入200个授权规则ID。', + 'type' => 'array', + 'items' => ['description' => '授权规则ID。', 'type' => 'string', 'required' => false, 'example' => 'ar-1234abcb8tmno0hdq****'], 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', + 'maxItems' => 200, ], ], [ - 'name' => 'ConnectionPoolId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '要查询的连接地址池ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cp-bp11234abctmno0hdq****', - ], + 'schema' => ['description' => '保证请求幂等性。'."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], [ - 'name' => 'Ip', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池中的IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.1', - ], + 'schema' => ['description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会更新授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后直接更新授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Type', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池中IP地址类型。取值：'."\n" - ."\n" - .'- **Cidr**：连接地址池所属的CIDR地址块。'."\n" - ."\n" - .'- **Host**：物联网卡的IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'Cidr', - ], + 'schema' => ['description' => '地域ID。默认为cn-hangzhou。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + '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', - ], - ], - ], - ], + '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.ConnectionPool', - 'errorMessage' => 'The specified resource of connection pool is not found.', + ['errorCode' => 'OperationDenied.IotCloudConnectorInGroup', 'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.', 'description' => '本次操作不被允许的原因是IotCloudConnector在Group分组中.'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.AuthorizationRule', 'errorMessage' => 'The param of AuthorizationRuleId is illegal.', 'description' => 'AuthorizationRuleId非法'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'IllegalParam.AuthoriztionRuleId', 'errorMessage' => 'The param of AuthoriztionRuleId is illegal.', 'description' => 'AuthoriztionRuleId不存在'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]', + 'title' => '批量删除授权规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAuthorizationRules'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteAuthorizationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], ], ], ], - '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":"<ListConnectionPoolAllIpsResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <TotalIpsCount>1</TotalIpsCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <ConnectionPoolIps>\\n <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>\\n <Ip>192.168.0.1</Ip>\\n <Status>activated</Status>\\n <Type>Cidr</Type>\\n <IpNum>254</IpNum>\\n </ConnectionPoolIps>\\n</ListConnectionPoolAllIpsResponse>","errorExample":""}]', - 'title' => '查询连接地址池所有IP地址', ], 'DeleteConnectionPool' => [ 'summary' => '删除连接地址池。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3867,64 +2682,37 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ 'name' => 'ConnectionPoolId', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址池的ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1234abc', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -3933,64 +2721,53 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceExist.AuthorizationRule', 'errorMessage' => 'The specified resource of AuthorizationRule exists.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.ConnectionPool', 'errorMessage' => 'The param of ConnectionPoolId is illegal.', 'description' => 'ConnectionPoolId参数非法'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'IllegalParam.ConnectionPoolId', 'errorMessage' => 'The param of ConnectionPoolId is illegal.', 'description' => 'ConnectionPoolId不存在'], + ['errorCode' => 'OperationDenied.GrantedInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of granted instance not support.', 'description' => '授权实例不允许IP管理相关操作。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DeleteConnectionPoolResponse>","errorExample":""}]', 'title' => '删除连接地址池', - ], - 'CreateAuthorizationRule' => [ - 'summary' => '创建授权规则。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:39.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConnectionPool'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DeleteDNSServiceRule' => [ + 'summary' => '删除DNS授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3999,168 +2776,144 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-1y6h8z7imd2yu4****'], ], [ - 'name' => 'DestinationType', + 'name' => 'DNSServiceRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '访问目标类型。取值：'."\n" - .'- **Cidr**：CIDR地址块。'."\n" - .'- **Domain**：域名。', - 'type' => 'string', - 'required' => true, - 'example' => 'Cidr', - ], + 'schema' => ['description' => 'DNS授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'ar-r56ijpurlu50gi****'], ], [ - 'name' => 'DestinationPort', + 'name' => 'ClientToken', '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', - ], + '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' => 'Protocol', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '协议类型。取值：'."\n" - ."\n" - .'- **tcp**。'."\n" - .'- **udp**。'."\n" - .'- **icmp**。'."\n" - .'- **all**：支持所有协议。', - 'type' => 'string', - 'required' => false, - 'example' => 'tcp', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除DNS授权规则。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Destination', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '访问目标。', - 'type' => 'string', - 'required' => true, - 'example' => '47.0.XX.XX', - ], + 'schema' => ['description' => 'DNS授权规则所在的地域ID。'."\n" + ."\n" + .'> 目前，支持开通云连接器的地域：华东1（杭州）、华东2（上海）、华北1（青岛）、华北2（北京）、华北5（呼和浩特）、华北6（乌兰察布）、华南1（深圳）、华南3（广州）、西南1（成都）、德国（法兰克福）。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - [ - 'name' => 'Policy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '访问策略。取值：'."\n" - .'- **Permit**：允许。'."\n" - .'- **Deny**：拒绝。', - 'type' => 'string', - 'required' => true, - 'example' => 'Permit', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'OperationDenied.IotCloudConnectorInGroup', 'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.', 'description' => '本次操作不被允许的原因是IotCloudConnector在Group分组中.'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.AuthorizationRule', 'errorMessage' => 'The param of AuthorizationRuleId is illegal.', 'description' => 'AuthorizationRuleId非法'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'IllegalParam.AuthoriztionRuleId', 'errorMessage' => 'The param of AuthoriztionRuleId is illegal.', 'description' => 'AuthoriztionRuleId不存在'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDNSServiceRuleResponse>\\n <RequestId>BC6D1C1D-6DBD-568C-B867-BC9CA699ED01</RequestId>\\n</DeleteDNSServiceRuleResponse>","errorExample":""}]', + 'title' => '删除DNS授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDNSServiceRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteDNSServiceRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], ], - 'required' => true, - 'maxItems' => 20, - 'minItems' => 1, ], ], + ], + ], + 'DeleteGroupAuthorizationRule' => [ + 'summary' => '删除实例组的授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AuthorizationRuleName', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], + ], + 'parameters' => [ + [ + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）或短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'rule01', - ], + 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'AuthorizationRuleDescription', + 'name' => 'AuthorizationRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则描述。'."\n" - ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'rule01', - ], + 'schema' => ['description' => '授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'gar-ez91t41jvi6tr8****'], ], [ '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '实例组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -4169,101 +2922,48 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], - 'AuthorizationRuleId' => [ - 'description' => '授权规则ID。', - 'type' => 'string', - 'example' => 'ar-1234abcb8tmno0hdq****', - ], + '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.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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AuthorizationRuleId\\": \\"ar-1234abcb8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAuthorizationRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AuthorizationRuleId>ar-1234abcb8tmno0hdq****</AuthorizationRuleId>\\n</CreateAuthorizationRuleResponse>","errorExample":""}]', - 'title' => '创建授权规则', - ], - 'CreateAuthorizationRules' => [ - 'summary' => '调用CreateAuthorizationRules接口创建多条授权规则。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGroupAuthorizationRuleResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</DeleteGroupAuthorizationRuleResponse>","errorExample":""}]', + 'title' => '删除实例组的授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-14T09:32:05.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupAuthorizationRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteGroupAuthorizationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DeleteGroupDNSServiceRule' => [ + 'summary' => '删除实例组的DNS授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4272,260 +2972,94 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '云连接器实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'ClientToken', + 'name' => 'DNSServiceRuleId', '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', - ], + 'schema' => ['description' => 'DNS授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'gar-ffnn1ewe2nmf3y****'], ], [ - 'name' => 'DryRun', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会创建多条授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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' => 'RegionId', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行删除。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'AuthorizationRules', + 'name' => 'RegionId', '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, - ], + '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' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], - 'AuthorizationRuleIds' => [ - 'description' => '授权规则ID。', - 'type' => 'array', - 'items' => [ - 'description' => '授权规则ID。', - 'type' => 'string', - 'example' => 'ar-1234abcb8tmno0hdq****', - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8'], ], + 'description' => '', ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AuthorizationRuleIds\\": [\\n \\"ar-1234abcb8tmno0hdq****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateAuthorizationRulesResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AuthorizationRuleIds>ar-1234abcb8tmno0hdq****</AuthorizationRuleIds>\\n</CreateAuthorizationRulesResponse>","errorExample":""}]', - 'title' => '创建多条授权规则', - ], - 'UpdateAuthorizationRuleAttribute' => [ - 'summary' => '更新授权规则信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGroupDNSServiceRuleResponse>\\n <RequestId>77111A6A-56BA-59B2-8CAA-7CBF21648FB8</RequestId>\\n</DeleteGroupDNSServiceRuleResponse>","errorExample":""}]', + 'title' => '删除实例组的DNS授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupDNSServiceRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteGroupDNSServiceRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'DeleteGroupIpMappingRule' => [ + 'summary' => '调用DeleteGroupIpMappingRule接口删除实例组授权规则IP重定向信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4534,176 +3068,129 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'AuthorizationRuleId', + 'name' => 'GroupIpMappingRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ar-1234abcb8tmno0hdq****', - ], + 'schema' => ['description' => '待删除的实例组IP重定向的授权规则的ID。', 'type' => 'string', 'required' => true, 'example' => 'im-irrp3bzuu5nrbx****'], ], [ - 'name' => 'DestinationType', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '访问目标类型。'."\n" - .'- **Cidr**：CIDR地址块。'."\n" - .'- **Domain**：域名。', - 'type' => 'string', - 'required' => false, - 'example' => 'Cidr', - ], + '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' => 'DestinationPort', + 'name' => 'DryRun', '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', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除实例组授权规则IP重定向信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Protocol', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '协议类型。取值：'."\n" - ."\n" - .'- **tcp**。'."\n" - .'- **udp**。'."\n" - .'- **icmp**。'."\n" - .'- **all**：支持所有协议。', - 'type' => 'string', - 'required' => false, - 'example' => 'tcp', - ], + 'schema' => ['description' => '实例组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - [ - 'name' => 'Destination', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '访问目标。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + ], ], ], - [ - 'name' => 'Policy', - 'in' => 'query', - 'schema' => [ - 'description' => '访问策略。'."\n" - .'- **Permit**：允许。'."\n" - .'- **Deny**：拒绝。', - 'type' => 'string', - 'required' => false, - 'example' => 'Permit', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGroupIpMappingRuleResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteGroupIpMappingRuleResponse>","errorExample":""}]', + 'title' => '删除实例组授权规则IP重定向信息', + 'changeSet' => [ + ['createdAt' => '2022-08-22T09:44:29.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupIpMappingRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteGroupIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 1, ], ], + ], + ], + 'DeleteIoTCloudConnector' => [ + 'summary' => '删除云连接器实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AuthorizationRuleName', - 'in' => 'query', - 'schema' => [ - 'description' => '授权规则名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'rule01', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], + ], + 'parameters' => [ [ - 'name' => 'AuthorizationRuleDescription', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则描述。'."\n" - ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'rule01', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -4712,84 +3199,54 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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.', - ], + ['errorCode' => 'OperationDenied.IotCloudConnectorInGroup', 'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.', 'description' => '本次操作不被允许的原因是IotCloudConnector在Group分组中.'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceInUse.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCC is in use.', 'description' => 'iotcc下有connection_pool未删除'], + ['errorCode' => 'IncorrectStatus.CloudConnector', 'errorMessage' => 'The status of CloudConnector is incorrect.', 'description' => ''], + ['errorCode' => 'ResourceInCreating.IoTCloudConnector', 'errorMessage' => 'ResourceInCreating.IoTCloudConnector', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAuthorizationRuleAttributeResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</UpdateAuthorizationRuleAttributeResponse>","errorExample":""}]', - 'title' => '更新授权规则信息', - ], - 'ListAuthorizationRules' => [ - 'summary' => '查询授权规则信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIoTCloudConnectorResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DeleteIoTCloudConnectorResponse>","errorExample":""}]', + 'title' => '删除云连接器实例', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-20T08:55:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIoTCloudConnector'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DeleteIoTCloudConnectorGroup' => [ + 'summary' => '删除实例组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4798,440 +3255,187 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', - 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], - ], - [ - 'name' => 'AuthorizationRuleIds', + 'name' => 'IoTCloudConnectorGroupId', '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, - ], + 'schema' => ['description' => '要删除的实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'DestinationType', + 'name' => 'ClientToken', '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, - ], + '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' => 'Protocol', + 'name' => 'DryRun', '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, - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除实例组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'DestinationPort', + 'name' => 'RegionId', '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, - ], + 'schema' => ['description' => '实例组所在的地域ID。 '."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - [ - 'name' => 'Destination', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '访问目标。', - 'type' => 'array', - 'items' => [ - 'description' => '访问目标。最多支持20个访问目标。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45'], ], - '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, - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceInCreating.IoTCloudConnectorGroup', 'errorMessage' => 'ResourceInCreating.IoTCloudConnectorGroup', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnectorGroup', 'errorMessage' => 'The specified resource of IoTCloudConnector Group is configuring, please try again later.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup', 'errorMessage' => 'The param of IoTCloudConnectorId Group is illegal.', 'description' => ''], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], - [ - '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, - ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIoTCloudConnectorGroupResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</DeleteIoTCloudConnectorGroupResponse>","errorExample":""}]', + 'title' => '删除实例组', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-14T09:32:05.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIoTCloudConnectorGroup'], ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteIoTCloudConnectorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 1, ], ], + ], + ], + 'DeleteIoTCloudConnetorBackhaulRoute' => [ + 'summary' => '调用DeleteIoTCloudConnetorBackhaulRoute接口删除当前云连接器实例绑定VPC后的回程路由。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], + ], + 'parameters' => [ [ - 'name' => 'MaxResults', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，取值：**1**~**50**。传入为空时，默认值：**10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'RegionId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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' => 'AuthorizationRuleType', - 'in' => 'query', - 'schema' => [ - 'description' => '授权规则的类型。取值：'."\n" - ."\n" - .'- **System**，表示授权规则的类型为系统类型。'."\n" - ."\n" - .'- **Customer**：表示授权规则的类型为自定义类型。'."\n" - ."\n" - .'- **Default**：表示授权规则的类型为默认类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'System', - ], - ], - [ - 'name' => 'FuzzyDestination', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '模糊的访问目标', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyuncs', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除当前云连接器实例绑定VPC后的回程路由。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除云连接器实例绑定VPC后的回程路由。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'FuzzyAuthorizationRuleName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '模糊的授权规则名称', - 'type' => 'string', - 'required' => false, - 'example' => '测试', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => '返回信息列表。', + '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' => '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', - ], - ], - ], - ], + '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' => 'ResourceNotFound.IoTCloudConnector', - 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', - ], + ['errorCode' => 'OperationDenied.IotCloudConnectorInGroup', 'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.', 'description' => '本次操作不被允许的原因是IotCloudConnector在Group分组中.'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceInUse.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCC is in use.', 'description' => 'iotcc下有connection_pool未删除'], + ['errorCode' => 'IncorrectStatus.CloudConnector', 'errorMessage' => 'The status of CloudConnector is incorrect.', 'description' => ''], + ['errorCode' => 'ResourceInCreating.IoTCloudConnector', 'errorMessage' => 'ResourceInCreating.IoTCloudConnector', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - '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":"<ListAuthorizationRulesResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <MaxResults>10</MaxResults>\\n <AuthorizationRules>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <Policy>Permit</Policy>\\n <AuthorizationRuleStatus>Created</AuthorizationRuleStatus>\\n <SourceCidrs>192.168.XX.XX</SourceCidrs>\\n <DestinationType>Cidr</DestinationType>\\n <Protocol>tcp</Protocol>\\n <DestinationPort>80/80</DestinationPort>\\n <Destination>192.168.XX.XX</Destination>\\n <AuthorizationRuleName>rule01</AuthorizationRuleName>\\n <AuthorizationRuleDescription>rule01</AuthorizationRuleDescription>\\n <AuthorizationRuleId>ar-1234abcb8tmno0hdq****</AuthorizationRuleId>\\n <AuthorizationRuleType>System</AuthorizationRuleType>\\n </AuthorizationRules>\\n</ListAuthorizationRulesResponse>","errorExample":""}]', - 'title' => '查询授权规则', - ], - 'DeleteAuthorizationRule' => [ - 'summary' => '删除授权规则。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIoTCloudConnetorBackhaulRouteResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteIoTCloudConnetorBackhaulRouteResponse>","errorExample":""}]', + 'title' => '删除当前云连接器实例绑定VPC后的回程路由', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-05-06T12:57:35.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIoTCloudConnetorBackhaulRoute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteIoTCloudConnetorBackhaulRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DeleteIpMappingRule' => [ + 'summary' => '调用DeleteIpMappingRule接口删除授权规则IP重定向信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5243,130 +3447,93 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'AuthorizationRuleId', + 'name' => 'IpMappingRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ar-1234abcb8tmno0hdq****', - ], + 'schema' => ['description' => '待删除的IP重定向的授权规则的ID。', 'type' => 'string', 'required' => true, 'example' => 'im-irrp3bzuu5nrbx****'], ], [ '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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.', - ], + ['errorCode' => 'OperationDenied.IotCloudConnectorInGroup', 'errorMessage' => 'The operation is not allowed because of IotCloudConnector In Group.', 'description' => '本次操作不被允许的原因是IotCloudConnector在Group分组中.'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.AuthorizationRule', 'errorMessage' => 'The param of AuthorizationRuleId is illegal.', 'description' => 'AuthorizationRuleId非法'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'IllegalParam.AuthoriztionRuleId', 'errorMessage' => 'The param of AuthoriztionRuleId is illegal.', 'description' => 'AuthoriztionRuleId不存在'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAuthorizationRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DeleteAuthorizationRuleResponse>","errorExample":""}]', - 'title' => '删除授权规则', - ], - 'CreateIoTCloudConnectorGroup' => [ - 'summary' => '创建实例组。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIpMappingRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DeleteIpMappingRuleResponse>","errorExample":""}]', + 'title' => '删除授权规则IP重定向信息', + 'changeSet' => [ + ['createdAt' => '2022-08-22T09:44:29.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIpMappingRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DeleteService' => [ + 'summary' => '删除分应用统计服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5375,93 +3542,44 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例组的名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'cctest', - ], + 'schema' => ['description' => '系统为分应用统计服务生成的ID，全网唯一。', 'type' => 'string', 'required' => true, 'example' => 'c910061f-****-44e6-b659-***c'], ], [ - 'name' => 'Description', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '实例组的描述信息。'."\n" - .'长度为2~256个字符，必须以字母或中文开头，但不能以`http://` 或`https://`开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + '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', - ], + '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', - ], + '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" - .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" - ."\n" - .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Standard', - ], + 'schema' => ['description' => '分应用统计服务所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -5470,49 +3588,45 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'IoTCloudConnectorGroupId' => [ - 'description' => '实例组ID。', - 'type' => 'string', - 'example' => 'iotccg-g00epppbi9di9y****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', - ], + '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' => 'QuotaExceeded.IoTCCGroupInstanceLimit', - 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIoTCloudConnectorGroupResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</CreateIoTCloudConnectorGroupResponse>","errorExample":""}]', - 'title' => '创建实例组', - ], - 'AddIoTCloudConnectorToGroup' => [ - 'summary' => '为实例组添加云连接器实例。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteServiceResponse>","errorExample":""}]', + 'title' => '删除分应用统计服务', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DeleteServiceEntry' => [ + 'summary' => '删除分应用统计条目。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5521,128 +3635,96 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['description' => '系统为分应用统计服务生成的ID，全网唯一。', 'type' => 'string', 'required' => true, 'example' => 'c910061f-****-44e6-b659-***c'], + ], + [ '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, - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'IoTCloudConnectorGroupId', + 'name' => 'ServiceEntryId', 'in' => 'query', - 'schema' => [ - 'description' => '实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '应用条目所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45'], ], ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"<AddIoTCloudConnectorToGroupResponse>\\n <RequestId>cn-hangzhou</RequestId>\\n</AddIoTCloudConnectorToGroupResponse>","errorExample":""}]', - 'title' => '添加云连接器到分组中', - ], - 'UpdateIoTCloudConnectorGroupAttribute' => [ - 'summary' => '修改云连接器分组属性。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceEntryResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</DeleteServiceEntryResponse>","errorExample":""}]', + 'title' => '删除分应用统计条目', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceEntry'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteServiceEntry', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DisableIoTCloudConnectorAccessLog' => [ + 'summary' => '关闭访问日志功能。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5654,136 +3736,83 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '要修改的实例组的描述信息。'."\n" - ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '请求ID。', + 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + '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' => '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIoTCloudConnectorGroupAttributeResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateIoTCloudConnectorGroupAttributeResponse>","errorExample":""}]', - 'title' => '修改云连接器分组属性', - ], - 'ListIoTCloudConnectorGroups' => [ - 'summary' => '查询实例组列表信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableIoTCloudConnectorAccessLogResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DisableIoTCloudConnectorAccessLogResponse>","errorExample":""}]', + 'title' => '关闭访问日志功能', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableIoTCloudConnectorAccessLog'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:DisableIoTCloudConnectorAccessLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'DissociateIpFromConnectionPool' => [ + 'summary' => '解除IP地址与云连接器关联的连接地址池的绑定关系。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5792,139 +3821,64 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorGroupStatus', + 'name' => 'ClientToken', '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, - ], + 'schema' => ['description' => '保证请求幂等性。'."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], [ - 'name' => 'IoTCloudConnectorGroupIds', + 'name' => 'DryRun', '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, - ], + 'schema' => ['description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会解除IP地址与云连接器关联的连接地址池的绑定关系。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后直接解除IP地址与云连接器关联的连接地址池的绑定关系。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'IoTCloudConnectorGroupName', + 'name' => 'RegionId', '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, - ], + 'schema' => ['description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'NextToken', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'MaxResults', + 'name' => 'ConnectionPoolId', 'in' => 'query', - 'schema' => [ - 'description' => '分批次查询时每次显示的条目数。取值：**1**~**50**。默认值：**10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '连接地址池ID。', 'type' => 'string', 'required' => true, 'example' => 'cp-bp11234abctmno0hdq****'], ], [ - 'name' => 'RegionId', + 'name' => 'Ips', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '实例组所在的地域ID。 '."\n" + 'description' => '要解除绑定的IP地址列表。'."\n" + .'最多支持传入500个IP地址。多个IP地址使用半角逗号（,）分隔。', + 'type' => 'array', + 'items' => ['description' => '要解除绑定的IP地址列表。'."\n" + .'最多支持传入500个IP地址。多个IP地址使用半角逗号（,）分隔。'."\n" ."\n" - .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + .'**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' => 'Type', + 'name' => 'IpsFilePath', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例的版本，不同版本有不同功能限制和计费策略。取值：'."\n" - ."\n" - .'- **Basic**：基础版。'."\n" - ."\n" - .'- **Standard**：标准版。'."\n" - ."\n" - .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" - ."\n" - .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Standard', - ], + 'schema' => ['description' => '模板文件OSS地址，即[GetStsInfoAndOssPath](~~313331~~)接口的返回参数**OssPath**。'."\n" + ."\n" + .'格式为`<BucketName>/<uid>/<FileName>`。'."\n" + ."\n" + .'**Ips**和**IpsFilePath**不能同时填写，如果IP数量较少，可直接选择**Ips**方式，如果IP数量较多，建议选择**IpsFilePath**方式，将需要解绑的IP地址记录在模板文件中，整体解绑。', 'type' => 'string', 'required' => false, 'example' => 'cciot-cn-hangzhou/127859184306****/test.csv'], ], ], 'responses' => [ @@ -5933,189 +3887,55 @@ '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" - .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" - ."\n" - .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", - 'type' => 'string', - 'example' => 'Standard', - ], - 'ServiceType' => [ - 'description' => '服务类型。取值：'."\n" - ."\n" - .'- **Normal**：普通型。'."\n" - .'- **CC5G**：云连接器5G实例托管类型。'."\n" - .'- **CC5GCCIoT**：云连接器5G过户类型。', - 'type' => 'string', - 'example' => 'Normal', - ], - ], - ], - ], + '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' => 'ResourceInConfiguring.ConnectionPool', 'errorMessage' => 'The specified resource of ConnectionPool is being configured, please try again later.', 'description' => '实例的连接池当前的状态不对，请稍后再试。'], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'MissingParam.IpParam', 'errorMessage' => 'The param of ip or ip path is missing.', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'OperationDenied.GrantedInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of granted instance not support.', 'description' => '授权实例不允许IP管理相关操作。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - '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":"<ListIoTCloudConnectorGroupsResponse>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <IoTCloudConnectorGroups>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <IoTCloudConnectorGroupStatus>Created</IoTCloudConnectorGroupStatus>\\n <IoTCloudConnectors>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <IoTCloudConnectorStatus>Created</IoTCloudConnectorStatus>\\n <IoTCloudConnectorName>cc01</IoTCloudConnectorName>\\n <IoTCloudConnectorDescription>cc01</IoTCloudConnectorDescription>\\n <ISP>mobile</ISP>\\n <APN>CMWAP</APN>\\n <ServiceType>Normal</ServiceType>\\n </IoTCloudConnectors>\\n <Name>cctest</Name>\\n <Description>test</Description>\\n <Type>Standard</Type>\\n <ServiceType>Normal</ServiceType>\\n </IoTCloudConnectorGroups>\\n</ListIoTCloudConnectorGroupsResponse>","errorExample":""}]', - 'title' => '查询实例组列表信息', - ], - 'RemoveIoTCloudConnectorFromGroup' => [ - 'summary' => '将云连接器实例从实例组中移除。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DissociateIpFromConnectionPoolResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DissociateIpFromConnectionPoolResponse>","errorExample":""}]', + 'title' => '解绑卡IP', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:39.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-21T10:11:40.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-08-27T02:33:48.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2021-08-27T02:33:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-27T02:33:48.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateIpFromConnectionPool'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:DissociateIpFromConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], ], + ], + 'DissociateVSwitchFromIoTCloudConnector' => [ + 'summary' => '将交换机与云连接器实例解关联。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6127,74 +3947,36 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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****', - ], + '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', - ], + '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**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -6203,44 +3985,48 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', - ], + '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' => 'QuotaExceeded.IoTCCGroupInstanceLimit', - 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', - ], - [ - 'errorCode' => 'OperationDenied.CC5GInstanceNotSupport', - 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotAssociated.VpcId', 'errorMessage' => 'The specified resource of VpcId is not associated.', 'description' => '用户VPC不存在'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveIoTCloudConnectorFromGroupResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</RemoveIoTCloudConnectorFromGroupResponse>","errorExample":""}]', - 'title' => '将云连接器实例从实例组中移除', - ], - 'DeleteIoTCloudConnectorGroup' => [ - 'summary' => '删除实例组。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DissociateVSwitchFromIoTCloudConnectorResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DissociateVSwitchFromIoTCloudConnectorResponse>","errorExample":""}]', + 'title' => '解绑vsw/vpc', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateVSwitchFromIoTCloudConnector'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:DissociateVSwitchFromIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'EnableIoTCloudConnectorAccessLog' => [ + 'summary' => '指定云连接器开启访问日志功能。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6249,61 +4035,49 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorGroupId', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '要删除的实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -6312,237 +4086,319 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', - ], + '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' => '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIoTCloudConnectorGroupResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</DeleteIoTCloudConnectorGroupResponse>","errorExample":""}]', - 'title' => '删除实例组', - ], - 'CreateGroupAuthorizationRule' => [ - 'summary' => '实例组创建授权规则。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableIoTCloudConnectorAccessLogResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</EnableIoTCloudConnectorAccessLogResponse>","errorExample":""}]', + 'title' => '开启访问日志功能', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableIoTCloudConnectorAccessLog'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:EnableIoTCloudConnectorAccessLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'GetConnectionPoolIpOperationResult' => [ + 'summary' => '获取IP地址与连接地址池绑定与解绑的操作结果。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AuthorizationRuleDescription', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则的描述信息。'."\n" - ."\n" - .'长度为2~256个字符，必须以字母或中文开头，但不能以`http://` 或`https://`开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'rule', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'AuthorizationRuleName', + 'name' => 'ConnectionPoolId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则的名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'ruletest', - ], + 'schema' => ['description' => '连接地址池ID。', 'type' => 'string', 'required' => true, 'example' => 'cp-0gd9qnmv8431rh****'], ], [ - 'name' => 'SourceCidrs', + 'name' => 'QueryRequestId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => '查询请求ID，即调用[AssociateIpWithConnectionPool](~~313334~~)或[DissociateIpFromConnectionPool](~~313335~~)接口，操作成功后返回的**RequestId**。', 'type' => 'string', 'required' => true, 'example' => 'CFA63CEB-15B6-4AE8-B203-F855FF7BA962'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '源CIDR地址块。最多支持20个CIDR地址块。', - 'type' => 'array', - 'items' => [ - 'description' => '源CIDR地址块。最多支持20个CIDR地址块。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.1/24', + '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://<BucketName.oss域名>/ipma/<执行结果文件>?<超期信息>&<临时AK/SK信息>&<签名信息>`。'."\n" + ."\n" + .'文件内容为绑定和解绑的错误IP地址或错误原因列表，如果该字段为空，代表没有失败记录。', + 'type' => 'array', + 'items' => ['description' => '绑定与解绑的执行结果文件地址，即调用[AssociateIpWithConnectionPool](~~313334~~)或[DissociateIpFromConnectionPool](~~313335~~)接口执行结果文件下载地址。格式为`https://<BucketName.oss域名>/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'], + ], ], - 'required' => true, - 'maxItems' => 200, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ], + ], + '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":"<GetConnectionPoolIpOperationResultResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA651</RequestId>\\n <ResultFilePaths>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</ResultFilePaths>\\n</GetConnectionPoolIpOperationResultResponse>","errorExample":""}]', + 'title' => '获取IP地址绑定与解绑结果', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionPoolIpOperationResult'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ [ - 'name' => 'DestinationType', - 'in' => 'query', - 'schema' => [ - 'description' => '访问目标类型。取值：'."\n" - .'- **Cidr**：CIDR地址块。'."\n" - .'- **Domain**：域名。', - 'type' => 'string', - 'required' => true, - 'example' => 'Cidr', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:GetConnectionPoolIpOperationResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], ], ], + ], + ], + 'GetDiagnoseResultForSingleCard' => [ + 'summary' => '获取单卡诊断结果。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], + ], + 'parameters' => [ [ - 'name' => 'Protocol', + 'name' => 'DiagnoseTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '协议类型。取值：'."\n" - ."\n" - .'- **tcp**。'."\n" - .'- **udp**。'."\n" - .'- **icmp**。'."\n" - .'- **all**：支持所有协议。', - 'type' => 'string', - 'required' => false, - 'example' => 'tcp', - ], + 'schema' => ['description' => '网络诊断任务ID。', 'type' => 'string', 'required' => true, 'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****'], ], [ - 'name' => 'Destination', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '网络诊断的云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '访问目标地址。', - 'type' => 'string', - 'required' => true, - 'example' => '47.0.XX.XX', + '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.', 'description' => 'RAM用户无权限执行此操作。'], + ], + ], + '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":"<GetDiagnoseResultForSingleCardResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <IoTCloudConnectorId>iotcc-smy9a5ockzp08n****</IoTCloudConnectorId>\\n <CardIp>169.254.XX.XX</CardIp>\\n <IccId>89860477*******27546</IccId>\\n <Destination>114.114.XX.XX</Destination>\\n <BeginTime>1643077466</BeginTime>\\n <EndTime>1643077666</EndTime>\\n <Status>failed</Status>\\n <ErrorResult>\\n <ErrorLevel>Warning</ErrorLevel>\\n <ErrorPart>Terminal</ErrorPart>\\n <ErrorDesc>Terminal abnormal</ErrorDesc>\\n <ErrorSuggestion>Please check whether the terminal and card are compatible or whether the terminal can send messages</ErrorSuggestion>\\n </ErrorResult>\\n <DiagnoseItem>\\n <Part>Terminal</Part>\\n <Status>Normal</Status>\\n </DiagnoseItem>\\n</GetDiagnoseResultForSingleCardResponse>","errorExample":""}]', + 'title' => '获取单卡诊断结果', + 'changeSet' => [ + ['createdAt' => '2022-02-15T02:36:16.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDiagnoseResultForSingleCard'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:GetDiagnoseResultForSingleCard', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + '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' => 'DryRun', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会为实例组创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'RegionId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '实例组所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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' => 'Policy', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '访问策略。取值：'."\n" - ."\n" - .'- **Permit**：允许。'."\n" - ."\n" - .'- **Deny**：拒绝。', - 'type' => 'string', - 'required' => true, - 'example' => 'Permit', - ], + 'schema' => ['description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会获取访问日志状态信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接获取访问日志状态信息。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Type', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则的类型。取值：'."\n" - ."\n" - .'- **System**，表示授权规则的类型为系统类型。'."\n" - ."\n" - .'- **Customer**：表示授权规则的类型为自定义类型。'."\n" - ."\n" - .'- **Default**：表示授权规则的类型为默认类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'System', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -6551,70 +4407,52 @@ '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****', - ], + '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.', - ], - [ - '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AuthorizationRuleId\\": \\"gar-ez91t41jvi6tr8****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupAuthorizationRuleResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <AuthorizationRuleId>gar-ez91t41jvi6tr8****</AuthorizationRuleId>\\n</CreateGroupAuthorizationRuleResponse>","errorExample":""}]', - 'title' => '实例组创建授权规则', - ], - 'UpdateGroupAuthorizationRuleAttribute' => [ - 'summary' => '修改实例组的授权规则。', - 'methods' => [ - 'post', - 'get', + '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":"<GetIoTCloudConnectorAccessLogResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AccessLogSlsProject>sls-setter</AccessLogSlsProject>\\n <AccessLogSlsLogStore>test</AccessLogSlsLogStore>\\n <AccessLogStatus>Opened</AccessLogStatus>\\n</GetIoTCloudConnectorAccessLogResponse>","errorExample":""}]', + 'title' => '获取指定云连接器访问日志', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIoTCloudConnectorAccessLog'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:GetIoTCloudConnectorAccessLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'GetStsInfoAndOssPath' => [ + 'summary' => '获取服务账号STS信息和模板文件临时提交地址。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6623,177 +4461,242 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorGroupId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '保证请求幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], [ - 'name' => 'AuthorizationRuleDescription', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则的描述信息。'."\n" - ."\n" - .'长度为2~256个字符，必须以字母或中文开头，但不能以`http://` 或`https://`开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'rule', - ], + 'schema' => ['description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会获取信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后直接获取信息。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'AuthorizationRuleName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则的名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'ruletest', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AuthorizationRuleId', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '要修改的授权规则ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gar-ez91t41jvi6tr8****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'SourceCidrs', + 'name' => 'ConnectionPoolId', '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, - ], + 'schema' => ['description' => '连接地址池的ID。', 'type' => 'string', 'required' => true, 'example' => 'cp-bp11234abctmno0hdq****'], ], [ - 'name' => 'DestinationType', + 'name' => 'FileName', 'in' => 'query', + 'schema' => ['description' => '模板文件名称。'."\n" + ."\n" + .'模板文件仅支持CSV格式。', 'type' => 'string', 'required' => false, 'example' => 'test.csv'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '访问目标类型。取值：'."\n" - .'- **Cidr**：CIDR地址块。'."\n" - .'- **Domain**：域名。', - 'type' => 'string', - 'required' => false, - 'example' => 'Cidr', + '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' => '<yourAccessKeyId>'], + 'AccessKeySecret' => ['title' => 'Sts info of accessKeySecret', 'description' => 'STS临时AccessKey Secret。', 'type' => 'string', 'example' => '<yourAccessKeySecret>'], + 'SecurityToken' => ['title' => 'Sts info of securityToken', 'description' => 'STS安全令牌。', 'type' => 'string', 'example' => '<yourSecurityToken>'], + 'OssPath' => ['title' => 'OssPath', 'description' => '模板文件提交临时地址。'."\n" + ."\n" + .'格式为`<BucketName>/<uid>/<FileName>`。'."\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.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"Expiration\\": \\"1633060876\\",\\n \\"AccessKeyId\\": \\"<yourAccessKeyId>\\",\\n \\"AccessKeySecret\\": \\"<yourAccessKeySecret>\\",\\n \\"SecurityToken\\": \\"<yourSecurityToken>\\",\\n \\"OssPath\\": \\"cciot-cn-hangzhou/127859184306****/test.csv\\"\\n}","errorExample":""},{"type":"xml","example":"<GetStsInfoAndOssPathResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <Expiration>1633060876</Expiration>\\n <AccessKeyId><yourAccessKeyId></AccessKeyId>\\n <AccessKeySecret><yourAccessKeySecret></AccessKeySecret>\\n <SecurityToken><yourSecurityToken></SecurityToken>\\n <OssPath>cciot-cn-hangzhou/127859184306****/test.csv</OssPath>\\n</GetStsInfoAndOssPathResponse>","errorExample":""}]', + 'title' => '获取服务账号信息和提交地址', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetStsInfoAndOssPath'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:GetStsInfoAndOssPath', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], ], ], + ], + ], + 'GrantVirtualBorderRouter' => [ + 'summary' => '获取边界路由器VBR的服务关联角色SLR权限。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Protocol', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VirtualBorderRouterId', 'in' => 'query', - 'schema' => [ - 'description' => '协议类型。取值：'."\n" - ."\n" - .'- **tcp**。'."\n" - .'- **udp**。'."\n" - .'- **icmp**。'."\n" - .'- **all**：支持所有协议。', - 'type' => 'string', - 'required' => false, - 'example' => 'tcp', - ], + 'schema' => ['description' => '边界路由器VBR实例ID。', 'type' => 'string', 'required' => false, 'example' => 'vbr-bp1svadp4lq38janc****'], ], [ - 'name' => 'Destination', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '边界路由器VBR实例所在的地域ID。 '."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '访问目标。', - 'type' => 'string', - 'required' => false, - 'example' => '47.0.XX.XX', + '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.', 'description' => 'RAM用户无权限执行此操作。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<GrantVirtualBorderRouterResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</GrantVirtualBorderRouterResponse>","errorExample":""}]', + 'title' => '授权绑定VBR', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-08-02T03:06:14.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantVirtualBorderRouter'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ [ - 'name' => 'Policy', - 'in' => 'query', - 'schema' => [ - 'description' => '访问策略。取值：'."\n" - ."\n" - .'- **Permit**：允许。'."\n" - ."\n" - .'- **Deny**：拒绝。', - 'type' => 'string', - 'required' => false, - 'example' => 'Permit', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:GrantVirtualBorderRouter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ListAPNs' => [ + 'summary' => '查询云连接器实例支持的APN列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClientToken', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', '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', - ], + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + ."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'], ], [ - 'name' => 'DryRun', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会修改实例组的授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + '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', - ], + '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" + .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" + ."\n" + .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard'], ], ], 'responses' => [ @@ -6802,20 +4705,44 @@ '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****', + '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'], + ], + ], + ], ], ], ], @@ -6823,45 +4750,40 @@ ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AuthorizationRuleId\\": \\"gar-ez91t41jvi6tr8****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateGroupAuthorizationRuleAttributeResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <AuthorizationRuleId>gar-ez91t41jvi6tr8****</AuthorizationRuleId>\\n</UpdateGroupAuthorizationRuleAttributeResponse>","errorExample":""}]', - 'title' => '修改实例组的授权规则', - ], - 'ListGroupAuthorizationRules' => [ - 'summary' => '查询实例组的授权规则信息。', - 'methods' => [ - 'post', - 'get', + '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":"<ListAPNsResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <APNs>\\n <ISP>mobile</ISP>\\n <APN>CMWAP</APN>\\n <Name>test</Name>\\n <Description>test</Description>\\n <ZoneList>[\\"eu-central-1a\\", \\"eu-central-1b\\"]</ZoneList>\\n <FeatureList>trafficMirror</FeatureList>\\n </APNs>\\n</ListAPNsResponse>","errorExample":""}]', + 'title' => '查询APN', + 'changeSet' => [ + ['createdAt' => '2022-06-20T09:08:14.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-08-27T02:33:48.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAPNs'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iotcc:ListAPNs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListAuthorizationRules' => [ + 'summary' => '查询授权规则信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6870,39 +4792,27 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorGroupId', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ 'name' => 'AuthorizationRuleIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '授权规则ID。最多支持20个授权规则ID。', + 'description' => '授权规则ID列表。最多支持传入20个授权规则ID。', 'type' => 'array', - 'items' => [ - 'description' => '授权规则ID。最多支持20个授权规则ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gar-ez91t41jvi6tr8****', - ], + 'items' => ['description' => '授权规则ID列表。最多支持传入20个授权规则ID。', 'type' => 'string', 'required' => false, 'example' => 'ar-1234abcb8tmno0hdq****'], 'required' => false, - 'maxItems' => 20, + 'maxItems' => 100, 'minItems' => 1, ], ], @@ -6911,37 +4821,13 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '访问目标类型。最多支持20个目标类型。取值：'."\n" + '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个目标地址。', + .'- **Domain**：域名。', 'type' => 'array', - 'items' => [ - 'description' => '访问目标地址。最多支持20个目标地址。', - 'type' => 'string', - 'required' => false, - 'example' => '47.0.XX.XX', - ], + 'items' => ['description' => '访问目标类型。最多支持传入20个访问目标类型。取值：'."\n" + .'- **Cidr**：CIDR地址块。'."\n" + .'- **Domain**：域名。', 'type' => 'string', 'required' => false, 'example' => 'Cidr'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -6952,24 +4838,19 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '协议类型。取值：'."\n" + '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', - ], + 'items' => ['description' => '协议类型。最多支持输入20个协议类型。取值：'."\n" + ."\n" + .'- **tcp**。'."\n" + .'- **udp**。'."\n" + .'- **icmp**。'."\n" + .'- **all**：支持所有协议。', 'type' => 'string', 'required' => false, 'example' => 'tcp'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -6980,22 +4861,30 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '目标端口范围。最多支持20个访问目标端口。取值范围：'."\n" + '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', - ], + '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, @@ -7006,30 +4895,17 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '授权规则状态。最多支持20个授权规则状态。取值：'."\n" - ."\n" + 'description' => '授权规则状态。最多支持传入20个授权规则状态。取值：'."\n" .'- **Creating**：创建中。'."\n" - ."\n" .'- **Created**：创建完成。'."\n" - ."\n" .'- **Deleting**：删除中。'."\n" - ."\n" - .'- **Updating**：更新中。', + .'- **Updating**：更新中。'."\n", 'type' => 'array', - 'items' => [ - 'description' => '授权规则状态。最多支持20个授权规则状态。取值：'."\n" - ."\n" - .'- **Creating**：创建中。'."\n" - ."\n" - .'- **Created**：创建完成。'."\n" - ."\n" - .'- **Deleting**：删除中。'."\n" - ."\n" - .'- **Updating**：更新中。', - 'type' => 'string', - 'required' => false, - 'example' => 'Created', - ], + 'items' => ['description' => '授权规则状态。最多支持传入20个授权规则状态。取值：'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Created**：创建完成。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **Updating**：更新中。', 'type' => 'string', 'required' => false, 'example' => 'Created'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -7040,18 +4916,13 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '授权规则的名称。最多支持20个授权规则名称。'."\n" + 'description' => '授权规则名称。最多支持传入20个授权规则名称。'."\n" ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', 'type' => 'array', - 'items' => [ - 'description' => '授权规则的名称。最多支持20个授权规则名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'ruletest', - ], + 'items' => ['description' => '授权规则名称。最多支持传入20个授权规则名称。'."\n" + ."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'rule01'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -7062,22 +4933,13 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '访问策略。最多支持20个访问策略。取值：'."\n" - ."\n" + 'description' => '访问策略。最多支持传入20个访问策略。'."\n" .'- **Permit**：允许。'."\n" - ."\n" .'- **Deny**：拒绝。', 'type' => 'array', - 'items' => [ - 'description' => '访问策略。最多支持20个访问策略。取值：'."\n" - ."\n" - .'- **Permit**：允许。'."\n" - ."\n" - .'- **Deny**：拒绝。', - 'type' => 'string', - 'required' => false, - 'example' => 'Permit', - ], + 'items' => ['description' => '访问策略。最多支持传入20个访问策略。取值：'."\n" + .'- **Permit**：允许。'."\n" + .'- **Deny**：拒绝。', 'type' => 'string', 'required' => false, 'example' => 'Permit'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -7086,184 +4948,105 @@ [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Type', + 'name' => 'AuthorizationRuleType', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则的类型。取值：'."\n" - ."\n" - .'- **System**，表示授权规则的类型为系统类型。'."\n" - .'- **Customer**：表示授权规则的类型为自定义类型。'."\n" - .'- **Default**：表示授权规则的类型为默认类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'System', - ], + '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' => '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' => [ + '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' => [ - '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', - ], + '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.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', - ], + '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'], ], ], ], @@ -7273,102 +5056,100 @@ ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - '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":"<ListGroupAuthorizationRulesResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <GroupAuthorizationRules>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <Policy>Permit</Policy>\\n <AuthorizationRuleStatus>Created</AuthorizationRuleStatus>\\n <SourceCidrs>192.168.0.0/32</SourceCidrs>\\n <DestinationType>Cidr</DestinationType>\\n <DestinationPort>80/80</DestinationPort>\\n <Protocol>tcp</Protocol>\\n <Destination>47.0.XX.XX</Destination>\\n <AuthorizationRuleName>ruletest</AuthorizationRuleName>\\n <AuthorizationRuleDescription>rule</AuthorizationRuleDescription>\\n <AuthorizationRuleId>gar-ez91t41jvi6tr8****</AuthorizationRuleId>\\n <Type>System</Type>\\n </GroupAuthorizationRules>\\n</ListGroupAuthorizationRulesResponse>","errorExample":""}]', - 'title' => '查询实例组的授权规则', - ], - 'DeleteGroupAuthorizationRule' => [ - 'summary' => '删除实例组的授权规则。', - 'methods' => [ - 'post', - 'get', + '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":"<ListAuthorizationRulesResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <MaxResults>10</MaxResults>\\n <AuthorizationRules>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <Policy>Permit</Policy>\\n <AuthorizationRuleStatus>Created</AuthorizationRuleStatus>\\n <SourceCidrs>192.168.XX.XX</SourceCidrs>\\n <DestinationType>Cidr</DestinationType>\\n <Protocol>tcp</Protocol>\\n <DestinationPort>80/80</DestinationPort>\\n <Destination>192.168.XX.XX</Destination>\\n <AuthorizationRuleName>rule01</AuthorizationRuleName>\\n <AuthorizationRuleDescription>rule01</AuthorizationRuleDescription>\\n <AuthorizationRuleId>ar-1234abcb8tmno0hdq****</AuthorizationRuleId>\\n <AuthorizationRuleType>System</AuthorizationRuleType>\\n </AuthorizationRules>\\n</ListAuthorizationRulesResponse>","errorExample":""}]', + 'title' => '查询授权规则', + 'changeSet' => [ + ['createdAt' => '2023-03-02T09:17:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-08-18T12:16:22.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-08-04T08:05:47.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-07-07T09:41:08.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAuthorizationRules'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListAuthorizationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], ], + ], + 'ListConnectionPoolAllIps' => [ + 'summary' => '查询连接地址池所有IP地址信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorGroupId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'], ], [ - 'name' => 'AuthorizationRuleId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gar-ez91t41jvi6tr8****', - ], + 'schema' => ['description' => '分批次查询时每次显示的条目数。取值：**1**~**50**。默认值：**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2000', 'minimum' => '1', 'example' => '10', 'default' => '50'], ], [ - 'name' => 'ClientToken', + 'name' => 'RegionId', '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DryRun', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会删除实例组的授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'RegionId', + 'name' => 'ConnectionPoolId', 'in' => 'query', - 'schema' => [ - 'description' => '实例组所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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' => [ @@ -7377,10 +5158,33 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', + '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'], + ], + ], ], ], ], @@ -7388,257 +5192,110 @@ ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.ConnectionPool', 'errorMessage' => 'The specified resource of connection pool is not found.', 'description' => '未找到连接地址池。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGroupAuthorizationRuleResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</DeleteGroupAuthorizationRuleResponse>","errorExample":""}]', - 'title' => '删除实例组的授权规则', - ], - 'GrantVirtualBorderRouter' => [ - 'summary' => '获取边界路由器VBR的服务关联角色SLR权限。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + '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":"<ListConnectionPoolAllIpsResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <TotalIpsCount>1</TotalIpsCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <ConnectionPoolIps>\\n <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>\\n <Ip>192.168.0.1</Ip>\\n <Status>activated</Status>\\n <Type>Cidr</Type>\\n <IpNum>254</IpNum>\\n </ConnectionPoolIps>\\n</ListConnectionPoolAllIpsResponse>","errorExample":""}]', + 'title' => '查询连接地址池所有IP地址', + 'changeSet' => [ + ['createdAt' => '2022-06-08T06:27:23.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-21T08:47:54.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-16T11:28:01.000Z', 'description' => 'OpenAPI 下线'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnectionPoolAllIps'], ], - 'tenantRelevance' => 'publicInformation', + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'parameters' => [ - [ - 'name' => 'VirtualBorderRouterId', - 'in' => 'query', - 'schema' => [ - 'description' => '边界路由器VBR实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vbr-bp1svadp4lq38janc****', - ], - ], + 'ramActions' => [ [ - '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', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListConnectionPoolAllIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], ], ], ], ], - '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":"<GrantVirtualBorderRouterResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</GrantVirtualBorderRouterResponse>","errorExample":""}]', - 'title' => '授权绑定VBR', ], - 'CreateDNSServiceRule' => [ - 'summary' => '创建DNS授权规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListConnectionPoolIps' => [ + 'summary' => '查询连接地址池中的IP地址状态信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'name' => 'NextToken', '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" - .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" - .'</props>'."\n" - ."\n" - .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>', - 'type' => 'string', - 'required' => true, - 'example' => '100.100.2.138', - ], + 'schema' => ['description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****'], ], [ - 'name' => 'DNSServiceRuleName', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'DNS授权规则名称。'."\n" - ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '分页大小，取值：**1**~**2000**。传入为空时，默认值为**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2000', 'minimum' => '1', 'example' => '10', 'default' => '50'], ], [ - 'name' => 'DNSServiceRuleDescription', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'DNS授权规则描述。'."\n" - ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ClientToken', + 'name' => 'IoTCloudConnectorId', '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', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => false, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'DryRun', + 'name' => 'ConnectionPoolId', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会创建DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行创建。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '连接地址池的ID。', 'type' => 'string', 'required' => false, 'example' => 'cp-bp11234abctmno0hdq****'], ], [ - 'name' => 'RegionId', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'description' => 'DNS授权规则所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01', - ], - 'DNSServiceRuleId' => [ - 'description' => 'DNS授权规则ID。', - 'type' => 'string', - 'example' => 'ar-r56ijpurlu50gi****', + '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'], + ], + ], ], ], ], @@ -7646,73 +5303,38 @@ ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\",\\n \\"DNSServiceRuleId\\": \\"ar-r56ijpurlu50gi****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDNSServiceRuleResponse>\\n <RequestId>BC6D1C1D-6DBD-568C-B867-BC9CA699ED01</RequestId>\\n <DNSServiceRuleId>ar-r56ijpurlu50gi****</DNSServiceRuleId>\\n</CreateDNSServiceRuleResponse>","errorExample":""}]', - 'title' => '创建DNS授权规则', - ], - 'UpdateDNSServiceRuleAttribute' => [ - 'summary' => '修改DNS授权规则。', - 'methods' => [ - 'post', - 'get', + '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":"<ListConnectionPoolIpsResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>2</TotalCount>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <MaxResults>10</MaxResults>\\n <ConnectionPoolIps>\\n <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>\\n <Ip>192.168.XX.XX</Ip>\\n <Status>activated</Status>\\n </ConnectionPoolIps>\\n</ListConnectionPoolIpsResponse>","errorExample":""}]', + 'title' => '查询连接地址池中的IP地址状态', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnectionPoolIps'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListConnectionPoolIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], ], + ], + 'ListConnectionPools' => [ + 'summary' => '查询云连接地址池。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7721,149 +5343,125 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'ServiceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'DNS授权规则的目标类型。取值：'."\n" - ."\n" - .'- **Normal**：普通类型。'."\n" - ."\n" - .'- **DNSRedirect**：重定向类型，重定向类型指将当前DNS服务地址重定向至另一个地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], - ], - [ - 'name' => 'Destination', + 'name' => 'ConnectionPoolIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '重定向后的DNS服务地址。'."\n" - ."\n" - .'> 当**ServiceType**参数取值为**DNSRedirect**时，该参数必选。', - 'type' => 'string', + 'description' => '连接地址池的ID列表。最多支持传入20个连接地址池ID。', + 'type' => 'array', + 'items' => ['description' => '连接地址池的ID列表。最多支持传入20个连接地址池ID。', 'type' => 'string', 'required' => false, 'example' => 'cp-bp11234abctmno0hdq****'], 'required' => false, - 'example' => '192.168.0.2', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'Source', + 'name' => 'ConnectionPoolName', 'in' => 'query', + 'style' => 'repeatList', '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" - .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" - .'</props>'."\n" + 'description' => '连接地址池的名称。最多支持传入20个连接地址池名称。'."\n" ."\n" - .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>', - 'type' => 'string', - 'required' => false, - 'example' => '100.100.2.138', - ], - ], - [ - 'name' => 'DNSServiceRuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'DNS授权规则名称。'."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', + 'type' => 'array', + 'items' => ['description' => '连接地址池的名称。最多支持传入20个连接地址池名称。'."\n" ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'pool01'], 'required' => false, - 'example' => 'test', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'DNSServiceRuleDescription', + 'name' => 'ConnectionPoolStatus', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'DNS授权规则描述。'."\n" - ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', + '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, - 'example' => 'description', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'ClientToken', + 'name' => 'NextToken', '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', - ], + 'schema' => ['description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****'], ], [ - 'name' => 'DryRun', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会修改DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行修改。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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' => 'DNS授权规则所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01', + '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'], + ], + ], ], ], ], @@ -7871,65 +5469,39 @@ ], '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.', + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ], + ], + '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":"<ListConnectionPoolsResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>2</TotalCount>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <MaxResults>50</MaxResults>\\n <ConnectionPools>\\n <ConnectionPoolId>cp-bp11234abctmno0hdq****</ConnectionPoolId>\\n <ConnectionPoolStatus>Running</ConnectionPoolStatus>\\n <ConnectionPoolName>pool01</ConnectionPoolName>\\n <ConnectionPoolDescription>pool01</ConnectionPoolDescription>\\n <Cidrs>192.168.XX.XX/32</Cidrs>\\n <OperateResultRequestID>CEF72CEB-54B6-4AE8-B225-F876FF7BA651</OperateResultRequestID>\\n </ConnectionPools>\\n</ListConnectionPoolsResponse>","errorExample":""}]', + 'title' => '查询云连接地址池', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnectionPools'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListConnectionPools', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateDNSServiceRuleAttributeResponse>\\n <RequestId>BC6D1C1D-6DBD-568C-B867-BC9CA699ED01</RequestId>\\n</UpdateDNSServiceRuleAttributeResponse>","errorExample":""}]', - 'title' => '修改DNS授权规则', ], 'ListDNSServiceRules' => [ 'summary' => '查询DNS授权规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7941,20 +5513,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-1y6h8z7imd2yu4****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-1y6h8z7imd2yu4****'], ], [ 'name' => 'DNSServiceRuleIds', @@ -7963,12 +5528,7 @@ 'schema' => [ 'description' => 'DNS授权规则ID。', 'type' => 'array', - 'items' => [ - 'description' => 'DNS授权规则ID。最多支持输入20个规则ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ar-c1dk4jb73j5791****', - ], + 'items' => ['description' => 'DNS授权规则ID。最多支持输入20个规则ID。', 'type' => 'string', 'required' => false, 'example' => 'ar-c1dk4jb73j5791****'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -7977,16 +5537,11 @@ [ 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'description' => 'DNS授权规则的目标类型。取值：'."\n" - ."\n" - .'- **Normal**：普通类型。'."\n" - ."\n" - .'- **DNSRedirect**：重定向类型，重定向类型指将当前DNS服务地址重定向至另一个地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => 'DNS授权规则的目标类型。取值：'."\n" + ."\n" + .'- **Normal**：普通类型。'."\n" + ."\n" + .'- **DNSRedirect**：重定向类型，重定向类型指将当前DNS服务地址重定向至另一个地址。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], ], [ 'name' => 'Destination', @@ -7995,14 +5550,9 @@ 'schema' => [ 'description' => '目标DNS授权规则IP地址。', 'type' => 'array', - 'items' => [ - 'description' => '重定向后的DNS服务地址。最多支持输入20个目标IP地址。'."\n" - ."\n" - .'> 当**ServiceType**参数取值为**DNSRedirect**时，该参数必选。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.2', - ], + 'items' => ['description' => '重定向后的DNS服务地址。最多支持输入20个目标IP地址。'."\n" + ."\n" + .'> 当**ServiceType**参数取值为**DNSRedirect**时，该参数必选。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.2'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -8015,20 +5565,15 @@ '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', - ], + '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, @@ -8041,14 +5586,9 @@ 'schema' => [ 'description' => 'DNS授权规则名称。最多支持输入20个规则名称。', 'type' => 'array', - 'items' => [ - 'description' => 'DNS授权规则名称。最多支持输入20个规则名称。'."\n" - ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['description' => 'DNS授权规则名称。最多支持输入20个规则名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -8061,19 +5601,14 @@ '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" - .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" - .'</props>'."\n" - ."\n" - .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.100.2.138', - ], + '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" + .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\n", 'type' => 'string', 'required' => false, 'example' => '100.100.2.138'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -8082,40 +5617,21 @@ [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -8124,30 +5640,12 @@ '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', - ], + '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', @@ -8155,71 +5653,39 @@ '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" - .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" - .'</props>'."\n" - ."\n" - .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\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****', - ], + '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" + .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\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****'], ], ], ], @@ -8229,236 +5695,90 @@ ], '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], '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":"<ListDNSServiceRulesResponse>\\n <RequestId>4A63118E-B375-5718-8F03-30F6804E1DCD</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <DNSServiceRules>\\n <IoTCloudConnectorId>iotcc-1y6h8z7imd2yu4****</IoTCloudConnectorId>\\n <ServiceType>Normal</ServiceType>\\n <Source>100.100.2.138</Source>\\n <Destination>192.168.0.2</Destination>\\n <DNSServiceRuleStatus>Created</DNSServiceRuleStatus>\\n <DNSServiceRuleName>test</DNSServiceRuleName>\\n <DNSServiceRuleDescription>description</DNSServiceRuleDescription>\\n <DNSServiceRuleId>ar-c1dk4jb73j5791****</DNSServiceRuleId>\\n </DNSServiceRules>\\n</ListDNSServiceRulesResponse>","errorExample":""}]', 'title' => '查询DNS授权规则', - ], - 'DeleteDNSServiceRule' => [ - 'summary' => '删除DNS授权规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDNSServiceRules'], ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], - ], - 'parameters' => [ + 'ramActions' => [ [ - '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', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListDNSServiceRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - '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":"<DeleteDNSServiceRuleResponse>\\n <RequestId>BC6D1C1D-6DBD-568C-B867-BC9CA699ED01</RequestId>\\n</DeleteDNSServiceRuleResponse>","errorExample":""}]', - 'title' => '删除DNS授权规则', ], - 'MoveAuthorizationRuleToDNSService' => [ - 'summary' => '将授权规则转移到DNS授权规则中。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDiagnoseInfoForSingleCard' => [ + 'summary' => '查询单卡诊断的诊断结果信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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-1y6h8z7imd2yu4****', - ], + 'schema' => ['description' => '网络诊断的云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-smy9a5ockzp08n****'], ], [ - 'name' => 'AuthorizationRuleId', + 'name' => 'SourceType', 'in' => 'query', - 'schema' => [ - 'description' => '授权规则ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ar-la6sn6gng90e1x****', - ], + 'schema' => ['description' => '网络诊断的源类型。取值：'."\n" + ."\n" + .'- **卡IP**：表示通过物联网卡的卡IP进行网络诊断。'."\n" + ."\n" + .'- **卡ID**：表示通过物联网卡的卡ID进行网络诊断。', 'type' => 'string', 'required' => false, 'example' => '卡IP'], ], [ - 'name' => 'ClientToken', + 'name' => 'Source', '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', - ], + 'schema' => ['description' => '网络诊断的源端卡IP或者卡ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '169.254.XX.XX'], ], [ - 'name' => 'DryRun', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会转移授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行转移。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'], ], [ - 'name' => 'RegionId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'> 目前，支持开通云连接器的地域：华东1（杭州）、华东2（上海）、华北1（青岛）、华北2（北京）、华北5（呼和浩特）、华北6（乌兰察布）、华南1（深圳）、华南3（广州）、西南1（成都）、德国（法兰克福）。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '分批次查询时每次显示的条目数。取值范围：**1~100**。默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -8467,45 +5787,86 @@ 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '862D2D7E-E6A9-5645-9CA0-64B520256A7B', + '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' => 'QuotaExceeded.IoTCCGroupInstanceLimit', - 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', - ], - [ - 'errorCode' => 'OperationDenied.CC5GInstanceNotSupport', - 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"862D2D7E-E6A9-5645-9CA0-64B520256A7B\\"\\n}","errorExample":""},{"type":"xml","example":"<MoveAuthorizationRuleToDNSServiceResponse>\\n <RequestId>862D2D7E-E6A9-5645-9CA0-64B520256A7B</RequestId>\\n</MoveAuthorizationRuleToDNSServiceResponse>","errorExample":""}]', - 'title' => '授权规则转移到DNS授权规则', - 'description' => '> 只允许将授权规则中访问目标类型为**Cidr**且目的地址为DNS IP的规则转移到DNS授权规则中，您可以通过调用[ListAuthorizationRules](~~298298~~)接口查看实例组授权规则的访问目标类型和目的地址。', - ], - 'CreateGroupDNSServiceRule' => [ - 'summary' => '实例组创建DNS授权规则。', - 'methods' => [ - 'post', - 'get', + '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":"<ListDiagnoseInfoForSingleCardResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <DiagnoseInfo>\\n <IoTCloudConnectorId>iotcc-smy9a5ockzp08n****</IoTCloudConnectorId>\\n <CardIp>169.254.XX.XX</CardIp>\\n <IccId>89860477*******27546</IccId>\\n <SourceType>卡IP</SourceType>\\n <Source>169.254.XX.XX</Source>\\n <DestinationType>IP</DestinationType>\\n <Destination>114.114.XX.XX</Destination>\\n <BeginTime>1643077466</BeginTime>\\n <EndTime>1643077666</EndTime>\\n <Status>completed</Status>\\n <DiagnoseTime>1649669904</DiagnoseTime>\\n <TaskId>diagnoseTask-bp2qhwdp2n9x6zkvq****</TaskId>\\n </DiagnoseInfo>\\n <TotalCount>10</TotalCount>\\n</ListDiagnoseInfoForSingleCardResponse>","errorExample":""}]', + 'title' => '查询单卡诊断的诊断结果信息', + 'changeSet' => [ + ['createdAt' => '2022-02-21T08:46:11.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-15T02:32:00.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseInfoForSingleCard'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListDiagnoseInfoForSingleCard', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'ListGroupAuthorizationRules' => [ + 'summary' => '查询实例组的授权规则信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8514,338 +5875,265 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'DNSServiceRuleDescription', + 'name' => 'AuthorizationRuleIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'DNS授权规则描述。'."\n" - ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', + 'description' => '授权规则ID。最多支持20个授权规则ID。', + 'type' => 'array', + 'items' => ['description' => '授权规则ID。最多支持20个授权规则ID。', 'type' => 'string', 'required' => false, 'example' => 'gar-ez91t41jvi6tr8****'], 'required' => false, - 'example' => 'description', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'DNSServiceRuleName', + 'name' => 'DestinationType', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'DNS授权规则名称。'."\n" - ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', + '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, - '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" - .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" - .'</props>'."\n" - ."\n" - .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\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', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ 'name' => 'Destination', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '目标DNS授权规则IP地址。'."\n" - ."\n" - .'> 当**ServiceType**参数取值为**DNSRedirect**时，该参数必选。', - 'type' => 'string', + 'description' => '访问目标地址。最多支持20个目标地址。', + 'type' => 'array', + 'items' => ['description' => '访问目标地址。最多支持20个目标地址。', 'type' => 'string', 'required' => false, 'example' => '47.0.XX.XX'], 'required' => false, - 'example' => '192.168.0.2', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'ClientToken', + 'name' => 'Protocol', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + 'description' => '协议类型。取值：'."\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', + .'- **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, - 'example' => 'false', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'RegionId', + 'name' => 'DestinationPort', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '云连接器实例组所在的地域ID。'."\n" + 'description' => '目标端口范围。最多支持20个访问目标端口。取值范围：'."\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":"<CreateGroupDNSServiceRuleResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>77111A6A-56BA-59B2-8CAA-7CBF21648FB8</RequestId>\\n <DNSServiceRuleId>gar-ffnn1ewe2nmf3y****</DNSServiceRuleId>\\n</CreateGroupDNSServiceRuleResponse>","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" + .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n" + .'- ICMP协议：-1/-1。'."\n" + .'- ALL：-1/-1。', + 'type' => 'array', + 'items' => ['description' => '目标端口范围。最多支持20个访问目标端口。取值范围：'."\n" ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', + .'- TCP、UDP协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。'."\n" + .'- ICMP协议：-1/-1。'."\n" + .'- ALL：-1/-1。', 'type' => 'string', 'required' => false, 'example' => '80/80'], 'required' => false, - 'example' => 'description', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'DNSServiceRuleName', + 'name' => 'AuthorizationRuleStatus', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'DNS授权规则名称。'."\n" + 'description' => '授权规则状态。最多支持20个授权规则状态。取值：'."\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" + .'- **Creating**：创建中。'."\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" + .'- **Created**：创建完成。'."\n" ."\n" - .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" - .'</props>'."\n" + .'- **Deleting**：删除中。'."\n" + ."\n" + .'- **Updating**：更新中。', + 'type' => 'array', + 'items' => ['description' => '授权规则状态。最多支持20个授权规则状态。取值：'."\n" ."\n" - .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\n", - 'type' => 'string', + .'- **Creating**：创建中。'."\n" + ."\n" + .'- **Created**：创建完成。'."\n" + ."\n" + .'- **Deleting**：删除中。'."\n" + ."\n" + .'- **Updating**：更新中。', 'type' => 'string', 'required' => false, 'example' => 'Created'], 'required' => false, - 'example' => '100.100.2.136', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'ServiceType', + 'name' => 'AuthorizationRuleName', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'DNS授权规则的目标类型。取值：'."\n" + 'description' => '授权规则的名称。最多支持20个授权规则名称。'."\n" ."\n" - .'- **Normal**：表示目标类型为DNS普通类型。'."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'array', + 'items' => ['description' => '授权规则的名称。最多支持20个授权规则名称。'."\n" ."\n" - .'- **DNSRedirect**：表示目标类型为DNS重定向类型。', - 'type' => 'string', + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'ruletest'], 'required' => false, - 'example' => 'Normal', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'Destination', + 'name' => 'Policy', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '目标DNS授权规则IP地址。'."\n" + 'description' => '访问策略。最多支持20个访问策略。取值：'."\n" + ."\n" + .'- **Permit**：允许。'."\n" ."\n" - .'> 当**ServiceType**参数取值为**DNSRedirect**时，该参数必选。', - 'type' => 'string', + .'- **Deny**：拒绝。', + 'type' => 'array', + 'items' => ['description' => '访问策略。最多支持20个访问策略。取值：'."\n" + ."\n" + .'- **Permit**：允许。'."\n" + ."\n" + .'- **Deny**：拒绝。', 'type' => 'string', 'required' => false, 'example' => 'Permit'], 'required' => false, - 'example' => '192.168.0.2', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'ClientToken', + 'name' => 'NextToken', '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', - ], + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'], ], [ - 'name' => 'DryRun', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会修改DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行修改。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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', - ], + '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' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8', + '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'], + ], + ], ], ], ], @@ -8853,33 +6141,41 @@ ], '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.', + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup', 'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.', 'description' => ''], + ], + ], + '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":"<ListGroupAuthorizationRulesResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <GroupAuthorizationRules>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <Policy>Permit</Policy>\\n <AuthorizationRuleStatus>Created</AuthorizationRuleStatus>\\n <SourceCidrs>192.168.0.0/32</SourceCidrs>\\n <DestinationType>Cidr</DestinationType>\\n <DestinationPort>80/80</DestinationPort>\\n <Protocol>tcp</Protocol>\\n <Destination>47.0.XX.XX</Destination>\\n <AuthorizationRuleName>ruletest</AuthorizationRuleName>\\n <AuthorizationRuleDescription>rule</AuthorizationRuleDescription>\\n <AuthorizationRuleId>gar-ez91t41jvi6tr8****</AuthorizationRuleId>\\n <Type>System</Type>\\n </GroupAuthorizationRules>\\n</ListGroupAuthorizationRulesResponse>","errorExample":""}]', + 'title' => '查询实例组的授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-18T12:16:22.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-06-13T11:44:38.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-12-16T05:13:55.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupAuthorizationRules'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iotcc:ListGroupAuthorizationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateGroupDNSServiceRuleAttributeResponse>\\n <RequestId>77111A6A-56BA-59B2-8CAA-7CBF21648FB8</RequestId>\\n</UpdateGroupDNSServiceRuleAttributeResponse>","errorExample":""}]', - 'title' => '改实例组的DNS授权规则', ], 'ListGroupDNSServiceRules' => [ 'summary' => '查询实例组的DNS授权规则。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8891,20 +6187,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '云连接器实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ 'name' => 'DNSServiceRuleIds', @@ -8913,12 +6202,7 @@ 'schema' => [ 'description' => 'DNS授权规则ID。', 'type' => 'array', - 'items' => [ - 'description' => 'DNS授权规则ID。最多支持输入20个规则ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gar-ffnn1ewe2nmf3y****', - ], + 'items' => ['description' => 'DNS授权规则ID。最多支持输入20个规则ID。', 'type' => 'string', 'required' => false, 'example' => 'gar-ffnn1ewe2nmf3y****'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -8927,16 +6211,11 @@ [ 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'description' => 'DNS授权规则的目标类型。取值：'."\n" - ."\n" - .'- **Normal**：表示目标类型为DNS普通类型。'."\n" - ."\n" - .'- **DNSRedirect**：表示目标类型为DNS重定向类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => 'DNS授权规则的目标类型。取值：'."\n" + ."\n" + .'- **Normal**：表示目标类型为DNS普通类型。'."\n" + ."\n" + .'- **DNSRedirect**：表示目标类型为DNS重定向类型。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], ], [ 'name' => 'Destination', @@ -8945,14 +6224,9 @@ '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', - ], + '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, @@ -8965,18 +6239,13 @@ '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" - .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\n" - ."\n" - .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.100.2.136', - ], + '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" + .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\n" + ."\n" + .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\n", 'type' => 'string', 'required' => false, 'example' => '100.100.2.136'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -8989,20 +6258,15 @@ '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', - ], + '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, @@ -9015,14 +6279,9 @@ 'schema' => [ 'description' => 'DNS授权规则名称。最多支持输入20个规则名称。', 'type' => 'array', - 'items' => [ - 'description' => 'DNS授权规则名称。最多支持输入20个规则名称。'."\n" - ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'items' => ['description' => 'DNS授权规则名称。最多支持输入20个规则名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -9031,40 +6290,21 @@ [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -9073,30 +6313,12 @@ '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', - ], + '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', @@ -9104,71 +6326,39 @@ '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" - .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" - .'</props>'."\n" - ."\n" - .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\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****', - ], + '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" + .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\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****'], ], ], ], @@ -9178,29 +6368,39 @@ ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup', 'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.', 'description' => ''], ], ], '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":"<ListGroupDNSServiceRulesResponse>\\n <RequestId>77111A6A-56BA-59B2-8CAA-7CBF21648FB8</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <DNSServiceRules>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <DNSServiceRuleStatus>Created</DNSServiceRuleStatus>\\n <Source>100.100.2.136</Source>\\n <ServiceType>Normal</ServiceType>\\n <Destination>192.168.0.2</Destination>\\n <DNSServiceRuleName>test</DNSServiceRuleName>\\n <DNSServiceRuleDescription>description</DNSServiceRuleDescription>\\n <DNSServiceRuleId>gar-ffnn1ewe2nmf3y****</DNSServiceRuleId>\\n </DNSServiceRules>\\n</ListGroupDNSServiceRulesResponse>","errorExample":""}]', 'title' => '查询实例组的DNS授权规则', - ], - 'MoveGroupAuthorizationRuleToDNSService' => [ - 'summary' => '将实例组的授权规则转移到DNS授权规则中。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupDNSServiceRules'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListGroupDNSServiceRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'ListGroupIpMappingRules' => [ + 'summary' => '调用ListGroupIpMappingRules接口查询实例组授权规则IP重定向信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9209,202 +6409,148 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '云连接器实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'AuthorizationRuleId', + 'name' => 'IpMappingRuleIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '授权规则ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gar-ez91t41jvi6tr8****', + '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' => 'ClientToken', + 'name' => 'DestinationIps', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '客户端Token，用于保证请求的幂等性。'."\n" - ."\n" - .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', + 'description' => '重定向的目标IP地址。最多支持20个目标IP地址。', + 'type' => 'array', + 'items' => ['description' => '重定向的目标IP地址。最多支持20个目标IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.10.8'], 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'DryRun', + 'name' => 'IpMappingRuleStatuses', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会转移授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行转移。', - 'type' => 'boolean', + '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, - 'example' => 'false', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'RegionId', + 'name' => 'IpMappingRuleNames', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '云连接器实例组所在的地域ID。'."\n" + 'description' => '需要进行IP重定向的授权规则名称。最多支持20个授权规则名称。', + 'type' => 'array', + 'items' => ['description' => '需要进行IP重定向的授权规则名称。最多支持20个授权规则名称。'."\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.', + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'Name'], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 1, ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<MoveGroupAuthorizationRuleToDNSServiceResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</MoveGroupAuthorizationRuleToDNSServiceResponse>","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', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'], ], [ - 'name' => 'DNSServiceRuleId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'DNS授权规则ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gar-ffnn1ewe2nmf3y****', - ], + 'schema' => ['description' => '分批次查询时每次显示的条目数。取值范围：**1**~**100**，默认值为**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '20', 'default' => '10'], ], [ - 'name' => 'ClientToken', + 'name' => 'RegionId', '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', - ], + 'schema' => ['description' => '实例组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DryRun', + 'name' => 'MappingIps', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会删除DNS授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行删除。', - 'type' => 'boolean', + 'description' => '需要进行重定向的IP地址。最多支持20个重定向的IP地址。', + 'type' => 'array', + 'items' => ['description' => '需要进行重定向的IP地址。最多支持20个重定向的IP地址。', 'type' => 'string', 'required' => false, 'example' => '47.0.XX.XX'], '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', + 'maxItems' => 20, + 'minItems' => 0, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8', + '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****'], + ], + ], ], ], ], @@ -9412,33 +6558,39 @@ ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup', 'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGroupDNSServiceRuleResponse>\\n <RequestId>77111A6A-56BA-59B2-8CAA-7CBF21648FB8</RequestId>\\n</DeleteGroupDNSServiceRuleResponse>","errorExample":""}]', - 'title' => '删除实例组的DNS授权规则', - ], - 'EnableIoTCloudConnectorAccessLog' => [ - 'summary' => '指定云连接器开启访问日志功能。', - 'methods' => [ - 'post', - 'get', + '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":"<ListGroupIpMappingRulesResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <IpMappingRules>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <IpMappingRuleStatus>Created</IpMappingRuleStatus>\\n <MappingIp>47.0.XX.XX</MappingIp>\\n <DestinationIp>192.168.10.8</DestinationIp>\\n <IpMappingRuleName>name</IpMappingRuleName>\\n <IpMappingRuleDescription>description</IpMappingRuleDescription>\\n <IpMappingRuleId>im-irrp3bzuu5nrbx****</IpMappingRuleId>\\n </IpMappingRules>\\n</ListGroupIpMappingRulesResponse>","errorExample":""}]', + 'title' => '查询实例组授权规则IP重定向信息', + 'changeSet' => [ + ['createdAt' => '2022-08-23T06:53:43.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupIpMappingRules'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListGroupIpMappingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'ListIoTCloudConnectorAvailableZones' => [ + 'summary' => '查询支持云连接器实例绑定交换机的可用区。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9447,81 +6599,21 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会开启访问日志的功能。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接开启访问日志的功能。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID，仅取值：**cn-hangzhou**。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], ], 'responses' => [ @@ -9530,10 +6622,12 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + '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'], ], ], ], @@ -9541,100 +6635,98 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableIoTCloudConnectorAccessLogResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</EnableIoTCloudConnectorAccessLogResponse>","errorExample":""}]', - 'title' => '开启访问日志功能', - ], - 'DisableIoTCloudConnectorAccessLog' => [ - 'summary' => '关闭访问日志功能。', - 'methods' => [ - 'post', - 'get', + '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":"<ListIoTCloudConnectorAvailableZonesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <AvailableZoneList>cn-hangzhou-h</AvailableZoneList>\\n</ListIoTCloudConnectorAvailableZonesResponse>","errorExample":""}]', + 'title' => 'IoTCC实例绑定交换机可用区', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorAvailableZones'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCloudConnectorAvailableZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListIoTCloudConnectorEIPs' => [ + 'summary' => '调用ListIoTCloudConnectorEIPs接口查询云连接器实例关联的弹性公网IP列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', 'type' => 'string', 'required' => false, 'example' => 'NextToken'], ], [ - 'name' => 'ClientToken', + 'name' => 'MaxResults', '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', - ], + 'schema' => ['description' => '分批次查询时每次显示的条目数。取值范围：**1**~**100**，默认值为**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '20', 'default' => '10'], ], [ - 'name' => 'DryRun', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求，取值：'."\n" - .'- **true**：发送检查请求，不会关闭访问日志功能。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接关闭访问日志功能。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + '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"]'], ], ], ], @@ -9642,25 +6734,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableIoTCloudConnectorAccessLogResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DisableIoTCloudConnectorAccessLogResponse>","errorExample":""}]', - 'title' => '关闭访问日志功能', - ], - 'GetIoTCloudConnectorAccessLog' => [ - 'summary' => '获取指定云连接器访问日志状态信息。', - 'methods' => [ - 'post', - 'get', + '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":"<ListIoTCloudConnectorEIPsResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <EIPs>[\\"42.1.XX.XX\\", \\"42.2.XX.XX\\", … \\"42.3.XX.XX\\"]</EIPs>\\n</ListIoTCloudConnectorEIPsResponse>","errorExample":""}]', + 'title' => '查询云连接器实例关联的弹性公网IP列表', + 'changeSet' => [ + ['createdAt' => '2022-06-21T08:03:29.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-21T07:43:00.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-21T07:38:17.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-20T09:09:27.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorEIPs'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCloudConnectorEIPs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'ListIoTCloudConnectorGroups' => [ + 'summary' => '查询实例组列表信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9672,58 +6781,95 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'IoTCloudConnectorGroupStatus', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', + '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' => 'ClientToken', + 'name' => 'IoTCloudConnectorGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '客户端Token，用于保证请求的幂等性。'."\n" - ."\n" - .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', + 'description' => '实例组的ID列表。最多支持20个实例组的ID列表。', + 'type' => 'array', + 'items' => ['description' => '实例组的ID列表。最多支持20个实例组的ID列表。', 'type' => 'string', 'required' => false, 'example' => 'iotccg-g00epppbi9di9y****'], 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'DryRun', + 'name' => 'IoTCloudConnectorGroupName', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '是否只预检此次请求，取值：'."\n" - .'- **true**：发送检查请求，不会获取访问日志状态信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接获取访问日志状态信息。', - 'type' => 'boolean', + 'description' => '实例组的名称。最多支持20个实例组的名称。', + 'type' => 'array', + 'items' => ['description' => '实例组的名称。最多支持20个实例组的名称。'."\n" + ."\n" + .'名称长度为2~128个英文或中文字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'cctest'], 'required' => false, - 'example' => '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。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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" + .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" + ."\n" + .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard'], ], ], 'responses' => [ @@ -9732,29 +6878,83 @@ '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', + '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" + .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" + ."\n" + .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\n", 'type' => 'string', 'example' => 'Standard'], + 'ServiceType' => ['description' => '服务类型。取值：'."\n" + ."\n" + .'- **Normal**：普通型。'."\n" + .'- **CC5G**：云连接器5G实例托管类型。'."\n" + .'- **CC5GCCIoT**：云连接器5G过户类型。', 'type' => 'string', 'example' => 'Normal'], + ], + ], ], ], ], @@ -9762,25 +6962,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - '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":"<GetIoTCloudConnectorAccessLogResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AccessLogSlsProject>sls-setter</AccessLogSlsProject>\\n <AccessLogSlsLogStore>test</AccessLogSlsLogStore>\\n <AccessLogStatus>Opened</AccessLogStatus>\\n</GetIoTCloudConnectorAccessLogResponse>","errorExample":""}]', - 'title' => '获取指定云连接器访问日志', - ], - 'CreateService' => [ - 'summary' => '创建分应用统计服务。', - 'methods' => [ - 'post', - 'get', + '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":"<ListIoTCloudConnectorGroupsResponse>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <IoTCloudConnectorGroups>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <IoTCloudConnectorGroupStatus>Created</IoTCloudConnectorGroupStatus>\\n <IoTCloudConnectors>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <IoTCloudConnectorStatus>Created</IoTCloudConnectorStatus>\\n <IoTCloudConnectorName>cc01</IoTCloudConnectorName>\\n <IoTCloudConnectorDescription>cc01</IoTCloudConnectorDescription>\\n <ISP>mobile</ISP>\\n <APN>CMWAP</APN>\\n <ServiceType>Normal</ServiceType>\\n </IoTCloudConnectors>\\n <Name>cctest</Name>\\n <Description>test</Description>\\n <Type>Standard</Type>\\n <ServiceType>Normal</ServiceType>\\n </IoTCloudConnectorGroups>\\n</ListIoTCloudConnectorGroupsResponse>","errorExample":""}]', + 'title' => '查询实例组列表信息', + 'changeSet' => [ + ['createdAt' => '2022-09-02T08:28:41.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-13T11:44:38.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-12-21T08:47:54.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-14T09:32:05.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorGroups'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCloudConnectorGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'ListIoTCloudConnectors' => [ + 'summary' => '查询云连接器实例信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9789,86 +7005,142 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'IoTCloudConnectorStatus', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', + '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' => 'ServiceName', + 'name' => 'IoTCloudConnectorIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '分应用统计服务的名称。'."\n" - ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', + 'description' => '云连接器实例ID列表。', + 'type' => 'array', + 'items' => ['description' => '云连接器实例ID列表。最多支持输入20个实例ID。', 'type' => 'string', 'required' => false, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], 'required' => false, - 'example' => 'service_name', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'ServiceDescription', + 'name' => 'IoTCloudConnectorName', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '分应用统计服务的描述。'."\n" + 'description' => '云连接器实例的名称。最多支持输入20个实例名称。'."\n" + ."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', + 'type' => 'array', + 'items' => ['description' => '云连接器实例的名称。最多支持输入20个实例名称。'."\n" ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], 'required' => false, - 'example' => 'service_description', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'ClientToken', + 'name' => 'ISP', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '客户端Token，用于保证请求的幂等性。'."\n" - ."\n" - .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', + '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, - 'example' => '123e4567-e89b-12d3-a456-426655440000', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'DryRun', + 'name' => 'VpcId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '是否只预检此次请求，取值：'."\n" - .'- **true**：发送检查请求，不会创建服务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建服务。', - 'type' => 'boolean', + 'description' => '云连接器实例连接的VPC的ID。', + 'type' => 'array', + 'items' => ['description' => '云连接器实例连接的VPC的ID。最多支持输入20个VPC的ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1aevy8sofi8mh1q****'], 'required' => false, - 'example' => 'false', + 'maxItems' => 20, ], ], [ - 'name' => 'RegionId', + 'name' => 'APN', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '分应用统计服务所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + '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 => [ @@ -9876,15 +7148,71 @@ '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', + '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" + .'<props="china">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)申请。</props>'."\n" + ."\n" + .'<props="intl">云连接器实例默认创建标准版，如果需要创建基础版实例，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)申请</props>'."\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'], + ], + ], ], ], ], @@ -9892,25 +7220,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'SystemBusy', 'errorMessage' => 'System is busy, please try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ServiceId\\": \\"c910061f-****-44e6-b659-***c\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <ServiceId>c910061f-****-44e6-b659-***c</ServiceId>\\n</CreateServiceResponse>","errorExample":""}]', - 'title' => '创建分应用统计服务', - ], - 'UpdateServiceAttribute' => [ - 'summary' => '修改分应用统计服务。', - 'methods' => [ - 'post', - 'get', + '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":"<ListIoTCloudConnectorsResponse>\\n <TotalCount>20</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <IoTCloudConnectors>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <IoTCloudConnectorStatus>Created</IoTCloudConnectorStatus>\\n <ISP>mobile</ISP>\\n <IoTCloudConnectorBusinessStatus>Normal</IoTCloudConnectorBusinessStatus>\\n <APN>CMWAP</APN>\\n <RateLimit>2</RateLimit>\\n <VpcId>vpc-bp1aevy8sofi8mh1q****</VpcId>\\n <VSwitchList>vsw-m5e3r57pxkgijcdvfcdvf****</VSwitchList>\\n <IoTCloudConnectorName>test</IoTCloudConnectorName>\\n <IoTCloudConnectorDescription>test</IoTCloudConnectorDescription>\\n <WildcardDomainEnabled>false</WildcardDomainEnabled>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <Mode>PassThrough</Mode>\\n <IpFeature>192.168.0.1</IpFeature>\\n <Type>Standard</Type>\\n <ServiceType>Normal</ServiceType>\\n <GrantAliUid>253460731706911258</GrantAliUid>\\n </IoTCloudConnectors>\\n</ListIoTCloudConnectorsResponse>","errorExample":""}]', + 'title' => '查询云连接器实例信息', + 'changeSet' => [ + ['createdAt' => '2022-09-07T17:01:30.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-26T16:07:02.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-10T10:09:37.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-13T09:41:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-21T16:06:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-21T16:06:13.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-20T07:02:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-07-07T09:41:11.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectors'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCloudConnectors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/*'], + ], + ], + ], ], + ], + 'ListIoTCoudConnectorBackhaulRoute' => [ + 'summary' => '调用ListIoTCoudConnectorBackhaulRoute接口查询当前云连接器实例绑定VPC后的回程路由。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9919,107 +7269,78 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeCode' => '136568', + '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', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'ServiceDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '分应用统计服务的描述。'."\n" - ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'service_description', - ], - ], - [ - 'name' => 'ClientToken', + 'name' => 'NextToken', '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', - ], + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'], ], [ - 'name' => 'DryRun', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求，取值：'."\n" - .'- **true**：发送检查请求，不会修改服务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接修改服务。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + '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' => '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'], + ], + ], ], ], ], @@ -10027,25 +7348,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateServiceAttributeResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateServiceAttributeResponse>","errorExample":""}]', - 'title' => '修改分应用统计服务', - ], - 'ListService' => [ - 'summary' => '查询分应用统计服务。', - 'methods' => [ - 'post', - 'get', + '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":"<ListIoTCoudConnectorBackhaulRouteResponse>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <Routes>\\n <DestinationCidrBlock>192.168.2.0/24</DestinationCidrBlock>\\n <NextHopId>eni-bp1d66qjxb3qoin3****</NextHopId>\\n <NextHopType>NetworkInterface</NextHopType>\\n <Status>Published</Status>\\n <Description>test</Description>\\n </Routes>\\n</ListIoTCoudConnectorBackhaulRouteResponse>","errorExample":""}]', + 'title' => '查询当前云连接器实例绑定VPC后的回程路由', + 'changeSet' => [ + ['createdAt' => '2024-11-19T07:41:56.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-05-06T12:57:35.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2022-05-06T12:57:35.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCoudConnectorBackhaulRoute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCoudConnectorBackhaulRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'ListIpMappingRules' => [ + 'summary' => '调用ListIpMappingRules接口查询授权规则IP重定向信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10054,193 +7391,172 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', + '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' => 'ServiceIds', + 'name' => 'MappingIps', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '分应用统计服务ID列表。', + 'description' => '需要进行重定向的IP地址。', 'type' => 'array', - 'items' => [ - 'description' => '系统为分应用统计服务生成的ID，全网唯一。最多支持输入20个服务ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'c910061f-****-44e6-b659-***c', - ], + 'items' => ['description' => '需要进行重定向的IP地址。最多支持20个重定向的IP地址。', 'type' => 'string', 'required' => false, 'example' => '47.0.XX.XX'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], [ - 'name' => 'ServiceNames', + 'name' => 'IpMappingRuleStatuses', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '分应用统计服务名称列表。', + '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' => '分应用统计服务名称，最多支持输入20个服务名称。'."\n" - ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'service_name', - ], + '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' => 'ResourceStatuses', + 'name' => 'IpMappingRuleNames', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '分应用统计服务资源状态列表。', + 'description' => '需要进行IP重定向的授权规则名称。', 'type' => 'array', - 'items' => [ - 'description' => '服务资源的状态，最多支持输入20个服务资源。取值：'."\n" - .'- **Creating**：创建中。'."\n" - .'- **Created**：已创建。'."\n" - .'- **Deleting**：删除中。'."\n" - .'- **Updating**：更新中。', - 'type' => 'string', - 'required' => false, - 'example' => 'Created', - ], + 'items' => ['description' => '需要进行IP重定向的授权规则名称。最多支持20个授权规则名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'name'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], [ - 'name' => 'NextToken', + 'name' => 'DestinationIps', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', + 'description' => '重定向的目标IP地址。', + 'type' => 'array', + 'items' => ['description' => '重定向的目标IP地址。最多支持20个目标IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.10.8'], 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + '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', - ], + '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', - ], + 'schema' => ['description' => '实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息列表。', + 'description' => '请求ID。', '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' => '服务列表。', + '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' => '服务列表。', + 'description' => '授权规则IP重定向列表。', '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', - ], + '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'], ], ], ], @@ -10250,25 +7566,39 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - '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":"<ListServiceResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>NextToken\\tFFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <Services>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <ServiceId>c910061f-****-44e6-b659-***c</ServiceId>\\n <ServiceStatus>Created</ServiceStatus>\\n <ServiceName>service_name</ServiceName>\\n <ServiceDescription>service_description</ServiceDescription>\\n </Services>\\n</ListServiceResponse>","errorExample":""}]', - 'title' => '查询分应用统计服务', - ], - 'DeleteService' => [ - 'summary' => '删除分应用统计服务。', - 'methods' => [ - 'post', - 'get', + '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":"<ListIpMappingRulesResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <IpMappingRules>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <IpMappingRuleId>im-irrp3bzuu5nrbx****</IpMappingRuleId>\\n <IpMappingRuleStatus>Created</IpMappingRuleStatus>\\n <MappingIp>47.0.XX.XX</MappingIp>\\n <DestinationIp>192.168.10.8</DestinationIp>\\n <IpMappingRuleName>name</IpMappingRuleName>\\n <IpMappingRuleDescription>description</IpMappingRuleDescription>\\n </IpMappingRules>\\n</ListIpMappingRulesResponse>","errorExample":""}]', + 'title' => '查询授权规则IP重定向信息', + 'changeSet' => [ + ['createdAt' => '2022-08-20T01:35:13.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIpMappingRules'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iotcc:ListIpMappingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'ListRegions' => [ + 'summary' => '查询云连接器支持的地域列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10277,71 +7607,24 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'name' => 'AcceptLanguage', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求，取值：'."\n" - .'- **true**：发送检查请求，不会删除服务。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除服务。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '支持的语言。取值：'."\n" + .'- **zh-CN**：中文。'."\n" + .'- **en-US**：英文。'."\n" + .'- **ja**：日文。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '分应用统计服务所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -10350,10 +7633,19 @@ 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + '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'], + ], + ], ], ], ], @@ -10361,189 +7653,38 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteServiceResponse>","errorExample":""}]', - 'title' => '删除分应用统计服务', - ], - 'CreateServiceEntry' => [ - 'summary' => '分应用统计服务列表中添加应用条目。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + '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":"<ListRegionsResponse>\\n <RequestId>79FAFC4C-6251-5C2D-818A-FD26FFFF10A5</RequestId>\\n <Regions>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>cciot.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东1（杭州）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-shanghai</RegionId>\\n <RegionEndpoint>cciot.cn-shanghai.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2（上海）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-qingdao</RegionId>\\n <RegionEndpoint>cciot.cn-qingdao.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北1（青岛）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-beijing</RegionId>\\n <RegionEndpoint>cciot.cn-beijing.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2（北京）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-huhehaote</RegionId>\\n <RegionEndpoint>cciot.cn-huhehaote.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北5（呼和浩特）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-wulanchabu</RegionId>\\n <RegionEndpoint>cciot.cn-wulanchabu.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北6（乌兰察布）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>cciot.cn-shenzhen.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1（深圳）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-guangzhou</RegionId>\\n <RegionEndpoint>cciot.cn-guangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南3（广州）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>cn-chengdu</RegionId>\\n <RegionEndpoint>cciot.cn-chengdu.aliyuncs.com</RegionEndpoint>\\n <LocalName>西南1（成都）</LocalName>\\n </Regions>\\n <Regions>\\n <RegionId>eu-central-1</RegionId>\\n <RegionEndpoint>cciot.eu-central-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>德国（法兰克福）</LocalName>\\n </Regions>\\n</ListRegionsResponse>","errorExample":""}]', + 'title' => '查询云连接器支持的地域列表', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'], ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - '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', - ], - ], + 'ramActions' => [ [ - '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****', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iotcc:ListRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - '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":"<CreateServiceEntryResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <ServiceEntryId>fwd-119smw5tkasdf****</ServiceEntryId>\\n</CreateServiceEntryResponse>","errorExample":""}]', - 'title' => '分应用功能列表中添加应用条目', ], - 'UpdateServiceEntryAttribute' => [ - 'summary' => '修改分应用统计服务列表中的应用条目。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListService' => [ + 'summary' => '查询分应用统计服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10552,117 +7693,116 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'ServiceEntryId', + 'name' => 'ServiceIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '应用条目的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'fwd-119smw5tkasdf****', + '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' => 'ServiceEntryName', + 'name' => 'ServiceNames', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '应用条目的名称。'."\n" + 'description' => '分应用统计服务名称列表。', + 'type' => 'array', + 'items' => ['description' => '分应用统计服务名称，最多支持输入20个服务名称。'."\n" ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'service_name'], 'required' => false, - 'example' => 'entry_name', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'ServiceEntryDescription', + 'name' => 'ResourceStatuses', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '应用条目的描述。'."\n" - ."\n" - .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', - 'type' => 'string', + 'description' => '分应用统计服务资源状态列表。', + 'type' => 'array', + 'items' => ['description' => '服务资源的状态，最多支持输入20个服务资源。取值：'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Created**：已创建。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **Updating**：更新中。', 'type' => 'string', 'required' => false, 'example' => 'Created'], 'required' => false, - 'example' => 'entry_description', + 'maxItems' => 20, + 'minItems' => 1, ], ], [ - 'name' => 'ClientToken', + 'name' => 'NextToken', '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', - ], + 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'], ], [ - 'name' => 'DryRun', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会修改应用条目。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接修改应用条目。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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', - ], + 'schema' => ['description' => '分应用统计服务所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '请求ID。', + 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', + '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'], + ], + ], ], ], ], @@ -10670,25 +7810,38 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ], + ], + '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":"<ListServiceResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>NextToken\\tFFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <Services>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <ServiceId>c910061f-****-44e6-b659-***c</ServiceId>\\n <ServiceStatus>Created</ServiceStatus>\\n <ServiceName>service_name</ServiceName>\\n <ServiceDescription>service_description</ServiceDescription>\\n </Services>\\n</ListServiceResponse>","errorExample":""}]', + 'title' => '查询分应用统计服务', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListService'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateServiceEntryAttributeResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</UpdateServiceEntryAttributeResponse>","errorExample":""}]', - 'title' => '修改分应用统计列表的应用条目', ], 'ListServiceEntries' => [ 'summary' => '查询分应用统计条目。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10700,30 +7853,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => '系统为分应用统计服务生成的ID，全网唯一。', - 'type' => 'string', - 'required' => true, - 'example' => 'c910061f-****-44e6-b659-***c', - ], + '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****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ 'name' => 'Target', @@ -10732,12 +7873,7 @@ 'schema' => [ 'description' => '应用条目的目的地址。', 'type' => 'array', - 'items' => [ - 'description' => '应用条目的目的地址。最多支持输入20个目的地址。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.32/27', - ], + 'items' => ['description' => '应用条目的目的地址。最多支持输入20个目的地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.1.32/27'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -10750,16 +7886,11 @@ 'schema' => [ 'description' => '应用条目的目的地址类型。', 'type' => 'array', - 'items' => [ - 'description' => '应用条目的目的地址类型，最多支持输入20个目的地址类型。取值：'."\n" - ."\n" - .'- **Cidr**：CIDR地址块。'."\n" - ."\n" - .'- **Domain**：域名。', - 'type' => 'string', - 'required' => false, - 'example' => 'Cidr', - ], + 'items' => ['description' => '应用条目的目的地址类型，最多支持输入20个目的地址类型。取值：'."\n" + ."\n" + .'- **Cidr**：CIDR地址块。'."\n" + ."\n" + .'- **Domain**：域名。', 'type' => 'string', 'required' => false, 'example' => 'Cidr'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -10772,20 +7903,15 @@ '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', - ], + '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, @@ -10798,14 +7924,9 @@ 'schema' => [ 'description' => '应用条目的名称。', 'type' => 'array', - 'items' => [ - 'description' => '应用条目的名称。最多支持输入20个应用条目名称。'."\n" - ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'entry_name', - ], + 'items' => ['description' => '应用条目的名称。最多支持输入20个应用条目名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'entry_name'], 'required' => false, 'maxItems' => 20, 'minItems' => 1, @@ -10814,40 +7935,21 @@ [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '应用条目所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ServiceEntryIds', @@ -10856,12 +7958,7 @@ 'schema' => [ 'description' => '应用条目的ID。', 'type' => 'array', - 'items' => [ - 'description' => '应用条目的ID。最多支持输入20个应用条目ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'fwd-119smw5tkasdf****', - ], + 'items' => ['description' => '应用条目的ID。最多支持输入20个应用条目ID。', 'type' => 'string', 'required' => false, 'example' => 'fwd-119smw5tkasdf****'], 'required' => false, 'maxItems' => 20, ], @@ -10873,30 +7970,12 @@ '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', - ], + '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', @@ -10904,57 +7983,29 @@ '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****', - ], + '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****'], ], ], ], @@ -10964,25 +8015,38 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'Ram user does not have permission to perform this operation.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], '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":"<ListServiceEntriesResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <ServiceEntries>\\n <ServiceId>c910061f-****-44e6-b659-***c</ServiceId>\\n <ServiceEntryStatus>Created</ServiceEntryStatus>\\n <Target>192.168.1.32/27</Target>\\n <TargetType>Cidr</TargetType>\\n <ServiceEntryName>entry_name</ServiceEntryName>\\n <ServiceEntryDescription>entry_description</ServiceEntryDescription>\\n <ServiceEntryId>fwd-119smw5tkasdf****</ServiceEntryId>\\n </ServiceEntries>\\n</ListServiceEntriesResponse>","errorExample":""}]', 'title' => '查询分应用统计条目', - ], - 'DeleteServiceEntry' => [ - 'summary' => '删除分应用统计条目。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceEntries'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListServiceEntries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + ], + ], + 'MoveAuthorizationRuleToDNSService' => [ + 'summary' => '将授权规则转移到DNS授权规则中。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10991,81 +8055,44 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-1y6h8z7imd2yu4****'], ], [ - 'name' => 'ServiceEntryId', + 'name' => 'AuthorizationRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '应用条目的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'fwd-119smw5tkasdf****', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'> 目前，支持开通云连接器的地域：华东1（杭州）、华东2（上海）、华北1（青岛）、华北2（北京）、华北5（呼和浩特）、华北6（乌兰察布）、华南1（深圳）、华南3（广州）、西南1（成都）、德国（法兰克福）。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -11074,36 +8101,49 @@ 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', - ], + '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceEntryResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</DeleteServiceEntryResponse>","errorExample":""}]', - 'title' => '删除分应用统计条目', - ], - 'SubmitDiagnoseTaskForSingleCard' => [ - 'summary' => '提交单卡诊断任务。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"862D2D7E-E6A9-5645-9CA0-64B520256A7B\\"\\n}","errorExample":""},{"type":"xml","example":"<MoveAuthorizationRuleToDNSServiceResponse>\\n <RequestId>862D2D7E-E6A9-5645-9CA0-64B520256A7B</RequestId>\\n</MoveAuthorizationRuleToDNSServiceResponse>","errorExample":""}]', + 'title' => '授权规则转移到DNS授权规则', + 'description' => '> 只允许将授权规则中访问目标类型为**Cidr**且目的地址为DNS IP的规则转移到DNS授权规则中，您可以通过调用[ListAuthorizationRules](~~298298~~)接口查看实例组授权规则的访问目标类型和目的地址。', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveAuthorizationRuleToDNSService'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:MoveAuthorizationRuleToDNSService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'MoveGroupAuthorizationRuleToDNSService' => [ + 'summary' => '将实例组的授权规则转移到DNS授权规则中。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11112,116 +8152,44 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '网路诊断的目的类型。取值：'."\n" - ."\n" - .'- **IP**：表示诊断的目的类型是IP类型。'."\n" - ."\n" - .'- **域名**：表示诊断的目的类型是域名类型。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], + 'schema' => ['description' => '云连接器实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'Destination', + 'name' => 'AuthorizationRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '网络诊断的目的IP或者域名。', - 'type' => 'string', - 'required' => false, - 'example' => '114.114.XX.XX', - ], + 'schema' => ['description' => '授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'gar-ez91t41jvi6tr8****'], ], [ - 'name' => 'BeginTime', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '网络诊断的开始时间戳。单位：秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1643077466', - ], + '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' => 'EndTime', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '网络诊断的结束时间戳。单位：秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1643077666', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会转移授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行转移。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ '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', - ], + 'schema' => ['description' => '云连接器实例组所在的地域ID。'."\n" + ."\n" + .'> 目前，支持开通云连接器的地域：华东1（杭州）、华东2（上海）、华北1（青岛）、华北2（北京）、华北5（呼和浩特）、华北6（乌兰察布）、华南1（深圳）、华南3（广州）、西南1（成都）、德国（法兰克福）。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -11230,98 +8198,69 @@ 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', - ], - 'DiagnoseTaskId' => [ - 'description' => '网络诊断任务ID。', - 'type' => 'string', - 'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****', - ], + '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' => '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2qhwdp2n9x6zkvq****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitDiagnoseTaskForSingleCardResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <DiagnoseTaskId>diagnoseTask-bp2qhwdp2n9x6zkvq****</DiagnoseTaskId>\\n</SubmitDiagnoseTaskForSingleCardResponse>","errorExample":""}]', - 'title' => '提交单卡诊断任务', - ], - 'GetDiagnoseResultForSingleCard' => [ - 'summary' => '获取单卡诊断结果。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<MoveGroupAuthorizationRuleToDNSServiceResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</MoveGroupAuthorizationRuleToDNSServiceResponse>","errorExample":""}]', + 'title' => '实例组规则转移到DNS授权规则', + 'description' => '> 只允许将授权规则中访问目标类型为**Cidr**且目的地址为DNS IP的规则转移到DNS授权规则中，您可以通过调用[ListGroupAuthorizationRules](~~402441~~)接口查看实例组授权规则的访问目标类型和目的地址。', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:37.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveGroupAuthorizationRuleToDNSService'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:MoveGroupAuthorizationRuleToDNSService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'OpenIoTCloudConnectorService' => [ + 'summary' => '开通云连接器服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -11330,388 +8269,148 @@ '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', - ], - ], - ], - ], + '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.IoTCloudConnectorServiceOpened', 'errorMessage' => 'The operation is not allowed because of iotcc service have opened.', 'description' => ''], ], ], - '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":"<GetDiagnoseResultForSingleCardResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <IoTCloudConnectorId>iotcc-smy9a5ockzp08n****</IoTCloudConnectorId>\\n <CardIp>169.254.XX.XX</CardIp>\\n <IccId>89860477*******27546</IccId>\\n <Destination>114.114.XX.XX</Destination>\\n <BeginTime>1643077466</BeginTime>\\n <EndTime>1643077666</EndTime>\\n <Status>failed</Status>\\n <ErrorResult>\\n <ErrorLevel>Warning</ErrorLevel>\\n <ErrorPart>Terminal</ErrorPart>\\n <ErrorDesc>Terminal abnormal</ErrorDesc>\\n <ErrorSuggestion>Please check whether the terminal and card are compatible or whether the terminal can send messages</ErrorSuggestion>\\n </ErrorResult>\\n <DiagnoseItem>\\n <Part>Terminal</Part>\\n <Status>Normal</Status>\\n </DiagnoseItem>\\n</GetDiagnoseResultForSingleCardResponse>","errorExample":""}]', - 'title' => '获取单卡诊断结果', - ], - 'ListDiagnoseInfoForSingleCard' => [ - 'summary' => '查询单卡诊断的诊断结果信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenIoTCloudConnectorServiceResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</OpenIoTCloudConnectorServiceResponse>","errorExample":""}]', + 'title' => '开通云连接器服务', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenIoTCloudConnectorService'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:OpenIoTCloudConnectorService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'RemoveIoTCloudConnectorFromGroup' => [ + 'summary' => '将云连接器实例从实例组中移除。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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', + 'style' => 'flat', 'schema' => [ - 'description' => '网络诊断的云连接器实例ID。', - 'type' => 'string', + 'description' => '云连接器实例ID。**N**的取值范围：**1**~**20**。', + 'type' => 'array', + 'items' => ['description' => '云连接器实例ID。**N**的取值范围：**1**~**20**。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], 'required' => true, - 'example' => 'iotcc-smy9a5ockzp08n****', ], ], [ - 'name' => 'SourceType', + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '网络诊断的源类型。取值：'."\n" - ."\n" - .'- **卡IP**：表示通过物联网卡的卡IP进行网络诊断。'."\n" - ."\n" - .'- **卡ID**：表示通过物联网卡的卡ID进行网络诊断。', - 'type' => 'string', - 'required' => false, - 'example' => '卡IP', - ], + 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'Source', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '网络诊断的源端卡IP或者卡ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '169.254.XX.XX', - ], + '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' => 'NextToken', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会将云连接器实例从实例组中移除。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'MaxResults', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '分批次查询时每次显示的条目数。取值范围：**1~100**。默认值：**20**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '实例组所在的地域ID。 '."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '请求ID。', + 'description' => '返回信息列表。', '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', - ], + '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' => 'ResourceNotFound.IoTCloudConnector', - 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - '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":"<ListDiagnoseInfoForSingleCardResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <DiagnoseInfo>\\n <IoTCloudConnectorId>iotcc-smy9a5ockzp08n****</IoTCloudConnectorId>\\n <CardIp>169.254.XX.XX</CardIp>\\n <IccId>89860477*******27546</IccId>\\n <SourceType>卡IP</SourceType>\\n <Source>169.254.XX.XX</Source>\\n <DestinationType>IP</DestinationType>\\n <Destination>114.114.XX.XX</Destination>\\n <BeginTime>1643077466</BeginTime>\\n <EndTime>1643077666</EndTime>\\n <Status>completed</Status>\\n <DiagnoseTime>1649669904</DiagnoseTime>\\n <TaskId>diagnoseTask-bp2qhwdp2n9x6zkvq****</TaskId>\\n </DiagnoseInfo>\\n <TotalCount>10</TotalCount>\\n</ListDiagnoseInfoForSingleCardResponse>","errorExample":""}]', - 'title' => '查询单卡诊断的诊断结果信息', - ], - 'CreateIoTCloudConnectorBackhaulRoute' => [ - 'summary' => '调用CreateIoTCloudConnectorBackhaulRoute接口创建当前云连接器实例绑定VPC后的回程路由。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveIoTCloudConnectorFromGroupResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</RemoveIoTCloudConnectorFromGroupResponse>","errorExample":""}]', + 'title' => '将云连接器实例从实例组中移除', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:36.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-14T09:32:05.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIoTCloudConnectorFromGroup'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:RemoveIoTCloudConnectorFromGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'RevertIoTCloudConnector' => [ + 'summary' => '调用RevertIoTCloudConnector接口归还已拒绝过户的云连接器实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11720,116 +8419,90 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '云连接器实例ID。', + 'description' => '返回参数列表。', 'type' => 'object', 'properties' => [ - 'IoTCloudConnectorId' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + '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' => '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorId\\": \\"iotcc-bp1odcab8tmno0hdq****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIoTCloudConnectorBackhaulRouteResponse>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</CreateIoTCloudConnectorBackhaulRouteResponse>","errorExample":""}]', - 'title' => '创建当前云连接器实例绑定VPC后的回程路由', - ], - 'ListIoTCoudConnectorBackhaulRoute' => [ - 'summary' => '调用ListIoTCoudConnectorBackhaulRoute接口查询当前云连接器实例绑定VPC后的回程路由。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<RevertIoTCloudConnectorResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <ResourceId>iotcc-bp1odcab8tmno0hdq****</ResourceId>\\n</RevertIoTCloudConnectorResponse>","errorExample":""}]', + 'title' => '归还已拒绝过户的云连接器实例', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:58.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevertIoTCloudConnector'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:RevertIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'SubmitDiagnoseTaskForSingleCard' => [ + 'summary' => '提交单卡诊断任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11838,235 +8511,66 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '136568', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '发起单张物联网卡网络诊断的实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-smy9a5ockzp08n****'], ], [ - 'name' => 'NextToken', + 'name' => 'SourceType', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + 'schema' => ['description' => '网络诊断的源类型。取值：'."\n" + ."\n" + .'- **卡IP**：表示通过物联网卡的卡IP进行网络诊断。'."\n" + ."\n" + .'- **卡ID**：表示通过物联网卡的卡ID进行网络诊断。', 'type' => 'string', 'required' => true, 'example' => '卡IP'], ], [ - 'name' => 'MaxResults', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**100**，默认值：**20**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => '网络诊断的源端卡IP或者卡ID。', 'type' => 'string', 'required' => true, 'example' => '169.254.XX.XX'], ], [ - 'name' => 'RegionId', + 'name' => 'DestinationType', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '网路诊断的目的类型。取值：'."\n" + ."\n" + .'- **IP**：表示诊断的目的类型是IP类型。'."\n" + ."\n" + .'- **域名**：表示诊断的目的类型是域名类型。'."\n", 'type' => 'string', 'required' => false, 'example' => 'IP'], ], - ], - '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":"<ListIoTCoudConnectorBackhaulRouteResponse>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <Routes>\\n <DestinationCidrBlock>192.168.2.0/24</DestinationCidrBlock>\\n <NextHopId>eni-bp1d66qjxb3qoin3****</NextHopId>\\n <NextHopType>NetworkInterface</NextHopType>\\n <Status>Published</Status>\\n <Description>test</Description>\\n </Routes>\\n</ListIoTCoudConnectorBackhaulRouteResponse>","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', + 'name' => 'Destination', + 'in' => 'query', + 'schema' => ['description' => '网络诊断的目的IP或者域名。', 'type' => 'string', 'required' => false, 'example' => '114.114.XX.XX'], ], - ], - 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'BeginTime', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '网络诊断的开始时间戳。单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1643077466'], ], [ - 'name' => 'ClientToken', + 'name' => 'EndTime', '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', - ], + 'schema' => ['description' => '网络诊断的结束时间戳。单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1643077666'], ], [ - 'name' => 'DryRun', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会删除当前云连接器实例绑定VPC后的回程路由。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除云连接器实例绑定VPC后的回程路由。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '网络诊断所在的地域ID。'."\n" + ."\n\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceUid', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '云连接器实例使用者的阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '253460731706911258'], ], ], 'responses' => [ @@ -12075,64 +8579,51 @@ 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45'], + 'DiagnoseTaskId' => ['description' => '网络诊断任务ID。', 'type' => 'string', 'example' => 'diagnoseTask-bp2qhwdp2n9x6zkvq****'], ], ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'cardIdNotExist', 'errorMessage' => 'diagnose task iccid not exist', 'description' => '卡ID不存在'], + ['errorCode' => 'CardIPNotBind', 'errorMessage' => 'card ip not bind', 'description' => '卡IP未绑定。'], + ['errorCode' => 'CardIPAndIccIdNotMatch', 'errorMessage' => 'card ip and iccid not match', 'description' => '卡IP和卡ID不匹配。'], + ['errorCode' => 'CardIPNotExist', 'errorMessage' => 'card ip not exist', 'description' => '卡IP不存在。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIoTCloudConnetorBackhaulRouteResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteIoTCloudConnetorBackhaulRouteResponse>","errorExample":""}]', - 'title' => '删除当前云连接器实例绑定VPC后的回程路由', - ], - 'CreateIpMappingRule' => [ - 'summary' => '调用CreateIpMappingRule接口创建授权规则IP的重定向功能。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"DiagnoseTaskId\\": \\"diagnoseTask-bp2qhwdp2n9x6zkvq****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitDiagnoseTaskForSingleCardResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <DiagnoseTaskId>diagnoseTask-bp2qhwdp2n9x6zkvq****</DiagnoseTaskId>\\n</SubmitDiagnoseTaskForSingleCardResponse>","errorExample":""}]', + 'title' => '提交单卡诊断任务', + 'changeSet' => [ + ['createdAt' => '2022-02-21T08:46:11.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDiagnoseTaskForSingleCard'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:SubmitDiagnoseTaskForSingleCard', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'UpdateAuthorizationRuleAttribute' => [ + 'summary' => '更新授权规则信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12141,200 +8632,171 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'DestinationIp', + 'name' => 'AuthorizationRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '重定向的目标IP地址。', - 'type' => 'string', - 'required' => true, - 'example' => '192.168.10.8', - ], + 'schema' => ['description' => '授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'ar-1234abcb8tmno0hdq****'], ], [ - 'name' => 'MappingIp', + 'name' => 'DestinationType', 'in' => 'query', - 'schema' => [ - 'description' => '需要进行重定向的IP地址。', - 'type' => 'string', - 'required' => true, - 'example' => '47.0.XX.XX', - ], + 'schema' => ['description' => '访问目标类型。'."\n" + .'- **Cidr**：CIDR地址块。'."\n" + .'- **Domain**：域名。', 'type' => 'string', 'required' => false, 'example' => 'Cidr'], ], [ - 'name' => 'IpMappingRuleName', + 'name' => 'DestinationPort', 'in' => 'query', - 'schema' => [ - 'description' => '需要进行IP重定向的授权规则名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + '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' => 'IpMappingRuleDescription', + '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' => '需要进行IP重定向的授权规则描述。'."\n" - ."\n" - .'长度为2~256个字符，必须以字母或中文开头，但不能以`http:// `或`https://`开头。', - 'type' => 'string', + 'description' => '源CIDR地址块。最多支持传入20个源CIDR地址块。', + 'type' => 'array', + 'items' => ['description' => '源CIDR地址块。最多支持传入20个源CIDR地址块。', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'], 'required' => false, - 'example' => 'description', + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '请求ID。', + 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], - 'IpMappingRuleId' => [ - 'description' => '需要进行IP重定向的授权规则的ID。', - 'type' => 'string', - 'example' => 'im-irrp3bzuu5nrbx****', - ], + '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.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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.NoParamModify', 'errorMessage' => 'The operation is not allowed because of no param modified.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'QuotaExceeded.sourceCidrLimit', 'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded', 'description' => 'SourceCidrsPerAuthorizationRule quota超出'], + ['errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit', 'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'IllegalParam', 'errorMessage' => 'The param is illegal.', 'description' => '参数非法'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.AuthorizationRule', 'errorMessage' => 'The param of AuthorizationRuleId is illegal.', 'description' => 'AuthorizationRuleId非法'], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], + ['errorCode' => 'OperationDenied.NotSupportModify', 'errorMessage' => 'The operation is not allowed because of this type not support modify.', 'description' => '此类型不支持修改。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"IpMappingRuleId\\": \\"im-irrp3bzuu5nrbx****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIpMappingRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <IpMappingRuleId>im-irrp3bzuu5nrbx****</IpMappingRuleId>\\n</CreateIpMappingRuleResponse>","errorExample":""}]', - 'title' => '创建授权规则IP的重定向功能', - ], - 'UpdateIpMappingRule' => [ - 'summary' => '调用UpdateIpMappingRule接口修改授权规则IP重定向的相关信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAuthorizationRuleAttributeResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</UpdateAuthorizationRuleAttributeResponse>","errorExample":""}]', + 'title' => '更新授权规则信息', + 'changeSet' => [ + ['createdAt' => '2022-06-23T05:13:55.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-03-08T07:52:22.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-07-23T09:49:14.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAuthorizationRuleAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateAuthorizationRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'UpdateConnectionPoolAttribute' => [ + 'summary' => '更新连接地址池。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12346,194 +8808,132 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'IpMappingRuleId', + 'name' => 'ConnectionPoolId', 'in' => 'query', - 'schema' => [ - 'description' => '需要进行重定向的授权规则的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'im-irrp3bzuu5nrbx****', - ], + 'schema' => ['description' => '连接地址池的ID。', 'type' => 'string', 'required' => true, 'example' => 'cp-bp11234abctmno0hdq****'], ], [ - 'name' => 'DestinationIp', + 'name' => 'Count', 'in' => 'query', - 'schema' => [ - 'description' => '重定向的目标IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.10.8', - ], + 'schema' => ['description' => '物联网卡的数量。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ - 'name' => 'MappingIp', + 'name' => 'ConnectionPoolName', 'in' => 'query', - 'schema' => [ - 'description' => '需要进行重定向的IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => '47.0.XX.XX', - ], + 'schema' => ['description' => '连接地址池的名称。'."\n" + ."\n" + .'长度为2~128个字符，必须以字母或中文开头，可包含数字、下划线（_）和短划线（-）。但不能以`http:// `或`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'pool01'], ], [ - 'name' => 'IpMappingRuleName', + 'name' => 'ConnectionPoolDescription', 'in' => 'query', - 'schema' => [ - 'description' => '需要进行IP重定向的授权规则名称。'."\n" - ."\n" - .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['description' => '连接地址池的描述信息。'."\n" + ."\n" + .'长度为2~256个字符，必须以字母或中文开头，但不能以`http:// `或`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'pool01'], ], [ - 'name' => 'IpMappingRuleDescription', + 'name' => 'Cidrs', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '需要进行IP重定向的授权规则描述。'."\n" + 'description' => '连接地址池所属的CIDR地址块。**N**的取值范围：**1**~**20**。'."\n" ."\n" - .'长度为2~256个字符，必须以字母或中文开头，但不能以`http://` 或`https://`开头。', - 'type' => 'string', + .'多个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, - 'example' => 'description', + 'maxItems' => 20, ], ], [ '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', - ], + '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**：发送检查请求，不会修改授权规则IP重定向的相关信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。 '."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '请求ID。', + 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'ResourceNotFound.ConnectionPool', 'errorMessage' => 'The param of ConnectionPoolId is illegal.', 'description' => 'ConnectionPoolId参数非法'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'IllegalParam.Cidrs', 'errorMessage' => 'The param of Cidrs is illegal.', 'description' => 'cidrs参数错误'], + ['errorCode' => 'IllegalParam.ConnectionPoolId', 'errorMessage' => 'The param of ConnectionPoolId is illegal.', 'description' => 'ConnectionPoolId不存在'], + ['errorCode' => 'OperationDenied.GrantedInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of granted instance not support.', 'description' => '授权实例不允许IP管理相关操作。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIpMappingRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</UpdateIpMappingRuleResponse>","errorExample":""}]', - 'title' => '修改授权规则IP重定向的相关信息', - ], - 'ListIpMappingRules' => [ - 'summary' => '调用ListIpMappingRules接口查询授权规则IP重定向信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateConnectionPoolAttributeResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</UpdateConnectionPoolAttributeResponse>","errorExample":""}]', + 'title' => '更新连接地址池', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:38.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConnectionPoolAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateConnectionPoolAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'UpdateDNSServiceRuleAttribute' => [ + 'summary' => '修改DNS授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12542,301 +8942,146 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-1y6h8z7imd2yu4****'], ], [ - 'name' => 'IpMappingRuleIds', + 'name' => 'DNSServiceRuleId', '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, - ], + 'schema' => ['description' => 'DNS授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'ar-r56ijpurlu50gi****'], ], [ - 'name' => 'MappingIps', + 'name' => 'ServiceType', '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, - ], + 'schema' => ['description' => 'DNS授权规则的目标类型。取值：'."\n" + ."\n" + .'- **Normal**：普通类型。'."\n" + ."\n" + .'- **DNSRedirect**：重定向类型，重定向类型指将当前DNS服务地址重定向至另一个地址。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], ], [ - 'name' => 'IpMappingRuleStatuses', + 'name' => 'Destination', '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, - ], + 'schema' => ['description' => '重定向后的DNS服务地址。'."\n" + ."\n" + .'> 当**ServiceType**参数取值为**DNSRedirect**时，该参数必选。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.2'], ], [ - 'name' => 'IpMappingRuleNames', + 'name' => 'Source', '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, - ], + '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" + .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>', 'type' => 'string', 'required' => false, 'example' => '100.100.2.138'], ], [ - 'name' => 'DestinationIps', + 'name' => 'DNSServiceRuleName', '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, - ], + 'schema' => ['description' => 'DNS授权规则名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'NextToken', + 'name' => 'DNSServiceRuleDescription', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" - .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + 'schema' => ['description' => 'DNS授权规则描述。'."\n" + ."\n" + .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ - 'name' => 'MaxResults', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**100**，默认值为**20**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + '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' => '实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'DNS授权规则所在的地域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', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC6D1C1D-6DBD-568C-B867-BC9CA699ED01'], ], + '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.NoParamModify', 'errorMessage' => 'The operation is not allowed because of no param modified.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'QuotaExceeded.sourceCidrLimit', 'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded', 'description' => 'SourceCidrsPerAuthorizationRule quota超出'], + ['errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit', 'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'IllegalParam', 'errorMessage' => 'The param is illegal.', 'description' => '参数非法'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.AuthorizationRule', 'errorMessage' => 'The param of AuthorizationRuleId is illegal.', 'description' => 'AuthorizationRuleId非法'], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - '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":"<ListIpMappingRulesResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <IpMappingRules>\\n <IoTCloudConnectorId>iotcc-bp1odcab8tmno0hdq****</IoTCloudConnectorId>\\n <IpMappingRuleId>im-irrp3bzuu5nrbx****</IpMappingRuleId>\\n <IpMappingRuleStatus>Created</IpMappingRuleStatus>\\n <MappingIp>47.0.XX.XX</MappingIp>\\n <DestinationIp>192.168.10.8</DestinationIp>\\n <IpMappingRuleName>name</IpMappingRuleName>\\n <IpMappingRuleDescription>description</IpMappingRuleDescription>\\n </IpMappingRules>\\n</ListIpMappingRulesResponse>","errorExample":""}]', - 'title' => '查询授权规则IP重定向信息', - ], - 'DeleteIpMappingRule' => [ - 'summary' => '调用DeleteIpMappingRule接口删除授权规则IP重定向信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC6D1C1D-6DBD-568C-B867-BC9CA699ED01\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateDNSServiceRuleAttributeResponse>\\n <RequestId>BC6D1C1D-6DBD-568C-B867-BC9CA699ED01</RequestId>\\n</UpdateDNSServiceRuleAttributeResponse>","errorExample":""}]', + 'title' => '修改DNS授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:36.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-17T07:06:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-02-17T05:32:11.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDNSServiceRuleAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateDNSServiceRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'UpdateGroupAuthorizationRuleAttribute' => [ + 'summary' => '修改实例组的授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12845,129 +9090,169 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorId', + 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'IpMappingRuleId', + 'name' => 'AuthorizationRuleDescription', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的IP重定向的授权规则的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'im-irrp3bzuu5nrbx****', - ], + 'schema' => ['description' => '授权规则的描述信息。'."\n" + ."\n" + .'长度为2~256个字符，必须以字母或中文开头，但不能以`http://` 或`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'rule'], ], [ - 'name' => 'ClientToken', + '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' => '客户端Token，用于保证请求的幂等性。'."\n" - ."\n" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', + 'description' => '源CIDR地址块。N的取值范围：**1**~**20**。', + 'type' => 'array', + 'items' => ['description' => '源CIDR地址块。N的取值范围：**1**~**20**。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1'], 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', + '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**：发送检查请求，不会删除授权规则IP重定向信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会修改实例组的授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '请求ID。', + 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + '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' => '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'OperationDenied.NoFieldModify', 'errorMessage' => 'The operation is not allowed because of no field modify.', 'description' => '没有变更任何参数，操作不允许。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIpMappingRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</DeleteIpMappingRuleResponse>","errorExample":""}]', - 'title' => '删除授权规则IP重定向信息', - ], - 'CreateGroupIpMappingRule' => [ - 'summary' => '调用CreateGroupIpMappingRule接口创建实例组授权规则IP的重定向规则。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AuthorizationRuleId\\": \\"gar-ez91t41jvi6tr8****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateGroupAuthorizationRuleAttributeResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <AuthorizationRuleId>gar-ez91t41jvi6tr8****</AuthorizationRuleId>\\n</UpdateGroupAuthorizationRuleAttributeResponse>","errorExample":""}]', + 'title' => '修改实例组的授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-27T16:03:41.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-23T06:27:36.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-01-04T12:38:26.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-16T05:13:55.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-14T12:33:41.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-14T09:32:05.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupAuthorizationRuleAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateGroupAuthorizationRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'UpdateGroupDNSServiceRuleAttribute' => [ + 'summary' => '修改实例组的DNS授权规则。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12979,165 +9264,133 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '云连接器实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'IpMappingRuleDescription', + 'name' => 'DNSServiceRuleDescription', 'in' => 'query', - 'schema' => [ - 'description' => '需要进行实例组IP重定向的授权规则描述。'."\n" - ."\n" - .'长度为2~256个字符，必须以字母或中文开头，但不能以`http:// `或`https://`开头。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'schema' => ['description' => 'DNS授权规则描述。'."\n" + ."\n" + .'长度为2~256个字符，开头必须为大小写英文字母或中文，但不能为`http://`或`https://`。', 'type' => 'string', 'required' => false, 'example' => 'description'], ], [ - 'name' => 'IpMappingRuleName', + 'name' => 'DNSServiceRuleName', 'in' => 'query', - 'schema' => [ - 'description' => '需要进行实例组IP重定向的授权规则名称。'."\n" - ."\n" - .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['description' => 'DNS授权规则名称。'."\n" + ."\n" + .'长度为2~128个英文或中文字符，开头必须为大小写英文字母或中文，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'DestinationIp', + 'name' => 'DNSServiceRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '重定向的目标IP地址。', - 'type' => 'string', - 'required' => true, - 'example' => '192.168.10.8', - ], + 'schema' => ['description' => 'DNS授权规则ID。', 'type' => 'string', 'required' => true, 'example' => 'gar-ffnn1ewe2nmf3y****'], ], [ - 'name' => 'MappingIp', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '需要进行重定向的IP地址。', - 'type' => 'string', - 'required' => true, - 'example' => '47.0.XX.XX', - ], + '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" + .'<props="china">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://selfservice.console.aliyun.com/ticket/category/ga/today)，并在工单中附上需要申请的DNS授权规则的IP。'."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">除以上默认的DNS授权规则的IP，如有其他DNS授权规则的IP诉求，请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.11182188.console-base-top.dworkorder.18ae4882n3v6ZW#/ticket/createIndex)，并在工单中附上需要申请的DNS授权规则的IP。</props>'."\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" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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**：发送检查请求，不会创建实例组授权规则IP的重定向功能。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + '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', - ], - 'GroupIpMappingRuleId' => [ - 'description' => '需要进行IP重定向的授权规则的ID。', - 'type' => 'string', - 'example' => 'im-irrp3bzuu5nrbx****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '77111A6A-56BA-59B2-8CAA-7CBF21648FB8'], ], + 'description' => '', ], ], ], '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'errorMessage' => 'The quota of IoTCCGroupPerUser is exceeded', 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"77111A6A-56BA-59B2-8CAA-7CBF21648FB8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateGroupDNSServiceRuleAttributeResponse>\\n <RequestId>77111A6A-56BA-59B2-8CAA-7CBF21648FB8</RequestId>\\n</UpdateGroupDNSServiceRuleAttributeResponse>","errorExample":""}]', + 'title' => '改实例组的DNS授权规则', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:36.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-15T11:56:00.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupDNSServiceRuleAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:UpdateGroupDNSServiceRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"GroupIpMappingRuleId\\": \\"im-irrp3bzuu5nrbx****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupIpMappingRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <GroupIpMappingRuleId>im-irrp3bzuu5nrbx****</GroupIpMappingRuleId>\\n</CreateGroupIpMappingRuleResponse>","errorExample":""}]', - 'title' => '创建实例组授权规则IP的重定向规则', ], 'UpdateGroupIpMappingRule' => [ 'summary' => '调用UpdateGroupIpMappingRule接口修改实例组授权规则IP重定向的相关信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13149,112 +9402,65 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + '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', - ], + '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', - ], + '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****', - ], + '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', - ], + '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', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '实例组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -13263,54 +9469,49 @@ '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****', - ], + '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.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.NoFieldModify', 'errorMessage' => 'The operation is not allowed because of no field modify.', 'description' => '没有变更任何参数，操作不允许。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"IoTCloudConnectorGroupId\\": \\"iotccg-g00epppbi9di9y****\\",\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AuthorizationRuleId\\": \\"ar-1234abcb8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateGroupIpMappingRuleResponse>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <AuthorizationRuleId>ar-1234abcb8tmno0hdq****</AuthorizationRuleId>\\n</UpdateGroupIpMappingRuleResponse>","errorExample":""}]', 'title' => '修改实例组授权规则IP重定向的相关信', - ], - 'ListGroupIpMappingRules' => [ - 'summary' => '调用ListGroupIpMappingRules接口查询实例组授权规则IP重定向信息。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-23T06:53:44.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupIpMappingRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateGroupIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'UpdateIoTCloudConnectorAttribute' => [ + 'summary' => '更新云连接器实例信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13319,275 +9520,127 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ - 'name' => 'IoTCloudConnectorGroupId', + 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'IpMappingRuleIds', + 'name' => 'IoTCloudConnectorName', '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, - ], + 'schema' => ['description' => '云连接器实例的名称。'."\n" + ."\n" + .'名称长度为2~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）或短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - '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', + 'name' => 'IoTCloudConnectorDescription', '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, - ], + 'schema' => ['description' => '云连接器实例描述信息。'."\n" + ."\n" + .'长度为2~256个字符，必须以字母或中文开头，但不能以`http://` 或`https://`开头。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'IpMappingRuleNames', + 'name' => 'WildcardDomainEnabled', '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, - ], + 'schema' => ['description' => '是否开启泛域名功能。取值：'."\n" + .'- **true**（默认值）：开启。'."\n" + .'- **false**：关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'NextToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" - .'- 如果**NextToken**为空表示没有下一次查询。'."\n" - .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', - 'type' => 'string', - 'required' => false, - 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', - ], + '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' => 'MaxResults', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**100**，默认值为**20**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + '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', - ], + 'schema' => ['description' => '云连接器实例所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。 ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'MappingIps', + 'name' => 'Mode', '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, - ], + 'schema' => ['description' => '实例模式。取值：'."\n" + ."\n" + .'- **PassThrough**：直通模式。'."\n" + .'- **VpcNat**：私网NAT模式。', 'type' => 'string', 'required' => false, 'example' => 'PassThrough'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '请求ID。', + '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' => '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****', - ], - ], - ], - ], + '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' => 'ResourceNotFound.IoTCloudConnectorGroup', - 'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], + ['errorCode' => 'OperationDenied.NotAssociateVpc', 'errorMessage' => 'The operation is not allowed because of not associate vpc.', 'description' => '云连接器没有绑定vpc/vsw。'], + ['errorCode' => 'OperationDenied.BasicInstanceNotSupportPassThrough', 'errorMessage' => 'The operation is not allowed because of basic instance not support.', 'description' => '基础版实例不支持此操作。'], + ['errorCode' => 'IllegalParam.Mode', 'errorMessage' => 'The param of Mode is illegal.', 'description' => 'Mode参数非法。'], ], ], - '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":"<ListGroupIpMappingRulesResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <TotalCount>10</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <IpMappingRules>\\n <IoTCloudConnectorGroupId>iotccg-g00epppbi9di9y****</IoTCloudConnectorGroupId>\\n <IpMappingRuleStatus>Created</IpMappingRuleStatus>\\n <MappingIp>47.0.XX.XX</MappingIp>\\n <DestinationIp>192.168.10.8</DestinationIp>\\n <IpMappingRuleName>name</IpMappingRuleName>\\n <IpMappingRuleDescription>description</IpMappingRuleDescription>\\n <IpMappingRuleId>im-irrp3bzuu5nrbx****</IpMappingRuleId>\\n </IpMappingRules>\\n</ListGroupIpMappingRulesResponse>","errorExample":""}]', - 'title' => '查询实例组授权规则IP重定向信息', - ], - 'DeleteGroupIpMappingRule' => [ - 'summary' => '调用DeleteGroupIpMappingRule接口删除实例组授权规则IP重定向信息。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIoTCloudConnectorAttributeResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <ResourceId>iotcc-bp1odcab8tmno0hdq****</ResourceId>\\n</UpdateIoTCloudConnectorAttributeResponse>","errorExample":""}]', + 'title' => '更新云连接器实例信息', + 'changeSet' => [ + ['createdAt' => '2022-11-24T03:04:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-09-14T07:10:46.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-09-14T07:10:46.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-26T07:05:10.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIoTCloudConnectorAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateIoTCloudConnectorAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'UpdateIoTCloudConnectorGroupAttribute' => [ + 'summary' => '修改云连接器分组属性。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13596,71 +9649,53 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotccg-g00epppbi9di9y****', - ], + 'schema' => ['description' => '实例组ID。', 'type' => 'string', 'required' => true, 'example' => 'iotccg-g00epppbi9di9y****'], ], [ - 'name' => 'GroupIpMappingRuleId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的实例组IP重定向的授权规则的ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'im-irrp3bzuu5nrbx****', - ], + '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" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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**：发送检查请求，不会删除实例组授权规则IP重定向信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + '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', - ], + 'schema' => ['description' => '实例组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -13669,40 +9704,50 @@ 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + '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', - ], + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnectorGroup', 'errorMessage' => 'The specified resource of IoTCloudConnectorGroup is configuring, please try again later.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnectorGroup', 'errorMessage' => 'The param of IoTCloudConnectorGroupId is illegal.', 'description' => ''], + ['errorCode' => 'OperationDenied.CC5GInstanceNotSupport', 'errorMessage' => 'The operation is not allowed because of CC5G instance not support.', 'description' => 'CC5G托管实例不支持此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGroupIpMappingRuleResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteGroupIpMappingRuleResponse>","errorExample":""}]', - 'title' => '删除实例组授权规则IP重定向信息', - ], - 'ConfirmIoTCloudConnector' => [ - 'summary' => '调用ConfirmIoTCloudConnector接口确认或拒绝云连接器实例过户。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIoTCloudConnectorGroupAttributeResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateIoTCloudConnectorGroupAttributeResponse>","errorExample":""}]', + 'title' => '修改云连接器分组属性', + 'changeSet' => [ + ['createdAt' => '2022-08-26T16:03:36.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-12-14T09:32:05.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIoTCloudConnectorGroupAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateIoTCloudConnectorGroupAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + ], + ], + 'UpdateIpMappingRule' => [ + 'summary' => '调用UpdateIpMappingRule接口修改授权规则IP重定向的相关信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13714,71 +9759,65 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + 'abilityTreeNodes' => ['FEATUREuisYFDH9T'], ], 'parameters' => [ [ 'name' => 'IoTCloudConnectorId', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'iotcc-bp1odcab8tmno0hdq****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'ClientToken', + 'name' => 'IpMappingRuleId', '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', - ], + 'schema' => ['description' => '需要进行重定向的授权规则的ID。', 'type' => 'string', 'required' => true, 'example' => 'im-irrp3bzuu5nrbx****'], ], [ - 'name' => 'DryRun', + 'name' => 'DestinationIp', 'in' => 'query', - 'schema' => [ - 'description' => '是否只预检此次请求。取值：'."\n" - .'- **true**：发送检查请求，不会确认或拒绝云连接器实例过户。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" - .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '重定向的目标IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.10.8'], ], [ - 'name' => 'RegionId', + 'name' => 'MappingIp', 'in' => 'query', - 'schema' => [ - 'description' => '云连接器实例所在的地域ID。'."\n" - ."\n" - .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '需要进行重定向的IP地址。', 'type' => 'string', 'required' => false, 'example' => '47.0.XX.XX'], ], [ - 'name' => 'ConfirmStatus', + 'name' => 'IpMappingRuleName', 'in' => 'query', - 'schema' => [ - 'description' => '确认状态。取值：'."\n" - ."\n" - .'- **Confirm**：确认。'."\n" - .'- **Refuse**：拒绝。', - 'type' => 'string', - 'required' => true, - 'example' => 'Confirm', - ], + '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' => [ @@ -13787,53 +9826,56 @@ 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', - ], - 'ResourceId' => [ - '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' => '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ['errorCode' => 'OperationDenied.NoParamModify', 'errorMessage' => 'The operation is not allowed because of no param modified.', 'description' => ''], + ['errorCode' => 'ResourceNotFound.IoTCloudConnector', 'errorMessage' => 'The param of IoTCloudConnectorId is illegal.', 'description' => 'IoTCloudConnectorId参数非法'], + ['errorCode' => 'QuotaExceeded.sourceCidrLimit', 'errorMessage' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded', 'description' => 'SourceCidrsPerAuthorizationRule quota超出'], + ['errorCode' => 'QuotaExceeded.authorizationRuleInstanceLimit', 'errorMessage' => 'The quota of AuthorizationRulePerIotCC is exceeded', 'description' => ''], + ['errorCode' => 'IllegalParamFormat', 'errorMessage' => 'The param is illegal.', 'description' => ''], + ['errorCode' => 'IllegalParam', 'errorMessage' => 'The param is illegal.', 'description' => '参数非法'], + ['errorCode' => 'ResourceInConfiguring.IoTCloudConnector', 'errorMessage' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['errorCode' => 'ResourceNotFound.IpMapping', 'errorMessage' => 'The param of IpMapping is illegal.', 'description' => 'IP地址映射对象未发现'], + ['errorCode' => 'IllegalParam.Destination', 'errorMessage' => 'The param of Destination is illegal.', 'description' => 'Destination无效'], + ['errorCode' => 'OperationDenied.NotSupportModify', 'errorMessage' => 'The operation is not allowed because of this type not support modify.', 'description' => '此类型不支持修改。'], + ['errorCode' => 'OperationDenied.CIDRMaskTooLarge', 'errorMessage' => 'The operation is not allowed because of CIDR too large.', 'description' => 'CIDR掩码太大了。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<ConfirmIoTCloudConnectorResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <ResourceId>iotcc-bp1odcab8tmno0hdq****</ResourceId>\\n</ConfirmIoTCloudConnectorResponse>","errorExample":""}]', - 'title' => '确认或拒绝云连接器实例过户', - ], - 'RevertIoTCloudConnector' => [ - 'summary' => '调用RevertIoTCloudConnector接口归还已拒绝过户的云连接器实例。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIpMappingRuleResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n</UpdateIpMappingRuleResponse>","errorExample":""}]', + 'title' => '修改授权规则IP重定向的相关信息', + 'changeSet' => [ + ['createdAt' => '2022-08-23T06:53:44.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIpMappingRule'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'UpdateServiceAttribute' => [ + 'summary' => '修改分应用统计服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13845,113 +9887,102 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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****', - ], + '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" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '分应用统计服务所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回参数列表。', + 'description' => '返回信息列表。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], - 'ResourceId' => [ - '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' => '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' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"ResourceId\\": \\"iotcc-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<RevertIoTCloudConnectorResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <ResourceId>iotcc-bp1odcab8tmno0hdq****</ResourceId>\\n</RevertIoTCloudConnectorResponse>","errorExample":""}]', - 'title' => '归还已拒绝过户的云连接器实例', - ], - 'DeleteAuthorizationRules' => [ - 'summary' => '批量删除授权规则。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateServiceAttributeResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateServiceAttributeResponse>","errorExample":""}]', + 'title' => '修改分应用统计服务', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateServiceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], ], + ], + 'UpdateServiceEntryAttribute' => [ + 'summary' => '修改分应用统计服务列表中的应用条目。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13960,164 +9991,1918 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREuisYFDH9T', - ], + '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****', - ], + 'schema' => ['description' => '云连接器实例ID。', 'type' => 'string', 'required' => true, 'example' => 'iotcc-bp1odcab8tmno0hdq****'], ], [ - 'name' => 'AuthorizationRuleIds', + 'name' => 'ServiceEntryId', '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, - ], + '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' => '保证请求幂等性。'."\n" - .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" - ."\n" - .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + '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', - ], + 'schema' => ['description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会修改应用条目。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接修改应用条目。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。默认为cn-hangzhou。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '应用条目所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~313836~~)接口获取地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息体', + 'description' => '请求ID。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45'], ], ], ], ], '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.', + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'Ram user does not have permission to perform this operation.', 'description' => 'RAM用户无权限执行此操作。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateServiceEntryAttributeResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</UpdateServiceEntryAttributeResponse>","errorExample":""}]', + 'title' => '修改分应用统计列表的应用条目', + 'changeSet' => [ + ['createdAt' => '2021-11-18T06:52:02.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceEntryAttribute'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateServiceEntryAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]', - 'title' => '批量删除授权规则', ], ], 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-beijing.aliyuncs.com', 'endpoint' => 'iotcc.cn-beijing.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-chengdu.aliyuncs.com', 'endpoint' => 'iotcc.cn-chengdu.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-guangzhou.aliyuncs.com', 'endpoint' => 'iotcc.cn-guangzhou.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-hangzhou.aliyuncs.com', 'endpoint' => 'iotcc.cn-hangzhou.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-huhehaote.aliyuncs.com', 'endpoint' => 'iotcc.cn-huhehaote.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-qingdao.aliyuncs.com', 'endpoint' => 'iotcc.cn-qingdao.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-shanghai.aliyuncs.com', 'endpoint' => 'iotcc.cn-shanghai.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-shenzhen.aliyuncs.com', 'endpoint' => 'iotcc.cn-shenzhen.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iotcc.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'iotcc.cn-wulanchabu.aliyuncs.com', 'vpc' => 'iotcc-vpc.cn-wulanchabu.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'cardIdNotExist', 'message' => 'diagnose task iccid not exist', 'http_code' => 400, 'description' => '卡ID不存在'], + ['code' => 'CardIPAndIccIdNotMatch', 'message' => 'card ip and iccid not match', 'http_code' => 400, 'description' => '卡IP和卡ID不匹配。'], + ['code' => 'CardIPNotBind', 'message' => 'card ip not bind', 'http_code' => 400, 'description' => '卡IP未绑定。'], + ['code' => 'CardIPNotExist', 'message' => 'card ip not exist', 'http_code' => 400, 'description' => '卡IP不存在。'], + ['code' => 'Conflict.Cidr', 'message' => 'The CIDR is in conflict.', 'http_code' => 400, 'description' => 'cidr冲突'], + ['code' => 'Conflict.Param', 'message' => 'The parameter conflicts with an existing rule.', 'http_code' => 400, 'description' => '参数和已有的规则有冲突'], + ['code' => 'DomainAuthorizationRuleNotExist', 'message' => 'Domain authorization rule not exist.', 'http_code' => 400, 'description' => '白名单规则在目标云连接器实例中不存在。'], + ['code' => 'DomainIpNotExistInSourceCciot', 'message' => 'Domain Ip mapping not exist in source cciot.', 'http_code' => 400, 'description' => '域名和IP的映射关系在源云连接器中不存在。'], + ['code' => 'Forbidden.IPUsedInCIDR', 'message' => 'IP has been used in CIDR.', 'http_code' => 400, 'description' => 'CIDR中有IP已经被使用。'], + ['code' => 'Forbidden.RAM', 'message' => 'Ram user does not have permission to perform this operation.', 'http_code' => 400, 'description' => 'RAM用户无权限执行此操作。'], + ['code' => 'IllegalParam', 'message' => 'The param is illegal.', 'http_code' => 400, 'description' => '参数非法'], + ['code' => 'IllegalParam.AsynchronousOperateId', 'message' => 'The param of AsynchronousOperateId is illegal.', 'http_code' => 400, 'description' => '参数AsynchronousOperateId无效，没有查询到详细的值'], + ['code' => 'IllegalParam.AuthoriztionRuleId', 'message' => 'The param of AuthoriztionRuleId is illegal.', 'http_code' => 400, 'description' => 'AuthoriztionRuleId不存在'], + ['code' => 'IllegalParam.Cidrs', 'message' => 'The param of Cidrs is too many, only most 2 can be supported at a time.', 'http_code' => 400, 'description' => 'Cidrs的参数太多，一次最多只能支持2个。'], + ['code' => 'IllegalParam.Cidrs', 'message' => 'The param of Cidrs is illegal.', 'http_code' => 400, 'description' => 'cidrs参数错误'], + ['code' => 'IllegalParam.ConnectionPoolId', 'message' => 'The param of ConnectionPoolId is illegal.', 'http_code' => 400, 'description' => 'ConnectionPoolId不存在'], + ['code' => 'IllegalParam.Destination', 'message' => 'The param of Destination is illegal.', 'http_code' => 400, 'description' => 'Destination无效'], + ['code' => 'IllegalParam.DomainIps', 'message' => 'IP is invalid.', 'http_code' => 400, 'description' => 'IP值不合法。'], + ['code' => 'IllegalParam.DomainIps', 'message' => 'The param of DomainIps is illegal.', 'http_code' => 400, 'description' => 'DomainIps参数非法。'], + ['code' => 'IllegalParam.DurationMustBeLessThan2Hours', 'message' => 'The param of StartTime/EndTime is illegal.', 'http_code' => 400, 'description' => '结束时间不能大于开始时间2小时，最大只能查2个小时数据。'], + ['code' => 'IllegalParam.EndTimeMustBeGreaterThanStartTime', 'message' => 'The param of StartTime/EndTime is illegal.', 'http_code' => 400, 'description' => '开始时间不能大于结束时间。'], + ['code' => 'IllegalParam.Ips.Empty', 'message' => 'The param of Ips is illegal, Ips is empty', 'http_code' => 400, 'description' => '参数Ips是空'], + ['code' => 'IllegalParam.Mode', 'message' => 'The param of Mode is illegal.', 'http_code' => 400, 'description' => 'Mode参数非法。'], + ['code' => 'IllegalParam.SourceAndDestinationIoTCloudConnector.APN', 'message' => 'The param of SourceIoTCloudConnectorId and DestinationIoTCloudConnectorId is illegal, SourceIoTCloudConnector and DestinationIoTCloudConnector not in a APN.', 'http_code' => 400, 'description' => '原和目标云连接器不在同一个APN中'], + ['code' => 'IllegalParam.VpcId', 'message' => 'The param of Vpc is illegal.', 'http_code' => 400, 'description' => 'VpcId参数错误'], + ['code' => 'IllegalParam.VSwitch', 'message' => 'The param of VSwitch is illegal.', 'http_code' => 400, 'description' => 'vswitchId参数错误'], + ['code' => 'IllegalParam.VSwitchSize', 'message' => 'The param of VSwitch size is illegal.', 'http_code' => 400, 'description' => '虚拟机交换机参数数量不对。'], + ['code' => 'IllegalParamFormat', 'message' => 'The parameter format is illegal.', 'http_code' => 400, 'description' => '参数格式错误'], + ['code' => 'IllegalParamFormat', 'message' => 'Invalid parameter value.', 'http_code' => 400, 'description' => '参数错误。'], + ['code' => 'IllegalParamSize.Cidr', 'message' => 'The param size of Cidr is illegal, only support one.', 'http_code' => 400, 'description' => 'Cidr参数大小现在只能支持1。'], + ['code' => 'IllegalParamSize.VSwitchList', 'message' => 'The param size of VSwitch is illegal', 'http_code' => 400, 'description' => 'vSwitch参数长度非法'], + ['code' => 'IncorrectStatus.APNNotReady', 'message' => 'The status of APN is incorrect.', 'http_code' => 400, 'description' => 'APN当前没有准备好，请稍等。'], + ['code' => 'IncorrectStatus.IP', 'message' => 'The status of IP is incorrect.', 'http_code' => 400, 'description' => 'IP状态不对，可能IP未申请或者已经绑定到别的云连接器实例。'], + ['code' => 'MissingParam.IpParam', 'message' => 'The parameter of IP or IP path is missing.', 'http_code' => 400, 'description' => 'IP或者IP文件路径参数缺失。'], + ['code' => 'OperationDenied.AliUidNotSupport', 'message' => 'The operation is not allowed because of aliuid not support.', 'http_code' => 400, 'description' => '此操作不支持。'], + ['code' => 'OperationDenied.ApnDisabledWildcardDomain', 'message' => 'The operation failed because APN gateway has not enabled wildcard domain.', 'http_code' => 400, 'description' => 'APN网关未开启泛域名。'], + ['code' => 'OperationDenied.ApnNotOpenWildcardDomain', 'message' => 'The operation failed because APN gateway has not enabled wildcard domain.', 'http_code' => 400, 'description' => 'APN网关未开泛域名属性。'], + ['code' => 'OperationDenied.BasicInstanceNotSupportPassThrough', 'message' => 'The operation is not allowed because of basic instance not support.', 'http_code' => 400, 'description' => '基础版实例不支持此操作。'], + ['code' => 'OperationDenied.CC5GInstanceNotSupport', 'message' => 'The operation is not allowed because of CC5G instance not support.', 'http_code' => 400, 'description' => 'CC5G托管实例不支持此操作。'], + ['code' => 'OperationDenied.CIDRMaskTooLarge', 'message' => 'The operation is not allowed because of CIDR too large.', 'http_code' => 400, 'description' => 'CIDR掩码太大了。'], + ['code' => 'OperationDenied.DomainFeatureDisabled', 'message' => 'The operation failed. The wildcard domain is not enabled.', 'http_code' => 400, 'description' => '因为泛域名未开导致此次操作失败。'], + ['code' => 'OperationDenied.DomainInHumanNetwork', 'message' => 'The operation is not allowed because of domain or CIDR in human network.', 'http_code' => 400, 'description' => '配置的域名或者网段在人联网里面，不被允许。'], + ['code' => 'OperationDenied.GrantedInstanceNotSupport', 'message' => 'The operation is not allowed because of granted instance not support.', 'http_code' => 400, 'description' => '授权实例不允许IP管理相关操作。'], + ['code' => 'OperationDenied.IotCloudConnectorInGroup', 'message' => 'The operation is not allowed because of IotCloudConnector In Group.', 'http_code' => 400, 'description' => '本次操作不被允许的原因是IotCloudConnector在Group分组中.'], + ['code' => 'OperationDenied.IoTCloudConnectorServiceOpened', 'message' => 'The operation is not allowed because the IoTCC service has been activated.', 'http_code' => 400, 'description' => 'IoTCC服务已经开通。'], + ['code' => 'OperationDenied.NoFieldModify', 'message' => 'The operation is not allowed because of no field modify.', 'http_code' => 400, 'description' => '没有变更任何参数，操作不允许。'], + ['code' => 'OperationDenied.NoParamModify', 'message' => 'No parameter is modified. The operation is not allowed.', 'http_code' => 400, 'description' => '由于未修改任何参数，因此不允许该操作。'], + ['code' => 'OperationDenied.NotAssociateVpc', 'message' => 'The operation is not allowed because of not associate vpc.', 'http_code' => 400, 'description' => '云连接器没有绑定vpc/vsw。'], + ['code' => 'OperationDenied.NotOpenIoTCloudConnectorService', 'message' => 'The operation is not allowed because the IoTCC service is not activated.', 'http_code' => 400, 'description' => '因为未开通IoTCC服务，所以没法创建实例。'], + ['code' => 'OperationDenied.NotSupportModify', 'message' => 'The operation is not allowed because of this type not support modify.', 'http_code' => 400, 'description' => '此类型不支持修改。'], + ['code' => 'OperationDenied.OneVpcOnlySupportOneSpecIoTCC', 'message' => 'The operation is not allowed because of one vpc create different spec IoTCC not support.', 'http_code' => 400, 'description' => '单VPC不支持不同类型的云连接器。'], + ['code' => 'OperationDenied.UserVpcRouteAlreadyPublished', 'message' => 'The operation is not allowed because of user vpc route already published.', 'http_code' => 400, 'description' => '本操作不允许，原因是VPC路由已经存在。'], + ['code' => 'OperationDenied.VpcStatusNotSupport', 'message' => 'The operation is not allowed because of vpc status not support.', 'http_code' => 400, 'description' => 'VPC状态不支持此操作。'], + ['code' => 'QuotaExceeded.authorizationRuleInstanceLimit', 'message' => 'The quota of AuthorizationRulePerIotCC is exceeded.', 'http_code' => 400, 'description' => '单个云连接器的授权规则配额超限。'], + ['code' => 'QuotaExceeded.AuthorizationRulePerIotCC', 'message' => 'The quota of AuthorizationRulePerIotCC is exceeded', 'http_code' => 400, 'description' => 'AuthorizationRulePerIotCC quota超出'], + ['code' => 'QuotaExceeded.CIDRLimit', 'message' => 'The quota of cidr_limit is exceeded.', 'http_code' => 400, 'description' => '连接池CIDR列表长度超配额。'], + ['code' => 'QuotaExceeded.ConnectionPoolPerIoTCC', 'message' => 'The quota of ConnectionPoolPerIoTCC is exceeded', 'http_code' => 400, 'description' => 'ConnectionPoolPerIoTCC quota超出'], + ['code' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'message' => 'The quota of IoTCCGroupPerUser is exceeded', 'http_code' => 400, 'description' => '云连接器组包含的云连接器实例数量超规格'], + ['code' => 'QuotaExceeded.IoTCCGroupInstanceLimit', 'message' => 'The quota of IoTCC Group Per User is exceeded', 'http_code' => 400, 'description' => '每个用户的物联网云连接器分组配额超限。'], + ['code' => 'QuotaExceeded.iotccInstanceLimit', 'message' => 'The quota of IoTCCPerUser is exceeded.', 'http_code' => 400, 'description' => 'IoTCCPerUser quota超出'], + ['code' => 'QuotaExceeded.IoTCCPerUser', 'message' => 'The quota of IoTCCPerUser is exceeded', 'http_code' => 400, 'description' => 'quota超出'], + ['code' => 'QuotaExceeded.sourceCidrLimit', 'message' => 'The quota of SourceCidrsPerAuthorizationRule is exceeded', 'http_code' => 400, 'description' => 'SourceCidrsPerAuthorizationRule quota超出'], + ['code' => 'ResourceAlreadyAssociated.CloudConnector', 'message' => 'The specified resource of CloudConnector is already associated.', 'http_code' => 400, 'description' => '云连接器已经绑定了分组。'], + ['code' => 'ResourceAlreadyAssociated.VpcId', 'message' => 'The specified resource of VpcId already associated', 'http_code' => 400, 'description' => '已绑定vpc'], + ['code' => 'ResourceAlreadyExist.AuthorizationRule', 'message' => 'The specified resource of AuthorizationRule already exists.', 'http_code' => 400, 'description' => '规则已经存在'], + ['code' => 'ResourceInConfiguring.APN', 'message' => 'The specified resource of apn is being configured, please try again later.', 'http_code' => 400, 'description' => 'APN当前处于变配中状态，请稍后再试。'], + ['code' => 'ResourceInConfiguring.ConnectionPool', 'message' => 'The specified resource of ConnectionPool is being configured, please try again later.', 'http_code' => 400, 'description' => '实例的连接池当前的状态不对，请稍后再试。'], + ['code' => 'ResourceInConfiguring.DestinationIoTCloudConnector', 'message' => 'The specified resource of Destination IoTCloudConnector is configuring, please try again later.', 'http_code' => 400, 'description' => '目标云连接器的正在配置中，请稍后重试'], + ['code' => 'ResourceInConfiguring.IoTCloudConnector', 'message' => 'The specified resource of IoTCloudConnector is configuring, please try again later.', 'http_code' => 400, 'description' => 'iotcc状态非稳态，或者锁冲突'], + ['code' => 'ResourceInConfiguring.SourceIoTCloudConnector', 'message' => 'The specified resource of Source IoTCloudConnector is configuring, please try again later.', 'http_code' => 400, 'description' => '原云连接器当前出于配置中，请稍后再进行配置'], + ['code' => 'ResourceInCreating.IoTCloudConnector', 'message' => 'The specified resource of IoTCloudConnector is being created. Please try again later.', 'http_code' => 400, 'description' => '实例正在创建中，请稍后重试'], + ['code' => 'ResourceInUse.IoTCloudConnector', 'message' => 'The specified resource of IoTCC is in use.', 'http_code' => 400, 'description' => 'iotcc下有connection_pool未删除'], + ['code' => 'ResourceNotAssociated.VpcId', 'message' => 'The specified resource of VpcId is not associated.', 'http_code' => 400, 'description' => '用户VPC不存在'], + ['code' => 'ResourceNotEnough.APN', 'message' => 'The specified resource of APN is not enough.', 'http_code' => 400, 'description' => 'APN资源不足'], + ['code' => 'ResourceNotEnough.CIDRNotHaveEnoughIp', 'message' => 'The specified resource of IP in CIDR is not enough.', 'http_code' => 400, 'description' => 'APN CIDR中的IP已经不足。'], + ['code' => 'ResourceNotFound.AuthorizationRule', 'message' => 'The specified resource of AuthorizationRule is not found.', 'http_code' => 400, 'description' => '未找到此授权规则。'], + ['code' => 'ResourceNotFound.AuthorizationRule', 'message' => 'The param of AuthorizationRuleId is illegal.', 'http_code' => 400, 'description' => 'AuthorizationRuleId非法'], + ['code' => 'ResourceNotFound.ConnectionPool', 'message' => 'The specified resource of connection pool is not found.', 'http_code' => 400, 'description' => '未找到连接地址池。'], + ['code' => 'ResourceNotFound.ConnectionPool', 'message' => 'The param of ConnectionPoolId is illegal.', 'http_code' => 400, 'description' => 'ConnectionPoolId参数非法'], + ['code' => 'ResourceNotFound.DestinationIoTCloudConnector', 'message' => 'The param of DestinationIoTCloudConnectorId is illegal.', 'http_code' => 400, 'description' => '参数DestinationIoTCloudConnectorId无效'], + ['code' => 'ResourceNotFound.DestinationIoTCloudConnector.ConnectionPool', 'message' => 'The param of DestinationIoTCloudConnectorId is illegal, not exist ConnectionPool in Source IoTCloudConnector.', 'http_code' => 400, 'description' => '目标云连接器下的连接池不存在'], + ['code' => 'ResourceNotFound.IoTCloudConnector', 'message' => 'The param of IoTCloudConnectorId is illegal.', 'http_code' => 400, 'description' => 'IoTCloudConnectorId参数非法'], + ['code' => 'ResourceNotFound.Ip', 'message' => 'Ips:%s', 'http_code' => 400, 'description' => '原云连接器下不存在此IP地址'], + ['code' => 'ResourceNotFound.IpMapping', 'message' => 'The param of IpMapping is illegal.', 'http_code' => 400, 'description' => 'IP地址映射对象未发现'], + ['code' => 'ResourceNotFound.SourceAndDestinationIoTCloudConnector', 'message' => 'The param of SourceIoTCloudConnectorId and DestinationIoTCloudConnectorId is illegal.', 'http_code' => 400, 'description' => '原和目标云连接器均不存在'], + ['code' => 'ResourceNotFound.SourceIoTCloudConnector', 'message' => 'The param of SourceIoTCloudConnectorId is illegal.', 'http_code' => 400, 'description' => '参数SourceIoTCloudConnectorId无效'], + ['code' => 'ResourceNotFound.SourceIoTCloudConnector.ConnectionPool', 'message' => 'The param of SourceIoTCloudConnectorId is illegal, not exist ConnectionPool in Source IoTCloudConnector.', 'http_code' => 400, 'description' => '原云连接器下的连接池对象不存在'], + ['code' => 'ResourceNotFound.UploadFile', 'message' => 'The uploaded IP parameter file is not found.', 'http_code' => 400, 'description' => '上传的ip参数文件未找到。'], + ['code' => 'ResourceNotFound.UploadFile', 'message' => 'The specified resource of uploaded ip file is not found.', 'http_code' => 400, 'description' => '输入的IP文件未找到。'], + ['code' => 'ResourceNotSupport.CidrContainedIp', 'message' => 'The specified resource of Source IoTCloudConnector is not support.', 'http_code' => 400, 'description' => '云连接器下此IP地址存在其添加的网段中，不支持进行替换'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ListIoTCoudConnectorBackhaulRoute'], + ], + 'createdAt' => '2024-11-19T07:42:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AssociateVSwitchWithIoTCloudConnector'], + ], + 'createdAt' => '2023-05-19T02:45:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateIoTCloudConnector'], + ], + 'createdAt' => '2023-04-23T12:16:33.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'iotcc.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAuthorizationRules'], + ], + 'createdAt' => '2023-03-24T08:25:21.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'iotcc.cn-qingdao.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateIoTCloudConnector'], + ], + 'createdAt' => '2023-03-24T08:22:59.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'iotcc.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'CreateAuthorizationRules'], + ], + 'createdAt' => '2023-03-24T08:19:58.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'iotcc.cn-huhehaote.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'AssociateIpWithConnectionPool'], + ], + 'createdAt' => '2023-01-05T09:15:20.000Z', + 'description' => '增加错误码', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'iotcc.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UpdateIoTCloudConnectorAttribute'], + ], + 'createdAt' => '2022-11-24T03:05:41.000Z', + 'description' => '错误码更新', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'iotcc.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateIoTCloudConnector'], + ], + 'createdAt' => '2022-11-16T08:45:21.000Z', + 'description' => '下线cc创建接口泛域名开启关闭字段', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'iotcc.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'UpdateAuthorizationRuleAttribute'], + ], + 'createdAt' => '2022-10-17T02:12:05.000Z', + 'description' => '增加错误码', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'iotcc.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateGroupAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'UpdateGroupAuthorizationRuleAttribute'], + ], + 'createdAt' => '2022-10-17T02:12:05.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AssociateVSwitchWithIoTCloudConnector'], + ['description' => '错误码发生变更', 'api' => 'AssociateVSwitchWithIoTCloudConnector'], + ], + 'createdAt' => '2022-09-16T07:35:20.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UpdateIoTCloudConnectorAttribute'], + ['description' => '错误码发生变更', 'api' => 'UpdateIoTCloudConnectorAttribute'], + ], + 'createdAt' => '2022-09-14T07:10:58.000Z', + 'description' => '增加错误码', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'iotcc.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ListIoTCloudConnectors'], + ], + 'createdAt' => '2022-09-07T17:02:02.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListIoTCloudConnectorGroups'], + ], + 'createdAt' => '2022-09-02T08:28:55.000Z', + 'description' => '增加字段', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'CreateIpMappingRule'], + ], + 'createdAt' => '2022-08-29T07:23:34.000Z', + 'description' => 'ipmapping发布', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UpdateGroupAuthorizationRuleAttribute'], + ], + 'createdAt' => '2022-08-27T16:04:02.000Z', + 'description' => '新增错误吗', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListIoTCloudConnectors'], + ], + 'createdAt' => '2022-08-26T16:07:17.000Z', + 'description' => 'cc过户', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddCidrToConnectionPool'], + ['description' => '错误码发生变更', 'api' => 'AddIoTCloudConnectorToGroup'], + ['description' => '错误码发生变更', 'api' => 'AssociateIpWithConnectionPool'], + ['description' => 'OpenAPI 下线', 'api' => 'ConfirmIoTCloudConnector'], + ['description' => '错误码发生变更', 'api' => 'CreateAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'CreateAuthorizationRules'], + ['description' => '错误码发生变更', 'api' => 'CreateConnectionPool'], + ['description' => '错误码发生变更', 'api' => 'CreateDNSServiceRule'], + ['description' => '错误码发生变更', 'api' => 'CreateGroupAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'CreateGroupDNSServiceRule'], + ], + 'createdAt' => '2022-08-26T16:04:13.000Z', + 'description' => 'cc过户', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateGroupIpMappingRule'], + ['description' => '请求参数发生变更', 'api' => 'ListGroupIpMappingRules'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateGroupIpMappingRule'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateIpMappingRule'], + ], + 'createdAt' => '2022-08-23T06:53:59.000Z', + 'description' => 'IpMapping接口发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DeleteGroupIpMappingRule'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteIpMappingRule'], + ], + 'createdAt' => '2022-08-22T09:44:48.000Z', + 'description' => 'IpMapping相关接口新发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ListIpMappingRules'], + ], + 'createdAt' => '2022-08-20T01:37:11.000Z', + 'description' => 'ListIpMappingRule', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateIpMappingRule'], + ], + 'createdAt' => '2022-08-19T03:29:34.000Z', + 'description' => 'IpMapping功能发布', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAuthorizationRules'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListGroupAuthorizationRules'], + ], + 'createdAt' => '2022-08-18T12:30:54.000Z', + 'description' => '支持端口级别白名单规则', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListIoTCloudConnectors'], + ], + 'createdAt' => '2022-08-10T10:09:51.000Z', + 'description' => '增加服务类型', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateGroupAuthorizationRule'], + ], + 'createdAt' => '2022-08-05T08:40:50.000Z', + 'description' => '新增错误吗', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListAuthorizationRules'], + ], + 'createdAt' => '2022-08-04T08:06:07.000Z', + 'description' => '变更', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateAuthorizationRules'], + ], + 'createdAt' => '2022-08-02T07:48:53.000Z', + 'description' => '批量创建ar', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpdateIoTCloudConnectorAttribute'], + ], + 'createdAt' => '2022-07-26T07:05:41.000Z', + 'description' => '源IP保持', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListIoTCloudConnectorEIPs'], + ], + 'createdAt' => '2022-06-21T08:03:53.000Z', + 'description' => '字段更新', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListIoTCloudConnectorEIPs'], + ], + 'createdAt' => '2022-06-21T07:43:19.000Z', + 'description' => '字段属性修改', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListIoTCloudConnectorEIPs'], + ], + 'createdAt' => '2022-06-21T07:38:39.000Z', + 'description' => '返回值修改', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListAPNs'], + ['description' => 'OpenAPI 下线', 'api' => 'ListIoTCloudConnectorEIPs'], + ], + 'createdAt' => '2022-06-20T09:09:49.000Z', + 'description' => '基础版', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateGroupAuthorizationRule'], + ['description' => '请求参数发生变更', 'api' => 'CreateIoTCloudConnectorGroup'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListGroupAuthorizationRules'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListIoTCloudConnectorGroups'], + ], + 'createdAt' => '2022-06-13T11:45:20.000Z', + 'description' => 'group新增type字段', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListIoTCloudConnectors'], + ], + 'createdAt' => '2022-06-13T09:41:53.000Z', + 'description' => '添加ListCC的Type字段', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ListConnectionPoolAllIps'], + ], + 'createdAt' => '2022-06-08T06:27:48.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'CreateGroupAuthorizationRule'], + ], + 'createdAt' => '2022-06-07T11:37:08.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateGroupAuthorizationRule'], + ], + 'createdAt' => '2022-05-23T04:51:53.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddCidrToConnectionPool'], + ], + 'createdAt' => '2022-05-10T11:40:23.000Z', + 'description' => '错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'], + ], + 'createdAt' => '2022-05-10T11:39:17.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'], + ['description' => '请求参数发生变更', 'api' => 'ListIoTCoudConnectorBackhaulRoute'], + ], + 'createdAt' => '2022-05-07T02:01:03.000Z', + 'description' => '发布新接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteIoTCloudConnetorBackhaulRoute'], + ['description' => '响应参数发生变更', 'api' => 'ListIoTCloudConnectors'], + ['description' => 'OpenAPI 下线', 'api' => 'ListIoTCoudConnectorBackhaulRoute'], + ], + 'createdAt' => '2022-05-06T12:58:12.000Z', + 'description' => '新发布接口', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UpdateGroupAuthorizationRuleAttribute'], + ], + 'createdAt' => '2022-04-13T07:20:44.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListIoTCloudConnectorAccessSessionLogs'], + ], + 'createdAt' => '2022-04-11T03:36:23.000Z', + 'description' => '变更一下时间字段，且时间必填', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ListIoTCloudConnectorAccessSessionLogs'], + ], + 'createdAt' => '2022-04-11T03:35:18.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AssociateVSwitchWithIoTCloudConnector'], + ['description' => '错误码发生变更', 'api' => 'UpdateAuthorizationRuleAttribute'], + ], + 'createdAt' => '2022-03-08T07:55:10.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddCidrToConnectionPool'], + ['description' => '错误码发生变更', 'api' => 'CreateIoTCloudConnector'], + ], + 'createdAt' => '2022-02-25T07:55:26.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateGroupDNSServiceRule'], + ], + 'createdAt' => '2022-02-22T11:32:48.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ListDiagnoseInfoForSingleCard'], + ['description' => '错误码发生变更', 'api' => 'SubmitDiagnoseTaskForSingleCard'], + ], + 'createdAt' => '2022-02-21T08:46:30.000Z', + 'description' => '增加错误码返回', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAuthorizationRules'], + ], + 'createdAt' => '2022-02-18T03:00:48.000Z', + 'description' => '添加规则类型查询和展示', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDNSServiceRule'], + ['description' => '请求参数发生变更', 'api' => 'UpdateDNSServiceRuleAttribute'], + ], + 'createdAt' => '2022-02-17T07:30:36.000Z', + 'description' => '描述和名称字段变更', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDNSServiceRule'], + ['description' => '请求参数发生变更', 'api' => 'UpdateDNSServiceRuleAttribute'], + ], + 'createdAt' => '2022-02-17T07:30:09.000Z', + 'description' => '名称和描述字段名称调整', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateDNSServiceRule'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateGroupDNSServiceRule'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteDNSServiceRule'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteGroupDNSServiceRule'], + ['description' => 'OpenAPI 下线', 'api' => 'ListDNSServiceRules'], + ['description' => 'OpenAPI 下线', 'api' => 'ListGroupDNSServiceRules'], + ['description' => 'OpenAPI 下线', 'api' => 'MoveAuthorizationRuleToDNSService'], + ['description' => 'OpenAPI 下线', 'api' => 'MoveGroupAuthorizationRuleToDNSService'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateDNSServiceRuleAttribute'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateGroupDNSServiceRuleAttribute'], + ], + 'createdAt' => '2022-02-15T11:56:48.000Z', + 'description' => 'DNS服务/DNS重定向功能', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListDiagnoseInfoForSingleCard'], + ], + 'createdAt' => '2022-02-15T03:26:57.000Z', + 'description' => '修改字段名', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetDiagnoseResultForSingleCard'], + ], + 'createdAt' => '2022-02-15T03:26:17.000Z', + 'description' => '修改字段名', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddCidrToConnectionPool'], + ['description' => '错误码发生变更', 'api' => 'CreateConnectionPool'], + ], + 'createdAt' => '2022-01-20T05:15:32.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateConnectionPool'], + ], + 'createdAt' => '2022-01-12T08:50:06.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddIoTCloudConnectorToGroup'], + ], + 'createdAt' => '2021-12-28T04:34:20.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListIoTCloudConnectors'], + ], + 'createdAt' => '2021-12-21T16:07:14.000Z', + 'description' => 'cc查询接口新增group id过滤条件', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DissociateIpFromConnectionPool'], + ], + 'createdAt' => '2021-12-21T10:12:16.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListConnectionPoolAllIps'], + ['description' => '响应参数发生变更', 'api' => 'ListIoTCloudConnectorGroups'], + ], + 'createdAt' => '2021-12-21T08:49:05.000Z', + 'description' => 'group的cc信息增加isp/apnall ips返回cout是所有ip的总数（包括cidr打散的）', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateConnectionPool'], + ], + 'createdAt' => '2021-12-21T07:37:59.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DeleteAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'DeleteIoTCloudConnector'], + ], + 'createdAt' => '2021-12-20T08:55:48.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddCidrToConnectionPool'], + ], + 'createdAt' => '2021-12-20T08:36:10.000Z', + 'description' => '增加错误码', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListIoTCloudConnectors'], + ], + 'createdAt' => '2021-12-20T07:13:27.000Z', + 'description' => '增加cc分组筛选功能', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'AddCidrToConnectionPool'], + ], + 'createdAt' => '2021-12-16T16:16:27.000Z', + 'description' => '新增给地址池增量加网段功能', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ListConnectionPoolAllIps'], + ], + 'createdAt' => '2021-12-16T11:28:29.000Z', + 'description' => '动态IP', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ListGroupAuthorizationRules'], + ['description' => '请求参数发生变更', 'api' => 'UpdateGroupAuthorizationRuleAttribute'], + ], + 'createdAt' => '2021-12-16T05:14:33.000Z', + 'description' => '分组规则更新和查询接口发布', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateGroupAuthorizationRule'], + ['description' => '请求参数发生变更', 'api' => 'UpdateGroupAuthorizationRuleAttribute'], + ], + 'createdAt' => '2021-12-15T03:36:12.000Z', + 'description' => 'sourcecidrs拼写错误', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateGroupAuthorizationRule'], + ], + 'createdAt' => '2021-12-14T12:19:46.000Z', + 'description' => 'group ar增加policy字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'AddIoTCloudConnectorToGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateGroupAuthorizationRule'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateIoTCloudConnectorGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteGroupAuthorizationRule'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteIoTCloudConnectorGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'ListIoTCloudConnectorGroups'], + ['description' => 'OpenAPI 下线', 'api' => 'RemoveIoTCloudConnectorFromGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateGroupAuthorizationRuleAttribute'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateIoTCloudConnectorGroupAttribute'], + ], + 'createdAt' => '2021-12-14T09:32:44.000Z', + 'description' => '规则分组功能', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AssociateIpWithConnectionPool'], + ['description' => '错误码发生变更', 'api' => 'AssociateVSwitchWithIoTCloudConnector'], + ['description' => '错误码发生变更', 'api' => 'CreateAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'CreateConnectionPool'], + ['description' => '错误码发生变更', 'api' => 'CreateIoTCloudConnector'], + ['description' => '错误码发生变更', 'api' => 'CreateService'], + ['description' => '错误码发生变更', 'api' => 'CreateServiceEntry'], + ['description' => '错误码发生变更', 'api' => 'DeleteAuthorizationRule'], + ['description' => '错误码发生变更', 'api' => 'DeleteConnectionPool'], + ['description' => '错误码发生变更', 'api' => 'DeleteIoTCloudConnector'], + ], + 'createdAt' => '2021-11-18T06:53:45.000Z', + 'description' => '增加RAM错误码信息', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListAPNs'], + ], + 'createdAt' => '2021-11-18T05:36:27.000Z', + 'description' => 'ListAPN增加ISP字段', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UpdateAuthorizationRuleAttribute'], + ], + 'createdAt' => '2021-10-22T14:32:21.000Z', + 'description' => '修改白名单接口新增错误码', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListAuthorizationRules'], + ], + 'createdAt' => '2021-09-22T10:09:43.000Z', + 'description' => '白名单支持domain过滤', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'AssociateIpWithConnectionPool'], + ['description' => '请求参数发生变更', 'api' => 'DissociateIpFromConnectionPool'], + ], + 'createdAt' => '2021-09-09T10:07:50.000Z', + 'description' => 'ip限定到1000个', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'AssociateIpWithConnectionPool'], + ['description' => '请求参数发生变更', 'api' => 'DissociateIpFromConnectionPool'], + ], + 'createdAt' => '2021-09-09T09:51:48.000Z', + 'description' => 'ip变更成2000', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'AssociateIpWithConnectionPool'], + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'DissociateIpFromConnectionPool'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListIoTCloudConnectors'], + ], + 'createdAt' => '2021-09-07T13:13:07.000Z', + 'description' => '绑定解绑支持文件参数', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GrantVirtualBorderRouter'], + ], + 'createdAt' => '2021-08-06T04:03:43.000Z', + 'description' => '新增一个授权vbr的接口，授权后端cciotgw网关能够绑定这个专线vbr', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIpMappingRules'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIoTCloudConnectorGroup'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIoTCloudConnectorFromGroup'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIoTCloudConnetorBackhaulRoute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantVirtualBorderRouter'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDNSServiceRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenIoTCloudConnectorService'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDNSServiceRuleAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateVSwitchWithIoTCloudConnector'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAPNs'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConnectionPoolAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableIoTCloudConnectorAccessLog'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnectionPoolAllIps'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnectionPool'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionPoolIpOperationResult'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIoTCloudConnectorAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevertIoTCloudConnector'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupDNSServiceRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupAuthorizationRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorEIPs'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupAuthorizationRuleAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIoTCloudConnector'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCoudConnectorBackhaulRoute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveAuthorizationRuleToDNSService'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIoTCloudConnectorAccessLog'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAuthorizationRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateIpWithConnectionPool'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConnectionPool'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupAuthorizationRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAuthorizationRules'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableIoTCloudConnectorAccessLog'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceEntries'], + ['threshold' => '5', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetStsInfoAndOssPath'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateService'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectors'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIpMappingRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAuthorizationRuleAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupIpMappingRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmIoTCloudConnector'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAuthorizationRules'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupDNSServiceRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDNSServiceRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCidrToConnectionPool'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupAuthorizationRules'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceEntry'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceEntryAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupIpMappingRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIoTCloudConnectorGroupAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAuthorizationRules'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIoTCloudConnectorBackhaulRoute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListService'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorGroups'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupDNSServiceRuleAttribute'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIpMappingRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnectionPools'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseInfoForSingleCard'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAuthorizationRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDNSServiceRules'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDiagnoseTaskForSingleCard'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDiagnoseResultForSingleCard'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupDNSServiceRules'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIpMappingRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveGroupAuthorizationRuleToDNSService'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnectionPoolIps'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIoTCloudConnectorAvailableZones'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateVSwitchFromIoTCloudConnector'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupIpMappingRule'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIoTCloudConnectorGroup'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIoTCloudConnector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateIpFromConnectionPool'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupIpMappingRules'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceEntry'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddIoTCloudConnectorToGroup'], + ], + 'product' => ['code' => 'uis', 'title' => '云连接器'], + ], + 'ram' => [ + 'productCode' => 'UIS', + 'productName' => '云连接器', + 'ramCodes' => ['fivegcc', 'iotcc'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'EnableIoTCloudConnectorAccessLog', + 'description' => '开启访问日志功能', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:EnableIoTCloudConnectorAccessLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'MoveGroupAuthorizationRuleToDNSService', + 'description' => '实例组规则转移到DNS授权规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:MoveGroupAuthorizationRuleToDNSService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateConnectionPoolAttribute', + 'description' => '更新连接地址池', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateConnectionPoolAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListDiagnoseInfoForSingleCard', + 'description' => '查询单卡诊断的诊断结果信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListDiagnoseInfoForSingleCard', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateDNSServiceRule', + 'description' => '创建DNS授权规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateDNSServiceRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'GetIoTCloudConnectorAccessLog', + 'description' => '获取指定云连接器访问日志', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:GetIoTCloudConnectorAccessLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGroupDNSServiceRuleAttribute', + 'description' => '改实例组的DNS授权规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:UpdateGroupDNSServiceRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'SubmitDiagnoseTaskForSingleCard', + 'description' => '提交单卡诊断任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:SubmitDiagnoseTaskForSingleCard', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'AssociateVSwitchWithIoTCloudConnector', + 'description' => '交换机与云连接器实例进行关联', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:AssociateVSwitchWithIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'VSwitch', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}'], + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'VPC', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}'], + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGroupIpMappingRule', + 'description' => '修改实例组授权规则IP重定向的相关信', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateGroupIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateGroupDNSServiceRule', + 'description' => '实例组创建DNS授权规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateGroupDNSServiceRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'AddCidrToConnectionPool', + 'description' => '连接池增加连接IP段', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:AddCidrToConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteService', + 'description' => '删除分应用统计服务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateService', + 'description' => '创建分应用统计服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteServiceEntry', + 'description' => '删除分应用统计条目', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteServiceEntry', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateDNSServiceRuleAttribute', + 'description' => '修改DNS授权规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateDNSServiceRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateIoTCloudConnectorAttribute', + 'description' => '更新云连接器实例信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateIoTCloudConnectorAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateAuthorizationRules', + 'description' => '创建多条授权规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateAuthorizationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListAPNs', + 'description' => '查询APN', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iotcc:ListAPNs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'MoveAuthorizationRuleToDNSService', + 'description' => '授权规则转移到DNS授权规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:MoveAuthorizationRuleToDNSService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DisableIoTCloudConnectorAccessLog', + 'description' => '关闭访问日志功能', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:DisableIoTCloudConnectorAccessLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListIoTCoudConnectorBackhaulRoute', + 'description' => '查询当前云连接器实例绑定VPC后的回程路由', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCoudConnectorBackhaulRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListGroupIpMappingRules', + 'description' => '查询实例组授权规则IP重定向信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListGroupIpMappingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateGroupAuthorizationRule', + 'description' => '实例组创建授权规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateGroupAuthorizationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateConnectionPool', + 'description' => '创建连接地址池', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateIpMappingRule', + 'description' => '修改授权规则IP重定向的相关信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateAuthorizationRule', + 'description' => '创建授权规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateAuthorizationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteIoTCloudConnetorBackhaulRoute', + 'description' => '删除当前云连接器实例绑定VPC后的回程路由', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteIoTCloudConnetorBackhaulRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'GrantVirtualBorderRouter', + 'description' => '授权绑定VBR', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:GrantVirtualBorderRouter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateIpMappingRule', + 'description' => '创建授权规则IP的重定向功能', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListIoTCloudConnectors', + 'description' => '查询云连接器实例信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCloudConnectors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/*'], + ], + ], + ], + [ + 'apiName' => 'ConfirmIoTCloudConnector', + 'description' => '确认或拒绝云连接器实例过户', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:ConfirmIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateServiceEntryAttribute', + 'description' => '修改分应用统计列表的应用条目', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateServiceEntryAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDNSServiceRule', + 'description' => '删除DNS授权规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteDNSServiceRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'GetConnectionPoolIpOperationResult', + 'description' => '获取IP地址绑定与解绑结果', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:GetConnectionPoolIpOperationResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateServiceAttribute', + 'description' => '修改分应用统计服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateServiceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteIoTCloudConnector', + 'description' => '删除云连接器实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteGroupDNSServiceRule', + 'description' => '删除实例组的DNS授权规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteGroupDNSServiceRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListConnectionPoolAllIps', + 'description' => '查询连接地址池所有IP地址', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListConnectionPoolAllIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListIoTCloudConnectorGroups', + 'description' => '查询实例组列表信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCloudConnectorGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteGroupIpMappingRule', + 'description' => '删除实例组授权规则IP重定向信息', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteGroupIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'OpenIoTCloudConnectorService', + 'description' => '开通云连接器服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:OpenIoTCloudConnectorService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetStsInfoAndOssPath', + 'description' => '获取服务账号信息和提交地址', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:GetStsInfoAndOssPath', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListConnectionPools', + 'description' => '查询云连接地址池', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListConnectionPools', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListServiceEntries', + 'description' => '查询分应用统计条目', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListServiceEntries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListIpMappingRules', + 'description' => '查询授权规则IP重定向信息', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iotcc:ListIpMappingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListAuthorizationRules', + 'description' => '查询授权规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListAuthorizationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListDNSServiceRules', + 'description' => '查询DNS授权规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListDNSServiceRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRegions', + 'description' => '查询云连接器支持的地域列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iotcc:ListRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAuthorizationRuleAttribute', + 'description' => '更新授权规则信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateAuthorizationRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListConnectionPoolIps', + 'description' => '查询连接地址池中的IP地址状态', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListConnectionPoolIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteAuthorizationRule', + 'description' => '删除授权规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteAuthorizationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateIoTCloudConnector', + 'description' => '创建云连接器实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAuthorizationRules', + 'description' => '批量删除授权规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteAuthorizationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteIoTCloudConnectorGroup', + 'description' => '删除实例组', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteIoTCloudConnectorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListGroupAuthorizationRules', + 'description' => '查询实例组的授权规则', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iotcc:ListGroupAuthorizationRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListGroupDNSServiceRules', + 'description' => '查询实例组的DNS授权规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListGroupDNSServiceRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListService', + 'description' => '查询分应用统计服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGroupAuthorizationRuleAttribute', + 'description' => '修改实例组的授权规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateGroupAuthorizationRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'RevertIoTCloudConnector', + 'description' => '归还已拒绝过户的云连接器实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:RevertIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'GetDiagnoseResultForSingleCard', + 'description' => '获取单卡诊断结果', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:GetDiagnoseResultForSingleCard', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateIoTCloudConnectorGroupAttribute', + 'description' => '修改云连接器分组属性', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:UpdateIoTCloudConnectorGroupAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'ListIoTCloudConnectorEIPs', + 'description' => '查询云连接器实例关联的弹性公网IP列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCloudConnectorEIPs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateIoTCloudConnectorGroup', + 'description' => '创建实例组', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateIoTCloudConnectorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListIoTCloudConnectorAvailableZones', + 'description' => 'IoTCC实例绑定交换机可用区', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iotcc:ListIoTCloudConnectorAvailableZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DissociateIpFromConnectionPool', + 'description' => '解绑卡IP', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:DissociateIpFromConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateIoTCloudConnectorBackhaulRoute', + 'description' => '创建当前云连接器实例绑定VPC后的回程路由', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateIoTCloudConnectorBackhaulRoute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'AssociateIpWithConnectionPool', + 'description' => '绑定IP地址与云连接器关联的连接地址池', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:AssociateIpWithConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteIpMappingRule', + 'description' => '删除授权规则IP重定向信息', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateGroupIpMappingRule', + 'description' => '创建实例组授权规则IP的重定向规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateGroupIpMappingRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'RemoveIoTCloudConnectorFromGroup', + 'description' => '将云连接器实例从实例组中移除', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:RemoveIoTCloudConnectorFromGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteGroupAuthorizationRule', + 'description' => '删除实例组的授权规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteGroupAuthorizationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'AddIoTCloudConnectorToGroup', + 'description' => '添加云连接器到分组中', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:AddIoTCloudConnectorToGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteConnectionPool', + 'description' => '删除连接地址池', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iotcc:DeleteConnectionPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'DissociateVSwitchFromIoTCloudConnector', + 'description' => '解绑vsw/vpc', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iotcc:DissociateVSwitchFromIoTCloudConnector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ], + ], + ], + [ + 'apiName' => 'CreateServiceEntry', + 'description' => '分应用功能列表中添加应用条目', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iotcc:CreateServiceEntry', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'UIS', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}'], + ['validationType' => 'always', 'resourceType' => 'VSwitch', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}'], + ['validationType' => 'always', 'resourceType' => 'VPC', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}'], + ['validationType' => 'always', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/*'], + ['validationType' => 'always', 'resourceType' => 'CloudConnector', 'arn' => 'acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}'], ], ], ]; |